credential

Documentation

Overview

Package credential contains auto-generated files. DO NOT MODIFY

Package credential contains auto-generated files. DO NOT MODIFY

Package credential contains auto-generated files. DO NOT MODIFY

Package credential contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchCredentialResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchCredentialResponse, error)
  • func (c Client) Update(input *UpdateCredentialInput) (*UpdateCredentialResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateCredentialInput) (*UpdateCredentialResponse, error)
• type ClientProperties
• type FetchCredentialResponse
• type UpdateCredentialInput
• type UpdateCredentialResponse

Types

type Client

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

Client for managing a specific role resource See https://www.twilio.com/docs/notify/api/credential-resource for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the credential client

func (Client) Delete

func (c Client) Delete() error

Delete removes a credentials resource from the account See https://www.twilio.com/docs/notify/api/credential-resource#delete-a-credential-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a credentials resource from the account See https://www.twilio.com/docs/notify/api/credential-resource#delete-a-credential-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchCredentialResponse, error)

Fetch retrieves a credential resource See https://www.twilio.com/docs/notify/api/credential-resource#fetch-a-credential-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchCredentialResponse, error)

FetchWithContext retrieves a credential resource See https://www.twilio.com/docs/notify/api/credential-resource#fetch-a-credential-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateCredentialInput) (*UpdateCredentialResponse, error)

Update modifies a credentials resource See https://www.twilio.com/docs/notify/api/credential-resource#update-a-credential-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateCredentialInput) (*UpdateCredentialResponse, error)

UpdateWithContext modifies a credentials resource See https://www.twilio.com/docs/notify/api/credential-resource#update-a-credential-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the credential resources

type FetchCredentialResponse

type FetchCredentialResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName *string    `json:"friendly_name,omitempty"`
	Sandbox      *bool      `json:"sandbox,omitempty"`
	Sid          string     `json:"sid"`
	Type         string     `json:"type"`
	URL          string     `json:"url"`
}

FetchCredentialResponse defines the response fields for the retrieved credential

type UpdateCredentialInput

type UpdateCredentialInput struct {
	Certificate  *string `form:"Certificate,omitempty"`
	FriendlyName *string `form:"FriendlyName,omitempty"`
	PrivateKey   *string `form:"PrivateKey,omitempty"`
	Sandbox      *bool   `form:"Sandbox,omitempty"`
	Secret       *string `form:"Secret,omitempty"`
}

UpdateCredentialInput defines input fields for updating a credential resource

type UpdateCredentialResponse

type UpdateCredentialResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName *string    `json:"friendly_name,omitempty"`
	Sandbox      *bool      `json:"sandbox,omitempty"`
	Sid          string     `json:"sid"`
	Type         string     `json:"type"`
	URL          string     `json:"url"`
}

UpdateCredentialResponse defines the response fields for the updated credential