openapi

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Jun 30, 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.18.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://serverless.twilio.com

Class Method HTTP request Description
ServicesApi CreateService Post /v1/Services
ServicesApi DeleteService Delete /v1/Services/{Sid}
ServicesApi FetchService Get /v1/Services/{Sid}
ServicesApi ListService Get /v1/Services
ServicesApi UpdateService Post /v1/Services/{Sid}
ServicesAssetsApi CreateAsset Post /v1/Services/{ServiceSid}/Assets
ServicesAssetsApi DeleteAsset Delete /v1/Services/{ServiceSid}/Assets/{Sid}
ServicesAssetsApi FetchAsset Get /v1/Services/{ServiceSid}/Assets/{Sid}
ServicesAssetsApi ListAsset Get /v1/Services/{ServiceSid}/Assets
ServicesAssetsApi UpdateAsset Post /v1/Services/{ServiceSid}/Assets/{Sid}
ServicesAssetsVersionsApi FetchAssetVersion Get /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}
ServicesAssetsVersionsApi ListAssetVersion Get /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions
ServicesBuildsApi CreateBuild Post /v1/Services/{ServiceSid}/Builds
ServicesBuildsApi DeleteBuild Delete /v1/Services/{ServiceSid}/Builds/{Sid}
ServicesBuildsApi FetchBuild Get /v1/Services/{ServiceSid}/Builds/{Sid}
ServicesBuildsApi ListBuild Get /v1/Services/{ServiceSid}/Builds
ServicesBuildsStatusApi FetchBuildStatus Get /v1/Services/{ServiceSid}/Builds/{Sid}/Status
ServicesEnvironmentsApi CreateEnvironment Post /v1/Services/{ServiceSid}/Environments
ServicesEnvironmentsApi DeleteEnvironment Delete /v1/Services/{ServiceSid}/Environments/{Sid}
ServicesEnvironmentsApi FetchEnvironment Get /v1/Services/{ServiceSid}/Environments/{Sid}
ServicesEnvironmentsApi ListEnvironment Get /v1/Services/{ServiceSid}/Environments
ServicesEnvironmentsDeploymentsApi CreateDeployment Post /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments
ServicesEnvironmentsDeploymentsApi FetchDeployment Get /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid}
ServicesEnvironmentsDeploymentsApi ListDeployment Get /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments
ServicesEnvironmentsLogsApi FetchLog Get /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}
ServicesEnvironmentsLogsApi ListLog Get /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs
ServicesEnvironmentsVariablesApi CreateVariable Post /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables
ServicesEnvironmentsVariablesApi DeleteVariable Delete /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}
ServicesEnvironmentsVariablesApi FetchVariable Get /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}
ServicesEnvironmentsVariablesApi ListVariable Get /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables
ServicesEnvironmentsVariablesApi UpdateVariable Post /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}
ServicesFunctionsApi CreateFunction Post /v1/Services/{ServiceSid}/Functions
ServicesFunctionsApi DeleteFunction Delete /v1/Services/{ServiceSid}/Functions/{Sid}
ServicesFunctionsApi FetchFunction Get /v1/Services/{ServiceSid}/Functions/{Sid}
ServicesFunctionsApi ListFunction Get /v1/Services/{ServiceSid}/Functions
ServicesFunctionsApi UpdateFunction Post /v1/Services/{ServiceSid}/Functions/{Sid}
ServicesFunctionsVersionsApi FetchFunctionVersion Get /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}
ServicesFunctionsVersionsApi ListFunctionVersion Get /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions
ServicesFunctionsVersionsContentApi FetchFunctionVersionContent Get /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content

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)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

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

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateAsset added in v0.11.0 

func (c *ApiService) CreateAsset(ServiceSid string, params *CreateAssetParams) (*ServerlessV1ServiceAsset, error)

Create a new Asset resource.

func (*ApiService) CreateBuild added in v0.11.0 

func (c *ApiService) CreateBuild(ServiceSid string, params *CreateBuildParams) (*ServerlessV1ServiceBuild, error)

