openapi

package
v1.23.1 Latest Latest
Warning

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

 Go to latest Published: Sep 18, 2024 License: MIT Imports: 6 Imported by: 0

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.0.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://marketplace.twilio.com

Class Method HTTP request Description
AvailableAddOnsApi FetchAvailableAddOn Get /v1/AvailableAddOns/{Sid}
AvailableAddOnsApi ListAvailableAddOn Get /v1/AvailableAddOns
AvailableAddOnsExtensionsApi FetchAvailableAddOnExtension Get /v1/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}
AvailableAddOnsExtensionsApi ListAvailableAddOnExtension Get /v1/AvailableAddOns/{AvailableAddOnSid}/Extensions
InstalledAddOnsApi CreateInstalledAddOn Post /v1/InstalledAddOns
InstalledAddOnsApi DeleteInstalledAddOn Delete /v1/InstalledAddOns/{Sid}
InstalledAddOnsApi FetchInstalledAddOn Get /v1/InstalledAddOns/{Sid}
InstalledAddOnsApi ListInstalledAddOn Get /v1/InstalledAddOns
InstalledAddOnsApi UpdateInstalledAddOn Post /v1/InstalledAddOns/{Sid}
InstalledAddOnsExtensionsApi FetchInstalledAddOnExtension Get /v1/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}
InstalledAddOnsExtensionsApi ListInstalledAddOnExtension Get /v1/InstalledAddOns/{InstalledAddOnSid}/Extensions
InstalledAddOnsExtensionsApi UpdateInstalledAddOnExtension Post /v1/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}
InstalledAddOnsUsageApi CreateBillingUsage Post /v1/InstalledAddOns/{InstalledAddOnSid}/Usage
ListingApi FetchModuleDataManagement Get /v1/Listing/{Sid}
ListingApi UpdateModuleDataManagement Post /v1/Listing/{Sid}
ReferralConversionApi CreateReferralConversion Post /v1/ReferralConversion

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 

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

func NewApiService 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateBillingUsage added in v1.22.2 

func (c *ApiService) CreateBillingUsage(InstalledAddOnSid string, params *CreateBillingUsageParams) (*MarketplaceV1InstalledAddOnUsage, error)

Allows Twilio Marketplace publishers to manually report customer usage on No-code Partner Listings that they own.

func (*ApiService) CreateInstalledAddOn added in v1.22.2 

func (c *ApiService) CreateInstalledAddOn(params *CreateInstalledAddOnParams) (*MarketplaceV1InstalledAddOn, error)

Install an Add-on for the Account specified.

func (*ApiService) CreateReferralConversion added in v1.22.4 

func (c *ApiService) CreateReferralConversion(params *CreateReferralConversionParams) (*MarketplaceV1ReferralConversion, error)

func (*ApiService) DeleteInstalledAddOn added in v1.22.2 

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

Remove an Add-on installation from your account

func (*ApiService) FetchAvailableAddOn added in v1.22.2 

func (c *ApiService) FetchAvailableAddOn(Sid string) (*MarketplaceV1AvailableAddOn, error)

Fetch an instance of an Add-on currently available to be installed.

func (*ApiService) FetchAvailableAddOnExtension added in v1.22.2 

func (c *ApiService) FetchAvailableAddOnExtension(AvailableAddOnSid string, Sid string) (*MarketplaceV1AvailableAddOnExtension, error)

Fetch an instance of an Extension for the Available Add-on.

func (*ApiService) FetchInstalledAddOn added in v1.22.2 

func (c *ApiService) FetchInstalledAddOn(Sid string) (*MarketplaceV1InstalledAddOn, error)

Fetch an instance of an Add-on currently installed on this Account.

func (*ApiService) FetchInstalledAddOnExtension added in v1.22.2 

func (c *ApiService) FetchInstalledAddOnExtension(InstalledAddOnSid string, Sid string) (*MarketplaceV1InstalledAddOnExtension, error)

