github.com/twilio/twilio-go@v1.20.1/rest/flex/v1/docs/PluginServicePluginsApi.md (about)

     1  # PluginServicePluginsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreatePlugin**](PluginServicePluginsApi.md#CreatePlugin) | **Post** /v1/PluginService/Plugins | 
     8  [**FetchPlugin**](PluginServicePluginsApi.md#FetchPlugin) | **Get** /v1/PluginService/Plugins/{Sid} | 
     9  [**ListPlugin**](PluginServicePluginsApi.md#ListPlugin) | **Get** /v1/PluginService/Plugins | 
    10  [**UpdatePlugin**](PluginServicePluginsApi.md#UpdatePlugin) | **Post** /v1/PluginService/Plugins/{Sid} | 
    11  
    12  
    13  
    14  ## CreatePlugin
    15  
    16  > FlexV1Plugin CreatePlugin(ctx, optional)
    17  
    18  
    19  
    20  
    21  
    22  ### Path Parameters
    23  
    24  This endpoint does not need any path parameter.
    25  
    26  ### Other Parameters
    27  
    28  Other parameters are passed through a pointer to a CreatePluginParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **FlexMetadata** | **string** | The Flex-Metadata HTTP request header
    34  **UniqueName** | **string** | The Flex Plugin's unique name.
    35  **FriendlyName** | **string** | The Flex Plugin's friendly name.
    36  **Description** | **string** | A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
    37  
    38  ### Return type
    39  
    40  [**FlexV1Plugin**](FlexV1Plugin.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: application/x-www-form-urlencoded
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## FetchPlugin
    57  
    58  > FlexV1Plugin FetchPlugin(ctx, Sidoptional)
    59  
    60  
    61  
    62  
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **Sid** | **string** | The SID of the Flex Plugin resource to fetch.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a FetchPluginParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  **FlexMetadata** | **string** | The Flex-Metadata HTTP request header
    80  
    81  ### Return type
    82  
    83  [**FlexV1Plugin**](FlexV1Plugin.md)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: application/json
    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  ## ListPlugin
   100  
   101  > []FlexV1Plugin ListPlugin(ctx, optional)
   102  
   103  
   104  
   105  
   106  
   107  ### Path Parameters
   108  
   109  This endpoint does not need any path parameter.
   110  
   111  ### Other Parameters
   112  
   113  Other parameters are passed through a pointer to a ListPluginParams struct
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  **FlexMetadata** | **string** | The Flex-Metadata HTTP request header
   119  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   120  **Limit** | **int** | Max number of records to return.
   121  
   122  ### Return type
   123  
   124  [**[]FlexV1Plugin**](FlexV1Plugin.md)
   125  
   126  ### Authorization
   127  
   128  [accountSid_authToken](../README.md#accountSid_authToken)
   129  
   130  ### HTTP request headers
   131  
   132  - **Content-Type**: Not defined
   133  - **Accept**: application/json
   134  
   135  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   136  [[Back to Model list]](../README.md#documentation-for-models)
   137  [[Back to README]](../README.md)
   138  
   139  
   140  ## UpdatePlugin
   141  
   142  > FlexV1Plugin UpdatePlugin(ctx, Sidoptional)
   143  
   144  
   145  
   146  
   147  
   148  ### Path Parameters
   149  
   150  
   151  Name | Type | Description
   152  ------------- | ------------- | -------------
   153  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   154  **Sid** | **string** | The SID of the Flex Plugin resource to update.
   155  
   156  ### Other Parameters
   157  
   158  Other parameters are passed through a pointer to a UpdatePluginParams struct
   159  
   160  
   161  Name | Type | Description
   162  ------------- | ------------- | -------------
   163  **FlexMetadata** | **string** | The Flex-Metadata HTTP request header
   164  **FriendlyName** | **string** | The Flex Plugin's friendly name.
   165  **Description** | **string** | A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
   166  
   167  ### Return type
   168  
   169  [**FlexV1Plugin**](FlexV1Plugin.md)
   170  
   171  ### Authorization
   172  
   173  [accountSid_authToken](../README.md#accountSid_authToken)
   174  
   175  ### HTTP request headers
   176  
   177  - **Content-Type**: application/x-www-form-urlencoded
   178  - **Accept**: application/json
   179  
   180  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   181  [[Back to Model list]](../README.md#documentation-for-models)
   182  [[Back to README]](../README.md)
   183