github.com/twilio/twilio-go@v1.20.1/rest/studio/v1/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  [**DeleteFlow**](FlowsApi.md#DeleteFlow) | **Delete** /v1/Flows/{Sid} | 
     8  [**FetchFlow**](FlowsApi.md#FetchFlow) | **Get** /v1/Flows/{Sid} | 
     9  [**ListFlow**](FlowsApi.md#ListFlow) | **Get** /v1/Flows | 
    10  
    11  
    12  
    13  ## DeleteFlow
    14  
    15  > DeleteFlow(ctx, Sid)
    16  
    17  
    18  
    19  Delete a specific Flow.
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **Sid** | **string** | The SID of the Flow resource to delete.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a DeleteFlowParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  
    37  ### Return type
    38  
    39   (empty response body)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: Not defined
    48  - **Accept**: Not defined
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## FetchFlow
    56  
    57  > StudioV1Flow FetchFlow(ctx, Sid)
    58  
    59  
    60  
    61  Retrieve a specific Flow.
    62  
    63  ### Path Parameters
    64  
    65  
    66  Name | Type | Description
    67  ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **Sid** | **string** | The SID of the Flow resource to fetch.
    70  
    71  ### Other Parameters
    72  
    73  Other parameters are passed through a pointer to a FetchFlowParams struct
    74  
    75  
    76  Name | Type | Description
    77  ------------- | ------------- | -------------
    78  
    79  ### Return type
    80  
    81  [**StudioV1Flow**](StudioV1Flow.md)
    82  
    83  ### Authorization
    84  
    85  [accountSid_authToken](../README.md#accountSid_authToken)
    86  
    87  ### HTTP request headers
    88  
    89  - **Content-Type**: Not defined
    90  - **Accept**: application/json
    91  
    92  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    93  [[Back to Model list]](../README.md#documentation-for-models)
    94  [[Back to README]](../README.md)
    95  
    96  
    97  ## ListFlow
    98  
    99  > []StudioV1Flow ListFlow(ctx, optional)
   100  
   101  
   102  
   103  Retrieve a list of all Flows.
   104  
   105  ### Path Parameters
   106  
   107  This endpoint does not need any path parameter.
   108  
   109  ### Other Parameters
   110  
   111  Other parameters are passed through a pointer to a ListFlowParams struct
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   117  **Limit** | **int** | Max number of records to return.
   118  
   119  ### Return type
   120  
   121  [**[]StudioV1Flow**](StudioV1Flow.md)
   122  
   123  ### Authorization
   124  
   125  [accountSid_authToken](../README.md#accountSid_authToken)
   126  
   127  ### HTTP request headers
   128  
   129  - **Content-Type**: Not defined
   130  - **Accept**: application/json
   131  
   132  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   133  [[Back to Model list]](../README.md#documentation-for-models)
   134  [[Back to README]](../README.md)
   135