Fetch an instance of an Extension for the Installed Add-on.

func (*ApiService) FetchModuleDataManagement added in v1.22.2 

func (c *ApiService) FetchModuleDataManagement(Sid string) (*MarketplaceV1ModuleDataManagement, error)

This endpoint returns the data of a given Listing. To find a Listing's SID, use the [Available Add-ons resource](/docs/marketplace/api/available-add-ons) or view its Listing details page in the Console by visiting the [Catalog](https://console.twilio.com/us1/develop/add-ons/catalog) or the [My Listings tab](https://console.twilio.com/us1/develop/add-ons/publish/my-listings) and selecting the Listing.

func (*ApiService) ListAvailableAddOn added in v1.22.2 

func (c *ApiService) ListAvailableAddOn(params *ListAvailableAddOnParams) ([]MarketplaceV1AvailableAddOn, error)

Lists AvailableAddOn records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListAvailableAddOnExtension added in v1.22.2 

func (c *ApiService) ListAvailableAddOnExtension(AvailableAddOnSid string, params *ListAvailableAddOnExtensionParams) ([]MarketplaceV1AvailableAddOnExtension, error)

Lists AvailableAddOnExtension records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInstalledAddOn added in v1.22.2 

func (c *ApiService) ListInstalledAddOn(params *ListInstalledAddOnParams) ([]MarketplaceV1InstalledAddOn, error)

Lists InstalledAddOn records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInstalledAddOnExtension added in v1.22.2 

func (c *ApiService) ListInstalledAddOnExtension(InstalledAddOnSid string, params *ListInstalledAddOnExtensionParams) ([]MarketplaceV1InstalledAddOnExtension, error)

Lists InstalledAddOnExtension records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageAvailableAddOn added in v1.22.2 

func (c *ApiService) PageAvailableAddOn(params *ListAvailableAddOnParams, pageToken, pageNumber string) (*ListAvailableAddOnResponse, error)

Retrieve a single page of AvailableAddOn records from the API. Request is executed immediately.

func (*ApiService) PageAvailableAddOnExtension added in v1.22.2 

func (c *ApiService) PageAvailableAddOnExtension(AvailableAddOnSid string, params *ListAvailableAddOnExtensionParams, pageToken, pageNumber string) (*ListAvailableAddOnExtensionResponse, error)

Retrieve a single page of AvailableAddOnExtension records from the API. Request is executed immediately.

func (*ApiService) PageInstalledAddOn added in v1.22.2 

func (c *ApiService) PageInstalledAddOn(params *ListInstalledAddOnParams, pageToken, pageNumber string) (*ListInstalledAddOnResponse, error)

Retrieve a single page of InstalledAddOn records from the API. Request is executed immediately.

func (*ApiService) PageInstalledAddOnExtension added in v1.22.2 

func (c *ApiService) PageInstalledAddOnExtension(InstalledAddOnSid string, params *ListInstalledAddOnExtensionParams, pageToken, pageNumber string) (*ListInstalledAddOnExtensionResponse, error)

Retrieve a single page of InstalledAddOnExtension records from the API. Request is executed immediately.

func (*ApiService) StreamAvailableAddOn added in v1.22.2 

func (c *ApiService) StreamAvailableAddOn(params *ListAvailableAddOnParams) (chan MarketplaceV1AvailableAddOn, chan error)

Streams AvailableAddOn records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamAvailableAddOnExtension added in v1.22.2 

func (c *ApiService) StreamAvailableAddOnExtension(AvailableAddOnSid string, params *ListAvailableAddOnExtensionParams) (chan MarketplaceV1AvailableAddOnExtension, chan error)

Streams AvailableAddOnExtension records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInstalledAddOn added in v1.22.2 

func (c *ApiService) StreamInstalledAddOn(params *ListInstalledAddOnParams) (chan MarketplaceV1InstalledAddOn, chan error)

