github.com/twilio/twilio-go@v1.20.1/rest/studio/v2/docs/FlowsApi.md (about)

     1  # FlowsApi
     2  
     3  All URIs are relative to *https://studio.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateFlow**](FlowsApi.md#CreateFlow) | **Post** /v2/Flows | 
     8  [**DeleteFlow**](FlowsApi.md#DeleteFlow) | **Delete** /v2/Flows/{Sid} | 
     9  [**FetchFlow**](FlowsApi.md#FetchFlow) | **Get** /v2/Flows/{Sid} | 
    10  [**ListFlow**](FlowsApi.md#ListFlow) | **Get** /v2/Flows | 
    11  [**UpdateFlow**](FlowsApi.md#UpdateFlow) | **Post** /v2/Flows/{Sid} | 
    12  
    13  
    14  
    15  ## CreateFlow
    16  
    17  > StudioV2Flow CreateFlow(ctx, optional)
    18  
    19  
    20  
    21  Create a Flow.
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateFlowParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **FriendlyName** | **string** | The string that you assigned to describe the Flow.
    35  **Status** | **string** | 
    36  **Definition** | [**interface{}**](interface{}.md) | JSON representation of flow definition.
    37  **CommitMessage** | **string** | Description of change made in the revision.
    38  
    39  ### Return type
    40  
    41  [**StudioV2Flow**](StudioV2Flow.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: application/x-www-form-urlencoded
    50  - **Accept**: application/json
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## DeleteFlow
    58  
    59  > DeleteFlow(ctx, Sid)
    60  
    61  
    62  
    63  Delete a specific Flow.
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **Sid** | **string** | The SID of the Flow resource to delete.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a DeleteFlowParams struct
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  
    81  ### Return type
    82  
    83   (empty response body)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: Not defined
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97  
    98  
    99  ## FetchFlow
   100  
   101  > StudioV2Flow FetchFlow(ctx, Sid)
   102  
   103  
   104  
   105  Retrieve a specific Flow.
   106  
   107  ### Path Parameters
   108  
   109  
   110  Name | Type | Description
   111  ------------- | ------------- | -------------
   112  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   113  **Sid** | **string** | The SID of the Flow resource to fetch.
   114  
   115  ### Other Parameters
   116  
   117  Other parameters are passed through a pointer to a FetchFlowParams struct
   118  
   119  
   120  Name | Type | Description
   121  ------------- | ------------- | -------------
   122  
   123  ### Return type
   124  
   125  [**StudioV2Flow**](StudioV2Flow.md)
   126  
   127  ### Authorization
   128  
   129  [accountSid_authToken](../README.md#accountSid_authToken)
   130  
   131  ### HTTP request headers
   132  
   133  - **Content-Type**: Not defined
   134  - **Accept**: application/json
   135  
   136  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   137  [[Back to Model list]](../README.md#documentation-for-models)
   138  [[Back to README]](../README.md)
   139  
   140  
   141  ## ListFlow
   142  
   143  > []StudioV2Flow ListFlow(ctx, optional)
   144  
   145  
   146  
   147  Retrieve a list of all Flows.
   148  
   149  ### Path Parameters
   150  
   151  This endpoint does not need any path parameter.
   152  
   153  ### Other Parameters
   154  
   155  Other parameters are passed through a pointer to a ListFlowParams struct
   156  
   157  
   158  Name | Type | Description
   159  ------------- | ------------- | -------------
   160  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   161  **Limit** | **int** | Max number of records to return.
   162  
   163  ### Return type
   164  
   165  [**[]StudioV2Flow**](StudioV2Flow.md)
   166  
   167  ### Authorization
   168  
   169  [accountSid_authToken](../README.md#accountSid_authToken)
   170  
   171  ### HTTP request headers
   172  
   173  - **Content-Type**: Not defined
   174  - **Accept**: application/json
   175  
   176  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   177  [[Back to Model list]](../README.md#documentation-for-models)
   178  [[Back to README]](../README.md)
   179  
   180  
   181  ## UpdateFlow
   182  
   183  > StudioV2Flow UpdateFlow(ctx, Sidoptional)
   184  
   185  
   186  
   187  Update a Flow.
   188  
   189  ### Path Parameters
   190  
   191  
   192  Name | Type | Description
   193  ------------- | ------------- | -------------
   194  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   195  **Sid** | **string** | The SID of the Flow resource to fetch.
   196  
   197  ### Other Parameters
   198  
   199  Other parameters are passed through a pointer to a UpdateFlowParams struct
   200  
   201  
   202  Name | Type | Description
   203  ------------- | ------------- | -------------
   204  **Status** | **string** | 
   205  **FriendlyName** | **string** | The string that you assigned to describe the Flow.
   206  **Definition** | [**interface{}**](interface{}.md) | JSON representation of flow definition.
   207  **CommitMessage** | **string** | Description of change made in the revision.
   208  
   209  ### Return type
   210  
   211  [**StudioV2Flow**](StudioV2Flow.md)
   212  
   213  ### Authorization
   214  
   215  [accountSid_authToken](../README.md#accountSid_authToken)
   216  
   217  ### HTTP request headers
   218  
   219  - **Content-Type**: application/x-www-form-urlencoded
   220  - **Accept**: application/json
   221  
   222  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   223  [[Back to Model list]](../README.md#documentation-for-models)
   224  [[Back to README]](../README.md)
   225