{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "marketplace.v1.available_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the AvailableAddOn resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "description": { "type": "string", "nullable": true, "description": "A short description of the Add-on's functionality." }, "pricing_type": { "type": "string", "nullable": true, "description": "How customers are charged for using this Add-on." }, "configuration_schema": { "nullable": true, "type": "object", "description": "The JSON object with the configuration that must be provided when installing a given Add-on." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "marketplace.v1.available_add_on.available_add_on_extension": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the AvailableAddOnExtension resource." }, "available_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the AvailableAddOn resource to which this extension applies." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", "nullable": true, "description": "The name of the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "marketplace.v1.installed_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, "description": "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'." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "description": { "type": "string", "nullable": true, "description": "A short description of the Add-on's functionality." }, "configuration": { "nullable": true, "type": "object", "description": "The JSON object that represents the current configuration of installed Add-on." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "marketplace.v1.installed_add_on.billing_usage_response": { "type": "object", "properties": { "billable_items": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "" }, "sid": { "type": "string", "description": "" }, "submitted": { "type": "boolean", "description": "Whether this billable item was successfully submitted for billing." } } } }, "total_submitted": { "type": "number", "description": "Represents the total quantity submitted." } } }, "marketplace.v1.installed_add_on.installed_add_on_extension": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the InstalledAddOn Extension resource." }, "installed_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the InstalledAddOn resource to which this extension applies." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", "nullable": true, "description": "The name of the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource." }, "enabled": { "type": "boolean", "nullable": true, "description": "Whether the Extension will be invoked." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "marketplace.v1.installed_add_on.installed_add_on_usage": { "type": "object", "properties": { "total_submitted": { "type": "number", "description": "Total amount in local currency that was billed in this request. Aggregates all billable_items that were successfully submitted.", "readOnly": true }, "billable_items": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Total amount in local currency that was billed for this Billing Item. Can be any floating number greater than 0." }, "sid": { "type": "string", "description": "BillingSid to use for billing." }, "submitted": { "type": "boolean", "description": "Whether the billing event was successfully generated for this Billable Item.", "readOnly": true } }, "required": [ "quantity", "sid" ] } } }, "required": [ "billable_items" ] }, "marketplace.v1.module_data_management": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true, "description": "URL to query the subresource." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, "description": "ModuleSid that identifies this Listing." }, "description": { "nullable": true, "type": "object", "description": "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" }, "support": { "nullable": true, "type": "object", "description": "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." }, "policies": { "nullable": true, "type": "object", "description": "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" }, "module_info": { "nullable": true, "type": "object", "description": "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" }, "documentation": { "nullable": true, "type": "object", "description": "A JSON object for providing comprehensive information, instructions, and resources related to the module" }, "configuration": { "nullable": true, "type": "object", "description": "A JSON object for providing listing specific configuration. Contains button setup, notification url, among others." }, "pricing": { "nullable": true, "type": "object", "description": "A JSON object for providing Listing specific pricing information." } } }, "marketplace.v1.referral_conversion": { "type": "object", "properties": { "converted_account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": false } } }, "marketplace.v1.referral_records": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XL[0-9a-fA-F]{32}$", "nullable": false, "description": "The unique identifier for this resource." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": false, "description": "The account sid that owns this record." }, "net_revenue": { "type": "number", "nullable": false, "description": "Net revenue collected as part of this record." }, "filename": { "type": "string", "nullable": false, "description": "Name of the file attached to the record." }, "documentation_link": { "type": "string", "nullable": false, "description": "Link to download record's invoice." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "marketplace.v1.TwilioServiceErrorResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "nullable": false }, "message": { "type": "string", "nullable": false }, "params": { "type": "object", "nullable": true }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "info": { "title": "Twilio - Marketplace", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "x-twilio": { "apiStandards": "v0.1" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "openapi": "3.0.1", "paths": { "/v1/AvailableAddOns": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "available_add_on_sid": "sid" }, "resource_url": "/v1/AvailableAddOns/{available_add_on_sid}/Extensions" } }, "pathType": "list" }, "get": { "description": "Retrieve a list of Add-ons currently available to be installed.", "tags": [ "MarketplaceAvailableAddOn" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "title": "ListAvailableAddOnResponse", "properties": { "available_add_ons": { "type": "array", "items": { "$ref": "#/components/schemas/marketplace.v1.available_add_on" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "examples": { "readFull": { "value": { "available_add_ons": [ { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "pricing_type": "per minute", "configuration_schema": { "type": "object", "properties": { "bad_words": { "type": "boolean" } }, "required": [ "bad_words" ] }, "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "available_add_ons" } } }, "readEmpty": { "value": { "available_add_ons": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "available_add_ons" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListAvailableAddOn" } }, "/v1/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "available_add_on_sid": "sid" }, "resource_url": "/v1/AvailableAddOns/{available_add_on_sid}/Extensions" } }, "pathType": "instance" }, "get": { "description": "Fetch an instance of an Add-on currently available to be installed.", "tags": [ "MarketplaceAvailableAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the AvailableAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.available_add_on" }, "examples": { "fetch": { "value": { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "pricing_type": "per minute", "configuration_schema": { "type": "object", "properties": { "bad_words": { "type": "boolean" } }, "required": [ "bad_words" ] }, "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAvailableAddOn" } }, "/v1/AvailableAddOns/{AvailableAddOnSid}/Extensions": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/AvailableAddOns/{Sid}", "className": "available_add_on_extension", "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Available Add-on.", "tags": [ "MarketplaceAvailableAddOnExtension" ], "parameters": [ { "name": "AvailableAddOnSid", "in": "path", "description": "The SID of the AvailableAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "title": "ListAvailableAddOnExtensionResponse", "properties": { "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/marketplace.v1.available_add_on.available_add_on_extension" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "examples": { "readFull": { "value": { "extensions": [ { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } }, "readEmpty": { "value": { "extensions": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListAvailableAddOnExtension" } }, "/v1/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/AvailableAddOns/{Sid}", "className": "available_add_on_extension", "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Available Add-on.", "tags": [ "MarketplaceAvailableAddOnExtension" ], "parameters": [ { "name": "AvailableAddOnSid", "in": "path", "description": "The SID of the AvailableAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the AvailableAddOn Extension resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.available_add_on.available_add_on_extension" }, "examples": { "fetch": { "value": { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAvailableAddOnExtension" } }, "/v1/InstalledAddOns": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Extensions" }, "usage": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Usage" } }, "pathType": "list" }, "post": { "description": "Install an Add-on for the Account specified.", "tags": [ "MarketplaceInstalledAddOn" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on" }, "examples": { "create": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription_1", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.TwilioServiceErrorResponse", "x-jvm-type": "com.twilio.rest.TwilioServiceErrorResponse" } } } } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateInstalledAddOnRequest", "properties": { "AvailableAddOnSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "description": "The SID of the AvaliableAddOn to install." }, "AcceptTermsOfService": { "type": "boolean", "description": "Whether the Terms of Service were accepted." }, "Configuration": { "description": "The JSON object that represents the configuration of the new Add-on being installed." }, "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } }, "required": [ "AvailableAddOnSid", "AcceptTermsOfService" ] }, "examples": { "create": { "value": { "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "AcceptTermsOfService": true, "Configuration": "{\"bad_words\": true}", "UniqueName": "voicebase_high_accuracy_transcription_1" } } } } } } }, "get": { "description": "Retrieve a list of Add-ons currently installed on this Account.", "tags": [ "MarketplaceInstalledAddOn" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "title": "ListInstalledAddOnResponse", "properties": { "installed_add_ons": { "type": "array", "items": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "examples": { "readFull": { "value": { "installed_add_ons": [ { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "installed_add_ons" } } }, "readEmpty": { "value": { "installed_add_ons": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "installed_add_ons" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListInstalledAddOn" } }, "/v1/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Extensions" }, "usage": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Usage" } }, "pathType": "instance" }, "delete": { "description": "Remove an Add-on installation from your account", "tags": [ "MarketplaceInstalledAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteInstalledAddOn" }, "get": { "description": "Fetch an instance of an Add-on currently installed on this Account.", "tags": [ "MarketplaceInstalledAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on" }, "examples": { "fetch": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchInstalledAddOn" }, "post": { "description": "Update an Add-on installation for the Account specified.", "tags": [ "MarketplaceInstalledAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on" }, "examples": { "update": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription_2", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateInstalledAddOnRequest", "properties": { "Configuration": { "description": "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" }, "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } } }, "examples": { "update": { "value": { "Configuration": "{\"bad_words\": true}", "UniqueName": "voicebase_high_accuracy_transcription_2" } } } } } } } }, "/v1/InstalledAddOns/{InstalledAddOnSid}/Extensions": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_extension", "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Installed Add-on.", "tags": [ "MarketplaceInstalledAddOnExtension" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "The SID of the InstalledAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "title": "ListInstalledAddOnExtensionResponse", "properties": { "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_extension" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "examples": { "readFull": { "value": { "extensions": [ { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "enabled": true, "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } }, "readEmpty": { "value": { "extensions": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListInstalledAddOnExtension" } }, "/v1/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_extension", "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Installed Add-on.", "tags": [ "MarketplaceInstalledAddOnExtension" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "The SID of the InstalledAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn Extension resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_extension" }, "examples": { "fetch": { "value": { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "enabled": true, "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchInstalledAddOnExtension" }, "post": { "description": "Update an Extension for an Add-on installation.", "tags": [ "MarketplaceInstalledAddOnExtension" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "The SID of the InstalledAddOn resource with the extension to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn Extension resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_extension" }, "examples": { "update": { "value": { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "enabled": false, "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateInstalledAddOnExtension", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateInstalledAddOnExtensionRequest", "properties": { "Enabled": { "type": "boolean", "description": "Whether the Extension should be invoked." } }, "required": [ "Enabled" ] }, "examples": { "update": { "value": { "Enabled": false } } } } } } } }, "/v1/InstalledAddOns/{InstalledAddOnSid}/Usage": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_usage", "pathType": "list" }, "post": { "description": "Allows Twilio Marketplace publishers to manually report customer usage on No-code Partner Listings that they own.", "tags": [ "MarketplaceBillingUsage" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "Customer Installation SID to report usage on.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true, "example": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_usage" }, "examples": { "create": { "value": { "total_submitted": 44.02, "billable_items": [ { "sid": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "quantity": 12.355, "submitted": false }, { "sid": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "quantity": 44.02, "submitted": true } ] } } } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateBillingUsage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_usage" }, "examples": { "multiple_sids": { "value": { "billable_items": [ { "sid": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "quantity": 12.355 }, { "sid": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "quantity": 44.02 } ] } } } } } } } }, "/v1/ReferralConversion": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" }, "post": { "description": "", "tags": [ "MarketplaceReferralConversion" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.referral_conversion" }, "examples": { "create": { "value": { "converted_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.referral_conversion" }, "examples": { "create": { "value": { "converted_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "ACCEPTED" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.TwilioServiceErrorResponse", "x-jvm-type": "com.twilio.rest.TwilioServiceErrorResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "NOT_FOUND" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateReferralConversion", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "referral_account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": false } } }, "examples": { "create": { "value": { "referral_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } } } }, "/v1/Listings": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "module_data", "pathType": "list" }, "post": { "description": "This endpoint creates a Listing based on the given data.", "tags": [ "MarketplaceModuleData" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.module_data_management" }, "examples": { "created": { "value": { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://marketplace.twilio.com/v1/Listing/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "description": { "body": "aBody", "highlights": [ { "title": "aTitle", "description": "aDescription" } ], "code_samples": [ { "title": "aTitle", "description": "aDescription", "code": "aCode" } ] }, "support": { "customer_support_email": "anEmail", "customer_support_phone": "+1 888-888-8888", "support_description": "aDescription", "billing_email": "anEmail", "billing_phone": "+1 888-888-8888", "technical_email": "anEmail", "technical_phone": "+1 888-888-8888" }, "policies": { "privacy": "someUrl", "legal": "someOtherUrl" }, "module_info": { "tag": "Description", "tagline": "aTagline", "logo_url": "aUrl", "logo_bg_color_hex": "#ff5722" }, "documentation": { "body": "aBody" }, "pricing": { "body": "Basic plan - $10/month" }, "configuration": { "buttons": [ { "url": "https://example.com", "label": "Configurable button text", "help_text": "The button text, url, and help text are now configurable via self service" } ], "notification_configuration": { "callback_url": "https://example.com" } } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateModuleData", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateModuleDataRequest", "properties": { "ModuleInfo": { "type": "string", "description": "A JSON object containing essential attributes that define a Listing." }, "Configuration": { "type": "string", "description": "A JSON object for providing Listing-specific configuration. Contains button setup, notification URL, and more." } } }, "examples": { "create": { "value": { "ModuleInfo": { "name": "My Company Marketplace Listing", "short_description": "Short description on what the Company does.", "tagline": "My Company Subheadline", "logo_url": "https://mycompany.com/image.png", "provider_web_url": "https://www.sampleurl.com", "provider_name": "My Company Name", "logo_bg_color_hex": "#ff5722" }, "Configuration": { "buttons": [ { "url": "https://mycompanysignup.com", "label": "Setup Account", "help_text": "Help caption for the button" } ], "notification_configuration": { "callback_url": "https://example.com", "notification_events": [ "module_install" ] } } } } } } } } }, "get": { "description": "This endpoint returns the Listings owned by the authenticated Account.", "tags": [ "MarketplaceModuleData" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "listings": { "nullable": false, "description": "", "type": "array", "items": { "type": "object" } } } }, "examples": { "fetch": { "value": { "listings": [ { "tag": "Description1", "tagline": "aTagline1", "logo_url": "aUrl1", "logo_bg_color_hex": "#ff5722" }, { "tag": "Description2", "tagline": "aTagline2", "logo_url": "aUrl2", "logo_bg_color_hex": "#ff5722" } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchModuleDataForListingOwner" } }, "/v1/Listing/{Sid}": { "servers": [ { "url": "https://marketplace.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "module_data_management", "pathType": "instance" }, "post": { "description": "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.", "tags": [ "MarketplaceModuleDataManagement" ], "parameters": [ { "name": "Sid", "in": "path", "description": "SID that uniquely identifies the Listing.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.module_data_management" }, "examples": { "update": { "value": { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://marketplace.twilio.com/v1/Listing/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "description": { "body": "aBody", "highlights": [ { "title": "aTitle", "description": "aDescription" } ], "code_samples": [ { "title": "aTitle", "description": "aDescription", "code": "aCode" } ] }, "support": { "customer_support_email": "anEmail", "customer_support_phone": "+1 888-888-8888", "support_description": "aDescription", "billing_email": "anEmail", "billing_phone": "+1 888-888-8888", "technical_email": "anEmail", "technical_phone": "+1 888-888-8888" }, "policies": { "privacy": "someUrl", "legal": "someOtherUrl" }, "module_info": { "tag": "Description", "tagline": "aTagline", "logo_url": "aUrl", "logo_bg_color_hex": "#ff5722" }, "documentation": { "body": "aBody" }, "pricing": { "body": "Basic plan - $10/month" }, "configuration": { "buttons": [ { "url": "https://example.com", "label": "Configurable button text", "help_text": "The button text, url, and help text are now configurable via self service" } ], "notification_configuration": { "callback_url": "https://example.com" } } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" }, "304": { "description": "Not Modified" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateModuleDataManagement", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateModuleDataManagementRequest", "properties": { "ModuleInfo": { "type": "string", "description": "A JSON object containing essential attributes that define a Listing." }, "Description": { "type": "string", "description": "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." }, "Documentation": { "type": "string", "description": "A JSON object for providing comprehensive information, instructions, and resources related to the Listing." }, "Policies": { "type": "string", "description": "A JSON object describing the Listing's privacy and legal policies. The maximum file size for Policies is 5MB." }, "Support": { "type": "string", "description": "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." }, "Configuration": { "type": "string", "description": "A JSON object for providing Listing-specific configuration. Contains button setup, notification URL, and more." }, "Pricing": { "type": "string", "description": "A JSON object for providing Listing's purchase options." } } }, "examples": { "update": { "value": { "ModuleInfo": { "name": "My Company Marketplace Listing", "short_description": "Short description on what the Company does.", "tagline": "My Company Subheadline", "logo_url": "https://mycompany.com/image.png", "provider_web_url": "https://www.sampleurl.com", "provider_name": "My Company Name", "logo_bg_color_hex": "#ff5722" }, "Description": { "body": "Long Description about the Listing/Company", "highlights": [ { "title": "Feature 1", "description": "Feature 1 Description" }, { "title": "Feature 2", "description": "Feature 2 Description" } ], "code_samples": [ { "title": "Example 1", "description": "This is just a code sample", "code": "console.log(\u2018Hello, World\u2019);" } ] }, "Documentation": { "body": "### Large documentation body." }, "Policies": { "privacy": "[Link Custom Name](https://www.mycompany.privacy.com)", "legal": "[Link Custom Name](https://www.mycompany.legal)" }, "Support": { "billing_email": "billing@billing.com", "billing_phone": "+1 888-888-8888", "technical_email": "support@support.com", "technical_phone": "+1 888-888-8888", "customer_support_email": "support@support.com", "customer_support_phone": "+1 888-888-8888", "support_description": "Call Support for any help." }, "Configuration": { "buttons": [ { "url": "https://mycompanysignup.com", "label": "Setup Account", "help_text": "Help caption for the button" } ], "notification_configuration": { "callback_url": "https://example.com", "notification_events": [ "module_install" ] } }, "Pricing": { "body": "### Basic plan - $15/month" } } } } } } } }, "get": { "description": "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.", "tags": [ "MarketplaceModuleDataManagement" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The unique identifier of a Listing.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketplace.v1.module_data_management" }, "examples": { "fetch": { "value": { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://marketplace.twilio.com/v1/Listing/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "description": { "body": "aBody", "highlights": [ { "title": "aTitle", "description": "aDescription" } ], "code_samples": [ { "title": "aTitle", "description": "aDescription", "code": "aCode" } ] }, "support": { "customer_support_email": "anEmail", "customer_support_phone": "+1 888-888-8888", "support_description": "aDescription", "billing_email": "anEmail", "billing_phone": "+1 888-888-8888", "technical_email": "anEmail", "technical_phone": "+1 888-888-8888" }, "policies": { "privacy": "someUrl", "legal": "someOtherUrl" }, "module_info": { "tag": "Description", "tagline": "aTagline", "logo_url": "aUrl", "logo_bg_color_hex": "#ff5722" }, "documentation": { "body": "aBody" }, "pricing": { "body": "Basic plan - $10/month" }, "configuration": { "buttons": [ { "url": "https://example.com", "label": "Configurable button text", "help_text": "The button text, url, and help text are now configurable via self service" } ], "notification_configuration": { "callback_url": "https://example.com" } } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchModuleDataManagement" } } }, "servers": [ { "url": "https://marketplace.twilio.com" } ], "tags": [ { "name": "MarketplaceAvailableAddOn" }, { "name": "MarketplaceAvailableAddOnExtension" }, { "name": "MarketplaceBillingUsage" }, { "name": "MarketplaceInstalledAddOn" }, { "name": "MarketplaceInstalledAddOnExtension" }, { "name": "MarketplaceInstalledAddOnUsage" }, { "name": "MarketplaceModuleDataManagement" }, { "name": "MarketplaceModuleData" }, { "name": "MarketplaceReferralConversion" } ], "security": [ { "accountSid_authToken": [] } ] }