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

     1  # RegulatoryComplianceBundlesApi
     2  
     3  All URIs are relative to *https://numbers.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateBundle**](RegulatoryComplianceBundlesApi.md#CreateBundle) | **Post** /v2/RegulatoryCompliance/Bundles | 
     8  [**DeleteBundle**](RegulatoryComplianceBundlesApi.md#DeleteBundle) | **Delete** /v2/RegulatoryCompliance/Bundles/{Sid} | 
     9  [**FetchBundle**](RegulatoryComplianceBundlesApi.md#FetchBundle) | **Get** /v2/RegulatoryCompliance/Bundles/{Sid} | 
    10  [**ListBundle**](RegulatoryComplianceBundlesApi.md#ListBundle) | **Get** /v2/RegulatoryCompliance/Bundles | 
    11  [**UpdateBundle**](RegulatoryComplianceBundlesApi.md#UpdateBundle) | **Post** /v2/RegulatoryCompliance/Bundles/{Sid} | 
    12  
    13  
    14  
    15  ## CreateBundle
    16  
    17  > NumbersV2Bundle CreateBundle(ctx, optional)
    18  
    19  
    20  
    21  Create a new Bundle.
    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 CreateBundleParams 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 Bundle resource changes status.
    36  **StatusCallback** | **string** | The URL we call to inform your application of status changes.
    37  **RegulationSid** | **string** | The unique string of a regulation that is associated to the Bundle resource.
    38  **IsoCountry** | **string** | The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
    39  **EndUserType** | **string** | 
    40  **NumberType** | **string** | The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll free`.
    41  
    42  ### Return type
    43  
    44  [**NumbersV2Bundle**](NumbersV2Bundle.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeleteBundle
    61  
    62  > DeleteBundle(ctx, Sid)
    63  
    64  
    65  
    66  Delete a specific Bundle.
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **Sid** | **string** | The unique string that we created to identify the Bundle resource.
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a DeleteBundleParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  
    84  ### Return type
    85  
    86   (empty response body)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: Not defined
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## FetchBundle
   103  
   104  > NumbersV2Bundle FetchBundle(ctx, Sid)
   105  
   106  
   107  
   108  Fetch a specific Bundle instance.
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **Sid** | **string** | The unique string that we created to identify the Bundle resource.
   117  
   118  ### Other Parameters
   119  
   120  Other parameters are passed through a pointer to a FetchBundleParams struct
   121  
   122  
   123  Name | Type | Description
   124  ------------- | ------------- | -------------
   125  
   126  ### Return type
   127  
   128  [**NumbersV2Bundle**](NumbersV2Bundle.md)
   129  
   130  ### Authorization
   131  
   132  [accountSid_authToken](../README.md#accountSid_authToken)
   133  
   134  ### HTTP request headers
   135  
   136  - **Content-Type**: Not defined
   137  - **Accept**: application/json
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   140  [[Back to Model list]](../README.md#documentation-for-models)
   141  [[Back to README]](../README.md)
   142  
   143  
   144  ## ListBundle
   145  
   146  > []NumbersV2Bundle ListBundle(ctx, optional)
   147  
   148  
   149  
   150  Retrieve a list of all Bundles for an account.
   151  
   152  ### Path Parameters
   153  
   154  This endpoint does not need any path parameter.
   155  
   156  ### Other Parameters
   157  
   158  Other parameters are passed through a pointer to a ListBundleParams struct
   159  
   160  
   161  Name | Type | Description
   162  ------------- | ------------- | -------------
   163  **Status** | **string** | The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
   164  **FriendlyName** | **string** | The string that you assigned to describe the resource. The column can contain 255 variable characters.
   165  **RegulationSid** | **string** | The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
   166  **IsoCountry** | **string** | The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
   167  **NumberType** | **string** | The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`.
   168  **HasValidUntilDate** | **bool** | Indicates that the Bundle is a valid Bundle until a specified expiration date.
   169  **SortBy** | **string** | Can be `valid-until` or `date-updated`. Defaults to `date-created`.
   170  **SortDirection** | **string** | Default is `DESC`. Can be `ASC` or `DESC`.
   171  **ValidUntilDate** | **time.Time** | Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
   172  **ValidUntilDateBefore** | **time.Time** | Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
   173  **ValidUntilDateAfter** | **time.Time** | Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
   174  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   175  **Limit** | **int** | Max number of records to return.
   176  
   177  ### Return type
   178  
   179  [**[]NumbersV2Bundle**](NumbersV2Bundle.md)
   180  
   181  ### Authorization
   182  
   183  [accountSid_authToken](../README.md#accountSid_authToken)
   184  
   185  ### HTTP request headers
   186  
   187  - **Content-Type**: Not defined
   188  - **Accept**: application/json
   189  
   190  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   191  [[Back to Model list]](../README.md#documentation-for-models)
   192  [[Back to README]](../README.md)
   193  
   194  
   195  ## UpdateBundle
   196  
   197  > NumbersV2Bundle UpdateBundle(ctx, Sidoptional)
   198  
   199  
   200  
   201  Updates a Bundle in an account.
   202  
   203  ### Path Parameters
   204  
   205  
   206  Name | Type | Description
   207  ------------- | ------------- | -------------
   208  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   209  **Sid** | **string** | The unique string that we created to identify the Bundle resource.
   210  
   211  ### Other Parameters
   212  
   213  Other parameters are passed through a pointer to a UpdateBundleParams struct
   214  
   215  
   216  Name | Type | Description
   217  ------------- | ------------- | -------------
   218  **Status** | **string** | 
   219  **StatusCallback** | **string** | The URL we call to inform your application of status changes.
   220  **FriendlyName** | **string** | The string that you assigned to describe the resource.
   221  **Email** | **string** | The email address that will receive updates when the Bundle resource changes status.
   222  
   223  ### Return type
   224  
   225  [**NumbersV2Bundle**](NumbersV2Bundle.md)
   226  
   227  ### Authorization
   228  
   229  [accountSid_authToken](../README.md#accountSid_authToken)
   230  
   231  ### HTTP request headers
   232  
   233  - **Content-Type**: application/x-www-form-urlencoded
   234  - **Accept**: application/json
   235  
   236  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   237  [[Back to Model list]](../README.md#documentation-for-models)
   238  [[Back to README]](../README.md)
   239