Create a new Build resource. At least one function version or asset version is required.

func (*ApiService) CreateDeployment added in v0.11.0 

func (c *ApiService) CreateDeployment(ServiceSid string, EnvironmentSid string, params *CreateDeploymentParams) (*ServerlessV1ServiceEnvironmentDeployment, error)

Create a new Deployment.

func (*ApiService) CreateEnvironment added in v0.11.0 

func (c *ApiService) CreateEnvironment(ServiceSid string, params *CreateEnvironmentParams) (*ServerlessV1ServiceEnvironment, error)

Create a new environment.

func (*ApiService) CreateFunction added in v0.11.0 

func (c *ApiService) CreateFunction(ServiceSid string, params *CreateFunctionParams) (*ServerlessV1ServiceFunction, error)

Create a new Function resource.

func (*ApiService) CreateService added in v0.11.0 

func (c *ApiService) CreateService(params *CreateServiceParams) (*ServerlessV1Service, error)

Create a new Service resource.

func (*ApiService) CreateVariable added in v0.11.0 

func (c *ApiService) CreateVariable(ServiceSid string, EnvironmentSid string, params *CreateVariableParams) (*ServerlessV1ServiceEnvironmentVariable, error)

Create a new Variable.

func (*ApiService) DeleteAsset added in v0.11.0 

func (c *ApiService) DeleteAsset(ServiceSid string, Sid string) error

Delete an Asset resource.

func (*ApiService) DeleteBuild added in v0.11.0 

func (c *ApiService) DeleteBuild(ServiceSid string, Sid string) error

Delete a Build resource.

func (*ApiService) DeleteEnvironment added in v0.11.0 

func (c *ApiService) DeleteEnvironment(ServiceSid string, Sid string) error

Delete a specific environment.

func (*ApiService) DeleteFunction added in v0.11.0 

func (c *ApiService) DeleteFunction(ServiceSid string, Sid string) error

Delete a Function resource.

func (*ApiService) DeleteService added in v0.11.0 

func (c *ApiService) DeleteService(Sid string) error

Delete a Service resource.

func (*ApiService) DeleteVariable added in v0.11.0 

func (c *ApiService) DeleteVariable(ServiceSid string, EnvironmentSid string, Sid string) error

Delete a specific Variable.

func (*ApiService) FetchAsset added in v0.11.0 

func (c *ApiService) FetchAsset(ServiceSid string, Sid string) (*ServerlessV1ServiceAsset, error)

Retrieve a specific Asset resource.

func (*ApiService) FetchAssetVersion added in v0.11.0 

func (c *ApiService) FetchAssetVersion(ServiceSid string, AssetSid string, Sid string) (*ServerlessV1ServiceAssetAssetVersion, error)

Retrieve a specific Asset Version.

func (*ApiService) FetchBuild added in v0.11.0 

func (c *ApiService) FetchBuild(ServiceSid string, Sid string) (*ServerlessV1ServiceBuild, error)

Retrieve a specific Build resource.

func (*ApiService) FetchBuildStatus added in v0.11.0 

func (c *ApiService) FetchBuildStatus(ServiceSid string, Sid string) (*ServerlessV1ServiceBuildBuildStatus, error)

Retrieve a specific Build resource.

func (*ApiService) FetchDeployment added in v0.11.0 

func (c *ApiService) FetchDeployment(ServiceSid string, EnvironmentSid string, Sid string) (*ServerlessV1ServiceEnvironmentDeployment, error)

Retrieve a specific Deployment.

func (*ApiService) FetchEnvironment added in v0.11.0 

func (c *ApiService) FetchEnvironment(ServiceSid string, Sid string) (*ServerlessV1ServiceEnvironment, error)

Retrieve a specific environment.

func (*ApiService) FetchFunction added in v0.11.0 

func (c *ApiService) FetchFunction(ServiceSid string, Sid string) (*ServerlessV1ServiceFunction, error)

Retrieve a specific Function resource.

