public_keys

Documentation

Overview

Package public_keys contains auto-generated files. DO NOT MODIFY

Package public_keys contains auto-generated files. DO NOT MODIFY

Package public_keys contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreatePublicKeyInput) (*CreatePublicKeyResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreatePublicKeyInput) (*CreatePublicKeyResponse, error)
  • func (c *Client) NewPublicKeysPaginator() *PublicKeysPaginator
  • func (c *Client) NewPublicKeysPaginatorWithOptions(options *PublicKeysPageOptions) *PublicKeysPaginator
  • func (c Client) Page(options *PublicKeysPageOptions) (*PublicKeysPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *PublicKeysPageOptions) (*PublicKeysPageResponse, error)
• type CreatePublicKeyInput
• type CreatePublicKeyResponse
• type PageMetaResponse
• type PagePublicKeyCredentialsResponse
• type PublicKeysPage
• type PublicKeysPageOptions
• type PublicKeysPageResponse
• type PublicKeysPaginator
  • func (p *PublicKeysPaginator) CurrentPage() *PublicKeysPageResponse
  • func (p *PublicKeysPaginator) Error() error
  • func (p *PublicKeysPaginator) Next() bool
  • func (p *PublicKeysPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing public resources

func New

func New(client *client.Client) *Client

New creates a new instance of the public keys client

func (Client) Create

func (c Client) Create(input *CreatePublicKeyInput) (*CreatePublicKeyResponse, error)

Create creates a public key resource Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreatePublicKeyInput) (*CreatePublicKeyResponse, error)

CreateWithContext creates a public key resource

func (*Client) NewPublicKeysPaginator

func (c *Client) NewPublicKeysPaginator() *PublicKeysPaginator

NewPublicKeysPaginator creates a new instance of the paginator for Page.

func (*Client) NewPublicKeysPaginatorWithOptions

func (c *Client) NewPublicKeysPaginatorWithOptions(options *PublicKeysPageOptions) *PublicKeysPaginator

NewPublicKeysPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *PublicKeysPageOptions) (*PublicKeysPageResponse, error)

Page retrieves a page of public key resources Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *PublicKeysPageOptions) (*PublicKeysPageResponse, error)

PageWithContext retrieves a page of public key resources

type CreatePublicKeyInput

type CreatePublicKeyInput struct {
	AccountSid   *string `form:"AccountSid,omitempty"`
	FriendlyName *string `form:"FriendlyName,omitempty"`
	PublicKey    string  `validate:"required" form:"PublicKey"`
}

CreatePublicKeyInput defines the input fields for creating a new public key resource

type CreatePublicKeyResponse

type CreatePublicKeyResponse 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"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
}

CreatePublicKeyResponse defines the response fields for the created public key

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}

type PagePublicKeyCredentialsResponse

type PagePublicKeyCredentialsResponse 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"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
}

type PublicKeysPage

type PublicKeysPage struct {
	CurrentPage *PublicKeysPageResponse
	Error       error
	// contains filtered or unexported fields
}

PublicKeysPage defines the fields for the page The CurrentPage and Error fields can be used to access the PagePublicKeyCredentialsResponse or error that is returned from the api call(s)

type PublicKeysPageOptions

type PublicKeysPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

PublicKeysPageOptions defines the query options for the api operation

type PublicKeysPageResponse

type PublicKeysPageResponse struct {
	Credentials []PagePublicKeyCredentialsResponse `json:"credentials"`
	Meta        PageMetaResponse                   `json:"meta"`
}

PublicKeysPageResponse defines the response fields for the public key resources page

type PublicKeysPaginator

type PublicKeysPaginator struct {
	Page        *PublicKeysPage
	Credentials []PagePublicKeyCredentialsResponse
	// contains filtered or unexported fields
}

PublicKeysPaginator defines the fields for makings paginated api calls Credentials is an array of credentials that have been returned from all of the page calls

func (*PublicKeysPaginator) CurrentPage

func (p *PublicKeysPaginator) CurrentPage() *PublicKeysPageResponse

CurrentPage retrieves the results for the current page

func (*PublicKeysPaginator) Error

func (p *PublicKeysPaginator) Error() error

Error retrieves the error returned from the page

func (*PublicKeysPaginator) Next

func (p *PublicKeysPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*PublicKeysPaginator) NextWithContext

func (p *PublicKeysPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate