openapi

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2021 License: MIT Imports: 6 Imported by: 2

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.17.0
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://numbers.twilio.com

Class Method HTTP request Description
DefaultApi CreateBundle Post /v2/RegulatoryCompliance/Bundles
DefaultApi CreateEndUser Post /v2/RegulatoryCompliance/EndUsers
DefaultApi CreateEvaluation Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations
DefaultApi CreateItemAssignment Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
DefaultApi CreateSupportingDocument Post /v2/RegulatoryCompliance/SupportingDocuments
DefaultApi DeleteBundle Delete /v2/RegulatoryCompliance/Bundles/{Sid}
DefaultApi DeleteEndUser Delete /v2/RegulatoryCompliance/EndUsers/{Sid}
DefaultApi DeleteItemAssignment Delete /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
DefaultApi DeleteSupportingDocument Delete /v2/RegulatoryCompliance/SupportingDocuments/{Sid}
DefaultApi FetchBundle Get /v2/RegulatoryCompliance/Bundles/{Sid}
DefaultApi FetchEndUser Get /v2/RegulatoryCompliance/EndUsers/{Sid}
DefaultApi FetchEndUserType Get /v2/RegulatoryCompliance/EndUserTypes/{Sid}
DefaultApi FetchEvaluation Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}
DefaultApi FetchItemAssignment Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
DefaultApi FetchRegulation Get /v2/RegulatoryCompliance/Regulations/{Sid}
DefaultApi FetchSupportingDocument Get /v2/RegulatoryCompliance/SupportingDocuments/{Sid}
DefaultApi FetchSupportingDocumentType Get /v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}
DefaultApi ListBundle Get /v2/RegulatoryCompliance/Bundles
DefaultApi ListEndUser Get /v2/RegulatoryCompliance/EndUsers
DefaultApi ListEndUserType Get /v2/RegulatoryCompliance/EndUserTypes
DefaultApi ListEvaluation Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations
DefaultApi ListItemAssignment Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
DefaultApi ListRegulation Get /v2/RegulatoryCompliance/Regulations
DefaultApi ListSupportingDocument Get /v2/RegulatoryCompliance/SupportingDocuments
DefaultApi ListSupportingDocumentType Get /v2/RegulatoryCompliance/SupportingDocumentTypes
DefaultApi UpdateBundle Post /v2/RegulatoryCompliance/Bundles/{Sid}
DefaultApi UpdateEndUser Post /v2/RegulatoryCompliance/EndUsers/{Sid}
DefaultApi UpdateSupportingDocument Post /v2/RegulatoryCompliance/SupportingDocuments/{Sid}

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

support@twilio.com

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateBundleParams 

type CreateBundleParams struct {
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"Email,omitempty"`
	// The type of End User of the Bundle resource.
	EndUserType *string `json:"EndUserType,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The ISO country code of the Bundle's phone number country ownership request.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// The type of phone number of the Bundle's ownership request.
	NumberType *string `json:"NumberType,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"RegulationSid,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"StatusCallback,omitempty"`
}

Optional parameters for the method 'CreateBundle'

func (*CreateBundleParams) SetEmail 

func (params *CreateBundleParams) SetEmail(Email string) *CreateBundleParams

func (*CreateBundleParams) SetEndUserType 

func (params *CreateBundleParams) SetEndUserType(EndUserType string) *CreateBundleParams

func (*CreateBundleParams) SetFriendlyName 

func (params *CreateBundleParams) SetFriendlyName(FriendlyName string) *CreateBundleParams

func (*CreateBundleParams) SetIsoCountry 

func (params *CreateBundleParams) SetIsoCountry(IsoCountry string) *CreateBundleParams

func (*CreateBundleParams) SetNumberType 

func (params *CreateBundleParams) SetNumberType(NumberType string) *CreateBundleParams

func (*CreateBundleParams) SetRegulationSid 

func (params *CreateBundleParams) SetRegulationSid(RegulationSid string) *CreateBundleParams

func (*CreateBundleParams) SetStatusCallback 

func (params *CreateBundleParams) SetStatusCallback(StatusCallback string) *CreateBundleParams

type CreateEndUserParams 