Streams InstalledAddOn records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInstalledAddOnExtension added in v1.22.2 

func (c *ApiService) StreamInstalledAddOnExtension(InstalledAddOnSid string, params *ListInstalledAddOnExtensionParams) (chan MarketplaceV1InstalledAddOnExtension, chan error)

Streams InstalledAddOnExtension records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateInstalledAddOn added in v1.22.2 

func (c *ApiService) UpdateInstalledAddOn(Sid string, params *UpdateInstalledAddOnParams) (*MarketplaceV1InstalledAddOn, error)

Update an Add-on installation for the Account specified.

func (*ApiService) UpdateInstalledAddOnExtension added in v1.22.2 

func (c *ApiService) UpdateInstalledAddOnExtension(InstalledAddOnSid string, Sid string, params *UpdateInstalledAddOnExtensionParams) (*MarketplaceV1InstalledAddOnExtension, error)

Update an Extension for an Add-on installation.

func (*ApiService) UpdateModuleDataManagement added in v1.22.2 

func (c *ApiService) UpdateModuleDataManagement(Sid string, params *UpdateModuleDataManagementParams) (*MarketplaceV1ModuleDataManagement, error)

This endpoint updates the data of a given Listing. To find a Listing's SID, use the [Available Add-ons resource](https://www.twilio.com/docs/marketplace/api/available-add-ons) or view its Listing details page in the Console by visiting the [Catalog](https://console.twilio.com/us1/develop/add-ons/catalog) or the [My Listings tab](https://console.twilio.com/us1/develop/add-ons/publish/my-listings) and selecting the Listing. Only Listing owners are allowed to update the Listing.

type CreateBillingUsageParams added in v1.22.2 

type CreateBillingUsageParams struct {
	//
	MarketplaceV1InstalledAddOnUsage *MarketplaceV1InstalledAddOnUsage `json:"MarketplaceV1InstalledAddOnUsage,omitempty"`
}

Optional parameters for the method 'CreateBillingUsage'

func (*CreateBillingUsageParams) SetMarketplaceV1InstalledAddOnUsage added in v1.22.4 

func (params *CreateBillingUsageParams) SetMarketplaceV1InstalledAddOnUsage(MarketplaceV1InstalledAddOnUsage MarketplaceV1InstalledAddOnUsage) *CreateBillingUsageParams

type CreateInstalledAddOnParams added in v1.22.2 