func (*ApiService) FetchFunctionVersion added in v0.11.0 

func (c *ApiService) FetchFunctionVersion(ServiceSid string, FunctionSid string, Sid string) (*ServerlessV1ServiceFunctionFunctionVersion, error)

Retrieve a specific Function Version resource.

func (*ApiService) FetchFunctionVersionContent added in v0.11.0 

func (c *ApiService) FetchFunctionVersionContent(ServiceSid string, FunctionSid string, Sid string) (*ServerlessV1ServiceFunctionFunctionVersionFunctionVersionContent, error)

Retrieve a the content of a specific Function Version resource.

func (*ApiService) FetchLog added in v0.11.0 

func (c *ApiService) FetchLog(ServiceSid string, EnvironmentSid string, Sid string) (*ServerlessV1ServiceEnvironmentLog, error)

Retrieve a specific log.

func (*ApiService) FetchService added in v0.11.0 

func (c *ApiService) FetchService(Sid string) (*ServerlessV1Service, error)

Retrieve a specific Service resource.

func (*ApiService) FetchVariable added in v0.11.0 

func (c *ApiService) FetchVariable(ServiceSid string, EnvironmentSid string, Sid string) (*ServerlessV1ServiceEnvironmentVariable, error)

Retrieve a specific Variable.

func (*ApiService) ListAsset added in v0.11.0 

func (c *ApiService) ListAsset(ServiceSid string, params *ListAssetParams) (*ListAssetResponse, error)

Retrieve a list of all Assets.

func (*ApiService) ListAssetVersion added in v0.11.0 

func (c *ApiService) ListAssetVersion(ServiceSid string, AssetSid string, params *ListAssetVersionParams) (*ListAssetVersionResponse, error)

Retrieve a list of all Asset Versions.

func (*ApiService) ListBuild added in v0.11.0 

func (c *ApiService) ListBuild(ServiceSid string, params *ListBuildParams) (*ListBuildResponse, error)

Retrieve a list of all Builds.

func (*ApiService) ListDeployment added in v0.11.0 

func (c *ApiService) ListDeployment(ServiceSid string, EnvironmentSid string, params *ListDeploymentParams) (*ListDeploymentResponse, error)

Retrieve a list of all Deployments.

func (*ApiService) ListEnvironment added in v0.11.0 

func (c *ApiService) ListEnvironment(ServiceSid string, params *ListEnvironmentParams) (*ListEnvironmentResponse, error)

Retrieve a list of all environments.

func (*ApiService) ListFunction added in v0.11.0 

func (c *ApiService) ListFunction(ServiceSid string, params *ListFunctionParams) (*ListFunctionResponse, error)

Retrieve a list of all Functions.

func (*ApiService) ListFunctionVersion added in v0.11.0 

func (c *ApiService) ListFunctionVersion(ServiceSid string, FunctionSid string, params *ListFunctionVersionParams) (*ListFunctionVersionResponse, error)

Retrieve a list of all Function Version resources.

func (*ApiService) ListLog added in v0.11.0 

func (c *ApiService) ListLog(ServiceSid string, EnvironmentSid string, params *ListLogParams) (*ListLogResponse, error)

Retrieve a list of all logs.

func (*ApiService) ListService added in v0.11.0 

func (c *ApiService) ListService(params *ListServiceParams) (*ListServiceResponse, error)

Retrieve a list of all Services.

func (*ApiService) ListVariable added in v0.11.0 

func (c *ApiService) ListVariable(ServiceSid string, EnvironmentSid string, params *ListVariableParams) (*ListVariableResponse, error)

Retrieve a list of all Variables.

func (*ApiService) UpdateAsset added in v0.11.0 

func (c *ApiService) UpdateAsset(ServiceSid string, Sid string, params *UpdateAssetParams) (*ServerlessV1ServiceAsset, error)

Update a specific Asset resource.

func (*ApiService) UpdateFunction added in v0.11.0 

func (c *ApiService) UpdateFunction(ServiceSid string, Sid string, params *UpdateFunctionParams) (*ServerlessV1ServiceFunction, error)