type CreateEndUserParams struct {
	// The set of parameters that are the attributes of the End User resource which are derived End User Types.
	Attributes *map[string]interface{} `json:"Attributes,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The type of end user of the Bundle resource - can be `individual` or `business`.
	Type *string `json:"Type,omitempty"`
}

Optional parameters for the method 'CreateEndUser'

func (*CreateEndUserParams) SetAttributes 

func (params *CreateEndUserParams) SetAttributes(Attributes map[string]interface{}) *CreateEndUserParams

func (*CreateEndUserParams) SetFriendlyName 

func (params *CreateEndUserParams) SetFriendlyName(FriendlyName string) *CreateEndUserParams

func (*CreateEndUserParams) SetType 

func (params *CreateEndUserParams) SetType(Type string) *CreateEndUserParams

type CreateItemAssignmentParams 

type CreateItemAssignmentParams struct {
	// The SID of an object bag that holds information of the different items.
	ObjectSid *string `json:"ObjectSid,omitempty"`
}

Optional parameters for the method 'CreateItemAssignment'

func (*CreateItemAssignmentParams) SetObjectSid 

func (params *CreateItemAssignmentParams) SetObjectSid(ObjectSid string) *CreateItemAssignmentParams

type CreateSupportingDocumentParams 

type CreateSupportingDocumentParams struct {
	// The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
	Attributes *map[string]interface{} `json:"Attributes,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The type of the Supporting Document.
	Type *string `json:"Type,omitempty"`
}

Optional parameters for the method 'CreateSupportingDocument'

func (*CreateSupportingDocumentParams) SetAttributes 

func (params *CreateSupportingDocumentParams) SetAttributes(Attributes map[string]interface{}) *CreateSupportingDocumentParams

func (*CreateSupportingDocumentParams) SetFriendlyName 

func (params *CreateSupportingDocumentParams) SetFriendlyName(FriendlyName string) *CreateSupportingDocumentParams

func (*CreateSupportingDocumentParams) SetType 

func (params *CreateSupportingDocumentParams) SetType(Type string) *CreateSupportingDocumentParams

type DefaultApiService 

type DefaultApiService struct {
	// contains filtered or unexported fields
}

func NewDefaultApiService 

func NewDefaultApiService(requestHandler *twilio.RequestHandler) *DefaultApiService

func NewDefaultApiServiceWithClient added in v0.9.0 

func NewDefaultApiServiceWithClient(client twilio.BaseClient) *DefaultApiService

func (*DefaultApiService) CreateBundle 

func (c *DefaultApiService) CreateBundle(params *CreateBundleParams) (*NumbersV2RegulatoryComplianceBundle, error)

Create a new Bundle.

func (*DefaultApiService) CreateEndUser 

func (c *DefaultApiService) CreateEndUser(params *CreateEndUserParams) (*NumbersV2RegulatoryComplianceEndUser, error)

Create a new End User.

func (*DefaultApiService) CreateEvaluation 

func (c *DefaultApiService) CreateEvaluation(BundleSid string) (*NumbersV2RegulatoryComplianceBundleEvaluation, error)

Creates an evaluation for a bundle

func (*DefaultApiService) CreateItemAssignment 

func (c *DefaultApiService) CreateItemAssignment(BundleSid string, params *CreateItemAssignmentParams) (*NumbersV2RegulatoryComplianceBundleItemAssignment, error)

Create a new Assigned Item.

func (*DefaultApiService) CreateSupportingDocument 

func (c *DefaultApiService) CreateSupportingDocument(params *CreateSupportingDocumentParams) (*NumbersV2RegulatoryComplianceSupportingDocument, error)

Create a new Supporting Document.

func (*DefaultApiService) DeleteBundle 

func (c *DefaultApiService) DeleteBundle(Sid string) error

Delete a specific Bundle.

func (*DefaultApiService) DeleteEndUser 

func (c *DefaultApiService) DeleteEndUser(Sid string) error

Delete a specific End User.

func (*DefaultApiService) DeleteItemAssignment 

func (c *DefaultApiService) DeleteItemAssignment(BundleSid string, Sid string) error

Remove an Assignment Item Instance.

func (*DefaultApiService) DeleteSupportingDocument 

func (c *DefaultApiService) DeleteSupportingDocument(Sid string) error

Delete a specific Supporting Document.

func (*DefaultApiService) FetchBundle 

func (c *DefaultApiService) FetchBundle(Sid string) (*NumbersV2RegulatoryComplianceBundle, error)

Fetch a specific Bundle instance.

func (*DefaultApiService) FetchEndUser 