type CreateInstalledAddOnParams struct {
	// The SID of the AvaliableAddOn to install.
	AvailableAddOnSid *string `json:"AvailableAddOnSid,omitempty"`
	// Whether the Terms of Service were accepted.
	AcceptTermsOfService *bool `json:"AcceptTermsOfService,omitempty"`
	// The JSON object that represents the configuration of the new Add-on being installed.
	Configuration *interface{} `json:"Configuration,omitempty"`
	// An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateInstalledAddOn'

func (*CreateInstalledAddOnParams) SetAcceptTermsOfService added in v1.22.2 

func (params *CreateInstalledAddOnParams) SetAcceptTermsOfService(AcceptTermsOfService bool) *CreateInstalledAddOnParams

func (*CreateInstalledAddOnParams) SetAvailableAddOnSid added in v1.22.2 

func (params *CreateInstalledAddOnParams) SetAvailableAddOnSid(AvailableAddOnSid string) *CreateInstalledAddOnParams

func (*CreateInstalledAddOnParams) SetConfiguration added in v1.22.2 

func (params *CreateInstalledAddOnParams) SetConfiguration(Configuration interface{}) *CreateInstalledAddOnParams

func (*CreateInstalledAddOnParams) SetUniqueName added in v1.22.2 

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

type CreateReferralConversionParams added in v1.22.4 

type CreateReferralConversionParams struct {
	//
	CreateReferralConversionRequest *CreateReferralConversionRequest `json:"CreateReferralConversionRequest,omitempty"`
}

Optional parameters for the method 'CreateReferralConversion'

func (*CreateReferralConversionParams) SetCreateReferralConversionRequest added in v1.22.4 

func (params *CreateReferralConversionParams) SetCreateReferralConversionRequest(CreateReferralConversionRequest CreateReferralConversionRequest) *CreateReferralConversionParams

type CreateReferralConversionRequest added in v1.22.4 

type CreateReferralConversionRequest struct {
	ReferralAccountSid string `json:"referral_account_sid,omitempty"`
}

CreateReferralConversionRequest struct for CreateReferralConversionRequest

type ListAvailableAddOnExtensionParams added in v1.22.2 

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

Optional parameters for the method 'ListAvailableAddOnExtension'

func (*ListAvailableAddOnExtensionParams) SetLimit added in v1.22.2 

func (params *ListAvailableAddOnExtensionParams) SetLimit(Limit int) *ListAvailableAddOnExtensionParams

func (*ListAvailableAddOnExtensionParams) SetPageSize added in v1.22.2 

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

type ListAvailableAddOnExtensionResponse added in v1.22.2 

type ListAvailableAddOnExtensionResponse struct {
	Extensions []MarketplaceV1AvailableAddOnExtension `json:"extensions,omitempty"`
	Meta       ListAvailableAddOnResponseMeta         `json:"meta,omitempty"`
}

ListAvailableAddOnExtensionResponse struct for ListAvailableAddOnExtensionResponse

type ListAvailableAddOnParams added in v1.22.2 

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

Optional parameters for the method 'ListAvailableAddOn'

func (*ListAvailableAddOnParams) SetLimit added in v1.22.2 

func (params *ListAvailableAddOnParams) SetLimit(Limit int) *ListAvailableAddOnParams

func (*ListAvailableAddOnParams) SetPageSize added in v1.22.2 

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

type ListAvailableAddOnResponse added in v1.22.2 

type ListAvailableAddOnResponse struct {
	AvailableAddOns []MarketplaceV1AvailableAddOn  `json:"available_add_ons,omitempty"`
	Meta            ListAvailableAddOnResponseMeta `json:"meta,omitempty"`
}

ListAvailableAddOnResponse struct for ListAvailableAddOnResponse

type ListAvailableAddOnResponseMeta added in v1.22.2 

type ListAvailableAddOnResponseMeta 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"`
}

ListAvailableAddOnResponseMeta struct for ListAvailableAddOnResponseMeta

type ListInstalledAddOnExtensionParams added in v1.22.2 

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

Optional parameters for the method 'ListInstalledAddOnExtension'

func (*ListInstalledAddOnExtensionParams) SetLimit added in v1.22.2 

func (params *ListInstalledAddOnExtensionParams) SetLimit(Limit int) *ListInstalledAddOnExtensionParams

func (*ListInstalledAddOnExtensionParams) SetPageSize added in v1.22.2 

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

type ListInstalledAddOnExtensionResponse added in v1.22.2 

type ListInstalledAddOnExtensionResponse struct {
	Extensions []MarketplaceV1InstalledAddOnExtension `json:"extensions,omitempty"`
	Meta       ListAvailableAddOnResponseMeta         `json:"meta,omitempty"`
}

ListInstalledAddOnExtensionResponse struct for ListInstalledAddOnExtensionResponse

type ListInstalledAddOnParams added in v1.22.2 

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

Optional parameters for the method 'ListInstalledAddOn'

func (*ListInstalledAddOnParams) SetLimit added in v1.22.2 

func (params *ListInstalledAddOnParams) SetLimit(Limit int) *ListInstalledAddOnParams

func (*ListInstalledAddOnParams) SetPageSize added in v1.22.2 

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

type ListInstalledAddOnResponse added in v1.22.2 

