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

     1  # Go API client for openapi
     2  
     3  This is the public Twilio REST API.
     4  
     5  ## Overview
     6  This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specs located at [twilio/twilio-oai](https://github.com/twilio/twilio-oai/tree/main/spec).  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
     7  
     8  - API version: 1.0.0
     9  - Package version: 1.0.0
    10  - Build package: com.twilio.oai.TwilioGoGenerator
    11  For more information, please visit [https://support.twilio.com](https://support.twilio.com)
    12  
    13  ## Installation
    14  
    15  Install the following dependencies:
    16  
    17  ```shell
    18  go get github.com/stretchr/testify/assert
    19  go get golang.org/x/net/context
    20  ```
    21  
    22  Put the package under your project folder and add the following in import:
    23  
    24  ```golang
    25  import "./openapi"
    26  ```
    27  
    28  ## Documentation for API Endpoints
    29  
    30  All URIs are relative to *https://trusthub.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ComplianceInquiriesCustomersInitializeApi* | [**CreateComplianceInquiry**](docs/ComplianceInquiriesCustomersInitializeApi.md#createcomplianceinquiry) | **Post** /v1/ComplianceInquiries/Customers/Initialize | 
    35  *ComplianceInquiriesCustomersInitializeApi* | [**UpdateComplianceInquiry**](docs/ComplianceInquiriesCustomersInitializeApi.md#updatecomplianceinquiry) | **Post** /v1/ComplianceInquiries/Customers/{CustomerId}/Initialize | 
    36  *ComplianceInquiriesRegistrationRegulatoryComplianceGBInitializeApi* | [**CreateComplianceRegistration**](docs/ComplianceInquiriesRegistrationRegulatoryComplianceGBInitializeApi.md#createcomplianceregistration) | **Post** /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize | 
    37  *ComplianceInquiriesRegistrationRegulatoryComplianceGBInitializeApi* | [**UpdateComplianceRegistration**](docs/ComplianceInquiriesRegistrationRegulatoryComplianceGBInitializeApi.md#updatecomplianceregistration) | **Post** /v1/ComplianceInquiries/Registration/{RegistrationId}/RegulatoryCompliance/GB/Initialize | 
    38  *ComplianceInquiriesTollfreeInitializeApi* | [**CreateComplianceTollfreeInquiry**](docs/ComplianceInquiriesTollfreeInitializeApi.md#createcompliancetollfreeinquiry) | **Post** /v1/ComplianceInquiries/Tollfree/Initialize | 
    39  *CustomerProfilesApi* | [**CreateCustomerProfile**](docs/CustomerProfilesApi.md#createcustomerprofile) | **Post** /v1/CustomerProfiles | 
    40  *CustomerProfilesApi* | [**DeleteCustomerProfile**](docs/CustomerProfilesApi.md#deletecustomerprofile) | **Delete** /v1/CustomerProfiles/{Sid} | 
    41  *CustomerProfilesApi* | [**FetchCustomerProfile**](docs/CustomerProfilesApi.md#fetchcustomerprofile) | **Get** /v1/CustomerProfiles/{Sid} | 
    42  *CustomerProfilesApi* | [**ListCustomerProfile**](docs/CustomerProfilesApi.md#listcustomerprofile) | **Get** /v1/CustomerProfiles | 
    43  *CustomerProfilesApi* | [**UpdateCustomerProfile**](docs/CustomerProfilesApi.md#updatecustomerprofile) | **Post** /v1/CustomerProfiles/{Sid} | 
    44  *CustomerProfilesChannelEndpointAssignmentsApi* | [**CreateCustomerProfileChannelEndpointAssignment**](docs/CustomerProfilesChannelEndpointAssignmentsApi.md#createcustomerprofilechannelendpointassignment) | **Post** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments | 
    45  *CustomerProfilesChannelEndpointAssignmentsApi* | [**DeleteCustomerProfileChannelEndpointAssignment**](docs/CustomerProfilesChannelEndpointAssignmentsApi.md#deletecustomerprofilechannelendpointassignment) | **Delete** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid} | 
    46  *CustomerProfilesChannelEndpointAssignmentsApi* | [**FetchCustomerProfileChannelEndpointAssignment**](docs/CustomerProfilesChannelEndpointAssignmentsApi.md#fetchcustomerprofilechannelendpointassignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid} | 
    47  *CustomerProfilesChannelEndpointAssignmentsApi* | [**ListCustomerProfileChannelEndpointAssignment**](docs/CustomerProfilesChannelEndpointAssignmentsApi.md#listcustomerprofilechannelendpointassignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments | 
    48  *CustomerProfilesEntityAssignmentsApi* | [**CreateCustomerProfileEntityAssignment**](docs/CustomerProfilesEntityAssignmentsApi.md#createcustomerprofileentityassignment) | **Post** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments | 
    49  *CustomerProfilesEntityAssignmentsApi* | [**DeleteCustomerProfileEntityAssignment**](docs/CustomerProfilesEntityAssignmentsApi.md#deletecustomerprofileentityassignment) | **Delete** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid} | 
    50  *CustomerProfilesEntityAssignmentsApi* | [**FetchCustomerProfileEntityAssignment**](docs/CustomerProfilesEntityAssignmentsApi.md#fetchcustomerprofileentityassignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid} | 
    51  *CustomerProfilesEntityAssignmentsApi* | [**ListCustomerProfileEntityAssignment**](docs/CustomerProfilesEntityAssignmentsApi.md#listcustomerprofileentityassignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments | 
    52  *CustomerProfilesEvaluationsApi* | [**CreateCustomerProfileEvaluation**](docs/CustomerProfilesEvaluationsApi.md#createcustomerprofileevaluation) | **Post** /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations | 
    53  *CustomerProfilesEvaluationsApi* | [**FetchCustomerProfileEvaluation**](docs/CustomerProfilesEvaluationsApi.md#fetchcustomerprofileevaluation) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid} | 
    54  *CustomerProfilesEvaluationsApi* | [**ListCustomerProfileEvaluation**](docs/CustomerProfilesEvaluationsApi.md#listcustomerprofileevaluation) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations | 
    55  *EndUserTypesApi* | [**FetchEndUserType**](docs/EndUserTypesApi.md#fetchendusertype) | **Get** /v1/EndUserTypes/{Sid} | 
    56  *EndUserTypesApi* | [**ListEndUserType**](docs/EndUserTypesApi.md#listendusertype) | **Get** /v1/EndUserTypes | 
    57  *EndUsersApi* | [**CreateEndUser**](docs/EndUsersApi.md#createenduser) | **Post** /v1/EndUsers | 
    58  *EndUsersApi* | [**DeleteEndUser**](docs/EndUsersApi.md#deleteenduser) | **Delete** /v1/EndUsers/{Sid} | 
    59  *EndUsersApi* | [**FetchEndUser**](docs/EndUsersApi.md#fetchenduser) | **Get** /v1/EndUsers/{Sid} | 
    60  *EndUsersApi* | [**ListEndUser**](docs/EndUsersApi.md#listenduser) | **Get** /v1/EndUsers | 
    61  *EndUsersApi* | [**UpdateEndUser**](docs/EndUsersApi.md#updateenduser) | **Post** /v1/EndUsers/{Sid} | 
    62  *PoliciesApi* | [**FetchPolicies**](docs/PoliciesApi.md#fetchpolicies) | **Get** /v1/Policies/{Sid} | 
    63  *PoliciesApi* | [**ListPolicies**](docs/PoliciesApi.md#listpolicies) | **Get** /v1/Policies | 
    64  *SupportingDocumentTypesApi* | [**FetchSupportingDocumentType**](docs/SupportingDocumentTypesApi.md#fetchsupportingdocumenttype) | **Get** /v1/SupportingDocumentTypes/{Sid} | 
    65  *SupportingDocumentTypesApi* | [**ListSupportingDocumentType**](docs/SupportingDocumentTypesApi.md#listsupportingdocumenttype) | **Get** /v1/SupportingDocumentTypes | 
    66  *SupportingDocumentsApi* | [**CreateSupportingDocument**](docs/SupportingDocumentsApi.md#createsupportingdocument) | **Post** /v1/SupportingDocuments | 
    67  *SupportingDocumentsApi* | [**DeleteSupportingDocument**](docs/SupportingDocumentsApi.md#deletesupportingdocument) | **Delete** /v1/SupportingDocuments/{Sid} | 
    68  *SupportingDocumentsApi* | [**FetchSupportingDocument**](docs/SupportingDocumentsApi.md#fetchsupportingdocument) | **Get** /v1/SupportingDocuments/{Sid} | 
    69  *SupportingDocumentsApi* | [**ListSupportingDocument**](docs/SupportingDocumentsApi.md#listsupportingdocument) | **Get** /v1/SupportingDocuments | 
    70  *SupportingDocumentsApi* | [**UpdateSupportingDocument**](docs/SupportingDocumentsApi.md#updatesupportingdocument) | **Post** /v1/SupportingDocuments/{Sid} | 
    71  *TrustProductsApi* | [**CreateTrustProduct**](docs/TrustProductsApi.md#createtrustproduct) | **Post** /v1/TrustProducts | 
    72  *TrustProductsApi* | [**DeleteTrustProduct**](docs/TrustProductsApi.md#deletetrustproduct) | **Delete** /v1/TrustProducts/{Sid} | 
    73  *TrustProductsApi* | [**FetchTrustProduct**](docs/TrustProductsApi.md#fetchtrustproduct) | **Get** /v1/TrustProducts/{Sid} | 
    74  *TrustProductsApi* | [**ListTrustProduct**](docs/TrustProductsApi.md#listtrustproduct) | **Get** /v1/TrustProducts | 
    75  *TrustProductsApi* | [**UpdateTrustProduct**](docs/TrustProductsApi.md#updatetrustproduct) | **Post** /v1/TrustProducts/{Sid} | 
    76  *TrustProductsChannelEndpointAssignmentsApi* | [**CreateTrustProductChannelEndpointAssignment**](docs/TrustProductsChannelEndpointAssignmentsApi.md#createtrustproductchannelendpointassignment) | **Post** /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments | 
    77  *TrustProductsChannelEndpointAssignmentsApi* | [**DeleteTrustProductChannelEndpointAssignment**](docs/TrustProductsChannelEndpointAssignmentsApi.md#deletetrustproductchannelendpointassignment) | **Delete** /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid} | 
    78  *TrustProductsChannelEndpointAssignmentsApi* | [**FetchTrustProductChannelEndpointAssignment**](docs/TrustProductsChannelEndpointAssignmentsApi.md#fetchtrustproductchannelendpointassignment) | **Get** /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid} | 
    79  *TrustProductsChannelEndpointAssignmentsApi* | [**ListTrustProductChannelEndpointAssignment**](docs/TrustProductsChannelEndpointAssignmentsApi.md#listtrustproductchannelendpointassignment) | **Get** /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments | 
    80  *TrustProductsEntityAssignmentsApi* | [**CreateTrustProductEntityAssignment**](docs/TrustProductsEntityAssignmentsApi.md#createtrustproductentityassignment) | **Post** /v1/TrustProducts/{TrustProductSid}/EntityAssignments | 
    81  *TrustProductsEntityAssignmentsApi* | [**DeleteTrustProductEntityAssignment**](docs/TrustProductsEntityAssignmentsApi.md#deletetrustproductentityassignment) | **Delete** /v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid} | 
    82  *TrustProductsEntityAssignmentsApi* | [**FetchTrustProductEntityAssignment**](docs/TrustProductsEntityAssignmentsApi.md#fetchtrustproductentityassignment) | **Get** /v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid} | 
    83  *TrustProductsEntityAssignmentsApi* | [**ListTrustProductEntityAssignment**](docs/TrustProductsEntityAssignmentsApi.md#listtrustproductentityassignment) | **Get** /v1/TrustProducts/{TrustProductSid}/EntityAssignments | 
    84  *TrustProductsEvaluationsApi* | [**CreateTrustProductEvaluation**](docs/TrustProductsEvaluationsApi.md#createtrustproductevaluation) | **Post** /v1/TrustProducts/{TrustProductSid}/Evaluations | 
    85  *TrustProductsEvaluationsApi* | [**FetchTrustProductEvaluation**](docs/TrustProductsEvaluationsApi.md#fetchtrustproductevaluation) | **Get** /v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid} | 
    86  *TrustProductsEvaluationsApi* | [**ListTrustProductEvaluation**](docs/TrustProductsEvaluationsApi.md#listtrustproductevaluation) | **Get** /v1/TrustProducts/{TrustProductSid}/Evaluations | 
    87  
    88  
    89  ## Documentation For Models
    90  
    91   - [TrusthubV1EndUserType](docs/TrusthubV1EndUserType.md)
    92   - [ListTrustProductChannelEndpointAssignmentResponse](docs/ListTrustProductChannelEndpointAssignmentResponse.md)
    93   - [TrusthubV1CustomerProfileEntityAssignment](docs/TrusthubV1CustomerProfileEntityAssignment.md)
    94   - [TrusthubV1SupportingDocumentType](docs/TrusthubV1SupportingDocumentType.md)
    95   - [TrusthubV1EndUser](docs/TrusthubV1EndUser.md)
    96   - [ListCustomerProfileResponse](docs/ListCustomerProfileResponse.md)
    97   - [TrusthubV1SupportingDocument](docs/TrusthubV1SupportingDocument.md)
    98   - [TrusthubV1TrustProductChannelEndpointAssignment](docs/TrusthubV1TrustProductChannelEndpointAssignment.md)
    99   - [TrusthubV1TrustProduct](docs/TrusthubV1TrustProduct.md)
   100   - [ListSupportingDocumentResponse](docs/ListSupportingDocumentResponse.md)
   101   - [ListTrustProductEntityAssignmentResponse](docs/ListTrustProductEntityAssignmentResponse.md)
   102   - [ListSupportingDocumentTypeResponse](docs/ListSupportingDocumentTypeResponse.md)
   103   - [ListTrustProductEvaluationResponse](docs/ListTrustProductEvaluationResponse.md)
   104   - [TrusthubV1CustomerProfile](docs/TrusthubV1CustomerProfile.md)
   105   - [TrusthubV1CustomerProfileChannelEndpointAssignment](docs/TrusthubV1CustomerProfileChannelEndpointAssignment.md)
   106   - [ListCustomerProfileEntityAssignmentResponse](docs/ListCustomerProfileEntityAssignmentResponse.md)
   107   - [ListCustomerProfileResponseMeta](docs/ListCustomerProfileResponseMeta.md)
   108   - [ListEndUserTypeResponse](docs/ListEndUserTypeResponse.md)
   109   - [TrusthubV1TrustProductEntityAssignment](docs/TrusthubV1TrustProductEntityAssignment.md)
   110   - [ListEndUserResponse](docs/ListEndUserResponse.md)
   111   - [TrusthubV1Policies](docs/TrusthubV1Policies.md)
   112   - [ListCustomerProfileEvaluationResponse](docs/ListCustomerProfileEvaluationResponse.md)
   113   - [TrusthubV1TrustProductEvaluation](docs/TrusthubV1TrustProductEvaluation.md)
   114   - [TrusthubV1ComplianceInquiry](docs/TrusthubV1ComplianceInquiry.md)
   115   - [ListPoliciesResponse](docs/ListPoliciesResponse.md)
   116   - [ListTrustProductResponse](docs/ListTrustProductResponse.md)
   117   - [ListCustomerProfileChannelEndpointAssignmentResponse](docs/ListCustomerProfileChannelEndpointAssignmentResponse.md)
   118   - [TrusthubV1ComplianceTollfreeInquiry](docs/TrusthubV1ComplianceTollfreeInquiry.md)
   119   - [TrusthubV1CustomerProfileEvaluation](docs/TrusthubV1CustomerProfileEvaluation.md)
   120   - [TrusthubV1ComplianceRegistration](docs/TrusthubV1ComplianceRegistration.md)
   121  
   122  
   123  ## Documentation For Authorization
   124  
   125  
   126  
   127  ## accountSid_authToken
   128  
   129  - **Type**: HTTP basic authentication
   130  
   131  Example
   132  
   133  ```golang
   134  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   135      UserName: "username",
   136      Password: "password",
   137  })
   138  r, err := client.Service.Operation(auth, args)
   139  ```
   140