Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DO NOT MERGE] docs team approval #118

Closed
wants to merge 1 commit into from
Closed

[DO NOT MERGE] docs team approval #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,592 changes: 976 additions & 1,616 deletions spec/json/twilio_api_v2010.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions spec/json/twilio_bulkexports_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
},
"size": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The size of the day's data file in bytes"
},
Expand Down
6 changes: 6 additions & 0 deletions spec/json/twilio_chat_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,13 @@
},
"members_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Members in the Channel."
},
"messages_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Messages in the Channel."
},
Expand Down Expand Up @@ -455,6 +457,7 @@
},
"index": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The index of the message within the [Channel](https://www.twilio.com/docs/chat/api/channels)."
},
Expand Down Expand Up @@ -630,11 +633,13 @@
},
"typing_indicator_timeout": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds."
},
"consumption_report_interval": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints."
},
Expand Down Expand Up @@ -779,6 +784,7 @@
},
"joined_channels_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Channels this User is a Member of."
},
Expand Down
8 changes: 8 additions & 0 deletions spec/json/twilio_chat_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,11 +203,13 @@
},
"members_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Members in the Channel."
},
"messages_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Messages that have been passed in the Channel."
},
Expand Down Expand Up @@ -675,6 +677,7 @@
},
"index": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The index of the message within the [Channel](https://www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message was received."
},
Expand Down Expand Up @@ -872,11 +875,13 @@
},
"typing_indicator_timeout": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds."
},
"consumption_report_interval": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints."
},
Expand Down Expand Up @@ -909,11 +914,13 @@
},
"pre_webhook_retry_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried."
},
"post_webhook_retry_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried."
},
Expand Down Expand Up @@ -1031,6 +1038,7 @@
},
"joined_channels_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Channels the User is a Member of."
},
Expand Down
2 changes: 2 additions & 0 deletions spec/json/twilio_chat_v3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,13 @@
},
"members_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Members in the Channel."
},
"messages_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The number of Messages that have been passed in the Channel."
},
Expand Down
88 changes: 86 additions & 2 deletions spec/json/twilio_content_sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,45 @@
"title"
]
},
"carouselActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carouselAction"
}
},
"carouselActionType": {
"type": "string",
"enum": [
"URL",
"PHONE_NUMBER",
"QUICK_REPLY"
]
},
"carouselAction": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"$ref": "#/components/schemas/carouselActionType"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"phone": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"title"
]
},
"authenticationActions": {
"type": "array",
"items": {
Expand Down Expand Up @@ -198,6 +237,30 @@
}
}
},
"carouselCards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carouselCard"
}
},
"carouselCard": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"media": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/carouselActions"
}
}
},
"twilioText": {
"type": "object",
"description": "Type containing only plain text-based content",
Expand Down Expand Up @@ -411,6 +474,24 @@
"body"
]
},
"twilioCarousel": {
"type": "object",
"description": "twilio/carousel templates allow you to send a single text message accompanied by a set of up to 10 carousel cards in a horizontally scrollable view",
"nullable": true,
"additionalProperties": false,
"properties": {
"body": {
"type": "string"
},
"cards": {
"$ref": "#/components/schemas/carouselCards"
}
},
"required": [
"body",
"cards"
]
},
"ContentApprovalRequest": {
"type": "object",
"description": "Content approval request body",
Expand Down Expand Up @@ -485,6 +566,9 @@
"twilio/catalog": {
"$ref": "#/components/schemas/twilioCatalog"
},
"twilio/carousel": {
"$ref": "#/components/schemas/twilioCarousel"
},
"whatsapp/card": {
"$ref": "#/components/schemas/whatsappCard"
},
Expand Down Expand Up @@ -832,7 +916,7 @@
"accountSid_authToken": []
}
],
"operationId": "CreateContentApprovalRequest"
"operationId": "CreateApprovalCreate"
}
},
"/v1/Content/{ContentSid}/ApprovalRequests": {
Expand Down Expand Up @@ -906,7 +990,7 @@
"accountSid_authToken": []
}
],
"operationId": "FetchApproval"
"operationId": "FetchApprovalFetch"
}
},
"/v1/Content/{Sid}": {
Expand Down
4 changes: 4 additions & 0 deletions spec/json/twilio_conversations_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@
},
"index": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). Indices may skip numbers, but will always be in order of when the message was received."
},
Expand Down Expand Up @@ -533,6 +534,7 @@
},
"error_code": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, "
},
Expand Down Expand Up @@ -1411,6 +1413,7 @@
},
"index": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)."
},
Expand Down Expand Up @@ -1586,6 +1589,7 @@
},
"error_code": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, "
},
Expand Down
3 changes: 3 additions & 0 deletions spec/json/twilio_events_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
},
"latest_version": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The latest version published of this schema."
}
Expand All @@ -103,6 +104,7 @@
},
"schema_version": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The version of this schema."
},
Expand Down Expand Up @@ -238,6 +240,7 @@
},
"schema_version": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The schema version that the Subscription should use."
},
Expand Down
16 changes: 16 additions & 0 deletions spec/json/twilio_flex_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,7 @@
},
"phase": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The phase this Flex Plugin would initialize at runtime."
},
Expand Down Expand Up @@ -581,6 +582,13 @@
"task"
]
},
"flex_meeting_callback_events_enum_webhook_method": {
"type": "string",
"enum": [
"POST",
"GET"
]
},
"flex.v1.insights_assessments": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -811,6 +819,7 @@
},
"segment_count": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "The count of segments for a conversation"
},
Expand Down Expand Up @@ -945,6 +954,7 @@
},
"usage": {
"type": "integer",
"default": 0,
"nullable": true,
"description": "Integer value that tells a particular question is used by how many questionnaires"
},
Expand Down Expand Up @@ -12945,6 +12955,12 @@
{
"name": "FlexV1FlexFlow"
},
{
"name": "FlexV1FlexMeetingCallbackEvents"
},
{
"name": "FlexV1FlexTokenInfo"
},
{
"name": "FlexV1FlexUser"
},
Expand Down
Loading
Loading