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

     1  # TypesApi
     2  
     3  All URIs are relative to *https://events.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchEventType**](TypesApi.md#FetchEventType) | **Get** /v1/Types/{Type} | 
     8  [**ListEventType**](TypesApi.md#ListEventType) | **Get** /v1/Types | 
     9  
    10  
    11  
    12  ## FetchEventType
    13  
    14  > EventsV1EventType FetchEventType(ctx, Type)
    15  
    16  
    17  
    18  Fetch a specific Event Type.
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **Type** | **string** | A string that uniquely identifies this Event Type.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchEventTypeParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**EventsV1EventType**](EventsV1EventType.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## ListEventType
    55  
    56  > []EventsV1EventType ListEventType(ctx, optional)
    57  
    58  
    59  
    60  Retrieve a paginated list of all the available Event Types.
    61  
    62  ### Path Parameters
    63  
    64  This endpoint does not need any path parameter.
    65  
    66  ### Other Parameters
    67  
    68  Other parameters are passed through a pointer to a ListEventTypeParams struct
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **SchemaId** | **string** | A string parameter filtering the results to return only the Event Types using a given schema.
    74  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    75  **Limit** | **int** | Max number of records to return.
    76  
    77  ### Return type
    78  
    79  [**[]EventsV1EventType**](EventsV1EventType.md)
    80  
    81  ### Authorization
    82  
    83  [accountSid_authToken](../README.md#accountSid_authToken)
    84  
    85  ### HTTP request headers
    86  
    87  - **Content-Type**: Not defined
    88  - **Accept**: application/json
    89  
    90  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    91  [[Back to Model list]](../README.md#documentation-for-models)
    92  [[Back to README]](../README.md)
    93