func (c *DefaultApiService) FetchEndUser(Sid string) (*NumbersV2RegulatoryComplianceEndUser, error)

Fetch specific End User Instance.

func (*DefaultApiService) FetchEndUserType 

func (c *DefaultApiService) FetchEndUserType(Sid string) (*NumbersV2RegulatoryComplianceEndUserType, error)

Fetch a specific End-User Type Instance.

func (*DefaultApiService) FetchEvaluation 

func (c *DefaultApiService) FetchEvaluation(BundleSid string, Sid string) (*NumbersV2RegulatoryComplianceBundleEvaluation, error)

Fetch specific Evaluation Instance.

func (*DefaultApiService) FetchItemAssignment 

func (c *DefaultApiService) FetchItemAssignment(BundleSid string, Sid string) (*NumbersV2RegulatoryComplianceBundleItemAssignment, error)

Fetch specific Assigned Item Instance.

func (*DefaultApiService) FetchRegulation 

func (c *DefaultApiService) FetchRegulation(Sid string) (*NumbersV2RegulatoryComplianceRegulation, error)

Fetch specific Regulation Instance.

func (*DefaultApiService) FetchSupportingDocument 

func (c *DefaultApiService) FetchSupportingDocument(Sid string) (*NumbersV2RegulatoryComplianceSupportingDocument, error)

Fetch specific Supporting Document Instance.

func (*DefaultApiService) FetchSupportingDocumentType 

func (c *DefaultApiService) FetchSupportingDocumentType(Sid string) (*NumbersV2RegulatoryComplianceSupportingDocumentType, error)

Fetch a specific Supporting Document Type Instance.

func (*DefaultApiService) ListBundle 

func (c *DefaultApiService) ListBundle(params *ListBundleParams) (*ListBundleResponse, error)

Retrieve a list of all Bundles for an account.

func (*DefaultApiService) ListEndUser 

func (c *DefaultApiService) ListEndUser(params *ListEndUserParams) (*ListEndUserResponse, error)

Retrieve a list of all End User for an account.

func (*DefaultApiService) ListEndUserType 

func (c *DefaultApiService) ListEndUserType(params *ListEndUserTypeParams) (*ListEndUserTypeResponse, error)

Retrieve a list of all End-User Types.

func (*DefaultApiService) ListEvaluation 

func (c *DefaultApiService) ListEvaluation(BundleSid string, params *ListEvaluationParams) (*ListEvaluationResponse, error)

Retrieve a list of Evaluations associated to the Bundle resource.

func (*DefaultApiService) ListItemAssignment 

func (c *DefaultApiService) ListItemAssignment(BundleSid string, params *ListItemAssignmentParams) (*ListItemAssignmentResponse, error)

Retrieve a list of all Assigned Items for an account.

func (*DefaultApiService) ListRegulation 

func (c *DefaultApiService) ListRegulation(params *ListRegulationParams) (*ListRegulationResponse, error)

Retrieve a list of all Regulations.

func (*DefaultApiService) ListSupportingDocument 

func (c *DefaultApiService) ListSupportingDocument(params *ListSupportingDocumentParams) (*ListSupportingDocumentResponse, error)

Retrieve a list of all Supporting Document for an account.

func (*DefaultApiService) ListSupportingDocumentType 

func (c *DefaultApiService) ListSupportingDocumentType(params *ListSupportingDocumentTypeParams) (*ListSupportingDocumentTypeResponse, error)

Retrieve a list of all Supporting Document Types.

func (*DefaultApiService) UpdateBundle 

func (c *DefaultApiService) UpdateBundle(Sid string, params *UpdateBundleParams) (*NumbersV2RegulatoryComplianceBundle, error)

Updates a Bundle in an account.

func (*DefaultApiService) UpdateEndUser 

func (c *DefaultApiService) UpdateEndUser(Sid string, params *UpdateEndUserParams) (*NumbersV2RegulatoryComplianceEndUser, error)

Update an existing End User.

func (*DefaultApiService) UpdateSupportingDocument 

func (c *DefaultApiService) UpdateSupportingDocument(Sid string, params *UpdateSupportingDocumentParams) (*NumbersV2RegulatoryComplianceSupportingDocument, error)

Update an existing Supporting Document.

type ListBundleParams 