type ListInstalledAddOnResponse struct {
	InstalledAddOns []MarketplaceV1InstalledAddOn  `json:"installed_add_ons,omitempty"`
	Meta            ListAvailableAddOnResponseMeta `json:"meta,omitempty"`
}

ListInstalledAddOnResponse struct for ListInstalledAddOnResponse

type MarketplaceV1AvailableAddOn added in v1.22.2 

type MarketplaceV1AvailableAddOn struct {
	// The unique string that we created to identify the AvailableAddOn resource.
	Sid *string `json:"sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A short description of the Add-on's functionality.
	Description *string `json:"description,omitempty"`
	// How customers are charged for using this Add-on.
	PricingType *string `json:"pricing_type,omitempty"`
	// The JSON object with the configuration that must be provided when installing a given Add-on.
	ConfigurationSchema *interface{} `json:"configuration_schema,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

MarketplaceV1AvailableAddOn struct for MarketplaceV1AvailableAddOn

type MarketplaceV1AvailableAddOnExtension added in v1.22.2 

type MarketplaceV1AvailableAddOnExtension struct {
	// The unique string that we created to identify the AvailableAddOnExtension resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the AvailableAddOn resource to which this extension applies.
	AvailableAddOnSid *string `json:"available_add_on_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The name of the Product this Extension is used within.
	ProductName *string `json:"product_name,omitempty"`
	// An application-defined string that uniquely identifies the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

MarketplaceV1AvailableAddOnExtension struct for MarketplaceV1AvailableAddOnExtension

type MarketplaceV1BillingUsageResponse added in v1.22.2 

type MarketplaceV1BillingUsageResponse struct {
	BillableItems []MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems `json:"billable_items,omitempty"`
	// Represents the total quantity submitted.
	TotalSubmitted float32 `json:"total_submitted,omitempty"`
}

MarketplaceV1BillingUsageResponse struct for MarketplaceV1BillingUsageResponse

func (*MarketplaceV1BillingUsageResponse) UnmarshalJSON added in v1.22.2 

func (response *MarketplaceV1BillingUsageResponse) UnmarshalJSON(bytes []byte) (err error)

type MarketplaceV1InstalledAddOn added in v1.22.2 

type MarketplaceV1InstalledAddOn struct {
	// The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A short description of the Add-on's functionality.
	Description *string `json:"description,omitempty"`
	// The JSON object that represents the current configuration of installed Add-on.
	Configuration *interface{} `json:"configuration,omitempty"`
	// An application-defined string that uniquely identifies the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

MarketplaceV1InstalledAddOn struct for MarketplaceV1InstalledAddOn

type MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems added in v1.22.2 

type MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems struct {
	//
	Quantity float32 `json:"quantity,omitempty"`
	//
	Sid string `json:"sid,omitempty"`
	// Whether this billable item was successfully submitted for billing.
	Submitted bool `json:"submitted,omitempty"`
}

MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems struct for MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems

func (*MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems) UnmarshalJSON added in v1.22.2 

func (response *MarketplaceV1InstalledAddOnBillingUsageResponseBillableItems) UnmarshalJSON(bytes []byte) (err error)

type MarketplaceV1InstalledAddOnExtension added in v1.22.2 

type MarketplaceV1InstalledAddOnExtension struct {
	// The unique string that we created to identify the InstalledAddOn Extension resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the InstalledAddOn resource to which this extension applies.
	InstalledAddOnSid *string `json:"installed_add_on_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The name of the Product this Extension is used within.
	ProductName *string `json:"product_name,omitempty"`
	// An application-defined string that uniquely identifies the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// Whether the Extension will be invoked.
	Enabled *bool `json:"enabled,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

MarketplaceV1InstalledAddOnExtension struct for MarketplaceV1InstalledAddOnExtension

type MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems added in v1.22.4 

type MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems struct {
	// Total amount in local currency that was billed for this Billing Item. Can be any floating number greater than 0.
	Quantity float32 `json:"quantity"`
	// BillingSid to use for billing.
	Sid string `json:"sid"`
	// Whether the billing event was successfully generated for this Billable Item.
	Submitted bool `json:"submitted,omitempty"`
}

MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems struct for MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems

func (*MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems) UnmarshalJSON added in v1.22.4 

func (response *MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems) UnmarshalJSON(bytes []byte) (err error)

type MarketplaceV1InstalledAddOnUsage added in v1.22.4 

type MarketplaceV1InstalledAddOnUsage struct {
	// Total amount in local currency that was billed in this request. Aggregates all billable_items that were successfully submitted.
	TotalSubmitted float32                                                       `json:"total_submitted,omitempty"`
	BillableItems  []MarketplaceV1InstalledAddOnInstalledAddOnUsageBillableItems `json:"billable_items"`
}

MarketplaceV1InstalledAddOnUsage struct for MarketplaceV1InstalledAddOnUsage

func (*MarketplaceV1InstalledAddOnUsage) UnmarshalJSON added in v1.23.1 

func (response *MarketplaceV1InstalledAddOnUsage) UnmarshalJSON(bytes []byte) (err error)

type MarketplaceV1ModuleDataManagement added in v1.22.2 

type MarketplaceV1ModuleDataManagement struct {
	// URL to query the subresource.
	Url *string `json:"url,omitempty"`
	// ModuleSid that identifies this Listing.
	Sid *string `json:"sid,omitempty"`
	// A JSON object describing the module and is displayed under the Description tab of the Module detail page. You can define the main body of the description, highlight key features or aspects of the module and if applicable, provide code samples for developers
	Description *interface{} `json:"description,omitempty"`
	// A JSON object containing information on how customers can obtain support for the module. Use this parameter to provide details such as contact information and support description.
	Support *interface{} `json:"support,omitempty"`
	// A JSON object describing the module's privacy and legal policies and is displayed under the Policies tab of the Module detail page. The maximum file size for Policies is 5MB
	Policies *interface{} `json:"policies,omitempty"`
	// A JSON object containing essential attributes that define a module. This information is presented on the Module detail page in the Twilio Marketplace Catalog. You can pass the following attributes in the JSON object
	ModuleInfo *interface{} `json:"module_info,omitempty"`
	// A JSON object for providing comprehensive information, instructions, and resources related to the module
	Documentation *interface{} `json:"documentation,omitempty"`
	// A JSON object for providing listing specific configuration. Contains button setup, notification url, among others.
	Configuration *interface{} `json:"configuration,omitempty"`
	// A JSON object for providing Listing specific pricing information.
	Pricing *interface{} `json:"pricing,omitempty"`
}

MarketplaceV1ModuleDataManagement struct for MarketplaceV1ModuleDataManagement

type MarketplaceV1ReferralConversion added in v1.22.4 

type MarketplaceV1ReferralConversion struct {
	ConvertedAccountSid string `json:"converted_account_sid,omitempty"`
}

MarketplaceV1ReferralConversion struct for MarketplaceV1ReferralConversion

type MarketplaceV1ReferralRecords added in v1.23.1 

type MarketplaceV1ReferralRecords struct {
	// The unique identifier for this resource.
	Sid string `json:"sid,omitempty"`
	// The account sid that owns this record.
	AccountSid string `json:"account_sid,omitempty"`
	// Net revenue collected as part of this record.
	NetRevenue float32 `json:"net_revenue,omitempty"`
	// Name of the file attached to the record.
	Filename string `json:"filename,omitempty"`
	// Link to download record's invoice.
	DocumentationLink string `json:"documentation_link,omitempty"`
	// The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

MarketplaceV1ReferralRecords struct for MarketplaceV1ReferralRecords

func (*MarketplaceV1ReferralRecords) UnmarshalJSON added in v1.23.1 

func (response *MarketplaceV1ReferralRecords) UnmarshalJSON(bytes []byte) (err error)

type UpdateInstalledAddOnExtensionParams added in v1.22.2 

type UpdateInstalledAddOnExtensionParams struct {
	// Whether the Extension should be invoked.
	Enabled *bool `json:"Enabled,omitempty"`
}

Optional parameters for the method 'UpdateInstalledAddOnExtension'

func (*UpdateInstalledAddOnExtensionParams) SetEnabled added in v1.22.2 

func (params *UpdateInstalledAddOnExtensionParams) SetEnabled(Enabled bool) *UpdateInstalledAddOnExtensionParams

type UpdateInstalledAddOnParams added in v1.22.2 

type UpdateInstalledAddOnParams struct {
	// Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured
	Configuration *interface{} `json:"Configuration,omitempty"`
	// An application-defined string that uniquely identifies the resource. This value must be unique within the Account.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'UpdateInstalledAddOn'

func (*UpdateInstalledAddOnParams) SetConfiguration added in v1.22.2 

func (params *UpdateInstalledAddOnParams) SetConfiguration(Configuration interface{}) *UpdateInstalledAddOnParams

func (*UpdateInstalledAddOnParams) SetUniqueName added in v1.22.2 

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

type UpdateModuleDataManagementParams added in v1.22.2 

type UpdateModuleDataManagementParams struct {
	// A JSON object containing essential attributes that define a Listing.
	ModuleInfo *string `json:"ModuleInfo,omitempty"`
	// A JSON object describing the Listing. You can define the main body of the description, highlight key features or aspects of the Listing, and provide code samples for developers if applicable.
	Description *string `json:"Description,omitempty"`
	// A JSON object for providing comprehensive information, instructions, and resources related to the Listing.
	Documentation *string `json:"Documentation,omitempty"`
	// A JSON object describing the Listing's privacy and legal policies. The maximum file size for Policies is 5MB.
	Policies *string `json:"Policies,omitempty"`
	// A JSON object containing information on how Marketplace users can obtain support for the Listing. Use this parameter to provide details such as contact information and support description.
	Support *string `json:"Support,omitempty"`
	// A JSON object for providing Listing-specific configuration. Contains button setup, notification URL, and more.
	Configuration *string `json:"Configuration,omitempty"`
	// A JSON object for providing Listing's purchase options.
	Pricing *string `json:"Pricing,omitempty"`
}

Optional parameters for the method 'UpdateModuleDataManagement'

func (*UpdateModuleDataManagementParams) SetConfiguration added in v1.22.4 

func (params *UpdateModuleDataManagementParams) SetConfiguration(Configuration string) *UpdateModuleDataManagementParams

func (*UpdateModuleDataManagementParams) SetDescription added in v1.22.2 

func (params *UpdateModuleDataManagementParams) SetDescription(Description string) *UpdateModuleDataManagementParams

func (*UpdateModuleDataManagementParams) SetDocumentation added in v1.22.2 

func (params *UpdateModuleDataManagementParams) SetDocumentation(Documentation string) *UpdateModuleDataManagementParams

func (*UpdateModuleDataManagementParams) SetModuleInfo added in v1.22.2 

func (params *UpdateModuleDataManagementParams) SetModuleInfo(ModuleInfo string) *UpdateModuleDataManagementParams

func (*UpdateModuleDataManagementParams) SetPolicies added in v1.22.2 

func (params *UpdateModuleDataManagementParams) SetPolicies(Policies string) *UpdateModuleDataManagementParams

func (*UpdateModuleDataManagementParams) SetPricing added in v1.23.1 

func (params *UpdateModuleDataManagementParams) SetPricing(Pricing string) *UpdateModuleDataManagementParams

func (*UpdateModuleDataManagementParams) SetSupport added in v1.22.2 

func (params *UpdateModuleDataManagementParams) SetSupport(Support string) *UpdateModuleDataManagementParams

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.