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

     1  # TrustProductsApi
     2  
     3  All URIs are relative to *https://trusthub.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateTrustProduct**](TrustProductsApi.md#CreateTrustProduct) | **Post** /v1/TrustProducts | 
     8  [**DeleteTrustProduct**](TrustProductsApi.md#DeleteTrustProduct) | **Delete** /v1/TrustProducts/{Sid} | 
     9  [**FetchTrustProduct**](TrustProductsApi.md#FetchTrustProduct) | **Get** /v1/TrustProducts/{Sid} | 
    10  [**ListTrustProduct**](TrustProductsApi.md#ListTrustProduct) | **Get** /v1/TrustProducts | 
    11  [**UpdateTrustProduct**](TrustProductsApi.md#UpdateTrustProduct) | **Post** /v1/TrustProducts/{Sid} | 
    12  
    13  
    14  
    15  ## CreateTrustProduct
    16  
    17  > TrusthubV1TrustProduct CreateTrustProduct(ctx, optional)
    18  
    19  
    20  
    21  Create a new Trust Product.
    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 CreateTrustProductParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **FriendlyName** | **string** | The string that you assigned to describe the resource.
    35  **Email** | **string** | The email address that will receive updates when the Trust Product resource changes status.
    36  **PolicySid** | **string** | The unique string of a policy that is associated to the Trust Product resource.
    37  **StatusCallback** | **string** | The URL we call to inform your application of status changes.
    38  
    39  ### Return type
    40  
    41  [**TrusthubV1TrustProduct**](TrusthubV1TrustProduct.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  ## DeleteTrustProduct
    58  
    59  > DeleteTrustProduct(ctx, Sid)
    60  
    61  
    62  
    63  Delete a specific Trust Product.
    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 unique string that we created to identify the Trust Product resource.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a DeleteTrustProductParams 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  ## FetchTrustProduct
   100  
   101  > TrusthubV1TrustProduct FetchTrustProduct(ctx, Sid)
   102  
   103  
   104  
   105  Fetch a specific Trust Product instance.
   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 unique string that we created to identify the Trust Product resource.
   114  
   115  ### Other Parameters
   116  
   117  Other parameters are passed through a pointer to a FetchTrustProductParams struct
   118  
   119  
   120  Name | Type | Description
   121  ------------- | ------------- | -------------
   122  
   123  ### Return type
   124  
   125  [**TrusthubV1TrustProduct**](TrusthubV1TrustProduct.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  ## ListTrustProduct
   142  
   143  > []TrusthubV1TrustProduct ListTrustProduct(ctx, optional)
   144  
   145  
   146  
   147  Retrieve a list of all Trust Products for an account.
   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 ListTrustProductParams struct
   156  
   157  
   158  Name | Type | Description
   159  ------------- | ------------- | -------------
   160  **Status** | **string** | The verification status of the Trust Product resource.
   161  **FriendlyName** | **string** | The string that you assigned to describe the resource.
   162  **PolicySid** | **string** | The unique string of a policy that is associated to the Trust Product resource.
   163  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   164  **Limit** | **int** | Max number of records to return.
   165  
   166  ### Return type
   167  
   168  [**[]TrusthubV1TrustProduct**](TrusthubV1TrustProduct.md)
   169  
   170  ### Authorization
   171  
   172  [accountSid_authToken](../README.md#accountSid_authToken)
   173  
   174  ### HTTP request headers
   175  
   176  - **Content-Type**: Not defined
   177  - **Accept**: application/json
   178  
   179  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   180  [[Back to Model list]](../README.md#documentation-for-models)
   181  [[Back to README]](../README.md)
   182  
   183  
   184  ## UpdateTrustProduct
   185  
   186  > TrusthubV1TrustProduct UpdateTrustProduct(ctx, Sidoptional)
   187  
   188  
   189  
   190  Updates a Trust Product in an account.
   191  
   192  ### Path Parameters
   193  
   194  
   195  Name | Type | Description
   196  ------------- | ------------- | -------------
   197  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   198  **Sid** | **string** | The unique string that we created to identify the Trust Product resource.
   199  
   200  ### Other Parameters
   201  
   202  Other parameters are passed through a pointer to a UpdateTrustProductParams struct
   203  
   204  
   205  Name | Type | Description
   206  ------------- | ------------- | -------------
   207  **Status** | **string** | 
   208  **StatusCallback** | **string** | The URL we call to inform your application of status changes.
   209  **FriendlyName** | **string** | The string that you assigned to describe the resource.
   210  **Email** | **string** | The email address that will receive updates when the Trust Product resource changes status.
   211  
   212  ### Return type
   213  
   214  [**TrusthubV1TrustProduct**](TrusthubV1TrustProduct.md)
   215  
   216  ### Authorization
   217  
   218  [accountSid_authToken](../README.md#accountSid_authToken)
   219  
   220  ### HTTP request headers
   221  
   222  - **Content-Type**: application/x-www-form-urlencoded
   223  - **Accept**: application/json
   224  
   225  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   226  [[Back to Model list]](../README.md#documentation-for-models)
   227  [[Back to README]](../README.md)
   228