Update a specific Function resource.

func (*ApiService) UpdateService added in v0.11.0 

func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*ServerlessV1Service, error)

Update a specific Service resource.

func (*ApiService) UpdateVariable added in v0.11.0 

func (c *ApiService) UpdateVariable(ServiceSid string, EnvironmentSid string, Sid string, params *UpdateVariableParams) (*ServerlessV1ServiceEnvironmentVariable, error)

Update a specific Variable.

type CreateAssetParams 

type CreateAssetParams struct {
	// A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateAsset'

func (*CreateAssetParams) SetFriendlyName 

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

type CreateBuildParams 

type CreateBuildParams struct {
	// The list of Asset Version resource SIDs to include in the Build.
	AssetVersions *[]string `json:"AssetVersions,omitempty"`
	// A list of objects that describe the Dependencies included in the Build. Each object contains the `name` and `version` of the dependency.
	Dependencies *string `json:"Dependencies,omitempty"`
	// The list of the Function Version resource SIDs to include in the Build.
	FunctionVersions *[]string `json:"FunctionVersions,omitempty"`
	// The Runtime version that will be used to run the Build resource when it is deployed.
	Runtime *string `json:"Runtime,omitempty"`
}

Optional parameters for the method 'CreateBuild'

func (*CreateBuildParams) SetAssetVersions 

func (params *CreateBuildParams) SetAssetVersions(AssetVersions []string) *CreateBuildParams

func (*CreateBuildParams) SetDependencies 

func (params *CreateBuildParams) SetDependencies(Dependencies string) *CreateBuildParams

func (*CreateBuildParams) SetFunctionVersions 

func (params *CreateBuildParams) SetFunctionVersions(FunctionVersions []string) *CreateBuildParams

func (*CreateBuildParams) SetRuntime 

func (params *CreateBuildParams) SetRuntime(Runtime string) *CreateBuildParams

type CreateDeploymentParams 

type CreateDeploymentParams struct {
	// The SID of the Build for the Deployment.
	BuildSid *string `json:"BuildSid,omitempty"`
}

Optional parameters for the method 'CreateDeployment'

func (*CreateDeploymentParams) SetBuildSid 

func (params *CreateDeploymentParams) SetBuildSid(BuildSid string) *CreateDeploymentParams

type CreateEnvironmentParams 

type CreateEnvironmentParams struct {
	// A URL-friendly name that represents the environment and forms part of the domain name. It can be a maximum of 16 characters.
	DomainSuffix *string `json:"DomainSuffix,omitempty"`
	// A user-defined string that uniquely identifies the Environment resource. It can be a maximum of 100 characters.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateEnvironment'

func (*CreateEnvironmentParams) SetDomainSuffix 

func (params *CreateEnvironmentParams) SetDomainSuffix(DomainSuffix string) *CreateEnvironmentParams

func (*CreateEnvironmentParams) SetUniqueName 

func (params *CreateEnvironmentParams) SetUniqueName(UniqueName string) *CreateEnvironmentParams

type CreateFunctionParams 

type CreateFunctionParams struct {
	// A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateFunction'

func (*CreateFunctionParams) SetFriendlyName 

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

type CreateServiceParams 

type CreateServiceParams struct {
	// A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Whether to inject Account credentials into a function invocation context. The default value is `true`.
	IncludeCredentials *bool `json:"IncludeCredentials,omitempty"`
	// Whether the Service's properties and subresources can be edited via the UI. The default value is `false`.
	UiEditable *bool `json:"UiEditable,omitempty"`
	// A user-defined string that uniquely identifies the Service resource. It can be used as an alternative to the `sid` in the URL path to address the Service resource. This value must be 50 characters or less in length and be unique.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateService'

func (*CreateServiceParams) SetFriendlyName 

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

func (*CreateServiceParams) SetIncludeCredentials 

func (params *CreateServiceParams) SetIncludeCredentials(IncludeCredentials bool) *CreateServiceParams

func (*CreateServiceParams) SetUiEditable 

func (params *CreateServiceParams) SetUiEditable(UiEditable bool) *CreateServiceParams

func (*CreateServiceParams) SetUniqueName 

func (params *CreateServiceParams) SetUniqueName(UniqueName string) *CreateServiceParams

type CreateVariableParams 

type CreateVariableParams struct {
	// A string by which the Variable resource can be referenced. It can be a maximum of 128 characters.
	Key *string `json:"Key,omitempty"`
	// A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'CreateVariable'

func (*CreateVariableParams) SetKey 

func (params *CreateVariableParams) SetKey(Key string) *CreateVariableParams

func (*CreateVariableParams) SetValue 

func (params *CreateVariableParams) SetValue(Value string) *CreateVariableParams

type ListAssetParams 

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

Optional parameters for the method 'ListAsset'

func (*ListAssetParams) SetPageSize 

func (params *ListAssetParams) SetPageSize(PageSize int) *ListAssetParams

type ListAssetResponse 

type ListAssetResponse struct {
	Assets []ServerlessV1ServiceAsset `json:"assets,omitempty"`
	Meta   ListServiceResponseMeta    `json:"meta,omitempty"`
}

ListAssetResponse struct for ListAssetResponse

type ListAssetVersionParams 

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

Optional parameters for the method 'ListAssetVersion'

func (*ListAssetVersionParams) SetPageSize 

func (params *ListAssetVersionParams) SetPageSize(PageSize int) *ListAssetVersionParams

type ListAssetVersionResponse 

type ListAssetVersionResponse struct {
	AssetVersions []ServerlessV1ServiceAssetAssetVersion `json:"asset_versions,omitempty"`
	Meta          ListServiceResponseMeta                `json:"meta,omitempty"`
}

ListAssetVersionResponse struct for ListAssetVersionResponse

type ListBuildParams 

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

Optional parameters for the method 'ListBuild'

func (*ListBuildParams) SetPageSize 

func (params *ListBuildParams) SetPageSize(PageSize int) *ListBuildParams

type ListBuildResponse 

type ListBuildResponse struct {
	Builds []ServerlessV1ServiceBuild `json:"builds,omitempty"`
	Meta   ListServiceResponseMeta    `json:"meta,omitempty"`
}

ListBuildResponse struct for ListBuildResponse

type ListDeploymentParams 

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

Optional parameters for the method 'ListDeployment'

func (*ListDeploymentParams) SetPageSize 

func (params *ListDeploymentParams) SetPageSize(PageSize int) *ListDeploymentParams

type ListDeploymentResponse 

type ListDeploymentResponse struct {
	Deployments []ServerlessV1ServiceEnvironmentDeployment `json:"deployments,omitempty"`
	Meta        ListServiceResponseMeta                    `json:"meta,omitempty"`
}

ListDeploymentResponse struct for ListDeploymentResponse

type ListEnvironmentParams 

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

Optional parameters for the method 'ListEnvironment'

func (*ListEnvironmentParams) SetPageSize 

func (params *ListEnvironmentParams) SetPageSize(PageSize int) *ListEnvironmentParams

type ListEnvironmentResponse 

type ListEnvironmentResponse struct {
	Environments []ServerlessV1ServiceEnvironment `json:"environments,omitempty"`
	Meta         ListServiceResponseMeta          `json:"meta,omitempty"`
}

ListEnvironmentResponse struct for ListEnvironmentResponse

type ListFunctionParams 

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

Optional parameters for the method 'ListFunction'

func (*ListFunctionParams) SetPageSize 

func (params *ListFunctionParams) SetPageSize(PageSize int) *ListFunctionParams

type ListFunctionResponse 

type ListFunctionResponse struct {
	Functions []ServerlessV1ServiceFunction `json:"functions,omitempty"`
	Meta      ListServiceResponseMeta       `json:"meta,omitempty"`
}

ListFunctionResponse struct for ListFunctionResponse

type ListFunctionVersionParams 

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

Optional parameters for the method 'ListFunctionVersion'

func (*ListFunctionVersionParams) SetPageSize 

func (params *ListFunctionVersionParams) SetPageSize(PageSize int) *ListFunctionVersionParams

type ListFunctionVersionResponse 

type ListFunctionVersionResponse struct {
	FunctionVersions []ServerlessV1ServiceFunctionFunctionVersion `json:"function_versions,omitempty"`
	Meta             ListServiceResponseMeta                      `json:"meta,omitempty"`
}

ListFunctionVersionResponse struct for ListFunctionVersionResponse

type ListLogParams 

type ListLogParams struct {
	// The SID of the function whose invocation produced the Log resources to read.
	FunctionSid *string `json:"FunctionSid,omitempty"`
	// The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListLog'

func (*ListLogParams) SetEndDate 

func (params *ListLogParams) SetEndDate(EndDate time.Time) *ListLogParams

func (*ListLogParams) SetFunctionSid 

func (params *ListLogParams) SetFunctionSid(FunctionSid string) *ListLogParams

func (*ListLogParams) SetPageSize 

func (params *ListLogParams) SetPageSize(PageSize int) *ListLogParams

func (*ListLogParams) SetStartDate 

func (params *ListLogParams) SetStartDate(StartDate time.Time) *ListLogParams

type ListLogResponse 

type ListLogResponse struct {
	Logs []ServerlessV1ServiceEnvironmentLog `json:"logs,omitempty"`
	Meta ListServiceResponseMeta             `json:"meta,omitempty"`
}

ListLogResponse struct for ListLogResponse

type ListServiceParams 

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

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetPageSize 

func (params *ListServiceParams) SetPageSize(PageSize int) *ListServiceParams

type ListServiceResponse 

type ListServiceResponse struct {
	Meta     ListServiceResponseMeta `json:"meta,omitempty"`
	Services []ServerlessV1Service   `json:"services,omitempty"`
}

ListServiceResponse struct for ListServiceResponse

type ListServiceResponseMeta 

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

ListServiceResponseMeta struct for ListServiceResponseMeta

type ListVariableParams 

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

Optional parameters for the method 'ListVariable'

func (*ListVariableParams) SetPageSize 

func (params *ListVariableParams) SetPageSize(PageSize int) *ListVariableParams

type ListVariableResponse 

type ListVariableResponse struct {
	Meta      ListServiceResponseMeta                  `json:"meta,omitempty"`
	Variables []ServerlessV1ServiceEnvironmentVariable `json:"variables,omitempty"`
}

ListVariableResponse struct for ListVariableResponse

type ServerlessV1Service 

type ServerlessV1Service struct {
	// The SID of the Account that created the Service resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Service resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Service resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the Service resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Whether to inject Account credentials into a function invocation context
	IncludeCredentials *bool `json:"include_credentials,omitempty"`
	// The URLs of the Service's nested resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the Service resource
	Sid *string `json:"sid,omitempty"`
	// Whether the Service resource's properties and subresources can be edited via the UI
	UiEditable *bool `json:"ui_editable,omitempty"`
	// A user-defined string that uniquely identifies the Service resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Service resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1Service struct for ServerlessV1Service

type ServerlessV1ServiceAsset 

type ServerlessV1ServiceAsset struct {
	// The SID of the Account that created the Asset resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Asset resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Asset resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the Asset resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of the Asset resource's nested resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the Service that the Asset resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Asset resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Asset resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceAsset struct for ServerlessV1ServiceAsset

type ServerlessV1ServiceAssetAssetVersion 

type ServerlessV1ServiceAssetAssetVersion struct {
	// The SID of the Account that created the Asset Version resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Asset resource that is the parent of the Asset Version
	AssetSid *string `json:"asset_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Asset Version resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The URL-friendly string by which the Asset Version can be referenced
	Path *string `json:"path,omitempty"`
	// The SID of the Service that the Asset Version resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Asset Version resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Asset Version resource
	Url *string `json:"url,omitempty"`
	// The access control that determines how the Asset Version can be accessed
	Visibility *string `json:"visibility,omitempty"`
}

ServerlessV1ServiceAssetAssetVersion struct for ServerlessV1ServiceAssetAssetVersion

type ServerlessV1ServiceBuild 

type ServerlessV1ServiceBuild struct {
	// The SID of the Account that created the Build resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The list of Asset Version resource SIDs that are included in the Build
	AssetVersions *[]map[string]interface{} `json:"asset_versions,omitempty"`
	// The ISO 8601 date and time in GMT when the Build resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Build resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// A list of objects that describe the Dependencies included in the Build
	Dependencies *[]map[string]interface{} `json:"dependencies,omitempty"`
	// The list of Function Version resource SIDs that are included in the Build
	FunctionVersions *[]map[string]interface{} `json:"function_versions,omitempty"`
	Links            *map[string]interface{}   `json:"links,omitempty"`
	// The Runtime version that will be used to run the Build.
	Runtime *string `json:"runtime,omitempty"`
	// The SID of the Service that the Build resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Build resource
	Sid *string `json:"sid,omitempty"`
	// The status of the Build
	Status *string `json:"status,omitempty"`
	// The absolute URL of the Build resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceBuild struct for ServerlessV1ServiceBuild

type ServerlessV1ServiceBuildBuildStatus 

type ServerlessV1ServiceBuildBuildStatus struct {
	// The SID of the Account that created the Build resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Service that the Build resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Build resource
	Sid *string `json:"sid,omitempty"`
	// The status of the Build
	Status *string `json:"status,omitempty"`
	// The absolute URL of the Build Status resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceBuildBuildStatus struct for ServerlessV1ServiceBuildBuildStatus

type ServerlessV1ServiceEnvironment 

type ServerlessV1ServiceEnvironment struct {
	// The SID of the Account that created the Environment resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the build deployed in the environment
	BuildSid *string `json:"build_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Environment resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Environment resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The base domain name for all Functions and Assets deployed in the Environment
	DomainName *string `json:"domain_name,omitempty"`
	// A URL-friendly name that represents the environment
	DomainSuffix *string `json:"domain_suffix,omitempty"`
	// The URLs of the Environment resource's nested resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the Service that the Environment resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Environment resource
	Sid *string `json:"sid,omitempty"`
	// A user-defined string that uniquely identifies the Environment resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Environment resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceEnvironment struct for ServerlessV1ServiceEnvironment

type ServerlessV1ServiceEnvironmentDeployment 

type ServerlessV1ServiceEnvironmentDeployment struct {
	// The SID of the Account that created the Deployment resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Build for the deployment
	BuildSid *string `json:"build_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Deployment resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Deployment resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Environment for the Deployment
	EnvironmentSid *string `json:"environment_sid,omitempty"`
	// The SID of the Service that the Deployment resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Deployment resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Deployment resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceEnvironmentDeployment struct for ServerlessV1ServiceEnvironmentDeployment

type ServerlessV1ServiceEnvironmentLog 

type ServerlessV1ServiceEnvironmentLog struct {
	// The SID of the Account that created the Log resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the build that corresponds to the log
	BuildSid *string `json:"build_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Log resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The SID of the deployment that corresponds to the log
	DeploymentSid *string `json:"deployment_sid,omitempty"`
	// The SID of the environment in which the log occurred
	EnvironmentSid *string `json:"environment_sid,omitempty"`
	// The SID of the function whose invocation produced the log
	FunctionSid *string `json:"function_sid,omitempty"`
	// The log level
	Level *string `json:"level,omitempty"`
	// The log message
	Message *string `json:"message,omitempty"`
	// The SID of the request associated with the log
	RequestSid *string `json:"request_sid,omitempty"`
	// The SID of the Service that the Log resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Log resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Log resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceEnvironmentLog struct for ServerlessV1ServiceEnvironmentLog

type ServerlessV1ServiceEnvironmentVariable 

type ServerlessV1ServiceEnvironmentVariable struct {
	// The SID of the Account that created the Variable resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Variable resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Variable resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Environment in which the Variable exists
	EnvironmentSid *string `json:"environment_sid,omitempty"`
	// A string by which the Variable resource can be referenced
	Key *string `json:"key,omitempty"`
	// The SID of the Service that the Variable resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Variable resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Variable resource
	Url *string `json:"url,omitempty"`
	// A string that contains the actual value of the Variable
	Value *string `json:"value,omitempty"`
}

ServerlessV1ServiceEnvironmentVariable struct for ServerlessV1ServiceEnvironmentVariable

type ServerlessV1ServiceFunction 

type ServerlessV1ServiceFunction struct {
	// The SID of the Account that created the Function resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Function resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Function resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the Function resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of nested resources of the Function resource
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the Service that the Function resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Function resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Function resource
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceFunction struct for ServerlessV1ServiceFunction

type ServerlessV1ServiceFunctionFunctionVersion 

type ServerlessV1ServiceFunctionFunctionVersion struct {
	// The SID of the Account that created the Function Version resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the Function Version resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The SID of the Function resource that is the parent of the Function Version resource
	FunctionSid *string                 `json:"function_sid,omitempty"`
	Links       *map[string]interface{} `json:"links,omitempty"`
	// The URL-friendly string by which the Function Version resource can be referenced
	Path *string `json:"path,omitempty"`
	// The SID of the Service that the Function Version resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Function Version resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Function Version resource
	Url *string `json:"url,omitempty"`
	// The access control that determines how the Function Version resource can be accessed
	Visibility *string `json:"visibility,omitempty"`
}

ServerlessV1ServiceFunctionFunctionVersion struct for ServerlessV1ServiceFunctionFunctionVersion

type ServerlessV1ServiceFunctionFunctionVersionFunctionVersionContent 

type ServerlessV1ServiceFunctionFunctionVersionFunctionVersionContent struct {
	// The SID of the Account that created the Function Version resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The content of the Function Version resource
	Content *string `json:"content,omitempty"`
	// The SID of the Function that is the parent of the Function Version
	FunctionSid *string `json:"function_sid,omitempty"`
	// The SID of the Service that the Function Version resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the Function Version resource
	Sid *string `json:"sid,omitempty"`
	Url *string `json:"url,omitempty"`
}

ServerlessV1ServiceFunctionFunctionVersionFunctionVersionContent struct for ServerlessV1ServiceFunctionFunctionVersionFunctionVersionContent

type UpdateAssetParams 

type UpdateAssetParams struct {
	// A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'UpdateAsset'

func (*UpdateAssetParams) SetFriendlyName 

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

type UpdateFunctionParams 

type UpdateFunctionParams struct {
	// A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'UpdateFunction'

func (*UpdateFunctionParams) SetFriendlyName 

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

type UpdateServiceParams 

type UpdateServiceParams struct {
	// A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Whether to inject Account credentials into a function invocation context.
	IncludeCredentials *bool `json:"IncludeCredentials,omitempty"`
	// Whether the Service resource's properties and subresources can be edited via the UI. The default value is `false`.
	UiEditable *bool `json:"UiEditable,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetFriendlyName 

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

func (*UpdateServiceParams) SetIncludeCredentials 

func (params *UpdateServiceParams) SetIncludeCredentials(IncludeCredentials bool) *UpdateServiceParams

func (*UpdateServiceParams) SetUiEditable 

func (params *UpdateServiceParams) SetUiEditable(UiEditable bool) *UpdateServiceParams

type UpdateVariableParams 

type UpdateVariableParams struct {
	// A string by which the Variable resource can be referenced. It can be a maximum of 128 characters.
	Key *string `json:"Key,omitempty"`
	// A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'UpdateVariable'

func (*UpdateVariableParams) SetKey 

func (params *UpdateVariableParams) SetKey(Key string) *UpdateVariableParams

func (*UpdateVariableParams) SetValue 

func (params *UpdateVariableParams) SetValue(Value string) *UpdateVariableParams

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.