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

     1  # SupportingDocumentsApi
     2  
     3  All URIs are relative to *https://trusthub.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSupportingDocument**](SupportingDocumentsApi.md#CreateSupportingDocument) | **Post** /v1/SupportingDocuments | 
     8  [**DeleteSupportingDocument**](SupportingDocumentsApi.md#DeleteSupportingDocument) | **Delete** /v1/SupportingDocuments/{Sid} | 
     9  [**FetchSupportingDocument**](SupportingDocumentsApi.md#FetchSupportingDocument) | **Get** /v1/SupportingDocuments/{Sid} | 
    10  [**ListSupportingDocument**](SupportingDocumentsApi.md#ListSupportingDocument) | **Get** /v1/SupportingDocuments | 
    11  [**UpdateSupportingDocument**](SupportingDocumentsApi.md#UpdateSupportingDocument) | **Post** /v1/SupportingDocuments/{Sid} | 
    12  
    13  
    14  
    15  ## CreateSupportingDocument
    16  
    17  > TrusthubV1SupportingDocument CreateSupportingDocument(ctx, optional)
    18  
    19  
    20  
    21  Create a new Supporting Document.
    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 CreateSupportingDocumentParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **FriendlyName** | **string** | The string that you assigned to describe the resource.
    35  **Type** | **string** | The type of the Supporting Document.
    36  **Attributes** | [**interface{}**](interface{}.md) | The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
    37  
    38  ### Return type
    39  
    40  [**TrusthubV1SupportingDocument**](TrusthubV1SupportingDocument.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  ## DeleteSupportingDocument
    57  
    58  > DeleteSupportingDocument(ctx, Sid)
    59  
    60  
    61  
    62  Delete a specific Supporting Document.
    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 unique string created by Twilio to identify the Supporting Document resource.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a DeleteSupportingDocumentParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  
    80  ### Return type
    81  
    82   (empty response body)
    83  
    84  ### Authorization
    85  
    86  [accountSid_authToken](../README.md#accountSid_authToken)
    87  
    88  ### HTTP request headers
    89  
    90  - **Content-Type**: Not defined
    91  - **Accept**: Not defined
    92  
    93  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    94  [[Back to Model list]](../README.md#documentation-for-models)
    95  [[Back to README]](../README.md)
    96  
    97  
    98  ## FetchSupportingDocument
    99  
   100  > TrusthubV1SupportingDocument FetchSupportingDocument(ctx, Sid)
   101  
   102  
   103  
   104  Fetch specific Supporting Document Instance.
   105  
   106  ### Path Parameters
   107  
   108  
   109  Name | Type | Description
   110  ------------- | ------------- | -------------
   111  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   112  **Sid** | **string** | The unique string created by Twilio to identify the Supporting Document resource.
   113  
   114  ### Other Parameters
   115  
   116  Other parameters are passed through a pointer to a FetchSupportingDocumentParams struct
   117  
   118  
   119  Name | Type | Description
   120  ------------- | ------------- | -------------
   121  
   122  ### Return type
   123  
   124  [**TrusthubV1SupportingDocument**](TrusthubV1SupportingDocument.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  ## ListSupportingDocument
   141  
   142  > []TrusthubV1SupportingDocument ListSupportingDocument(ctx, optional)
   143  
   144  
   145  
   146  Retrieve a list of all Supporting Document for an account.
   147  
   148  ### Path Parameters
   149  
   150  This endpoint does not need any path parameter.
   151  
   152  ### Other Parameters
   153  
   154  Other parameters are passed through a pointer to a ListSupportingDocumentParams struct
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   160  **Limit** | **int** | Max number of records to return.
   161  
   162  ### Return type
   163  
   164  [**[]TrusthubV1SupportingDocument**](TrusthubV1SupportingDocument.md)
   165  
   166  ### Authorization
   167  
   168  [accountSid_authToken](../README.md#accountSid_authToken)
   169  
   170  ### HTTP request headers
   171  
   172  - **Content-Type**: Not defined
   173  - **Accept**: application/json
   174  
   175  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   176  [[Back to Model list]](../README.md#documentation-for-models)
   177  [[Back to README]](../README.md)
   178  
   179  
   180  ## UpdateSupportingDocument
   181  
   182  > TrusthubV1SupportingDocument UpdateSupportingDocument(ctx, Sidoptional)
   183  
   184  
   185  
   186  Update an existing Supporting Document.
   187  
   188  ### Path Parameters
   189  
   190  
   191  Name | Type | Description
   192  ------------- | ------------- | -------------
   193  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   194  **Sid** | **string** | The unique string created by Twilio to identify the Supporting Document resource.
   195  
   196  ### Other Parameters
   197  
   198  Other parameters are passed through a pointer to a UpdateSupportingDocumentParams struct
   199  
   200  
   201  Name | Type | Description
   202  ------------- | ------------- | -------------
   203  **FriendlyName** | **string** | The string that you assigned to describe the resource.
   204  **Attributes** | [**interface{}**](interface{}.md) | The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
   205  
   206  ### Return type
   207  
   208  [**TrusthubV1SupportingDocument**](TrusthubV1SupportingDocument.md)
   209  
   210  ### Authorization
   211  
   212  [accountSid_authToken](../README.md#accountSid_authToken)
   213  
   214  ### HTTP request headers
   215  
   216  - **Content-Type**: application/x-www-form-urlencoded
   217  - **Accept**: application/json
   218  
   219  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   220  [[Back to Model list]](../README.md#documentation-for-models)
   221  [[Back to README]](../README.md)
   222