type ListBundleParams struct {
	// The verification status of the Bundle resource.
	Status *string `json:"Status,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"RegulationSid,omitempty"`
	// The ISO country code of the Bundle's phone number country ownership request.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// The type of phone number of the Bundle's ownership request.
	NumberType *string `json:"NumberType,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListBundle'

func (*ListBundleParams) SetFriendlyName 

func (params *ListBundleParams) SetFriendlyName(FriendlyName string) *ListBundleParams

func (*ListBundleParams) SetIsoCountry 

func (params *ListBundleParams) SetIsoCountry(IsoCountry string) *ListBundleParams

func (*ListBundleParams) SetNumberType 

func (params *ListBundleParams) SetNumberType(NumberType string) *ListBundleParams

func (*ListBundleParams) SetPageSize 

func (params *ListBundleParams) SetPageSize(PageSize int32) *ListBundleParams

func (*ListBundleParams) SetRegulationSid 

func (params *ListBundleParams) SetRegulationSid(RegulationSid string) *ListBundleParams

func (*ListBundleParams) SetStatus 

func (params *ListBundleParams) SetStatus(Status string) *ListBundleParams

type ListBundleResponse 

type ListBundleResponse struct {
	Meta    ListBundleResponseMeta                `json:"meta,omitempty"`
	Results []NumbersV2RegulatoryComplianceBundle `json:"results,omitempty"`
}

ListBundleResponse struct for ListBundleResponse

type ListBundleResponseMeta 

type ListBundleResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int32  `json:"page,omitempty"`
	PageSize        int32  `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListBundleResponseMeta struct for ListBundleResponseMeta

type ListEndUserParams 

type ListEndUserParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListEndUser'

func (*ListEndUserParams) SetPageSize 

func (params *ListEndUserParams) SetPageSize(PageSize int32) *ListEndUserParams

type ListEndUserResponse 

type ListEndUserResponse struct {
	Meta    ListBundleResponseMeta                 `json:"meta,omitempty"`
	Results []NumbersV2RegulatoryComplianceEndUser `json:"results,omitempty"`
}

ListEndUserResponse struct for ListEndUserResponse

type ListEndUserTypeParams 

type ListEndUserTypeParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListEndUserType'

func (*ListEndUserTypeParams) SetPageSize 

func (params *ListEndUserTypeParams) SetPageSize(PageSize int32) *ListEndUserTypeParams

type ListEndUserTypeResponse 

type ListEndUserTypeResponse struct {
	EndUserTypes []NumbersV2RegulatoryComplianceEndUserType `json:"end_user_types,omitempty"`
	Meta         ListBundleResponseMeta                     `json:"meta,omitempty"`
}

ListEndUserTypeResponse struct for ListEndUserTypeResponse

type ListEvaluationParams 

type ListEvaluationParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListEvaluation'

func (*ListEvaluationParams) SetPageSize 

func (params *ListEvaluationParams) SetPageSize(PageSize int32) *ListEvaluationParams

type ListEvaluationResponse 

type ListEvaluationResponse struct {
	Meta    ListBundleResponseMeta                          `json:"meta,omitempty"`
	Results []NumbersV2RegulatoryComplianceBundleEvaluation `json:"results,omitempty"`
}

ListEvaluationResponse struct for ListEvaluationResponse

type ListItemAssignmentParams 

type ListItemAssignmentParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListItemAssignment'

func (*ListItemAssignmentParams) SetPageSize 

func (params *ListItemAssignmentParams) SetPageSize(PageSize int32) *ListItemAssignmentParams

type ListItemAssignmentResponse 

type ListItemAssignmentResponse struct {
	Meta    ListBundleResponseMeta                              `json:"meta,omitempty"`
	Results []NumbersV2RegulatoryComplianceBundleItemAssignment `json:"results,omitempty"`
}

ListItemAssignmentResponse struct for ListItemAssignmentResponse

type ListRegulationParams 

type ListRegulationParams struct {
	// The type of End User the regulation requires - can be `individual` or `business`.
	EndUserType *string `json:"EndUserType,omitempty"`
	// The ISO country code of the phone number's country.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// The type of phone number that the regulatory requiremnt is restricting.
	NumberType *string `json:"NumberType,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListRegulation'

func (*ListRegulationParams) SetEndUserType 

func (params *ListRegulationParams) SetEndUserType(EndUserType string) *ListRegulationParams

func (*ListRegulationParams) SetIsoCountry 

func (params *ListRegulationParams) SetIsoCountry(IsoCountry string) *ListRegulationParams

func (*ListRegulationParams) SetNumberType 

func (params *ListRegulationParams) SetNumberType(NumberType string) *ListRegulationParams

func (*ListRegulationParams) SetPageSize 

func (params *ListRegulationParams) SetPageSize(PageSize int32) *ListRegulationParams

type ListRegulationResponse 

type ListRegulationResponse struct {
	Meta    ListBundleResponseMeta                    `json:"meta,omitempty"`
	Results []NumbersV2RegulatoryComplianceRegulation `json:"results,omitempty"`
}

ListRegulationResponse struct for ListRegulationResponse

type ListSupportingDocumentParams 

type ListSupportingDocumentParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSupportingDocument'

func (*ListSupportingDocumentParams) SetPageSize 

func (params *ListSupportingDocumentParams) SetPageSize(PageSize int32) *ListSupportingDocumentParams

type ListSupportingDocumentResponse 

type ListSupportingDocumentResponse struct {
	Meta    ListBundleResponseMeta                            `json:"meta,omitempty"`
	Results []NumbersV2RegulatoryComplianceSupportingDocument `json:"results,omitempty"`
}

ListSupportingDocumentResponse struct for ListSupportingDocumentResponse

type ListSupportingDocumentTypeParams 

type ListSupportingDocumentTypeParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSupportingDocumentType'

func (*ListSupportingDocumentTypeParams) SetPageSize 

func (params *ListSupportingDocumentTypeParams) SetPageSize(PageSize int32) *ListSupportingDocumentTypeParams

type ListSupportingDocumentTypeResponse 

type ListSupportingDocumentTypeResponse struct {
	Meta                    ListBundleResponseMeta                                `json:"meta,omitempty"`
	SupportingDocumentTypes []NumbersV2RegulatoryComplianceSupportingDocumentType `json:"supporting_document_types,omitempty"`
}

ListSupportingDocumentTypeResponse struct for ListSupportingDocumentTypeResponse

type NumbersV2RegulatoryComplianceBundle 

type NumbersV2RegulatoryComplianceBundle struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The email address
	Email *string `json:"email,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of the Assigned Items of the Bundle resource
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string of a regulation.
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The unique string that identifies the resource.
	Sid *string `json:"sid,omitempty"`
	// The verification status of the Bundle resource
	Status *string `json:"status,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The absolute URL of the Bundle resource
	Url *string `json:"url,omitempty"`
	// The ISO 8601 date and time in GMT when the resource will be valid until.
	ValidUntil *time.Time `json:"valid_until,omitempty"`
}

NumbersV2RegulatoryComplianceBundle struct for NumbersV2RegulatoryComplianceBundle

type NumbersV2RegulatoryComplianceBundleEvaluation 

type NumbersV2RegulatoryComplianceBundleEvaluation struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string that identifies the resource
	BundleSid   *string    `json:"bundle_sid,omitempty"`
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The unique string of a regulation
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The results of the Evaluation resource
	Results *[]map[string]interface{} `json:"results,omitempty"`
	// The unique string that identifies the Evaluation resource
	Sid *string `json:"sid,omitempty"`
	// The compliance status of the Evaluation resource
	Status *string `json:"status,omitempty"`
	Url    *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceBundleEvaluation struct for NumbersV2RegulatoryComplianceBundleEvaluation

type NumbersV2RegulatoryComplianceBundleItemAssignment 

type NumbersV2RegulatoryComplianceBundleItemAssignment struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string that identifies the Bundle resource.
	BundleSid *string `json:"bundle_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The sid of an object bag
	ObjectSid *string `json:"object_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Identity resource
	Url *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceBundleItemAssignment struct for NumbersV2RegulatoryComplianceBundleItemAssignment

type NumbersV2RegulatoryComplianceEndUser 

type NumbersV2RegulatoryComplianceEndUser struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The set of parameters that compose the End Users resource
	Attributes *map[string]interface{} `json:"attributes,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The type of end user of the Bundle resource
	Type *string `json:"type,omitempty"`
	// The absolute URL of the End User resource
	Url *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceEndUser struct for NumbersV2RegulatoryComplianceEndUser

type NumbersV2RegulatoryComplianceEndUserType 

type NumbersV2RegulatoryComplianceEndUserType struct {
	// The required information for creating an End-User.
	Fields *[]map[string]interface{} `json:"fields,omitempty"`
	// A human-readable description of the End-User Type resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A machine-readable description of the End-User Type resource
	MachineName *string `json:"machine_name,omitempty"`
	// The unique string that identifies the End-User Type resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the End-User Type resource
	Url *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceEndUserType struct for NumbersV2RegulatoryComplianceEndUserType

type NumbersV2RegulatoryComplianceRegulation 

type NumbersV2RegulatoryComplianceRegulation struct {
	// The type of End User of the Regulation resource
	EndUserType *string `json:"end_user_type,omitempty"`
	// A human-readable description of the Regulation resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The ISO country code of the phone number's country
	IsoCountry *string `json:"iso_country,omitempty"`
	// The type of phone number restricted by the regulatory requirement
	NumberType *string `json:"number_type,omitempty"`
	// The sid of a regulation object that dictates requirements
	Requirements *map[string]interface{} `json:"requirements,omitempty"`
	// The unique string that identifies the Regulation resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Regulation resource
	Url *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceRegulation struct for NumbersV2RegulatoryComplianceRegulation

type NumbersV2RegulatoryComplianceSupportingDocument 

type NumbersV2RegulatoryComplianceSupportingDocument struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The set of parameters that compose the Supporting Documents resource
	Attributes *map[string]interface{} `json:"attributes,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The image type of the file
	MimeType *string `json:"mime_type,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The verification status of the Supporting Document resource
	Status *string `json:"status,omitempty"`
	// The type of the Supporting Document
	Type *string `json:"type,omitempty"`
	// The absolute URL of the Supporting Document resource
	Url *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceSupportingDocument struct for NumbersV2RegulatoryComplianceSupportingDocument

type NumbersV2RegulatoryComplianceSupportingDocumentType 

type NumbersV2RegulatoryComplianceSupportingDocumentType struct {
	// The required information for creating a Supporting Document
	Fields *[]map[string]interface{} `json:"fields,omitempty"`
	// A human-readable description of the Supporting Document Type resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The machine-readable description of the Supporting Document Type resource
	MachineName *string `json:"machine_name,omitempty"`
	// The unique string that identifies the Supporting Document Type resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Supporting Document Type resource
	Url *string `json:"url,omitempty"`
}

NumbersV2RegulatoryComplianceSupportingDocumentType struct for NumbersV2RegulatoryComplianceSupportingDocumentType

type UpdateBundleParams 

type UpdateBundleParams struct {
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"Email,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The verification status of the Bundle resource.
	Status *string `json:"Status,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"StatusCallback,omitempty"`
}

Optional parameters for the method 'UpdateBundle'

func (*UpdateBundleParams) SetEmail 

func (params *UpdateBundleParams) SetEmail(Email string) *UpdateBundleParams

func (*UpdateBundleParams) SetFriendlyName 

func (params *UpdateBundleParams) SetFriendlyName(FriendlyName string) *UpdateBundleParams

func (*UpdateBundleParams) SetStatus 

func (params *UpdateBundleParams) SetStatus(Status string) *UpdateBundleParams

func (*UpdateBundleParams) SetStatusCallback 

func (params *UpdateBundleParams) SetStatusCallback(StatusCallback string) *UpdateBundleParams

type UpdateEndUserParams 

type UpdateEndUserParams struct {
	// The set of parameters that are the attributes of the End User resource which are derived End User Types.
	Attributes *map[string]interface{} `json:"Attributes,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'UpdateEndUser'

func (*UpdateEndUserParams) SetAttributes 

func (params *UpdateEndUserParams) SetAttributes(Attributes map[string]interface{}) *UpdateEndUserParams

func (*UpdateEndUserParams) SetFriendlyName 

func (params *UpdateEndUserParams) SetFriendlyName(FriendlyName string) *UpdateEndUserParams

type UpdateSupportingDocumentParams 

type UpdateSupportingDocumentParams struct {
	// The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
	Attributes *map[string]interface{} `json:"Attributes,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'UpdateSupportingDocument'

func (*UpdateSupportingDocumentParams) SetAttributes 

func (params *UpdateSupportingDocumentParams) SetAttributes(Attributes map[string]interface{}) *UpdateSupportingDocumentParams

func (*UpdateSupportingDocumentParams) SetFriendlyName 

func (params *UpdateSupportingDocumentParams) SetFriendlyName(FriendlyName string) *UpdateSupportingDocumentParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.