github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/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://verify.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *AttemptsApi* | [**FetchVerificationAttempt**](docs/AttemptsApi.md#fetchverificationattempt) | **Get** /v2/Attempts/{Sid} | 
    35  *AttemptsApi* | [**ListVerificationAttempt**](docs/AttemptsApi.md#listverificationattempt) | **Get** /v2/Attempts | 
    36  *AttemptsSummaryApi* | [**FetchVerificationAttemptsSummary**](docs/AttemptsSummaryApi.md#fetchverificationattemptssummary) | **Get** /v2/Attempts/Summary | 
    37  *FormsApi* | [**FetchForm**](docs/FormsApi.md#fetchform) | **Get** /v2/Forms/{FormType} | 
    38  *SafeListNumbersApi* | [**CreateSafelist**](docs/SafeListNumbersApi.md#createsafelist) | **Post** /v2/SafeList/Numbers | 
    39  *SafeListNumbersApi* | [**DeleteSafelist**](docs/SafeListNumbersApi.md#deletesafelist) | **Delete** /v2/SafeList/Numbers/{PhoneNumber} | 
    40  *SafeListNumbersApi* | [**FetchSafelist**](docs/SafeListNumbersApi.md#fetchsafelist) | **Get** /v2/SafeList/Numbers/{PhoneNumber} | 
    41  *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v2/Services | 
    42  *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v2/Services/{Sid} | 
    43  *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v2/Services/{Sid} | 
    44  *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v2/Services | 
    45  *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v2/Services/{Sid} | 
    46  *ServicesAccessTokensApi* | [**CreateAccessToken**](docs/ServicesAccessTokensApi.md#createaccesstoken) | **Post** /v2/Services/{ServiceSid}/AccessTokens | 
    47  *ServicesAccessTokensApi* | [**FetchAccessToken**](docs/ServicesAccessTokensApi.md#fetchaccesstoken) | **Get** /v2/Services/{ServiceSid}/AccessTokens/{Sid} | 
    48  *ServicesEntitiesApi* | [**CreateEntity**](docs/ServicesEntitiesApi.md#createentity) | **Post** /v2/Services/{ServiceSid}/Entities | 
    49  *ServicesEntitiesApi* | [**DeleteEntity**](docs/ServicesEntitiesApi.md#deleteentity) | **Delete** /v2/Services/{ServiceSid}/Entities/{Identity} | 
    50  *ServicesEntitiesApi* | [**FetchEntity**](docs/ServicesEntitiesApi.md#fetchentity) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity} | 
    51  *ServicesEntitiesApi* | [**ListEntity**](docs/ServicesEntitiesApi.md#listentity) | **Get** /v2/Services/{ServiceSid}/Entities | 
    52  *ServicesEntitiesChallengesApi* | [**CreateChallenge**](docs/ServicesEntitiesChallengesApi.md#createchallenge) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges | 
    53  *ServicesEntitiesChallengesApi* | [**FetchChallenge**](docs/ServicesEntitiesChallengesApi.md#fetchchallenge) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid} | 
    54  *ServicesEntitiesChallengesApi* | [**ListChallenge**](docs/ServicesEntitiesChallengesApi.md#listchallenge) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges | 
    55  *ServicesEntitiesChallengesApi* | [**UpdateChallenge**](docs/ServicesEntitiesChallengesApi.md#updatechallenge) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid} | 
    56  *ServicesEntitiesChallengesNotificationsApi* | [**CreateNotification**](docs/ServicesEntitiesChallengesNotificationsApi.md#createnotification) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications | 
    57  *ServicesEntitiesFactorsApi* | [**CreateNewFactor**](docs/ServicesEntitiesFactorsApi.md#createnewfactor) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors | 
    58  *ServicesEntitiesFactorsApi* | [**DeleteFactor**](docs/ServicesEntitiesFactorsApi.md#deletefactor) | **Delete** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} | 
    59  *ServicesEntitiesFactorsApi* | [**FetchFactor**](docs/ServicesEntitiesFactorsApi.md#fetchfactor) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} | 
    60  *ServicesEntitiesFactorsApi* | [**ListFactor**](docs/ServicesEntitiesFactorsApi.md#listfactor) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors | 
    61  *ServicesEntitiesFactorsApi* | [**UpdateFactor**](docs/ServicesEntitiesFactorsApi.md#updatefactor) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} | 
    62  *ServicesMessagingConfigurationsApi* | [**CreateMessagingConfiguration**](docs/ServicesMessagingConfigurationsApi.md#createmessagingconfiguration) | **Post** /v2/Services/{ServiceSid}/MessagingConfigurations | 
    63  *ServicesMessagingConfigurationsApi* | [**DeleteMessagingConfiguration**](docs/ServicesMessagingConfigurationsApi.md#deletemessagingconfiguration) | **Delete** /v2/Services/{ServiceSid}/MessagingConfigurations/{Country} | 
    64  *ServicesMessagingConfigurationsApi* | [**FetchMessagingConfiguration**](docs/ServicesMessagingConfigurationsApi.md#fetchmessagingconfiguration) | **Get** /v2/Services/{ServiceSid}/MessagingConfigurations/{Country} | 
    65  *ServicesMessagingConfigurationsApi* | [**ListMessagingConfiguration**](docs/ServicesMessagingConfigurationsApi.md#listmessagingconfiguration) | **Get** /v2/Services/{ServiceSid}/MessagingConfigurations | 
    66  *ServicesMessagingConfigurationsApi* | [**UpdateMessagingConfiguration**](docs/ServicesMessagingConfigurationsApi.md#updatemessagingconfiguration) | **Post** /v2/Services/{ServiceSid}/MessagingConfigurations/{Country} | 
    67  *ServicesRateLimitsApi* | [**CreateRateLimit**](docs/ServicesRateLimitsApi.md#createratelimit) | **Post** /v2/Services/{ServiceSid}/RateLimits | 
    68  *ServicesRateLimitsApi* | [**DeleteRateLimit**](docs/ServicesRateLimitsApi.md#deleteratelimit) | **Delete** /v2/Services/{ServiceSid}/RateLimits/{Sid} | 
    69  *ServicesRateLimitsApi* | [**FetchRateLimit**](docs/ServicesRateLimitsApi.md#fetchratelimit) | **Get** /v2/Services/{ServiceSid}/RateLimits/{Sid} | 
    70  *ServicesRateLimitsApi* | [**ListRateLimit**](docs/ServicesRateLimitsApi.md#listratelimit) | **Get** /v2/Services/{ServiceSid}/RateLimits | 
    71  *ServicesRateLimitsApi* | [**UpdateRateLimit**](docs/ServicesRateLimitsApi.md#updateratelimit) | **Post** /v2/Services/{ServiceSid}/RateLimits/{Sid} | 
    72  *ServicesRateLimitsBucketsApi* | [**CreateBucket**](docs/ServicesRateLimitsBucketsApi.md#createbucket) | **Post** /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets | 
    73  *ServicesRateLimitsBucketsApi* | [**DeleteBucket**](docs/ServicesRateLimitsBucketsApi.md#deletebucket) | **Delete** /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid} | 
    74  *ServicesRateLimitsBucketsApi* | [**FetchBucket**](docs/ServicesRateLimitsBucketsApi.md#fetchbucket) | **Get** /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid} | 
    75  *ServicesRateLimitsBucketsApi* | [**ListBucket**](docs/ServicesRateLimitsBucketsApi.md#listbucket) | **Get** /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets | 
    76  *ServicesRateLimitsBucketsApi* | [**UpdateBucket**](docs/ServicesRateLimitsBucketsApi.md#updatebucket) | **Post** /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid} | 
    77  *ServicesVerificationCheckApi* | [**CreateVerificationCheck**](docs/ServicesVerificationCheckApi.md#createverificationcheck) | **Post** /v2/Services/{ServiceSid}/VerificationCheck | 
    78  *ServicesVerificationsApi* | [**CreateVerification**](docs/ServicesVerificationsApi.md#createverification) | **Post** /v2/Services/{ServiceSid}/Verifications | 
    79  *ServicesVerificationsApi* | [**FetchVerification**](docs/ServicesVerificationsApi.md#fetchverification) | **Get** /v2/Services/{ServiceSid}/Verifications/{Sid} | 
    80  *ServicesVerificationsApi* | [**UpdateVerification**](docs/ServicesVerificationsApi.md#updateverification) | **Post** /v2/Services/{ServiceSid}/Verifications/{Sid} | 
    81  *ServicesWebhooksApi* | [**CreateWebhook**](docs/ServicesWebhooksApi.md#createwebhook) | **Post** /v2/Services/{ServiceSid}/Webhooks | 
    82  *ServicesWebhooksApi* | [**DeleteWebhook**](docs/ServicesWebhooksApi.md#deletewebhook) | **Delete** /v2/Services/{ServiceSid}/Webhooks/{Sid} | 
    83  *ServicesWebhooksApi* | [**FetchWebhook**](docs/ServicesWebhooksApi.md#fetchwebhook) | **Get** /v2/Services/{ServiceSid}/Webhooks/{Sid} | 
    84  *ServicesWebhooksApi* | [**ListWebhook**](docs/ServicesWebhooksApi.md#listwebhook) | **Get** /v2/Services/{ServiceSid}/Webhooks | 
    85  *ServicesWebhooksApi* | [**UpdateWebhook**](docs/ServicesWebhooksApi.md#updatewebhook) | **Post** /v2/Services/{ServiceSid}/Webhooks/{Sid} | 
    86  *TemplatesApi* | [**ListVerificationTemplate**](docs/TemplatesApi.md#listverificationtemplate) | **Get** /v2/Templates | 
    87  
    88  
    89  ## Documentation For Models
    90  
    91   - [ListMessagingConfigurationResponse](docs/ListMessagingConfigurationResponse.md)
    92   - [VerifyV2RateLimit](docs/VerifyV2RateLimit.md)
    93   - [VerifyV2AccessToken](docs/VerifyV2AccessToken.md)
    94   - [VerifyV2Webhook](docs/VerifyV2Webhook.md)
    95   - [ListServiceResponse](docs/ListServiceResponse.md)
    96   - [VerifyV2Notification](docs/VerifyV2Notification.md)
    97   - [VerifyV2Factor](docs/VerifyV2Factor.md)
    98   - [VerifyV2Form](docs/VerifyV2Form.md)
    99   - [VerifyV2VerificationAttempt](docs/VerifyV2VerificationAttempt.md)
   100   - [VerifyV2Safelist](docs/VerifyV2Safelist.md)
   101   - [VerifyV2Challenge](docs/VerifyV2Challenge.md)
   102   - [ListEntityResponse](docs/ListEntityResponse.md)
   103   - [ListWebhookResponse](docs/ListWebhookResponse.md)
   104   - [ListRateLimitResponse](docs/ListRateLimitResponse.md)
   105   - [ListFactorResponse](docs/ListFactorResponse.md)
   106   - [ListVerificationTemplateResponse](docs/ListVerificationTemplateResponse.md)
   107   - [VerifyV2MessagingConfiguration](docs/VerifyV2MessagingConfiguration.md)
   108   - [VerifyV2Service](docs/VerifyV2Service.md)
   109   - [ListBucketResponseMeta](docs/ListBucketResponseMeta.md)
   110   - [VerifyV2VerificationTemplate](docs/VerifyV2VerificationTemplate.md)
   111   - [VerifyV2VerificationCheck](docs/VerifyV2VerificationCheck.md)
   112   - [ListVerificationAttemptResponse](docs/ListVerificationAttemptResponse.md)
   113   - [VerifyV2NewFactor](docs/VerifyV2NewFactor.md)
   114   - [VerifyV2VerificationAttemptsSummary](docs/VerifyV2VerificationAttemptsSummary.md)
   115   - [VerifyV2Verification](docs/VerifyV2Verification.md)
   116   - [ListBucketResponse](docs/ListBucketResponse.md)
   117   - [ListChallengeResponse](docs/ListChallengeResponse.md)
   118   - [VerifyV2Bucket](docs/VerifyV2Bucket.md)
   119   - [VerifyV2Entity](docs/VerifyV2Entity.md)
   120  
   121  
   122  ## Documentation For Authorization
   123  
   124  
   125  
   126  ## accountSid_authToken
   127  
   128  - **Type**: HTTP basic authentication
   129  
   130  Example
   131  
   132  ```golang
   133  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   134      UserName: "username",
   135      Password: "password",
   136  })
   137  r, err := client.Service.Operation(auth, args)
   138  ```
   139