sim_card_group_id is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.sim_card_group_id\
+ \ is provided, the SIM cards will be associated with that group. Otherwise,\
+ \ the default group for the current user will be used.customer_reference containing
- the given value will be returned. Matching is not case-sensitive.
- explode: true
- in: query
- name: filter[customer_reference][contains]
- required: false
- schema:
- type: string
- style: form
- - description: 'If set as ''true'', only addresses used as the emergency address
- for at least one active phone-number will be returned. When set to ''false'',
- the opposite happens: only addresses not used as the emergency address from
- phone-numbers will be returned.'
- explode: true
- in: query
- name: filter[used_as_emergency]
- required: false
- schema:
- default: "null"
- type: string
- style: form
- - description: If present, addresses with street_address containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
- explode: true
- in: query
- name: filter[street_address][contains]
- required: false
- schema:
- default: "null"
- type: string
- style: form
- - description: If present, only returns results with the address_book
- flag set to the given value.
- explode: true
- in: query
- name: filter[address_book][eq]
- required: false
- schema:
- default: "null"
- type: string
- style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.street_address: sorts the result by the
- street_address field in ascending order.
- -street_address: sorts the result by the
- street_address field in descending order.
- created_at in descending order.
- explode: true
- in: query
- name: sort
- required: false
- schema:
- default: created_at
- enum:
- - created_at
- - first_name
- - last_name
- - business_name
- - street_address
- example: street_address
- type: string
- style: form
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Get_All_Address_Response'
- description: Successful response
- "400":
- description: Bad request
- "401":
- description: Unauthorized
- "404":
- description: Resource not found
- summary: List all addresses
- tags:
- - Addresses
- x-endpoint-cost: medium
- x-latency-category: responsive
- x-accepts: application/json
- post:
- description: Creates an address.
- operationId: CreateAddress
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AddressCreate'
- description: Parameters that can be defined during address creation
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Address_Response'
- description: Successful response
- "422":
- description: Bad request
- summary: Creates an address
- tags:
- - Addresses
- x-endpoint-cost: medium
- x-latency-category: responsive
- x-contentType: application/json
- x-accepts: application/json
- /addresses/actions/validate:
- post:
- description: Validates an address for emergency services.
- operationId: validateAddress
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ValidateAddressRequest'
- description: Parameters that can be defined during address validation
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Validate_Address_Response'
- description: Action response
- "422":
- description: Bad request
- summary: Validate an address
- tags:
- - Addresses
- x-latency-category: responsive
- x-contentType: application/json
- x-accepts: application/json
- /addresses/{id}:
- delete:
- description: Deletes an existing address.
- operationId: DeleteAddress
- parameters:
- - description: address ID
- explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Address_Response'
- description: Successful response
- "401":
- description: Unauthorized
- "404":
- description: Resource not found
- "422":
- description: Bad request
- summary: Deletes an address
- tags:
- - Addresses
- x-latency-category: responsive
- x-accepts: application/json
- get:
- description: Retrieves the details of an existing address.
- operationId: getAddress
- parameters:
- - description: address ID
- explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Address_Response'
- description: Successful response
- "401":
- description: Unauthorized
- "404":
- description: Resource not found
- "422":
- description: Bad request
- summary: Retrieve an address
- tags:
- - Addresses
- x-latency-category: responsive
- x-accepts: application/json
/authentication_providers:
get:
description: Returns a list of your SSO authentication providers.
@@ -1110,7 +858,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -1120,7 +868,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -1128,19 +876,14 @@ paths:
minimum: 1
type: integer
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.name: sorts the result by the
- name field in ascending order.
- -name: sorts the result by the
- name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.name:\
+ \ sorts the result by the\n name field in ascending order.\n\
+ \ -name: sorts the result by the\n \
+ \ name field in descending order.\n created_at in descending\
+ \ order."
explode: true
in: query
name: sort
@@ -1166,7 +909,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Get_All_Authentication_Providers_Response'
+ $ref: '#/components/schemas/findAuthenticationProviders_200_response'
description: Successful response
"400":
description: Bad request
@@ -1196,7 +939,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Authentication_Provider_Response'
+ $ref: '#/components/schemas/CreateAuthenticationProvider_200_response'
description: Successful response
"422":
description: Bad request
@@ -1204,7 +947,7 @@ paths:
tags:
- Authentication Providers
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/authentication_providers/{id}:
delete:
@@ -1224,7 +967,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Authentication_Provider_Response'
+ $ref: '#/components/schemas/CreateAuthenticationProvider_200_response'
description: Successful response
"401":
description: Unauthorized
@@ -1254,7 +997,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Authentication_Provider_Response'
+ $ref: '#/components/schemas/CreateAuthenticationProvider_200_response'
description: Successful response
"401":
description: Unauthorized
@@ -1291,7 +1034,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Authentication_Provider_Response'
+ $ref: '#/components/schemas/CreateAuthenticationProvider_200_response'
description: Successful response
"401":
description: Unauthorized
@@ -1303,7 +1046,7 @@ paths:
tags:
- Authentication Providers
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/available_phone_number_blocks:
get:
@@ -1313,7 +1056,7 @@ paths:
after `national_destination_code` filter has been set).
explode: true
in: query
- name: filter[phone_number][starts_with]
+ name: "filter[phone_number][starts_with]"
required: false
schema:
example: "201"
@@ -1322,7 +1065,7 @@ paths:
- description: Filter numbers ending with a pattern.
explode: true
in: query
- name: filter[phone_number][ends_with]
+ name: "filter[phone_number][ends_with]"
required: false
schema:
example: "8000"
@@ -1331,7 +1074,7 @@ paths:
- description: Filter numbers containing a pattern.
explode: true
in: query
- name: filter[phone_number][contains]
+ name: "filter[phone_number][contains]"
required: false
schema:
example: "456"
@@ -1347,7 +1090,7 @@ paths:
value: Canberra
explode: true
in: query
- name: filter[locality]
+ name: "filter[locality]"
required: false
schema:
type: string
@@ -1355,7 +1098,7 @@ paths:
- description: Filter phone numbers by US state/CA province.
explode: true
in: query
- name: filter[administrative_area]
+ name: "filter[administrative_area]"
required: false
schema:
example: IL
@@ -1364,7 +1107,7 @@ paths:
- description: Filter phone numbers by ISO alpha-2 country code.
explode: true
in: query
- name: filter[country_code]
+ name: "filter[country_code]"
required: false
schema:
example: US
@@ -1381,7 +1124,7 @@ paths:
value: "0251"
explode: true
in: query
- name: filter[national_destination_code]
+ name: "filter[national_destination_code]"
required: false
schema:
type: string
@@ -1390,7 +1133,7 @@ paths:
applicable to North American numbers.
explode: true
in: query
- name: filter[rate_center]
+ name: "filter[rate_center]"
required: false
schema:
example: CHICAGO HEIGHTS
@@ -1399,7 +1142,7 @@ paths:
- description: Filter phone numbers by number type.
explode: true
in: query
- name: filter[number_type]
+ name: "filter[number_type]"
required: false
schema:
enum:
@@ -1407,14 +1150,14 @@ paths:
example: toll-free
type: string
style: form
- - description: Filter if the phone number should be used for voice, fax, mms,
- sms, emergency.
+ - description: "Filter if the phone number should be used for voice, fax, mms,\
+ \ sms, emergency."
explode: true
in: query
- name: filter[features]
+ name: "filter[features]"
required: false
schema:
- example: voice,sms
+ example: "voice,sms"
items:
enum:
- sms
@@ -1428,7 +1171,7 @@ paths:
- description: Filter number blocks by minimum blocks size
explode: true
in: query
- name: filter[minimum_block_size]
+ name: "filter[minimum_block_size]"
required: false
schema:
example: 100
@@ -1437,7 +1180,7 @@ paths:
- description: Limits the number of results.
explode: true
in: query
- name: filter[limit]
+ name: "filter[limit]"
required: false
schema:
example: 100
@@ -1474,7 +1217,7 @@ paths:
value: FREE
explode: true
in: query
- name: filter[phone_number][starts_with]
+ name: "filter[phone_number][starts_with]"
required: false
schema:
type: string
@@ -1487,7 +1230,7 @@ paths:
value: CALL
explode: true
in: query
- name: filter[phone_number][ends_with]
+ name: "filter[phone_number][ends_with]"
required: false
schema:
type: string
@@ -1500,7 +1243,7 @@ paths:
value: FOO
explode: true
in: query
- name: filter[phone_number][contains]
+ name: "filter[phone_number][contains]"
required: false
schema:
type: string
@@ -1515,7 +1258,7 @@ paths:
value: Canberra
explode: true
in: query
- name: filter[locality]
+ name: "filter[locality]"
required: false
schema:
type: string
@@ -1523,7 +1266,7 @@ paths:
- description: Filter phone numbers by US state/CA province.
explode: true
in: query
- name: filter[administrative_area]
+ name: "filter[administrative_area]"
required: false
schema:
example: IL
@@ -1532,7 +1275,7 @@ paths:
- description: Filter phone numbers by ISO alpha-2 country code.
explode: true
in: query
- name: filter[country_code]
+ name: "filter[country_code]"
required: false
schema:
example: US
@@ -1549,7 +1292,7 @@ paths:
value: "0251"
explode: true
in: query
- name: filter[national_destination_code]
+ name: "filter[national_destination_code]"
required: false
schema:
type: string
@@ -1558,7 +1301,7 @@ paths:
applicable to North American numbers.
explode: true
in: query
- name: filter[rate_center]
+ name: "filter[rate_center]"
required: false
schema:
example: CHICAGO HEIGHTS
@@ -1567,7 +1310,7 @@ paths:
- description: Filter phone numbers by number type.
explode: true
in: query
- name: filter[phone_number_type]
+ name: "filter[phone_number_type]"
required: false
schema:
enum:
@@ -1580,14 +1323,14 @@ paths:
example: local
type: string
style: form
- - description: Filter if the phone number should be used for voice, fax, mms,
- sms, emergency.
+ - description: "Filter if the phone number should be used for voice, fax, mms,\
+ \ sms, emergency."
explode: true
in: query
- name: filter[features]
+ name: "filter[features]"
required: false
schema:
- example: voice,sms
+ example: "voice,sms"
items:
enum:
- sms
@@ -1601,7 +1344,7 @@ paths:
- description: Limits the number of results.
explode: true
in: query
- name: filter[limit]
+ name: "filter[limit]"
required: false
schema:
example: 100
@@ -1611,7 +1354,7 @@ paths:
Only available in NANPA countries.
explode: true
in: query
- name: filter[best_effort]
+ name: "filter[best_effort]"
required: false
schema:
example: false
@@ -1621,7 +1364,7 @@ paths:
to purchase to receive phone calls. Only available for toll-free numbers.
explode: true
in: query
- name: filter[quickship]
+ name: "filter[quickship]"
required: false
schema:
example: true
@@ -1631,7 +1374,7 @@ paths:
purchase.
explode: true
in: query
- name: filter[reservable]
+ name: "filter[reservable]"
required: false
schema:
example: true
@@ -1641,7 +1384,7 @@ paths:
your account.
explode: true
in: query
- name: filter[exclude_held_numbers]
+ name: "filter[exclude_held_numbers]"
required: false
schema:
example: false
@@ -1675,7 +1418,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/User_Balance_Response'
+ $ref: '#/components/schemas/getUserBalance_200_response'
description: Retrieve user balance details
default:
content:
@@ -1695,7 +1438,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -1705,7 +1448,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -1718,7 +1461,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Billing_Groups_Response'
+ $ref: '#/components/schemas/listBillingGroups_200_response'
description: A paginated array of billing groups
default:
content:
@@ -1745,7 +1488,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Billing_Group_Response'
+ $ref: '#/components/schemas/createBillingGroup_200_response'
description: Expected billing group response to a valid request
default:
content:
@@ -1757,7 +1500,7 @@ paths:
tags:
- Billing Groups
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/billing_groups/{id}:
delete:
@@ -1777,7 +1520,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Delete_Billing_Group_Response'
+ $ref: '#/components/schemas/createBillingGroup_200_response'
description: Expected billing group response to a valid request
default:
content:
@@ -1807,7 +1550,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Retrieve_Billing_Group_Response'
+ $ref: '#/components/schemas/createBillingGroup_200_response'
description: Expected billing group response to a valid request
default:
content:
@@ -1844,7 +1587,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Update_Billing_Group_Response'
+ $ref: '#/components/schemas/createBillingGroup_200_response'
description: Expected billing group response to a valid request
default:
content:
@@ -1856,7 +1599,99 @@ paths:
tags:
- Billing Groups
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
+ x-accepts: application/json
+ /bulk_sim_card_actions:
+ get:
+ description: This API lists a paginated collection of bulk SIM card actions.
+ A bulk SIM card action contains details about a collection of individual SIM
+ card actions.
+ operationId: ListBulkSIMCardActions
+ parameters:
+ - description: The page number to load
+ explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ default: 1
+ minimum: 1
+ type: integer
+ style: form
+ - description: The size of the page
+ explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ default: 20
+ maximum: 250
+ minimum: 1
+ type: integer
+ style: form
+ - description: Filter by action type.
+ explode: true
+ in: query
+ name: "filter[action_type]"
+ required: false
+ schema:
+ enum:
+ - bulk_set_public_ips
+ example: bulk_set_public_ips
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListBulkSIMCardActions_200_response'
+ description: Successful response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: List bulk SIM card actions
+ tags:
+ - SIM Card Actions
+ x-latency-category: responsive
+ x-accepts: application/json
+ /bulk_sim_card_actions/{id}:
+ get:
+ description: This API fetches information about a bulk SIM card action. A bulk
+ SIM card action contains details about a collection of individual SIM card
+ actions.
+ operationId: BulkSimCardActionGet
+ parameters:
+ - description: Identifies the resource.
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
+ format: uuid
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/BulkSimCardActionGet_200_response'
+ description: Successful Response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Get bulk SIM card action details
+ tags:
+ - SIM Card Actions
+ x-latency-category: responsive
x-accepts: application/json
/business_identities:
get:
@@ -1865,7 +1700,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -1875,7 +1710,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -1925,7 +1760,7 @@ paths:
tags:
- Business Identity
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/business_identities/{id}:
delete:
@@ -2025,7 +1860,7 @@ paths:
tags:
- Business Identity
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/call_control_applications:
get:
@@ -2035,7 +1870,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -2045,7 +1880,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -2053,12 +1888,12 @@ paths:
minimum: 1
type: integer
style: form
- - description: If present, applications with application_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, applications with application_name\
+ \ containing the given value will be returned. Matching is not case-sensitive.\
+ \ Requires at least three characters."
explode: true
in: query
- name: filter[application_name][contains]
+ name: "filter[application_name][contains]"
required: false
schema:
default: "null"
@@ -2067,26 +1902,21 @@ paths:
- description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -2110,7 +1940,8 @@ paths:
"400":
description: Bad request
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
summary: List call control applications
@@ -2144,7 +1975,7 @@ paths:
- Call Control Applications
x-endpoint-cost: medium
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/call_control_applications/{id}:
delete:
@@ -2169,7 +2000,8 @@ paths:
$ref: '#/components/schemas/Call_Control_Application_Response'
description: Successful response with details about a call control application.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
"422":
@@ -2201,7 +2033,8 @@ paths:
$ref: '#/components/schemas/Call_Control_Application_Response'
description: Successful response with details about a call control application.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
"422":
@@ -2240,7 +2073,8 @@ paths:
$ref: '#/components/schemas/Call_Control_Application_Response'
description: Successful response with details about a call control application.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
"422":
@@ -2249,20 +2083,20 @@ paths:
tags:
- Call Control Applications
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/call_events:
get:
- description: |
- Filters call events by given filter parameters. Events are ordered by `event_timestamp`. If filter for `call_leg_id` or `call_session_id` is not present, it only filters events from the last 24 hours.
-
- **Note**: Only one `filter[event_timestamp]` can be passed.
+ description: "Filters call events by given filter parameters. Events are ordered\
+ \ by `event_timestamp`. If filter for `call_leg_id` or `call_session_id` is\
+ \ not present, it only filters events from the last 24 hours.\n\n**Note**:\
+ \ Only one `filter[event_timestamp]` can be passed.\n"
operationId: listCallEvents
parameters:
- description: The unique identifier of an individual call leg.
explode: true
in: query
- name: filter[call_leg_id]
+ name: "filter[call_leg_id]"
required: false
schema:
format: uuid
@@ -2272,7 +2106,7 @@ paths:
may include multiple call leg events.
explode: true
in: query
- name: filter[call_session_id]
+ name: "filter[call_session_id]"
required: false
schema:
format: uuid
@@ -2281,7 +2115,7 @@ paths:
- description: Event status
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -2293,7 +2127,7 @@ paths:
- description: Event type
explode: true
in: query
- name: filter[type]
+ name: "filter[type]"
required: false
schema:
enum:
@@ -2302,46 +2136,46 @@ paths:
example: webhook
type: string
style: form
- - description: 'Event timestamp: greater than'
+ - description: "Event timestamp: greater than"
explode: true
in: query
- name: filter[event_timestamp][gt]
+ name: "filter[event_timestamp][gt]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
- - description: 'Event timestamp: greater than or equal'
+ - description: "Event timestamp: greater than or equal"
explode: true
in: query
- name: filter[event_timestamp][gte]
+ name: "filter[event_timestamp][gte]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
- - description: 'Event timestamp: lower than'
+ - description: "Event timestamp: lower than"
explode: true
in: query
- name: filter[event_timestamp][lt]
+ name: "filter[event_timestamp][lt]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
- - description: 'Event timestamp: lower than or equal'
+ - description: "Event timestamp: lower than or equal"
explode: true
in: query
- name: filter[event_timestamp][lte]
+ name: "filter[event_timestamp][lte]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
- - description: 'Event timestamp: equal'
+ - description: "Event timestamp: equal"
explode: true
in: query
- name: filter[event_timestamp][eq]
+ name: "filter[event_timestamp][eq]"
required: false
schema:
example: 2019-03-29T11:10:00Z
@@ -2350,7 +2184,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -2360,7 +2194,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -2402,8 +2236,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callAnswered:
'{$request.body#/webhook_url}':
@@ -2417,8 +2251,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callHangup:
'{$request.body#/webhook_url}':
@@ -2432,8 +2266,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callMachineDetectionEnded:
'{$request.body#/webhook_url}':
@@ -2447,8 +2281,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callMachineGreetingEnded:
'{$request.body#/webhook_url}':
@@ -2462,8 +2296,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
streamingStarted:
'{$request.body#/webhook_url}':
@@ -2477,8 +2311,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
streamingStopped:
'{$request.body#/webhook_url}':
@@ -2492,19 +2326,34 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Dial a number or SIP URI from a given connection. A successful response will include a `call_leg_id` which can be used to correlate the command with subsequent webhooks.
-
- **Expected Webhooks:**
-
- - `call.initiated`
- - `call.answered` or `call.hangup`
- - `call.machine.detection.ended` if `answering_machine_detection` was requested
- - `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
- - `streaming.started` and `streaming.stopped` if `stream_url` was set
+ streamingFailed:
+ '{$request.body#/webhook_url}':
+ post:
+ operationId: streamingFailed_Post
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CallStreamingFailedEvent'
+ required: true
+ responses:
+ "200":
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
+ x-callback-request: true
+ description: "Dial a number or SIP URI from a given connection. A successful\
+ \ response will include a `call_leg_id` which can be used to correlate the\
+ \ command with subsequent webhooks.\n\n**Expected Webhooks:**\n\n- `call.initiated`\n\
+ - `call.answered` or `call.hangup`\n- `call.machine.detection.ended` if `answering_machine_detection`\
+ \ was requested\n- `call.machine.greeting.ended` if `answering_machine_detection`\
+ \ was requested to detect the end of machine greeting\n- `call.machine.premium.detection.ended`\
+ \ if `answering_machine_detection=premium` was requested\n- `call.machine.premium.greeting.ended`\
+ \ if `answering_machine_detection=premium` was requested and a beep was detected\n\
+ - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url`\
+ \ was set\n"
operationId: callDial
requestBody:
content:
@@ -2530,7 +2379,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/register:
post:
@@ -2562,7 +2411,7 @@ paths:
tags:
- Register Call
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}:
get:
@@ -2611,8 +2460,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
streamingStarted:
'{$request.body#/webhook_url}':
@@ -2626,8 +2475,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
streamingStopped:
'{$request.body#/webhook_url}':
@@ -2641,16 +2490,28 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |-
- Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call.
-
- **Expected Webhooks:**
-
- - `call.answered`
- - `streaming.started` and `streaming.stopped` if `stream_url` was set
+ streamingFailed:
+ '{$request.body#/webhook_url}':
+ post:
+ operationId: streamingFailed_Post
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CallStreamingFailedEvent'
+ required: true
+ responses:
+ "200":
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
+ x-callback-request: true
+ description: "Answer an incoming call. You must issue this command before executing\
+ \ subsequent commands on an incoming call.\n\n**Expected Webhooks:**\n\n-\
+ \ `call.answered`\n- `streaming.started`, `streaming.stopped` or `streaming.failed`\
+ \ if `stream_url` was set\n"
operationId: callAnswer
parameters:
- description: Unique identifier and token for controlling the call
@@ -2685,7 +2546,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/bridge:
post:
@@ -2702,8 +2563,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Bridge two call control calls.
@@ -2746,7 +2607,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/client_state_update:
put:
@@ -2786,7 +2647,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/enqueue:
post:
@@ -2803,8 +2664,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callLeftQueue:
'{$request.body#/webhook_url}':
@@ -2818,8 +2679,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: Put the call in a queue.
operationId: callEnqueue
@@ -2856,7 +2717,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/fork_start:
post:
@@ -2873,8 +2734,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callForkStopped:
'{$request.body#/webhook_url}':
@@ -2888,8 +2749,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: "Call forking allows you to stream the media from a call to a specific\
\ target in realtime. \nThis stream can be used to enable realtime audio analysis\
@@ -2972,7 +2833,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/fork_stop:
post:
@@ -2989,8 +2850,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Stop forking a call.
@@ -3032,7 +2893,80 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
+ x-accepts: application/json
+ /calls/{call_control_id}/actions/gather:
+ post:
+ callbacks:
+ callDtmfReceived:
+ '{$request.body#/webhook_url}':
+ post:
+ operationId: callDtmfReceived_Post
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CallDtmfReceivedEvent'
+ required: true
+ responses:
+ "200":
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
+ x-callback-request: true
+ callGatherEnded:
+ '{$request.body#/webhook_url}':
+ post:
+ operationId: callGatherEnded_Post
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CallGatherEndedEvent'
+ required: true
+ responses:
+ "200":
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
+ x-callback-request: true
+ description: "Gather DTMF signals to build interactive menus.\n\nYou can pass\
+ \ a list of valid digits. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer)\
+ \ command must be issued before the `gather` command.\n\n**Expected Webhooks:**\n\
+ \n- `call.dtmf.received` (you may receive many of these webhooks)\n- `call.gather.ended`\n"
+ operationId: callGather
+ parameters:
+ - description: Unique identifier and token for controlling the call
+ explode: false
+ in: path
+ name: call_control_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GatherRequest'
+ description: Gather
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Call_Control_Command_Response'
+ description: Successful response upon making a call control command.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Gather
+ tags:
+ - Call Commands
+ x-latency-category: interactive
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/gather_stop:
post:
@@ -3049,8 +2983,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Stop current gather.
@@ -3092,7 +3026,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/gather_using_audio:
post:
@@ -3109,8 +3043,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callPlaybackEnded:
'{$request.body#/webhook_url}':
@@ -3124,8 +3058,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callDtmfReceived:
'{$request.body#/webhook_url}':
@@ -3139,8 +3073,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callGatherEnded:
'{$request.body#/webhook_url}':
@@ -3154,20 +3088,17 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.
-
- You can pass a list of valid digits along with an 'invalid_audio_url', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer) command must be issued before the `gather_using_audio` command.
-
- **Expected Webhooks:**
-
- - `call.playback.started`
- - `call.playback.ended`
- - `call.dtmf.received` (you may receive many of these webhooks)
- - `call.gather.ended`
+ description: "Play an audio file on the call until the required DTMF signals\
+ \ are gathered to build interactive menus.\n\nYou can pass a list of valid\
+ \ digits along with an 'invalid_audio_url', which will be played back at the\
+ \ beginning of each prompt. Playback will be interrupted when a DTMF signal\
+ \ is received. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer)\
+ \ command must be issued before the `gather_using_audio` command.\n\n**Expected\
+ \ Webhooks:**\n\n- `call.playback.started`\n- `call.playback.ended`\n- `call.dtmf.received`\
+ \ (you may receive many of these webhooks)\n- `call.gather.ended`\n"
operationId: callGatherUsingAudio
parameters:
- description: Unique identifier and token for controlling the call
@@ -3202,7 +3133,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/gather_using_speak:
post:
@@ -3219,8 +3150,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callGatherEnded:
'{$request.body#/webhook_url}':
@@ -3234,18 +3165,17 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.
-
- You can pass a list of valid digits along with an 'invalid_payload', which will be played back at the beginning of each prompt. Speech will be interrupted when a DTMF signal is received. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer) command must be issued before the `gather_using_speak` command.
-
- **Expected Webhooks:**
-
- - `call.dtmf.received` (you may receive many of these webhooks)
- - `call.gather.ended`
+ description: "Convert text to speech and play it on the call until the required\
+ \ DTMF signals are gathered to build interactive menus.\n\nYou can pass a\
+ \ list of valid digits along with an 'invalid_payload', which will be played\
+ \ back at the beginning of each prompt. Speech will be interrupted when a\
+ \ DTMF signal is received. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer)\
+ \ command must be issued before the `gather_using_speak` command.\n\n**Expected\
+ \ Webhooks:**\n\n- `call.dtmf.received` (you may receive many of these webhooks)\n\
+ - `call.gather.ended`\n"
operationId: callGatherUsingSpeak
parameters:
- description: Unique identifier and token for controlling the call
@@ -3280,7 +3210,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/hangup:
post:
@@ -3297,8 +3227,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callRecordingSaved:
'{$request.body#/webhook_url}':
@@ -3312,8 +3242,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callRecordingError:
'{$request.body#/webhook_url}':
@@ -3327,23 +3257,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
- x-callback-request: true
- callCost:
- '{$request.body#/webhook_url}':
- post:
- operationId: callCost_Post
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CallCost'
- required: true
- responses:
- "200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Hang up the call.
@@ -3386,7 +3301,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/leave_queue:
post:
@@ -3403,8 +3318,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: Removes the call from a queue.
operationId: leaveQueue
@@ -3422,8 +3337,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/LeaveQueueRequest'
- description: Removes the call from the queue, the call currently is enqueued
- in.
+ description: "Removes the call from the queue, the call currently is enqueued\
+ \ in."
required: true
responses:
"200":
@@ -3442,7 +3357,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/playback_start:
post:
@@ -3459,8 +3374,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callPlaybackEnded:
'{$request.body#/webhook_url}':
@@ -3474,22 +3389,15 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Play an audio file on the call. If multiple play audio commands are issued consecutively,
- the audio files will be placed in a queue awaiting playback.
-
- *Notes:*
-
- - When `overlay` is enabled, `target_legs` is limited to `self`.
- - A customer cannot Play Audio with `overlay=true` unless there is a Play Audio with `overlay=false` actively playing.
-
- **Expected Webhooks:**
-
- - `call.playback.started`
- - `call.playback.ended`
+ description: "Play an audio file on the call. If multiple play audio commands\
+ \ are issued consecutively,\nthe audio files will be placed in a queue awaiting\
+ \ playback.\n\n*Notes:*\n\n- When `overlay` is enabled, `target_legs` is limited\
+ \ to `self`.\n- A customer cannot Play Audio with `overlay=true` unless there\
+ \ is a Play Audio with `overlay=false` actively playing.\n\n**Expected Webhooks:**\n\
+ \n- `call.playback.started`\n- `call.playback.ended`\n"
operationId: callPlaybackStart
parameters:
- description: Unique identifier and token for controlling the call
@@ -3524,7 +3432,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/playback_stop:
post:
@@ -3541,8 +3449,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callSpeakEnded:
'{$request.body#/webhook_url}':
@@ -3556,8 +3464,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Stop audio being played on the call.
@@ -3599,7 +3507,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/record_pause:
post:
@@ -3643,7 +3551,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/record_resume:
post:
@@ -3687,16 +3595,13 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/record_start:
post:
- description: |
- Start recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command.
-
- **Expected Webhooks:**
-
- - `call.recording.saved`
+ description: "Start recording the call. Recording will stop on call hang-up,\
+ \ or can be initiated via the Stop Recording command.\n\n**Expected Webhooks:**\n\
+ \n- `call.recording.saved`\n"
operationId: callRecordStart
parameters:
- description: Unique identifier and token for controlling the call
@@ -3731,7 +3636,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/record_stop:
post:
@@ -3748,8 +3653,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callRecordingError:
'{$request.body#/webhook_url}':
@@ -3763,8 +3668,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Stop recording the call.
@@ -3806,7 +3711,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/refer:
post:
@@ -3823,8 +3728,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callReferCompleted:
'{$request.body#/webhook_url}':
@@ -3838,8 +3743,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callReferFailed:
'{$request.body#/webhook_url}':
@@ -3853,8 +3758,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call.
@@ -3898,7 +3803,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/reject:
post:
@@ -3915,8 +3820,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Reject an incoming call.
@@ -3958,7 +3863,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/send_dtmf:
post:
@@ -4002,7 +3907,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/speak:
post:
@@ -4019,8 +3924,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callSpeakEnded:
'{$request.body#/webhook_url}':
@@ -4034,16 +3939,13 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Convert text to speech and play it back on the call. If multiple speak text commands are issued consecutively, the audio files will be placed in a queue awaiting playback.
-
- **Expected Webhooks:**
-
- - `call.speak.started`
- - `call.speak.ended`
+ description: "Convert text to speech and play it back on the call. If multiple\
+ \ speak text commands are issued consecutively, the audio files will be placed\
+ \ in a queue awaiting playback.\n\n**Expected Webhooks:**\n\n- `call.speak.started`\n\
+ - `call.speak.ended`\n"
operationId: callSpeak
parameters:
- description: Unique identifier and token for controlling the call
@@ -4078,7 +3980,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/streaming_start:
post:
@@ -4095,8 +3997,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callStreamingStopped:
'{$request.body#/webhook_url}':
@@ -4110,35 +4012,67 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
+ x-callback-request: true
+ callStreamingFailed:
+ '{$request.body#/webhook_url}':
+ post:
+ operationId: callStreamingFailed_Post
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CallStreamingFailedEvent'
+ required: true
+ responses:
+ "200":
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: "Start streaming the media from a call to a specific WebSocket\
- \ address in near-realtime. \nAudio will be delivered as base64-encoded RTP\
- \ packets, wrapped in JSON payloads. \n\n**Expected Webhooks:**\n\n- `streaming.started`\n\
- - `streaming.stopped`\n\n**WebSocket events**\n\nWhen the WebSocket connection\
+ \ address or Dialogflow connection in near-realtime. Audio will be delivered\
+ \ as base64-encoded RTP payload (raw audio), wrapped in JSON payloads. \n\n\
+ **Example: Starting a stream to a Websocket address**\n\n The `stream_url`\
+ \ param is mandatory.\n\n```\ncurl -X POST \\ \n --header \"Content-Type:\
+ \ application/json\" \\ \n --header \"Accept: application/json\" \\ \n --header\
+ \ \"Authorization: Bearer YOUR_API_KEY\" \\ \n --data '{\n \"stream_url\"\
+ : \"wss://www.example.com/websocket\",\\ \n\"client_state\":\"aGF2ZSBhIG5pY2UgZGF5ID1d\"\
+ ,\\ \n\"command_id\":\"891510ac-f3e4-11e8-af5b-de00688a4901\" \\ \n}' \\ \n\
+ \ https://api.telnyx.com/v2/calls/{call_control_id}/actions/streaming_start\
+ \ \n``` \n\n **Example: Starting a stream to a Dialogflow connection** \n\n\
+ \ Enable the Dialogflow integration by sending `\"enable_dialogflow\": true`\
+ \ in the request. You need to have a Dialogflow connection associated with\
+ \ your Call Control application first, [click here for instructions](https://developers.telnyx.com/docs/v2/call-control/tutorials/dialogflow-es).\n\
+ ```\ncurl -X POST \\ \n --header \"Content-Type: application/json\" \\ \n\
+ \ --header \"Accept: application/json\" \\ \n --header \"Authorization:\
+ \ Bearer YOUR_API_KEY\" \\ \n --data '{\n \"client_state\":\"aGF2ZSBhIG5pY2UgZGF5ID1d\"\
+ , \\ \n\"command_id\":\"891510ac-f3e4-11e8-af5b-de00688a4901\", \\ \n\"enable_dialogflow\"\
+ : true \\ \n}' \\ \n https://api.telnyx.com/v2/calls/{call_control_id}/actions/streaming_start\
+ \ \n```\n\n**Expected Webhooks:**\n\n- `streaming.started`\n- `streaming.stopped`\n\
+ - `streaming.failed`\n\n**WebSocket events**\n\nWhen the WebSocket connection\
\ is established, the following event is being sent over it:\n```\n{\n \"\
event\": \"connected\",\n \"version\": \"1.0.0\"\n}\n```\nAnd when the call\
\ is started, an event which contains information about the encoding and `stream_id`\
\ that identifies a particular stream:\n```\n{\n \"event\": \"start\",\n\
- \ \"sequence_number\": \"1\",\n \"start\": {\n \"user_id\": \"3E6F995F-85F7-4705-9741-53B116D28237\"\
+ \ \"sequence_number\": \"1\",\n \"start\": {\n \"user_id\": \"3e6f995f-85f7-4705-9741-53b116d28237\"\
+ ,\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\"\
+ , \n \"client_state\": \"aGF2ZSBhIG5pY2UgZGF5ID1d\",\n \"media_format\"\
+ : {\n \"encoding\": \"audio/x-mulaw\",\n \"sample_rate\": 8000,\n\
+ \ \"channels\": 1\n }\n },\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\"\
+ \n}\n```\nThe start event is followed by the following media events that contain\
+ \ base64-encoded RTP payload (raw audio, no RTP headers) (:\n```\n{ \n \"\
+ event\": \"media\",\n \"sequence_number\": \"4\",\n \"media\": { \n \"\
+ track\": \"inbound/outbound\", \n \"chunk\": \"2\",\n \"timestamp\"\
+ : \"5\",\n \"payload\": \"no+JhoaJjpzSHxAKBgYJD...IsSbjomGhoqQn1Ic\" \n\
+ \ },\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\" \n}\n```\n\
+ Please note that the order of events is not guaranteed and the chunk number\
+ \ can be used to reorder the events.\n\nWhen the call ends, the stop event\
+ \ over WebSockets connection is sent:\n```\n{ \n \"event\": \"stop\",\n \
+ \ \"sequence_number\": \"5\",\n \"stop\": {\n \"user_id\": \"3e6f995f-85f7-4705-9741-53b116d28237\"\
,\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\"\
- ,\n \"media_format\": {\n \"encoding\": \"audio/x-mulaw\",\n \
- \ \"sample_rate\": 8000,\n \"channels\": 1\n }\n },\n \"stream_id\"\
- : \"32DE0DEA-53CB-4B21-89A4-9E1819C043BC\"\n}\n```\nThe start event is followed\
- \ by the following media events that contain base64-encoded RTP packets as\
- \ their payloads:\n```\n{ \n \"event\": \"media\",\n \"sequence_number\"\
- : \"4\",\n \"media\": { \n \"track\": \"inbound/outbound\", \n \"chunk\"\
- : \"2\",\n \"timestamp\": \"5\",\n \"payload\": \"no+JhoaJjpzSHxAKBgYJD...IsSbjomGhoqQn1Ic\"\
- \ \n },\n \"stream_id\": \"32DE0DEA-53CB-4B21-89A4-9E1819C043BC\"\
- \ \n}\n```\nPlease note that the order of events is not guaranteed and the\
- \ chunk number can be used to reorder the events.\n\nWhen the call ends, the\
- \ stop event over WebSockets connection is sent:\n```\n{ \n \"event\": \"\
- stop\",\n \"sequence_number\": \"5\",\n \"stop\": {\n \"user_id\": \"\
- 3E6F995F-85F7-4705-9741-53B116D28237\",\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\"\
- \n },\n \"stream_id\": \"32DE0DEA-53CB-4B21-89A4-9E1819C043BC\" \n }\n\
+ \n },\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\" \n }\n\
```\n"
- operationId: callStreamingStart
parameters:
- description: Unique identifier and token for controlling the call
explode: false
@@ -4172,7 +4106,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/streaming_stop:
post:
@@ -4189,8 +4123,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Stop streaming a call to a WebSocket.
@@ -4232,7 +4166,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/transcription_start:
post:
@@ -4249,15 +4183,12 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command.
-
- **Expected Webhooks:**
-
- - `call.transcription`
+ description: "Start real-time transcription. Transcription will stop on call\
+ \ hang-up, or can be initiated via the Transcription stop command.\n\n**Expected\
+ \ Webhooks:**\n\n- `call.transcription`\n"
operationId: callTranscriptionStart
parameters:
- description: Unique identifier and token for controlling the call
@@ -4292,7 +4223,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/transcription_stop:
post:
@@ -4331,7 +4262,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/calls/{call_control_id}/actions/transfer:
post:
@@ -4348,8 +4279,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callBridged:
'{$request.body#/webhook_url}':
@@ -4363,8 +4294,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callAnswered:
'{$request.body#/webhook_url}':
@@ -4378,8 +4309,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callHangup:
'{$request.body#/webhook_url}':
@@ -4393,19 +4324,18 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |-
- Transfer a call to a new destination. If the transfer is unsuccessful, a `call.hangup` webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination.
-
- **Expected Webhooks:**
-
- - `call.initiated`
- - `call.bridged` to Leg B
- - `call.answered` or `call.hangup`
- - `call.machine.detection.ended` if `answering_machine_detection` was requested
- - `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
+ description: "Transfer a call to a new destination. If the transfer is unsuccessful,\
+ \ a `call.hangup` webhook for the other call (Leg B) will be sent indicating\
+ \ that the transfer could not be completed. The original call will remain\
+ \ active and may be issued additional commands, potentially transfering the\
+ \ call to an alternate destination.\n\n**Expected Webhooks:**\n\n- `call.initiated`\n\
+ - `call.bridged` to Leg B\n- `call.answered` or `call.hangup`\n- `call.machine.detection.ended`\
+ \ if `answering_machine_detection` was requested\n- `call.machine.greeting.ended`\
+ \ if `answering_machine_detection` was set to `detect_beep`, `greeting_end`\
+ \ or `detect_words`"
operationId: callTransfer
parameters:
- description: Unique identifier and token for controlling the call
@@ -4440,7 +4370,7 @@ paths:
tags:
- Call Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/channel_zones:
get:
@@ -4450,7 +4380,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -4460,7 +4390,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -4473,7 +4403,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Get_Gcb_Channel_Zones_Request_Response'
+ $ref: '#/components/schemas/getChannelZones_200_response'
description: A list of channel zones
summary: Get list of channel zones
tags:
@@ -4524,16 +4454,10 @@ paths:
type: string
style: simple
requestBody:
- $ref: '#/components/requestBodies/Update_Channel_Zone'
content:
application/json:
schema:
- properties:
- channels:
- format: int64
- type: integer
- title: Update Channel Zone
- type: object
+ $ref: '#/components/schemas/patchGroup_request'
description: Quantity of reserved channels
required: true
responses:
@@ -4554,7 +4478,7 @@ paths:
- ChannelZones
x-codegen-request-body-name: body
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/channel_zones/{channel_zone_id}/channel_zone_phone_numbers:
get:
@@ -4575,7 +4499,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -4585,7 +4509,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -4598,7 +4522,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Get_Gcb_Phone_Numbers_Request_Response'
+ $ref: '#/components/schemas/getPhoneNumbers_200_response'
description: A list of phone numbers
summary: Get the list of phone numbers assigned to a channel zone
tags:
@@ -4606,9 +4530,9 @@ paths:
x-latency-category: interactive
x-accepts: application/json
post:
- description: You should own the phone number being assigned to the channel zone.
- Remember that you should reserve channels in this channel zone, otherwise
- you won't be able to receive incoming calls.
+ description: "You should own the phone number being assigned to the channel\
+ \ zone. Remember that you should reserve channels in this channel zone, otherwise\
+ \ you won't be able to receive incoming calls."
operationId: assignPhoneNumber
parameters:
- description: Channel zone identifier
@@ -4620,19 +4544,10 @@ paths:
type: string
style: simple
requestBody:
- $ref: '#/components/requestBodies/List_Channel_Zones_by_Phone_Number'
content:
application/json:
schema:
- properties:
- phone_number:
- example: +15554441234
- format: +E.164
- type: string
- required:
- - phone_number
- title: List Channel Zones by Phone Number
- type: object
+ $ref: '#/components/schemas/assignPhoneNumber_request'
description: Phone number to assign to the channel zone. The phone number
should be in E.164 format.
required: true
@@ -4654,7 +4569,7 @@ paths:
- ChannelZones
x-codegen-request-body-name: body
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}:
delete:
@@ -4696,11 +4611,11 @@ paths:
get:
operationId: listComments
parameters:
- - description: Record type that the comment relates to i.e number_order, sub_number_order
- or number_order_phone_number
+ - description: "Record type that the comment relates to i.e number_order, sub_number_order\
+ \ or number_order_phone_number"
explode: true
in: query
- name: filter[comment_record_type]
+ name: "filter[comment_record_type]"
required: true
schema:
example: sub_number_order
@@ -4709,7 +4624,7 @@ paths:
- description: ID of the record the comments relate to
explode: true
in: query
- name: filter[comment_record_id]
+ name: "filter[comment_record_id]"
required: true
schema:
example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
@@ -4720,7 +4635,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Comments_Response'
+ $ref: '#/components/schemas/listComments_200_response'
description: An array of Comment Responses
default:
content:
@@ -4746,7 +4661,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Comment_Response'
+ $ref: '#/components/schemas/createComment_200_response'
description: A Comment Response
default:
content:
@@ -4758,7 +4673,7 @@ paths:
tags:
- Number Orders
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/comments/{id}:
get:
@@ -4777,7 +4692,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Comment_Response'
+ $ref: '#/components/schemas/createComment_200_response'
description: A Comment Response
default:
content:
@@ -4807,7 +4722,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Read_Comment_Response'
+ $ref: '#/components/schemas/markCommentRead_200_response'
description: A Comment Response
default:
content:
@@ -4822,25 +4737,25 @@ paths:
x-accepts: application/json
/conferences:
get:
- description: Lists conferences. Conferences are created on demand, and will
- expire after all participants have left the conference or after 4 hours regardless
- of the number of active participants. Conferences are listed in descending
- order by `expires_at`.
+ description: "Lists conferences. Conferences are created on demand, and will\
+ \ expire after all participants have left the conference or after 4 hours\
+ \ regardless of the number of active participants. Conferences are listed\
+ \ in descending order by `expires_at`."
operationId: listConferences
parameters:
- - description: If present, conferences will be filtered to those with a matching
- `name` attribute. Matching is case-sensitive
+ - description: "If present, conferences will be filtered to those with a matching\
+ \ `name` attribute. Matching is case-sensitive"
explode: true
in: query
- name: filter[name]
+ name: "filter[name]"
required: false
schema:
type: string
style: form
- - description: If present, conferences will be filtered by status.
+ - description: "If present, conferences will be filtered by status."
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -4852,7 +4767,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -4862,7 +4777,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -4878,7 +4793,8 @@ paths:
$ref: '#/components/schemas/List_Conferences_Response'
description: Successful response with a list of conferences.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"422":
description: Unprocessable entity
summary: List conferences
@@ -4901,8 +4817,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantJoined:
'{$request.body#/webhook_url}':
@@ -4916,8 +4832,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceEnded:
'{$request.body#/webhook_url}':
@@ -4931,8 +4847,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantLeft:
'{$request.body#/webhook_url}':
@@ -4946,8 +4862,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceFloorChanged:
'{$request.body#/webhook_url}':
@@ -4961,20 +4877,16 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Create a conference from an existing call leg using a `call_control_id` and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.
-
- **Expected Webhooks:**
-
- - `conference.created`
- - `conference.participant.joined`
- - `conference.participant.left`
- - `conference.ended`
- - `conference.recording.saved`
- - `conference.floor.changed`
+ description: "Create a conference from an existing call leg using a `call_control_id`\
+ \ and a conference name. Upon creating the conference, the call will be automatically\
+ \ bridged to the conference. Conferences will expire after all participants\
+ \ have left the conference or after 4 hours regardless of the number of active\
+ \ participants.\n\n**Expected Webhooks:**\n\n- `conference.created`\n- `conference.participant.joined`\n\
+ - `conference.participant.left`\n- `conference.ended`\n- `conference.recording.saved`\n\
+ - `conference.floor.changed`\n"
operationId: createConference
requestBody:
content:
@@ -4991,14 +4903,15 @@ paths:
$ref: '#/components/schemas/Conference_Response'
description: Successful response with details about a conference.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"422":
description: Unprocessable entity
summary: Create conference
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{conference_id}/participants:
get:
@@ -5013,29 +4926,29 @@ paths:
schema:
type: string
style: simple
- - description: If present, participants will be filtered to those who are/are
- not muted
+ - description: "If present, participants will be filtered to those who are/are\
+ \ not muted"
explode: true
in: query
- name: filter[muted]
+ name: "filter[muted]"
required: false
schema:
type: boolean
style: form
- - description: If present, participants will be filtered to those who are/are
- not put on hold
+ - description: "If present, participants will be filtered to those who are/are\
+ \ not put on hold"
explode: true
in: query
- name: filter[on_hold]
+ name: "filter[on_hold]"
required: false
schema:
type: boolean
style: form
- - description: If present, participants will be filtered to those who are whispering
- or are not
+ - description: "If present, participants will be filtered to those who are whispering\
+ \ or are not"
explode: true
in: query
- name: filter[whispering]
+ name: "filter[whispering]"
required: false
schema:
type: boolean
@@ -5043,7 +4956,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -5053,7 +4966,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -5069,9 +4982,10 @@ paths:
$ref: '#/components/schemas/List_Participants_Response'
description: Successful response with a list of conference participants.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: List conference participants
@@ -5101,7 +5015,7 @@ paths:
$ref: '#/components/schemas/Conference_Response'
description: Successful response with details about a conference.
"404":
- description: Conference does not exist
+ description: Fax does not exist
summary: Retrieve a conference
tags:
- Conference Commands
@@ -5122,8 +5036,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
callHangup:
'{$request.body#/webhook_url}':
@@ -5137,8 +5051,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantJoined:
'{$request.body#/webhook_url}':
@@ -5152,8 +5066,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantLeft:
'{$request.body#/webhook_url}':
@@ -5167,18 +5081,12 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Dials a phone number and, when the call is answered, automatically joins them into the specified conference.
-
- **Expected Webhooks:**
-
- - `call.hangup`
- - `call.answered`
- - `conference.participant.joined`
- - `conference.participant.left`
+ description: "Dials a phone number and, when the call is answered, automatically\
+ \ joins them into the specified conference.\n\n**Expected Webhooks:**\n\n\
+ - `call.hangup`\n- `call.answered`\n- `conference.participant.joined`\n- `conference.participant.left`\n"
operationId: conferenceDialParticipantIn
parameters:
- description: Uniquely identifies the conference by id or name
@@ -5204,16 +5112,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Dial a new participant into a conference
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/hold:
post:
@@ -5242,16 +5151,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Hold conference participants
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/join:
post:
@@ -5268,8 +5178,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantLeft:
'{$request.body#/webhook_url}':
@@ -5283,8 +5193,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: "Join an existing call leg to a conference. Issue the Join Conference\
\ command with the conference ID in the path and the `call_control_id` of\
@@ -5317,14 +5227,15 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"422":
description: Unprocessable entity
summary: Join a conference
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/leave:
post:
@@ -5341,8 +5252,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Removes a call leg from a conference and moves it back to parked state. **Expected Webhooks:**
@@ -5373,14 +5284,15 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"422":
description: Unprocessable entity
summary: Leave a conference
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/mute:
post:
@@ -5409,16 +5321,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Mute conference participants
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/play:
post:
@@ -5435,8 +5348,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferencePlaybackEnded:
'{$request.body#/webhook_url}':
@@ -5450,8 +5363,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantPlaybackStarted:
'{$request.body#/webhook_url}':
@@ -5465,8 +5378,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantPlaybackEnded:
'{$request.body#/webhook_url}':
@@ -5480,8 +5393,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: Play audio to all or some participants on a conference call.
operationId: conferencePlayAudio
@@ -5508,25 +5421,22 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Play audio to conference participants
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/record_start:
post:
- description: |-
- Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.
-
- **Expected Webhooks:**
-
- - `conference.recording.saved`
+ description: "Start recording the conference. Recording will stop on conference\
+ \ end, or via the Stop Recording command.\n\n**Expected Webhooks:**\n\n- `conference.recording.saved`"
operationId: conferenceStartRecording
parameters:
- description: Specifies the conference to record by id or name
@@ -5551,16 +5461,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Conference recording start
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/record_stop:
post:
@@ -5577,8 +5488,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: |
Stop recording the conference.
@@ -5611,16 +5522,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Conference recording stop
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/speak:
post:
@@ -5637,8 +5549,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceSpeakEnded:
'{$request.body#/webhook_url}':
@@ -5652,8 +5564,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantSpeakStarted:
'{$request.body#/webhook_url}':
@@ -5667,8 +5579,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
conferenceParticipantSpeakEnded:
'{$request.body#/webhook_url}':
@@ -5682,8 +5594,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: Convert text to speech and play it to all or some participants.
operationId: conferenceSpeakText
@@ -5710,16 +5622,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Speak text to conference participants
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/stop:
post:
@@ -5736,8 +5649,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
description: Stop audio being played to all or some participants on a conference
call.
@@ -5765,16 +5678,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Stop audio being played on the conference
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/unhold:
post:
@@ -5803,16 +5717,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Unhold conference participants
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/unmute:
post:
@@ -5841,16 +5756,17 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
- description: Conference does not exist
+ description: Fax does not exist
"422":
description: Unprocessable entity
summary: Unmute conference participants
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/conferences/{id}/actions/update:
post:
@@ -5880,14 +5796,15 @@ paths:
$ref: '#/components/schemas/Conference_Command_Response'
description: Successful response upon making a conference command.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"422":
description: Unprocessable entity
summary: Update conference participant
tags:
- Conference Commands
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/connections:
get:
@@ -5897,7 +5814,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -5907,7 +5824,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -5915,40 +5832,34 @@ paths:
minimum: 1
type: integer
style: form
- - description: If present, connections with connection_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, connections with connection_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[connection_name][contains]
+ name: "filter[connection_name][contains]"
required: false
schema:
- default: "null"
type: string
style: form
- description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -5984,9 +5895,9 @@ paths:
x-accepts: application/json
/connections/{id}:
get:
- description: Retrieves the high-level details of an existing connection. To
- retrieve specific authentication information, use the endpoint for the specific
- connection type.
+ description: "Retrieves the high-level details of an existing connection. To\
+ \ retrieve specific authentication information, use the endpoint for the specific\
+ \ connection type."
operationId: retrieveConnection
parameters:
- description: IP Connection ID
@@ -6023,7 +5934,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -6033,7 +5944,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -6041,40 +5952,34 @@ paths:
minimum: 1
type: integer
style: form
- - description: If present, connections with connection_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, connections with connection_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[connection_name][contains]
+ name: "filter[connection_name][contains]"
required: false
schema:
- default: "null"
type: string
style: form
- description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound.outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -6133,7 +6038,7 @@ paths:
- Credential Connections
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/credential_connections/{id}:
delete:
@@ -6232,15 +6137,14 @@ paths:
tags:
- Credential Connections
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/custom_storage_credentials/{connection_id}:
delete:
description: Deletes a stored custom credentials configuration.
operationId: deleteCustomStorageCredentials
parameters:
- - description: Uniquely identifies a Telnyx application (Call Control, TeXML)
- or Sip connection resource.
+ - description: Uniquely identifies a Telnyx application (Call Control).
explode: false
in: path
name: connection_id
@@ -6267,8 +6171,7 @@ paths:
description: Returns the information about custom storage credentials.
operationId: getCustomStorageCredentials
parameters:
- - description: Uniquely identifies a Telnyx application (Call Control, TeXML)
- or Sip connection resource.
+ - description: Uniquely identifies a Telnyx application (Call Control).
explode: false
in: path
name: connection_id
@@ -6298,8 +6201,7 @@ paths:
description: Creates custom storage credentials configuration.
operationId: createCustomStorageCredentials
parameters:
- - description: Uniquely identifies a Telnyx application (Call Control, TeXML)
- or Sip connection resource.
+ - description: Uniquely identifies a Telnyx application (Call Control).
explode: false
in: path
name: connection_id
@@ -6326,14 +6228,13 @@ paths:
tags:
- Call Recordings
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
put:
description: Updates a stored custom credentials configuration.
operationId: updateCustomStorageCredentials
parameters:
- - description: Uniquely identifies a Telnyx application (Call Control, TeXML)
- or Sip connection resource.
+ - description: Uniquely identifies a Telnyx application (Call Control).
explode: false
in: path
name: connection_id
@@ -6360,7 +6261,204 @@ paths:
tags:
- Call Recordings
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
+ x-accepts: application/json
+ /customer_service_requests:
+ get:
+ description: List customer service requests.
+ operationId: listCustomerServiceRequests
+ parameters:
+ - description: The page number to load
+ explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ default: 1
+ minimum: 1
+ type: integer
+ style: form
+ - description: The size of the page
+ explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ default: 20
+ maximum: 250
+ minimum: 1
+ type: integer
+ style: form
+ - description: "Specifies the sort order for results. If not given, results\
+ \ are sorted by created_at in descending order."
+ explode: true
+ in: query
+ name: "sort[]"
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ example: created_at
+ type: string
+ style: form
+ - description: Filters records to those with a specified number.
+ explode: true
+ in: query
+ name: "filter[phone_number][eq]"
+ required: false
+ schema:
+ example: +12441239999
+ type: string
+ style: form
+ - description: Filters records to those with at least one number in the list.
+ explode: true
+ in: query
+ name: "filter[phone_number][in][]"
+ required: false
+ schema:
+ items:
+ example: +12441239999
+ type: string
+ type: array
+ style: form
+ - description: Filters records to those with a specific status.
+ explode: true
+ in: query
+ name: "filter[status][eq]"
+ required: false
+ schema:
+ enum:
+ - pending
+ - completed
+ - failed
+ example: pending
+ type: string
+ style: form
+ - description: Filters records to those with a least one status in the list.
+ explode: true
+ in: query
+ name: "filter[status][in][]"
+ required: false
+ schema:
+ items:
+ enum:
+ - pending
+ - completed
+ - failed
+ example: pending
+ type: string
+ type: array
+ style: form
+ - description: Filters records to those created before a specific date.
+ explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ example: 2020-01-01T00:00:00Z
+ format: date-time
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_200_response'
+ description: Successful Response
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_401_response'
+ description: The required authentication headers were either invalid or
+ not included in the request.
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_403_response'
+ description: You do not have permission to perform the requested action
+ on the specified resource or resources.
+ "422":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_422_response'
+ description: Unprocessable entity. Check the 'detail' field in response
+ for details.
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_500_response'
+ description: An unexpected error occurred.
+ summary: List customer service requests
+ tags:
+ - Customer Service Request
+ x-latency-category: responsive
+ x-accepts: application/json
+ post:
+ callbacks:
+ CustomerServiceRequestStatusChanged:
+ '{$request.body#/webhook_url}':
+ post:
+ operationId: customerServiceRequestStatusChanged_Post
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_customer_service_requests_get_request'
+ required: true
+ responses:
+ "200":
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
+ x-callback-request: true
+ description: Create a new customer service request for the provided phone number.
+ operationId: createCustomerServiceRequest
+ requestBody:
+ $ref: '#/components/requestBodies/CreateCustomerServiceRequest'
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/createCustomerServiceRequest_201_response'
+ description: Successful Response
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_401_response'
+ description: The required authentication headers were either invalid or
+ not included in the request.
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_403_response'
+ description: You do not have permission to perform the requested action
+ on the specified resource or resources.
+ "422":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_422_response'
+ description: Unprocessable entity. Check the 'detail' field in response
+ for details.
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listCustomerServiceRequests_500_response'
+ description: An unexpected error occurred.
+ summary: Create a customer service request
+ tags:
+ - Customer Service Request
+ x-latency-category: responsive
+ x-content-type: application/json
x-accepts: application/json
/customer_service_requests/phone_number_coverages:
post:
@@ -6373,60 +6471,40 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Customer_Service_Request_PhoneNumber_Coverage'
+ $ref: '#/components/schemas/verifyPhoneNumberCoverage_201_response'
description: Successful Response
"401":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/UnauthorizedError'
- type: array
- title: Unauthorized Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_401_response'
description: The required authentication headers were either invalid or
not included in the request.
"403":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/ForbiddenError'
- type: array
- title: Forbidden Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_403_response'
description: You do not have permission to perform the requested action
on the specified resource or resources.
"422":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/UnprocessableEntityError'
- type: array
- title: Unprocessable Enttiy Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_422_response'
description: Unprocessable entity. Check the 'detail' field in response
for details.
"500":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/UnexpectedError'
- type: array
- title: Unexpected Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_500_response'
description: An unexpected error occurred.
summary: Verify CSR phone number coverage
tags:
- Customer Service Request
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/customer_service_requests/{customer_service_request_id}:
get:
@@ -6446,52 +6524,33 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Show_Customer_Service_Request'
+ $ref: '#/components/schemas/createCustomerServiceRequest_201_response'
description: Successful Response
"401":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/UnauthorizedError'
- type: array
- title: Unauthorized Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_401_response'
description: The required authentication headers were either invalid or
not included in the request.
"403":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/ForbiddenError'
- type: array
- title: Forbidden Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_403_response'
description: You do not have permission to perform the requested action
on the specified resource or resources.
"404":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/ResourceNotFoundError'
- type: array
+ $ref: '#/components/schemas/getCustomerServiceRequest_404_response'
description: Resource not found
"500":
content:
application/json:
schema:
- properties:
- errors:
- items:
- $ref: '#/components/schemas/UnexpectedError'
- type: array
- title: Unexpected Error Response
+ $ref: '#/components/schemas/listCustomerServiceRequests_500_response'
description: An unexpected error occurred.
summary: Get a customer service request
tags:
@@ -6500,39 +6559,70 @@ paths:
x-accepts: application/json
/detail_records:
get:
- description: Search for any detail record across the Telnyx Platform
+ description: "Search for any detail record across the Telnyx Platform. Examples\
+ \ and additional information found [here](/docs/v2/debugging/detail-record-search)."
operationId: DetailRecordsSearch
parameters:
- - description: Filter by the given record type
+ - description: Filter by the given record type.
examples:
filter[record_type]=messaging:
summary: Searches for messaging detail records
value: messaging
+ filter[record_type]=verify:
+ summary: Searches for verify detail records
+ value: verify
explode: true
in: query
- name: filter[record_type]
+ name: "filter[record_type]"
required: true
schema:
+ enum:
+ - amd
+ - conference
+ - conference-participant
+ - media_storage
+ - messaging
+ - verify
+ - whatsapp
+ - whatsapp-conversation
+ - wireless
type: string
style: form
- - description: Filter by the given user-friendly date range
+ - description: "Filter by the given user-friendly date range. You can specify\
+ \ one of the following enum values, or a dynamic one using this format:\
+ \ last_N_days."
examples:
filter[date_range]=today:
summary: Searches for records with timestamp starting at `00:00:00` of
the current day
value: today
- filter[date_range]=last_3_days:
- summary: Searches for records with timestamp starting at `00:00:00` since
- 3 days ago
- value: last_3_days
+ filter[date_range]=yesterday:
+ summary: Searches for records with timestamp starting at `00:00:00` of
+ yesterday
+ value: yesterday
+ filter[date_range]=last_month:
+ summary: Searches for records with timestamp starting at `00:00:00` on
+ the first day of the month
+ value: last_month
explode: true
in: query
- name: filter[date_range]
+ name: "filter[date_range]"
required: false
schema:
+ enum:
+ - yesterday
+ - today
+ - tomorrow
+ - last_week
+ - this_week
+ - next_week
+ - last_month
+ - this_month
+ - next_month
type: string
style: form
- - description: Filter records
+ - description: "Filter records on a given record attribute and value. application_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, applications with application_name\
+ \ containing the given value will be returned. Matching is not case-sensitive.\
+ \ Requires at least three characters."
explode: true
in: query
- name: filter[application_name][contains]
+ name: "filter[application_name][contains]"
required: false
schema:
default: "null"
@@ -7334,26 +7547,21 @@ paths:
- description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -7387,10 +7595,10 @@ paths:
x-latency-category: responsive
x-accepts: application/json
post:
- description: Creates a new Fax Application based on the parameters sent in the
- request. The application name and webhook URL are required. Once created,
- you can assign phone numbers to your application using the `/phone_numbers`
- endpoint.
+ description: "Creates a new Fax Application based on the parameters sent in\
+ \ the request. The application name and webhook URL are required. Once created,\
+ \ you can assign phone numbers to your application using the `/phone_numbers`\
+ \ endpoint."
operationId: CreateFaxApplication
parameters: []
requestBody:
@@ -7414,7 +7622,7 @@ paths:
- Programmable Fax Applications
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/fax_applications/{id}:
delete:
@@ -7522,17 +7730,18 @@ paths:
tags:
- Programmable Fax Applications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/faxes:
get:
+ description: ""
operationId: ListFaxes
parameters:
- description: ISO 8601 date time for filtering faxes created after or on that
date
explode: true
in: query
- name: filter[created_at][gte]
+ name: "filter[created_at][gte]"
required: false
schema:
example: 2020-02-02T22:25:27.521992Z
@@ -7542,7 +7751,7 @@ paths:
- description: ISO 8601 date time for filtering faxes created after that date
explode: true
in: query
- name: filter[created_at][gt]
+ name: "filter[created_at][gt]"
required: false
schema:
example: 2020-02-02T22:25:27.521992Z
@@ -7553,7 +7762,7 @@ paths:
before that date
explode: true
in: query
- name: filter[created_at][lte]
+ name: "filter[created_at][lte]"
required: false
schema:
example: 2020-02-02T22:25:27.521992Z
@@ -7564,28 +7773,28 @@ paths:
that date
explode: true
in: query
- name: filter[created_at][lt]
+ name: "filter[created_at][lt]"
required: false
schema:
example: 2020-02-02T22:25:27.521992Z
format: date-time
type: string
style: form
- - description: The direction, inbound or outbound, for filtering faxes sent
- from this account
+ - description: "The direction, inbound or outbound, for filtering faxes sent\
+ \ from this account"
explode: true
in: query
- name: filter[direction][eq]
+ name: "filter[direction][eq]"
required: false
schema:
example: inbound
type: string
style: form
- - description: The phone number, in E.164 format for filtering faxes sent from
- this number
+ - description: "The phone number, in E.164 format for filtering faxes sent from\
+ \ this number"
explode: true
in: query
- name: filter[from][eq]
+ name: "filter[from][eq]"
required: false
schema:
example: +13127367276
@@ -7594,7 +7803,7 @@ paths:
- description: Number of fax resourcxes for the single page returned
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
example: 2
@@ -7603,7 +7812,7 @@ paths:
- description: Number of the page to be retrieved
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
example: 2
@@ -7641,8 +7850,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
fax.media.processed:
'{$response.body#/data/webhook_url}':
@@ -7656,8 +7865,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
fax.sending.started:
'{$response.body#/data/webhook_url}':
@@ -7671,8 +7880,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
fax.delivered:
'{$response.body#/data/webhook_url}':
@@ -7686,8 +7895,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
fax.failed:
'{$response.body#/data/webhook_url}':
@@ -7701,9 +7910,14 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
+ description: "Send a fax. Files have size limits and page count limit validations.\
+ \ If a file is bigger than 50MB or has more than 350 pages it will fail with\
+ \ `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively.\
+ \ \n\n**Expected Webhooks:**\n\n- `fax.queued`\n- `fax.media.processed`\n\
+ - `fax.sending.started`\n- `fax.delivered`\n- `fax.failed`\n"
operationId: SendFax
requestBody:
content:
@@ -7732,7 +7946,7 @@ paths:
tags:
- Programmable Fax Commands
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/faxes/{id}:
delete:
@@ -7791,6 +8005,43 @@ paths:
- Programmable Fax Commands
x-latency-category: responsive
x-accepts: application/json
+ /faxes/{id}/actions/cancel:
+ post:
+ description: "Cancel the outbound fax that is in one of the following states:\
+ \ `queued`, `media.processed`, `originated` or `sending` "
+ operationId: CancelFax
+ parameters:
+ - description: The unique identifier of a fax.
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ format: uuid
+ type: string
+ style: simple
+ responses:
+ "202":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Successful_response_upon_accepting_cancel_fax_command'
+ description: Successful response upon accepting cancel fax command
+ "404":
+ description: Fax does not exist
+ "422":
+ description: Unprocessable entity
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Cancel a fax
+ tags:
+ - Programmable Fax Commands
+ x-latency-category: responsive
+ x-accepts: application/json
/faxes/{id}/actions/refresh:
post:
description: Refreshes the inbound fax's media_url when it has expired
@@ -7813,7 +8064,7 @@ paths:
$ref: '#/components/schemas/Refresh_Fax_Response'
description: Refresh fax response
"404":
- description: Conference does not exist
+ description: Fax does not exist
default:
content:
application/json:
@@ -7833,7 +8084,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -7843,7 +8094,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -7851,30 +8102,24 @@ paths:
minimum: 1
type: integer
style: form
- - description: If present, connections with connection_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, connections with connection_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[connection_name][contains]
+ name: "filter[connection_name][contains]"
required: false
schema:
- default: "null"
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -7933,7 +8178,7 @@ paths:
- FQDN Connections
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/fqdn_connections/{id}:
delete:
@@ -8032,7 +8277,7 @@ paths:
tags:
- FQDN Connections
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/fqdns:
get:
@@ -8042,7 +8287,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -8052,7 +8297,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -8063,7 +8308,7 @@ paths:
- description: ID of the FQDN connection to which the FQDN belongs.
explode: true
in: query
- name: filter[connection_id]
+ name: "filter[connection_id]"
required: false
schema:
type: string
@@ -8071,7 +8316,7 @@ paths:
- description: FQDN represented by the resource.
explode: true
in: query
- name: filter[fqdn]
+ name: "filter[fqdn]"
required: false
schema:
example: example.com
@@ -8080,7 +8325,7 @@ paths:
- description: Port to use when connecting to the FQDN.
explode: true
in: query
- name: filter[port]
+ name: "filter[port]"
required: false
schema:
example: 5060
@@ -8089,7 +8334,7 @@ paths:
- description: DNS record type used by the FQDN.
explode: true
in: query
- name: filter[dns_record_type]
+ name: "filter[dns_record_type]"
required: false
schema:
example: a
@@ -8137,7 +8382,7 @@ paths:
- FQDNs
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/fqdns/{id}:
delete:
@@ -8234,19 +8479,19 @@ paths:
tags:
- FQDNs
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/inventory_coverage:
get:
- description: Creates an inventory coverage request. If locality, npa or national_destination_code
- is used in groupBy, and no region or locality filters are used, the whole
- paginated set is returned.
+ description: "Creates an inventory coverage request. If locality, npa or national_destination_code\
+ \ is used in groupBy, and no region or locality filters are used, the whole\
+ \ paginated set is returned."
operationId: createInventoryCoverageRequest
parameters:
- example: 318
explode: true
in: query
- name: filter[npa]
+ name: "filter[npa]"
required: false
schema:
description: Filter by npa
@@ -8255,7 +8500,7 @@ paths:
- example: 202
explode: true
in: query
- name: filter[nxx]
+ name: "filter[nxx]"
required: false
schema:
description: Filter by nxx
@@ -8264,7 +8509,7 @@ paths:
- example: LA
explode: true
in: query
- name: filter[administrative_area]
+ name: "filter[administrative_area]"
required: false
schema:
description: Filter by administrative area
@@ -8273,7 +8518,7 @@ paths:
- example: local
explode: true
in: query
- name: filter[phone_number_type]
+ name: "filter[phone_number_type]"
required: false
schema:
description: Filter by phone number type
@@ -8289,7 +8534,7 @@ paths:
- example: US
explode: true
in: query
- name: filter[country_code]
+ name: "filter[country_code]"
required: false
schema:
description: Filter by country. Defaults to US
@@ -8302,7 +8547,7 @@ paths:
- example: "true"
explode: true
in: query
- name: filter[count]
+ name: "filter[count]"
required: false
schema:
description: Include count in the result
@@ -8311,7 +8556,7 @@ paths:
- example: nxx
explode: true
in: query
- name: filter[groupBy]
+ name: "filter[groupBy]"
required: true
schema:
description: Filter to group results
@@ -8326,7 +8571,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Inventory_Coverage_Response'
+ $ref: '#/components/schemas/createInventoryCoverageRequest_200_response'
description: Successful response with a list of inventory coverage levels
default:
content:
@@ -8347,7 +8592,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -8357,7 +8602,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -8365,40 +8610,34 @@ paths:
minimum: 1
type: integer
style: form
- - description: If present, connections with connection_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, connections with connection_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[connection_name][contains]
+ name: "filter[connection_name][contains]"
required: false
schema:
- default: "null"
type: string
style: form
- description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound.outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -8457,7 +8696,7 @@ paths:
- IP Connections
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/ip_connections/{id}:
delete:
@@ -8556,7 +8795,7 @@ paths:
tags:
- IP Connections
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/ips:
get:
@@ -8566,7 +8805,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -8576,7 +8815,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -8587,7 +8826,7 @@ paths:
- description: ID of the IP Connection to which this IP should be attached.
explode: true
in: query
- name: filter[connection_id]
+ name: "filter[connection_id]"
required: false
schema:
type: string
@@ -8595,7 +8834,7 @@ paths:
- description: IP adddress represented by this resource.
explode: true
in: query
- name: filter[ip_address]
+ name: "filter[ip_address]"
required: false
schema:
example: 192.168.0.0
@@ -8604,7 +8843,7 @@ paths:
- description: Port to use when connecting to this IP.
explode: true
in: query
- name: filter[port]
+ name: "filter[port]"
required: false
schema:
example: 5060
@@ -8652,7 +8891,7 @@ paths:
- IPs
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/ips/{id}:
delete:
@@ -8749,7 +8988,7 @@ paths:
tags:
- IPs
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/ledger_billing_group_reports:
post:
@@ -8766,7 +9005,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Ledger_Billing_Group_Report_Response'
+ $ref: '#/components/schemas/createLedgerBillingGroupReport_200_response'
description: Expected ledger billing group report response to a valid request
default:
content:
@@ -8778,7 +9017,7 @@ paths:
tags:
- Reports
x-latency-category: background
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/ledger_billing_group_reports/{id}:
get:
@@ -8798,7 +9037,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Retrieve_Ledger_Billing_Group_Report_Response'
+ $ref: '#/components/schemas/createLedgerBillingGroupReport_200_response'
description: Expected ledger billing group report response to a valid request
default:
content:
@@ -8820,7 +9059,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -8830,7 +9069,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -8838,39 +9077,34 @@ paths:
minimum: 1
type: integer
style: form
- - description: If present, email containing the given value will be returned.
- Matching is not case-sensitive. Requires at least three characters.
+ - description: "If present, email containing the given value will be returned.\
+ \ Matching is not case-sensitive. Requires at least three characters."
explode: true
in: query
- name: filter[email][contains]
+ name: "filter[email][contains]"
required: false
schema:
default: "null"
type: string
style: form
- - description: If present, only returns results with the email
- matching exactly the value given.
+ - description: "If present, only returns results with the email\
+ \ matching exactly the value given."
explode: true
in: query
- name: filter[email][eq]
+ name: "filter[email][eq]"
required: false
schema:
default: "null"
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.email: sorts the result by the
- email field in ascending order.
- -email: sorts the result by the
- email field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.email:\
+ \ sorts the result by the\n email field in ascending order.\n\
+ \ -email: sorts the result by the\n \
+ \ email field in descending order.\n created_at in descending\
+ \ order."
explode: true
in: query
name: sort
@@ -8883,15 +9117,26 @@ paths:
example: email
type: string
style: form
+ - description: Specifies if cancelled accounts should be included in the results.
+ explode: true
+ in: query
+ name: include_cancelled_accounts
+ required: false
+ schema:
+ default: false
+ example: true
+ type: boolean
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Managed_Accounts_Response'
+ $ref: '#/components/schemas/listManagedAccounts_200_response'
description: Successful response with a list of managed accounts.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
summary: Lists accounts managed by the current user.
tags:
- Managed Accounts
@@ -8915,16 +9160,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Managed_Account_Response'
+ $ref: '#/components/schemas/createManagedAccount_200_response'
description: Successful response with information about a single managed
account.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"422":
content:
application/json:
schema:
- $ref: '#/components/schemas/Unprocessable_Managed_Account_Entity'
+ $ref: '#/components/schemas/createManagedAccount_422_response'
description: Unprocessable entity. Check the 'detail' field in response
for details.
summary: Create a new managed account.
@@ -8932,7 +9178,7 @@ paths:
- Managed Accounts
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/managed_accounts/{id}:
get:
@@ -8952,11 +9198,12 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Managed_Account_Response'
+ $ref: '#/components/schemas/createManagedAccount_200_response'
description: Successful response with information about a single managed
account.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
summary: Retrieve a managed account
@@ -8988,32 +9235,33 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Managed_Account_Response'
+ $ref: '#/components/schemas/createManagedAccount_200_response'
description: Successful response with information about a single managed
account.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
"422":
content:
application/json:
schema:
- $ref: '#/components/schemas/Unprocessable_Managed_Account_Entity'
+ $ref: '#/components/schemas/createManagedAccount_422_response'
description: Unprocessable entity. Check the 'detail' field in response
for details.
summary: Update a managed account
tags:
- Managed Accounts
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/managed_accounts/{id}/actions/disable:
post:
- description: Disables a managed account, forbidding it to use Telnyx services,
- including sending or receiving phone calls and SMS messages. Ongoing phone
- calls will not be affected. The managed account and its sub-users will still
- be able to log in via the mission control portal.
+ description: "Disables a managed account, forbidding it to use Telnyx services,\
+ \ including sending or receiving phone calls and SMS messages. Ongoing phone\
+ \ calls will not be affected. The managed account and its sub-users will still\
+ \ be able to log in via the mission control portal."
operationId: disableManagedAccount
parameters:
- description: Managed Account User ID
@@ -9029,18 +9277,19 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Managed_Account_Response'
+ $ref: '#/components/schemas/createManagedAccount_200_response'
description: Successful response with information about a single managed
account.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
"422":
content:
application/json:
schema:
- $ref: '#/components/schemas/Unprocessable_Managed_Account_Entity'
+ $ref: '#/components/schemas/createManagedAccount_422_response'
description: Unprocessable entity. Check the 'detail' field in response
for details.
summary: Disables a managed account
@@ -9066,18 +9315,19 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Managed_Account_Response'
+ $ref: '#/components/schemas/createManagedAccount_200_response'
description: Successful response with information about a single managed
account.
"401":
- description: Unauthorized
+ description: Unauthorized response. Happens when the current user is not
+ a manager account.
"404":
description: Resource not found
"422":
content:
application/json:
schema:
- $ref: '#/components/schemas/Unprocessable_Managed_Account_Entity'
+ $ref: '#/components/schemas/createManagedAccount_422_response'
description: Unprocessable entity. Check the 'detail' field in response
for details.
summary: Enables a managed account
@@ -9093,7 +9343,7 @@ paths:
- description: Filters files by given content types
explode: true
in: query
- name: filter[content_type][]
+ name: "filter[content_type][]"
required: false
schema:
example: application_xml
@@ -9148,7 +9398,7 @@ paths:
tags:
- Media Storage API
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/media/{media_name}:
delete:
@@ -9246,7 +9496,7 @@ paths:
tags:
- Media Storage API
x-latency-category: interactive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/media/{media_name}/download:
get:
@@ -9267,7 +9517,6 @@ paths:
'*/*':
schema:
format: binary
- title: Media Download Response
type: string
description: A response describing a media resource
default:
@@ -9296,15 +9545,13 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
- description: |
- Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.
-
- This endpoint allows you to send a message with any messaging resource.
- Current messaging resources include: long-code, short-code, number-pool, and
- alphanumeric-sender-id.
+ description: "Send a message with a Phone Number, Alphanumeric Sender ID, Short\
+ \ Code or Number Pool.\n\nThis endpoint allows you to send a message with\
+ \ any messaging resource.\nCurrent messaging resources include: long-code,\
+ \ short-code, number-pool, and\nalphanumeric-sender-id.\n"
operationId: createMessage
requestBody:
content:
@@ -9329,7 +9576,7 @@ paths:
tags:
- Messages
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messages/long_code:
post:
@@ -9346,8 +9593,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
operationId: createLongCodeMessage
requestBody:
@@ -9373,7 +9620,7 @@ paths:
tags:
- Messages
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messages/number_pool:
post:
@@ -9390,8 +9637,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
operationId: createNumberPoolMessage
requestBody:
@@ -9417,7 +9664,7 @@ paths:
tags:
- Messages
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messages/short_code:
post:
@@ -9434,8 +9681,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
operationId: createShortCodeMessage
requestBody:
@@ -9461,13 +9708,13 @@ paths:
tags:
- Messages
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messages/{id}:
get:
- description: 'Note: This API endpoint can only retrieve messages that are no
- older than 10 days since their creation. If you require messages older than
- this, please generate an [MDR report.](https://developers.telnyx.com/docs/api/v1/reports/MDR-Reports)'
+ description: "Note: This API endpoint can only retrieve messages that are no\
+ \ older than 10 days since their creation. If you require messages older than\
+ \ this, please generate an [MDR report.](https://developers.telnyx.com/docs/api/v1/reports/MDR-Reports)"
operationId: retrieveMessage
parameters:
- description: The id of the message
@@ -9504,7 +9751,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -9514,7 +9761,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -9568,7 +9815,7 @@ paths:
tags:
- Messaging Hosted Number
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messaging_hosted_number_orders/{id}:
get:
@@ -9644,7 +9891,7 @@ paths:
tags:
- Messaging Hosted Number
x-latency-category: responsive
- x-contentType: multipart/form-data
+ x-content-type: multipart/form-data
x-accepts: application/json
/messaging_hosted_numbers/{id}:
delete:
@@ -9683,7 +9930,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -9693,7 +9940,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -9752,7 +9999,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -9762,7 +10009,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -9804,8 +10051,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
deliveryUpdate:
'{$request.body#/webhook_url}':
@@ -9819,8 +10066,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
replacedLinkClick:
'{$request.body#/webhook_url}':
@@ -9834,8 +10081,8 @@ paths:
required: true
responses:
"200":
- description: The server must return an HTTP 200, otherwise we will
- reattempt delivery at the failover webhook URL.
+ description: "The server must return an HTTP 200, otherwise we will\
+ \ reattempt delivery at the failover webhook URL."
x-callback-request: true
operationId: createMessagingProfile
requestBody:
@@ -9863,7 +10110,7 @@ paths:
- Messaging Profiles
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messaging_profiles/{id}:
delete:
@@ -9962,7 +10209,7 @@ paths:
tags:
- Messaging Profiles
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/messaging_profiles/{id}/metrics:
get:
@@ -10020,7 +10267,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10030,7 +10277,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10074,7 +10321,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10084,7 +10331,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10128,7 +10375,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10138,7 +10385,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10165,357 +10412,20 @@ paths:
x-group-parameters: "true"
x-latency-category: responsive
x-accepts: application/json
- /mobile_applications:
- get:
- description: Retrieves all mobile applications for a user
- operationId: getAllMobileApplications
- responses:
- "200":
- content:
- application/json:
- schema:
- items:
- $ref: '#/components/schemas/MobileApplicationResponse'
- type: array
- description: Mobile application created
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Resource not found
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Retrieves mobile applications
- tags:
- - Mobile Applications
- x-latency-category: responsive
- x-accepts: application/json
- post:
- description: Creates a new mobile application which can be android or ios based
- on the `type` parameter
- operationId: addMobileApplication
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CreateMobileApplicationRequest'
- description: Mobile application parameters that need to be sent in the request
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MobileApplicationResponse'
- description: Mobile application created
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Adds a mobile application
- tags:
- - Mobile Applications
- x-latency-category: responsive
- x-contentType: application/json
- x-accepts: application/json
- /mobile_applications/{mobile_application_id}:
- delete:
- description: Deletes a mobile application based on the given `id`
- operationId: deleteMobileApplicationById
- parameters:
- - description: The unique identifier of a mobile application
- explode: false
- in: path
- name: mobile_application_id
- required: true
- schema:
- example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- format: uuid
- type: string
- style: simple
- responses:
- "204":
- description: The mobile application was deleted successfully
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Resource not found
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Deletes a mobile application
- tags:
- - Mobile Applications
- x-latency-category: responsive
- x-accepts: application/json
- get:
- description: Retrieves a mobile application based on the given `id`
- operationId: getMobileApplicationById
- parameters:
- - description: The unique identifier of a mobile application
- explode: false
- in: path
- name: mobile_application_id
- required: true
- schema:
- example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- format: uuid
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MobileApplicationResponse'
- description: Successful get mobile application response
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Resource not found
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Retrieves a given mobile application
- tags:
- - Mobile Applications
- x-latency-category: responsive
- x-accepts: application/json
- patch:
- description: Updates a mobile application based on the given `id`
- operationId: updateMobileApplicationById
- parameters:
- - description: The unique identifier of a mobile application
- explode: false
- in: path
- name: mobile_application_id
- required: true
- schema:
- example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- format: uuid
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CreateMobileApplicationRequest'
- description: Mobile application parameters that need to be sent in the request
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MobileApplicationResponse'
- description: The modile application was updated successfully
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Resource not found
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Updates a mobile application
- tags:
- - Mobile Applications
- x-latency-category: responsive
- x-contentType: application/json
- x-accepts: application/json
- /mobile_applications/{mobile_application_id}/push_credentials:
- get:
- description: Retrieves push credentials for a given mobile application based
- on filters for a user
- operationId: getPushCredentials
- parameters:
- - description: The unique identifier of a mobile application
- explode: false
- in: path
- name: mobile_application_id
- required: true
- schema:
- example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- format: uuid
- type: string
- style: simple
- - description: ISO 8601 date for filtering credentials created on that date
- explode: true
- in: query
- name: filter[created_at][eq]
- required: false
- schema:
- example: 2021-04-25
- format: date
- type: string
- style: form
- - description: ISO 8601 date for filtering credentials created after that date
- explode: true
- in: query
- name: filter[created_at][gte]
- required: false
- schema:
- example: 2021-04-25
- format: date
- type: string
- style: form
- - description: ISO 8601 date for filtering credentials created before that date
- explode: true
- in: query
- name: filter[created_at][lte]
- required: false
- schema:
- example: 2021-04-25
- format: date
- type: string
- style: form
- - description: Unique push credential alias
- explode: true
- in: query
- name: filter[alias]
- required: false
- schema:
- example: LucyCredential
- type: string
- style: form
- responses:
- "200":
- content:
- application/json:
- schema:
- items:
- $ref: '#/components/schemas/PushCredentialResponse'
- type: array
- description: Mobile application created
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Retrieves push credentials associated to a mobile application
- tags:
- - Push Credentials
- x-latency-category: responsive
- x-accepts: application/json
- post:
- description: Creates a new credential for a given mobile application
- operationId: addPushCredential
- parameters:
- - description: The unique identifier of a mobile application
- explode: false
- in: path
- name: mobile_application_id
- required: true
- schema:
- example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- format: uuid
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- oneOf:
- - $ref: '#/components/schemas/CreateIosPushCredentialRequest'
- - $ref: '#/components/schemas/CreateAndroidPushCredentialRequest'
- description: Push credential parameters that need to be sent in the request
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PushCredentialResponse'
- description: Push credential created
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unauthorized request
- "422":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Errors'
- description: Unable to process request
- summary: Adds push credential to a given mobile application
- tags:
- - Mobile Applications
- x-latency-category: responsive
- x-contentType: application/json
- x-accepts: application/json
/mobile_operator_networks:
get:
- description: Telnyx has a set of GSM mobile operators partners that are available
- through our mobile network roaming. This resource is entirely managed by Telnyx
- and may change over time. That means that this resource won't allow any write
- operations for it. Still, it's available so it can be used as a support resource
- that can be related to other resources or become a configuration option.
+ description: "Telnyx has a set of GSM mobile operators partners that are available\
+ \ through our mobile network roaming. This resource is entirely managed by\
+ \ Telnyx and may change over time. That means that this resource won't allow\
+ \ any write operations for it. Still, it's available so it can be used as\
+ \ a support resource that can be related to other resources or become a configuration\
+ \ option."
operationId: MobileOperatorNetworksGet
parameters:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10525,7 +10435,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10536,7 +10446,7 @@ paths:
- description: Filter by name starting with.
explode: true
in: query
- name: filter[name][starts_with]
+ name: "filter[name][starts_with]"
required: false
schema:
example: AT
@@ -10545,7 +10455,7 @@ paths:
- description: Filter by name containing match.
explode: true
in: query
- name: filter[name][contains]
+ name: "filter[name][contains]"
required: false
schema:
example: T&T
@@ -10554,7 +10464,7 @@ paths:
- description: Filter by name ending with.
explode: true
in: query
- name: filter[name][ends_with]
+ name: "filter[name][ends_with]"
required: false
schema:
example: T
@@ -10563,7 +10473,7 @@ paths:
- description: Filter by exact country_code.
explode: true
in: query
- name: filter[country_code]
+ name: "filter[country_code]"
required: false
schema:
example: US
@@ -10572,7 +10482,7 @@ paths:
- description: Filter by exact MCC.
explode: true
in: query
- name: filter[mcc]
+ name: "filter[mcc]"
required: false
schema:
example: "310"
@@ -10581,7 +10491,7 @@ paths:
- description: Filter by exact MNC.
explode: true
in: query
- name: filter[mnc]
+ name: "filter[mnc]"
required: false
schema:
example: "410"
@@ -10590,7 +10500,7 @@ paths:
- description: Filter by exact TADIG.
explode: true
in: query
- name: filter[tadig]
+ name: "filter[tadig]"
required: false
schema:
example: USACG
@@ -10601,7 +10511,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Search_Mobile_Operator_Networks_Response'
+ $ref: '#/components/schemas/MobileOperatorNetworksGet_200_response'
description: Successful response
default:
content:
@@ -10614,6 +10524,465 @@ paths:
- Mobile Operator Networks
x-latency-category: responsive
x-accepts: application/json
+ /mobile_push_credentials:
+ get:
+ description: List mobile push credentials
+ operationId: listPushCredentials
+ parameters:
+ - description: type of mobile push credentials
+ explode: true
+ in: query
+ name: "filter[type]"
+ required: false
+ schema:
+ enum:
+ - ios
+ - android
+ example: ios
+ type: string
+ style: form
+ - description: Unique mobile push credential alias
+ explode: true
+ in: query
+ name: "filter[alias]"
+ required: false
+ schema:
+ example: LucyCredential
+ type: string
+ style: form
+ - description: The size of the page
+ explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ default: 20
+ maximum: 250
+ minimum: 1
+ type: integer
+ style: form
+ - description: The page number to load
+ explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ default: 1
+ minimum: 1
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListPushCredentialsResponse'
+ description: Mobile mobile push credentials
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unauthorized request
+ summary: List mobile push credentials
+ tags:
+ - Push Credentials
+ x-latency-category: responsive
+ x-accepts: application/json
+ post:
+ description: Creates a new mobile push credential
+ operationId: createPushCredential
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/createPushCredential_request'
+ description: Mobile push credential parameters that need to be sent in the
+ request
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/PushCredentialResponse'
+ description: Mobile push credential created
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unauthorized request
+ "422":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unable to process request
+ summary: Creates a new mobile push credential
+ tags:
+ - Push Credentials
+ x-latency-category: responsive
+ x-content-type: application/json
+ x-accepts: application/json
+ /mobile_push_credentials/{push_credential_id}:
+ delete:
+ description: Deletes a mobile push credential based on the given `push_credential_id`
+ operationId: deletePushCredentialById
+ parameters:
+ - description: The unique identifier of a mobile push credential
+ explode: false
+ in: path
+ name: push_credential_id
+ required: true
+ schema:
+ example: 0ccc7b76-4df3-4bca-a05a-3da1ecc389f0
+ format: uuid
+ type: string
+ style: simple
+ responses:
+ "204":
+ description: The mobile push credential was deleted successfully
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unauthorized request
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Resource not found
+ "422":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unable to process request
+ summary: Deletes a mobile push credential
+ tags:
+ - Push Credentials
+ x-latency-category: responsive
+ x-accepts: application/json
+ get:
+ description: Retrieves mobile push credential based on the given `push_credential_id`
+ operationId: getPushCredentialById
+ parameters:
+ - description: The unique identifier of a mobile push credential
+ explode: false
+ in: path
+ name: push_credential_id
+ required: true
+ schema:
+ example: 0ccc7b76-4df3-4bca-a05a-3da1ecc389f0
+ format: uuid
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/PushCredentialResponse'
+ description: Successful get mobile push credential response
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unauthorized request
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Resource not found
+ "422":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unable to process request
+ summary: Retrieves a mobile push credential
+ tags:
+ - Push Credentials
+ x-latency-category: responsive
+ x-accepts: application/json
+ /networks:
+ get:
+ description: List all Networks.
+ operationId: NetworkList
+ parameters:
+ - description: The page number to load
+ explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ default: 1
+ minimum: 1
+ type: integer
+ style: form
+ - description: The size of the page
+ explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ default: 20
+ maximum: 250
+ minimum: 1
+ type: integer
+ style: form
+ - description: The network name to filter on.
+ explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ example: test network
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkList_200_response'
+ description: Successful response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: List all Networks
+ tags:
+ - Networks
+ x-latency-category: responsive
+ x-accepts: application/json
+ post:
+ description: Create a new Network.
+ operationId: NetworkCreate
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkCreate'
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkCreate_200_response'
+ description: Successful response
+ "422":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unprocessable entity. Check the 'detail' field in response
+ for details.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Create a Network
+ tags:
+ - Networks
+ x-latency-category: responsive
+ x-content-type: application/json
+ x-accepts: application/json
+ /networks/{id}:
+ delete:
+ description: Delete a Network.
+ operationId: NetworkDelete
+ parameters:
+ - description: Identifies the resource.
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
+ format: uuid
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkCreate_200_response'
+ description: Successful response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Delete a Network
+ tags:
+ - Networks
+ x-latency-category: responsive
+ x-accepts: application/json
+ get:
+ description: Retrieve a Network.
+ operationId: NetworkGet
+ parameters:
+ - description: Identifies the resource.
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
+ format: uuid
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkCreate_200_response'
+ description: Successful response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Retrieve a Network
+ tags:
+ - Networks
+ x-latency-category: responsive
+ x-accepts: application/json
+ patch:
+ description: Update a Network.
+ operationId: NetworkUpdate
+ parameters:
+ - description: Identifies the resource.
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
+ format: uuid
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkCreate'
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkCreate_200_response'
+ description: Successful response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: Update a Network
+ tags:
+ - Networks
+ x-latency-category: responsive
+ x-content-type: application/json
+ x-accepts: application/json
+ /networks/{id}/network_interfaces:
+ get:
+ description: List all Interfaces for a Network.
+ operationId: NetworkInterfaceList
+ parameters:
+ - description: Identifies the resource.
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
+ format: uuid
+ type: string
+ style: simple
+ - description: The page number to load
+ explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ default: 1
+ minimum: 1
+ type: integer
+ style: form
+ - description: The size of the page
+ explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ default: 20
+ maximum: 250
+ minimum: 1
+ type: integer
+ style: form
+ - description: The interface name to filter on.
+ explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ example: test interface
+ type: string
+ style: form
+ - description: The interface type to filter on.
+ explode: true
+ in: query
+ name: "filter[type]"
+ required: false
+ schema:
+ example: wireguard_interface
+ type: string
+ style: form
+ - description: The interface status to filter on.
+ explode: true
+ in: query
+ name: "filter[status]"
+ required: false
+ schema:
+ $ref: '#/components/schemas/InterfaceStatus'
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetworkInterfaceList_200_response'
+ description: Successful response
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Errors'
+ description: Unexpected error
+ summary: List all Interfaces for a Network.
+ tags:
+ - Networks
+ x-latency-category: responsive
+ x-accepts: application/json
/notification_channels:
get:
description: List notification channels.
@@ -10622,7 +10991,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10632,7 +11001,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10643,7 +11012,7 @@ paths:
- description: Filter by the id of a channel type
explode: true
in: query
- name: filter[channel_type_id][eq]
+ name: "filter[channel_type_id][eq]"
required: false
schema:
enum:
@@ -10659,7 +11028,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Notification_Channels'
+ $ref: '#/components/schemas/listNotificationChannels_200_response'
description: Returns a list of notification channels.
default:
content:
@@ -10686,7 +11055,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Notification_Channel'
+ $ref: '#/components/schemas/createNotificationChannels_200_response'
description: A Notification Channel response
default:
content:
@@ -10698,20 +11067,19 @@ paths:
tags:
- Notifications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/notification_channels/{id}:
delete:
description: Delete a notification channel.
operationId: deleteNotificationChannel
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -10720,7 +11088,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Delete_Notification_Channel'
+ $ref: '#/components/schemas/createNotificationChannels_200_response'
description: A Notification Channel response
default:
content:
@@ -10737,13 +11105,12 @@ paths:
description: Retrieve a notification channel.
operationId: retrieveNotificationChannel
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -10752,7 +11119,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Retrieve_Notification_Channel'
+ $ref: '#/components/schemas/createNotificationChannels_200_response'
description: A Notification Channel response
default:
content:
@@ -10769,13 +11136,12 @@ paths:
description: Update a notification channel.
operationId: updateNotificationChannel
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -10791,7 +11157,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Update_Notification_Channel'
+ $ref: '#/components/schemas/createNotificationChannels_200_response'
description: A Notification Channel response
default:
content:
@@ -10803,7 +11169,7 @@ paths:
tags:
- Notifications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/notification_event_conditions:
get:
@@ -10813,7 +11179,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10823,7 +11189,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10834,7 +11200,7 @@ paths:
- description: Filter by the associated record type
explode: true
in: query
- name: filter[associated_record_type][eq]
+ name: "filter[associated_record_type][eq]"
required: false
schema:
enum:
@@ -10848,7 +11214,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Notification_Even_Conditions'
+ $ref: '#/components/schemas/findNotificationsEventsConditions_200_response'
description: Returns a list of notification event conditions available.
default:
content:
@@ -10869,7 +11235,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10879,7 +11245,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10892,7 +11258,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Notification_Events'
+ $ref: '#/components/schemas/findNotificationsEvents_200_response'
description: Returns a list of notification events available.
default:
content:
@@ -10913,7 +11279,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -10923,7 +11289,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -10936,7 +11302,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Notification_Profiles'
+ $ref: '#/components/schemas/findNotificationsProfiles_200_response'
description: Returns a list of notification profiles.
default:
content:
@@ -10963,7 +11329,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Notification_Profile'
+ $ref: '#/components/schemas/createNotificationProfile_200_response'
description: A Notification Profile response
default:
content:
@@ -10975,20 +11341,19 @@ paths:
tags:
- Notifications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/notification_profiles/{id}:
delete:
description: Delete a notification profile.
operationId: deleteNotificationProfile
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -10997,7 +11362,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Delete_Notification_Profiles'
+ $ref: '#/components/schemas/createNotificationProfile_200_response'
description: A Notification Profile response
default:
content:
@@ -11014,13 +11379,12 @@ paths:
description: Retrieve a notification profile.
operationId: retrieveNotificationProfile
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -11029,7 +11393,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Retrieve_Notification_Profile'
+ $ref: '#/components/schemas/createNotificationProfile_200_response'
description: A Notification Profile response
default:
content:
@@ -11046,13 +11410,12 @@ paths:
description: Update a notification profile.
operationId: updateNotificationProfile
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -11068,7 +11431,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Update_Notification_Profile'
+ $ref: '#/components/schemas/createNotificationProfile_200_response'
description: A Notification Profile response
default:
content:
@@ -11080,7 +11443,7 @@ paths:
tags:
- Notifications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/notification_settings:
get:
@@ -11090,7 +11453,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -11100,7 +11463,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -11111,7 +11474,7 @@ paths:
- description: Filter by the id of a notification profile
explode: true
in: query
- name: filter[notification_profile_id][eq]
+ name: "filter[notification_profile_id][eq]"
required: false
schema:
example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
@@ -11120,7 +11483,7 @@ paths:
- description: Filter by the id of a notification channel
explode: true
in: query
- name: filter[notification_channel][eq]
+ name: "filter[notification_channel][eq]"
required: false
schema:
example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
@@ -11129,7 +11492,7 @@ paths:
- description: Filter by the id of a notification channel
explode: true
in: query
- name: filter[notification_event_condition_id][eq]
+ name: "filter[notification_event_condition_id][eq]"
required: false
schema:
example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
@@ -11138,7 +11501,7 @@ paths:
- description: Filter by the associated record type
explode: true
in: query
- name: filter[associated_record_type][eq]
+ name: "filter[associated_record_type][eq]"
required: false
schema:
enum:
@@ -11150,7 +11513,7 @@ paths:
- description: The status of a notification setting
explode: true
in: query
- name: filter[status][eq]
+ name: "filter[status][eq]"
required: false
schema:
enum:
@@ -11170,7 +11533,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/List_Notification_Settings'
+ $ref: '#/components/schemas/listNotificationSettings_200_response'
description: Returns a list of notification settings.
default:
content:
@@ -11196,13 +11559,13 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Notification_Setting'
+ $ref: '#/components/schemas/createNotificationSetting_200_response'
description: A Notification Setting response
"201":
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Notification_Setting_Async'
+ $ref: '#/components/schemas/createNotificationSetting_200_response'
description: A Notification Setting response - async
default:
content:
@@ -11214,20 +11577,19 @@ paths:
tags:
- Notifications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/notification_settings/{id}:
delete:
description: Delete a notification setting.
operationId: deleteNotificationSetting
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -11236,13 +11598,13 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Delete_Notification_Setting'
+ $ref: '#/components/schemas/createNotificationSetting_200_response'
description: A Notification Setting response
"201":
content:
application/json:
schema:
- $ref: '#/components/schemas/Delete_Notification_Setting_Async'
+ $ref: '#/components/schemas/createNotificationSetting_200_response'
description: A Notification Setting response - async
default:
content:
@@ -11259,13 +11621,12 @@ paths:
description: Retrieve a notification setting.
operationId: retrieveNotificationSetting
parameters:
- - description: Identifies the resource.
+ - description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
@@ -11274,7 +11635,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Retrieve_Notification_Setting'
+ $ref: '#/components/schemas/createNotificationSetting_200_response'
description: A Notification Setting response
default:
content:
@@ -11295,7 +11656,7 @@ paths:
- description: Filter number block orders by status.
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
example: pending
@@ -11304,7 +11665,7 @@ paths:
- description: Filter number block orders later than this value.
explode: true
in: query
- name: filter[created_at][gt]
+ name: "filter[created_at][gt]"
required: false
schema:
example: 2018-01-01T00:00:00.000000Z
@@ -11313,7 +11674,7 @@ paths:
- description: Filter number block orders earlier than this value.
explode: true
in: query
- name: filter[created_at][lt]
+ name: "filter[created_at][lt]"
required: false
schema:
example: 2018-01-01T00:00:00.000000Z
@@ -11322,7 +11683,7 @@ paths:
- description: Filter number block orders having these phone numbers.
explode: true
in: query
- name: filter[phone_numbers.starting_number]
+ name: "filter[phone_numbers.starting_number]"
required: false
schema:
example: +19705555000
@@ -11331,7 +11692,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -11341,7 +11702,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -11381,8 +11742,8 @@ paths:
required: true
responses:
"200":
- description: The server must return a HTTP 200, otherwise we will
- reattempt to deliver the webhook to the failover URL.
+ description: "The server must return a HTTP 200, otherwise we will\
+ \ reattempt to deliver the webhook to the failover URL."
x-callback-request: true
description: Creates a phone number block order.
operationId: createNumberBlockOrder
@@ -11409,7 +11770,7 @@ paths:
tags:
- Number Block Orders
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_block_orders/{number_block_order_id}:
get:
@@ -11500,7 +11861,7 @@ paths:
- description: Filter number order documents by `requirement_id`.
explode: true
in: query
- name: filter[requirement_id]
+ name: "filter[requirement_id]"
required: false
schema:
type: string
@@ -11508,7 +11869,7 @@ paths:
- description: Filter number order documents after this datetime.
explode: true
in: query
- name: filter[created_at][gt]
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
@@ -11516,7 +11877,7 @@ paths:
- description: Filter number order documents from before this datetime.
explode: true
in: query
- name: filter[created_at][lt]
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
@@ -11524,7 +11885,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -11534,7 +11895,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -11587,7 +11948,7 @@ paths:
tags:
- Number Order Documents
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_order_documents/{number_order_document_id}:
get:
@@ -11655,7 +12016,7 @@ paths:
tags:
- Number Order Documents
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_order_phone_numbers:
get:
@@ -11747,7 +12108,7 @@ paths:
tags:
- Number Orders
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_orders:
get:
@@ -11757,7 +12118,7 @@ paths:
- description: Filter number orders by status.
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
type: string
@@ -11765,7 +12126,7 @@ paths:
- description: Filter number orders later than this value.
explode: true
in: query
- name: filter[created_at][gt]
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
@@ -11773,7 +12134,7 @@ paths:
- description: Filter number orders earlier than this value.
explode: true
in: query
- name: filter[created_at][lt]
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
@@ -11781,7 +12142,7 @@ paths:
- description: Filter number order with this amount of numbers
explode: true
in: query
- name: filter[phone_numbers_count]
+ name: "filter[phone_numbers_count]"
required: false
schema:
type: string
@@ -11789,7 +12150,7 @@ paths:
- description: Filter number orders via the customer reference set.
explode: true
in: query
- name: filter[customer_reference]
+ name: "filter[customer_reference]"
required: false
schema:
type: string
@@ -11797,7 +12158,7 @@ paths:
- description: Filter number orders by requirements met.
explode: true
in: query
- name: filter[requirements_met]
+ name: "filter[requirements_met]"
required: false
schema:
type: boolean
@@ -11805,7 +12166,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -11815,7 +12176,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -11857,8 +12218,8 @@ paths:
required: true
responses:
"200":
- description: The server must return a HTTP 200, otherwise we will
- reattempt to deliver the webhook to the failover URL.
+ description: "The server must return a HTTP 200, otherwise we will\
+ \ reattempt to deliver the webhook to the failover URL."
x-callback-request: true
description: Creates a phone number order.
operationId: createNumberOrder
@@ -11886,7 +12247,7 @@ paths:
- Number Orders
x-endpoint-cost: heavy
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_orders/{number_order_id}:
get:
@@ -11954,7 +12315,7 @@ paths:
tags:
- Number Orders
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_reservations:
get:
@@ -11964,7 +12325,7 @@ paths:
- description: Filter number reservations by status.
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
type: string
@@ -11972,7 +12333,7 @@ paths:
- description: Filter number reservations later than this value.
explode: true
in: query
- name: filter[created_at][gt]
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
@@ -11980,7 +12341,7 @@ paths:
- description: Filter number reservations earlier than this value.
explode: true
in: query
- name: filter[created_at][lt]
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
@@ -11988,7 +12349,7 @@ paths:
- description: Filter number reservations having these phone numbers.
explode: true
in: query
- name: filter[phone_numbers.phone_number]
+ name: "filter[phone_numbers.phone_number]"
required: false
schema:
type: string
@@ -11996,7 +12357,7 @@ paths:
- description: Filter number reservations via the customer reference set.
explode: true
in: query
- name: filter[customer_reference]
+ name: "filter[customer_reference]"
required: false
schema:
type: string
@@ -12004,7 +12365,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -12014,7 +12375,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -12067,7 +12428,7 @@ paths:
tags:
- Number Reservations
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/number_reservations/{number_reservation_id}:
get:
@@ -12138,7 +12499,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -12148,7 +12509,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -12159,7 +12520,7 @@ paths:
- description: Filter by a specific status of the resource's lifecycle.
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -12172,7 +12533,7 @@ paths:
- description: The SIM card identification UUID.
explode: true
in: query
- name: filter[sim_card_id]
+ name: "filter[sim_card_id]"
required: false
schema:
type: string
@@ -12180,7 +12541,7 @@ paths:
- description: Filter by type.
explode: true
in: query
- name: filter[type]
+ name: "filter[type]"
required: false
schema:
enum:
@@ -12193,7 +12554,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Search_OTA_Update_Response'
+ $ref: '#/components/schemas/OTAUpdatesList_200_response'
description: Successful response
default:
content:
@@ -12226,7 +12587,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/OTA_Update_Response'
+ $ref: '#/components/schemas/OTAUpdateGET_200_response'
description: Successful response
default:
content:
@@ -12248,7 +12609,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -12258,7 +12619,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -12269,25 +12630,18 @@ paths:
- description: Optional filter on outbound voice profile name.
explode: true
in: query
- name: filter[name][contains]
+ name: "filter[name][contains]"
required: false
schema:
example: office-profile
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.name: sorts the result by the
- name field in ascending order.
- -name: sorts the result by the
- name field in descending order.
- -\
+ \ prefix.name: sorts\
+ \ the result by the\n name field in ascending order.\n \
+ \ -name: sorts the result by the\n \
+ \ name field in descending order.\n tags they will be found.['customers', 'staff', 'test']
- ['test']['customers']['customers', 'test'] returns only the first because it's the only one with both tags.test returns the first two SIMs, because both of them have such tag.customers returns the first and last SIMs.tags they will\
+ \ be found.['customers', 'staff', 'test']\n ['test']['customers']['customers',\
+ \ 'test'] returns only the first because it's the only one with both\
+ \ tags.test returns the first two SIMs,\
+ \ because both of them have such tag.customers\
+ \ returns the first and last SIMs.disabling.disabling.friendly_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ - description: "If present, applications with friendly_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[friendly_name][contains]
+ name: "filter[friendly_name][contains]"
required: false
schema:
default: "null"
@@ -20319,26 +20971,21 @@ paths:
- description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- - description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ - description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -20396,7 +21043,7 @@ paths:
- TeXML Applications
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/texml_applications/{id}:
delete:
@@ -20501,7 +21148,7 @@ paths:
tags:
- TeXML Applications
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/by_phone_number/{phone_number}:
get:
@@ -20569,12 +21216,13 @@ paths:
schema:
$ref: '#/components/schemas/Errors'
description: Unexpected error
- summary: 'Submit a verification code. Deprecation notice: `verify_profile_id''
- is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.'
+ summary: "Submit a verification code. Deprecation notice: `verify_profile_id'\
+ \ is now a mandatory field. The sunset date for this change is 2022-04-02\
+ \ 00:00:00."
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/call:
post:
@@ -20602,7 +21250,7 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/flashcall:
post:
@@ -20630,7 +21278,7 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/psd2:
post:
@@ -20658,7 +21306,7 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/sms:
post:
@@ -20686,7 +21334,7 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/whatsapp:
post:
@@ -20714,7 +21362,7 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verifications/{verification_id}:
get:
@@ -20755,7 +21403,7 @@ paths:
- description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -20765,7 +21413,7 @@ paths:
- description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -20822,7 +21470,7 @@ paths:
x-group-parameters: "true"
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verified_calls_display_profiles/{id}:
delete:
@@ -20892,13 +21540,13 @@ paths:
x-latency-category: responsive
x-accepts: application/json
patch:
- description: 'Update an existing Verified Calls Display Profile and allows adding/removing
- nested Call Reasons and Phone Numbers. Different attributes can be updated
- depending on the Verified Calls Display Profile''s status: For the VERIFICATION_STATE_PENDING
- status, no fields can be updated. For the VERIFICATION_STATE_VERIFIED status,
- it is allowed only to add/remove Call Reaons and Phone Numbers. For the other
- statuses, all fields can be updated. All existing Call Reasons and Phone Numbers
- must be sent during the request, or the update will fail.'
+ description: "Update an existing Verified Calls Display Profile and allows adding/removing\
+ \ nested Call Reasons and Phone Numbers. Different attributes can be updated\
+ \ depending on the Verified Calls Display Profile's status: For the VERIFICATION_STATE_PENDING\
+ \ status, no fields can be updated. For the VERIFICATION_STATE_VERIFIED status,\
+ \ it is allowed only to add/remove Call Reaons and Phone Numbers. For the\
+ \ other statuses, all fields can be updated. All existing Call Reasons and\
+ \ Phone Numbers must be sent during the request, or the update will fail."
operationId: updateVerifiedCallsDisplayProfile
parameters:
- description: Identifies the Verified Calls Display Profile
@@ -20930,7 +21578,7 @@ paths:
x-group-parameters: "true"
x-endpoint-cost: medium
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verified_calls_display_profiles/{id}/verification_request:
post:
@@ -20966,29 +21614,29 @@ paths:
parameters:
- explode: true
in: query
- name: filter[name]
+ name: "filter[name]"
required: false
schema:
description: Optional filter for profile names.
- title: filter[name]
+ title: "filter[name]"
type: string
style: form
- explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 25
- title: page[size]
+ title: "page[size]"
type: integer
style: form
- explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
- title: page[number]
+ title: "page[number]"
type: integer
style: form
responses:
@@ -21014,37 +21662,10 @@ paths:
description: Creates a new Verify profile to associate verifications with.
operationId: createVerifyProfile
requestBody:
- $ref: '#/components/requestBodies/Create_Verify_Profile_Request'
content:
application/json:
schema:
- properties:
- name:
- example: Test Profile
- type: string
- webhook_url:
- example: http://example.com/webhook
- type: string
- webhook_failover_url:
- example: http://example.com/webhook/failover
- type: string
- sms:
- $ref: '#/components/schemas/CreateVerifyProfileSMSRequest'
- psd2:
- $ref: '#/components/schemas/CreateVerifyProfilePSD2Request'
- whatsapp:
- $ref: '#/components/schemas/CreateVerifyProfileWhatsappRequest'
- call:
- $ref: '#/components/schemas/CreateVerifyProfileCallRequest'
- flashcall:
- $ref: '#/components/schemas/CreateVerifyProfileFlashcallRequest'
- language:
- example: en-US
- type: string
- required:
- - name
- title: Create Verify Profile Request
- type: object
+ $ref: '#/components/schemas/Create_Verify_Profile_Request'
required: true
responses:
"200":
@@ -21063,7 +21684,7 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
x-accepts: application/json
/verify_profiles/{verify_profile_id}:
delete:
@@ -21143,35 +21764,10 @@ paths:
type: string
style: simple
requestBody:
- $ref: '#/components/requestBodies/Update_Verify_Profile_Request'
content:
application/json:
schema:
- properties:
- name:
- example: Test Profile
- type: string
- webhook_url:
- example: http://example.com/webhook
- type: string
- webhook_failover_url:
- example: http://example.com/webhook/failover
- type: string
- sms:
- $ref: '#/components/schemas/UpdateVerifyProfileSMSRequest'
- psd2:
- $ref: '#/components/schemas/UpdateVerifyProfilePSD2Request'
- whatsapp:
- $ref: '#/components/schemas/UpdateVerifyProfileWhatsappRequest'
- call:
- $ref: '#/components/schemas/UpdateVerifyProfileCallRequest'
- flashcall:
- $ref: '#/components/schemas/UpdateVerifyProfileFlashcallRequest'
- language:
- example: en-US
- type: string
- title: Update Verify Profile Request
- type: object
+ $ref: '#/components/schemas/Update_Verify_Profile_Request'
required: true
responses:
"200":
@@ -21190,7 +21786,355 @@ paths:
tags:
- Verify
x-latency-category: responsive
- x-contentType: application/json
+ x-content-type: application/json
+ x-accepts: application/json
+ /virtual_cross_connect_regions:
+ get:
+ description: List all Virtual Cross Connects Cloud Regions.address_book
- flag set to the given value.
- explode: true
- in: query
- name: filter[address_book][eq]
- required: false
- schema:
- default: "null"
- type: string
- style: form
FilterAddressByAdministrativeArea:
description: Filter by state or province where the address is located.
explode: true
in: query
- name: filter[address.administrative_area]
+ name: "filter[address.administrative_area]"
required: false
schema:
example: IL
@@ -22464,7 +24215,7 @@ components:
origin country code.
explode: true
in: query
- name: filter[address.country_code]
+ name: "filter[address.country_code]"
required: false
schema:
example: US
@@ -22475,7 +24226,7 @@ components:
address information.
explode: true
in: query
- name: filter[address.extended_address]
+ name: "filter[address.extended_address]"
required: false
schema:
example: Suite 504
@@ -22485,7 +24236,7 @@ components:
description: Uniquely identifies the address for the order.
explode: true
in: query
- name: filter[address.id]
+ name: "filter[address.id]"
required: false
schema:
example: "1293384261075731499"
@@ -22496,7 +24247,7 @@ components:
description: Filter by the name of the city where the address is located.
explode: true
in: query
- name: filter[address.locality]
+ name: "filter[address.locality]"
required: false
schema:
example: Chicago
@@ -22506,7 +24257,7 @@ components:
description: Filter by postal code for the address.
explode: true
in: query
- name: filter[address.postal_code]
+ name: "filter[address.postal_code]"
required: false
schema:
example: "60654"
@@ -22517,19 +24268,19 @@ components:
is located.
explode: true
in: query
- name: filter[address.street_address]
+ name: "filter[address.street_address]"
required: false
schema:
example: 311 W Superior St
type: string
style: form
FilterApplicationName:
- description: If present, applications with application_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ description: "If present, applications with application_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[application_name][contains]
+ name: "filter[application_name][contains]"
required: false
schema:
default: "null"
@@ -22539,7 +24290,7 @@ components:
description: Filter by a specific status of the resource's lifecycle.
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -22549,11 +24300,22 @@ components:
example: in-progress
type: string
style: form
+ FilterBulkSIMCardActionId:
+ description: Filter by a bulk SIM card action ID.
+ explode: true
+ in: query
+ name: "filter[bulk_sim_card_action_id]"
+ required: false
+ schema:
+ example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
+ format: uuid
+ type: string
+ style: form
FilterByPhoneNumber:
description: Filter results by phone number
explode: true
in: query
- name: filter[phone_number]
+ name: "filter[phone_number]"
required: false
schema:
example: +12003151212
@@ -22563,7 +24325,7 @@ components:
description: Filter results by a list of phone numbers
explode: true
in: query
- name: filter[phone_number][in][]
+ name: "filter[phone_number][in][]"
required: false
schema:
items:
@@ -22575,7 +24337,7 @@ components:
description: Filter results by portability status
explode: true
in: query
- name: filter[portability_status]
+ name: "filter[portability_status]"
required: false
schema:
$ref: '#/components/schemas/PortabilityStatus'
@@ -22584,7 +24346,7 @@ components:
description: Filter results by activation status
explode: true
in: query
- name: filter[activation_status]
+ name: "filter[activation_status]"
required: false
schema:
$ref: '#/components/schemas/PortingOrderActivationStatus'
@@ -22593,7 +24355,7 @@ components:
description: Filter results by porting order id
explode: true
in: query
- name: filter[porting_order_id]
+ name: "filter[porting_order_id]"
required: false
schema:
example: f3575e15-32ce-400e-a4c0-dd78800c20b0
@@ -22604,7 +24366,7 @@ components:
description: Filter results by a list of porting order ids
explode: true
in: query
- name: filter[porting_order_id][in][]
+ name: "filter[porting_order_id][in][]"
required: false
schema:
items:
@@ -22617,7 +24379,7 @@ components:
description: Filter results by status
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -22636,7 +24398,7 @@ components:
description: Filter results by support key
explode: true
in: query
- name: filter[support_key][eq]
+ name: "filter[support_key][eq]"
required: false
schema:
example: sr_a12345
@@ -22646,7 +24408,7 @@ components:
description: Filter results by a list of support keys
explode: true
in: query
- name: filter[support_key][in][]
+ name: "filter[support_key][in][]"
required: false
schema:
items:
@@ -22658,7 +24420,7 @@ components:
description: Event status
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -22668,50 +24430,50 @@ components:
type: string
style: form
FilterCallEventTimestampEqualTo:
- description: 'Event timestamp: equal'
+ description: "Event timestamp: equal"
explode: true
in: query
- name: filter[event_timestamp][eq]
+ name: "filter[event_timestamp][eq]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
FilterCallEventTimestampGreaterThan:
- description: 'Event timestamp: greater than'
+ description: "Event timestamp: greater than"
explode: true
in: query
- name: filter[event_timestamp][gt]
+ name: "filter[event_timestamp][gt]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
FilterCallEventTimestampGreaterThanOrEqualTo:
- description: 'Event timestamp: greater than or equal'
+ description: "Event timestamp: greater than or equal"
explode: true
in: query
- name: filter[event_timestamp][gte]
+ name: "filter[event_timestamp][gte]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
FilterCallEventTimestampLessThan:
- description: 'Event timestamp: lower than'
+ description: "Event timestamp: lower than"
explode: true
in: query
- name: filter[event_timestamp][lt]
+ name: "filter[event_timestamp][lt]"
required: false
schema:
example: 2019-03-29T11:10:00Z
type: string
style: form
FilterCallEventTimestampLessThanOrEqualTo:
- description: 'Event timestamp: lower than or equal'
+ description: "Event timestamp: lower than or equal"
explode: true
in: query
- name: filter[event_timestamp][lte]
+ name: "filter[event_timestamp][lte]"
required: false
schema:
example: 2019-03-29T11:10:00Z
@@ -22721,7 +24483,7 @@ components:
description: Event type
explode: true
in: query
- name: filter[type]
+ name: "filter[type]"
required: false
schema:
enum:
@@ -22734,7 +24496,7 @@ components:
description: The unique identifier of an individual call leg.
explode: true
in: query
- name: filter[call_leg_id]
+ name: "filter[call_leg_id]"
required: false
schema:
format: uuid
@@ -22745,27 +24507,27 @@ components:
include multiple call leg events.
explode: true
in: query
- name: filter[call_session_id]
+ name: "filter[call_session_id]"
required: false
schema:
format: uuid
type: string
style: form
FilterConferenceName:
- description: If present, conferences will be filtered to those with a matching
- `name` attribute. Matching is case-sensitive
+ description: "If present, conferences will be filtered to those with a matching\
+ \ `name` attribute. Matching is case-sensitive"
explode: true
in: query
- name: filter[name]
+ name: "filter[name]"
required: false
schema:
type: string
style: form
FilterConferenceStatus:
- description: If present, conferences will be filtered by status.
+ description: "If present, conferences will be filtered by status."
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
enum:
@@ -22775,22 +24537,21 @@ components:
type: string
style: form
FilterConnectionName:
- description: If present, connections with connection_name containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
+ description: "If present, connections with connection_name containing\
+ \ the given value will be returned. Matching is not case-sensitive. Requires\
+ \ at least three characters."
explode: true
in: query
- name: filter[connection_name][contains]
+ name: "filter[connection_name][contains]"
required: false
schema:
- default: "null"
type: string
style: form
FilterCostByAmount:
description: The total monetary amount of the order.
explode: true
in: query
- name: filter[cost.amount]
+ name: "filter[cost.amount]"
required: false
schema:
example: "2.53"
@@ -22800,7 +24561,7 @@ components:
description: Filter by ISO 4217 currency string.
explode: true
in: query
- name: filter[cost.currency]
+ name: "filter[cost.currency]"
required: false
schema:
example: USD
@@ -22811,50 +24572,30 @@ components:
creation date-time.
explode: true
in: query
- name: filter[created_at]
+ name: "filter[created_at]"
required: false
schema:
example: 2018-02-02T22:25:27.521Z
format: datetime
type: string
style: form
- FilterCustomerReferenceContains:
- description: If present, addresses with customer_reference containing
- the given value will be returned. Matching is not case-sensitive.
- explode: true
- in: query
- name: filter[customer_reference][contains]
- required: false
- schema:
- type: string
- style: form
- FilterCustomerReferenceEquals:
- description: Filter addresses via the customer reference set. Matching is not
- case-sensitive.
- explode: true
- in: query
- name: filter[customer_reference][eq]
- required: false
- schema:
- type: string
- style: form
FilterEmailContains:
- description: If present, email containing the given value will be returned.
- Matching is not case-sensitive. Requires at least three characters.
+ description: "If present, email containing the given value will be returned.\
+ \ Matching is not case-sensitive. Requires at least three characters."
explode: true
in: query
- name: filter[email][contains]
+ name: "filter[email][contains]"
required: false
schema:
default: "null"
type: string
style: form
FilterEmailEq:
- description: If present, only returns results with the email matching
- exactly the value given.
+ description: "If present, only returns results with the email matching\
+ \ exactly the value given."
explode: true
in: query
- name: filter[email][eq]
+ name: "filter[email][eq]"
required: false
schema:
default: "null"
@@ -22864,27 +24605,18 @@ components:
description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound.outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
format: int64
type: string
style: form
- FilterIpAddressEquals:
- description: Filter access control IPs via the ip_address sent.
- explode: true
- in: query
- name: filter[ip_address][eq]
- required: false
- schema:
- type: string
- style: form
FilterName:
description: Filter by name
explode: true
in: query
- name: filter[name]
+ name: "filter[name]"
required: false
schema:
type: string
@@ -22893,7 +24625,7 @@ components:
description: Identifies the associated outbound voice profile.
explode: true
in: query
- name: filter[outbound.outbound_voice_profile_id]
+ name: "filter[outbound_voice_profile_id]"
required: false
schema:
example: "1293384261075731499"
@@ -22904,7 +24636,7 @@ components:
description: Filter orders by how many SIM cards were ordered.
explode: true
in: query
- name: filter[quantity]
+ name: "filter[quantity]"
required: false
schema:
example: 21
@@ -22915,7 +24647,7 @@ components:
argument.
explode: true
in: query
- name: filter[quantity][lt]
+ name: "filter[quantity][lt]"
required: false
schema:
example: 21
@@ -22925,7 +24657,7 @@ components:
description: Filter by resource_id
explode: true
in: query
- name: filter[resource_id]
+ name: "filter[resource_id]"
required: false
schema:
type: string
@@ -22934,7 +24666,7 @@ components:
description: A valid SIM card group ID.
explode: true
in: query
- name: filter[sim_card_group_id]
+ name: "filter[sim_card_group_id]"
required: false
schema:
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
@@ -22945,7 +24677,7 @@ components:
description: A valid SIM card ID.
explode: true
in: query
- name: filter[sim_card_id]
+ name: "filter[sim_card_id]"
required: false
schema:
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
@@ -22956,7 +24688,7 @@ components:
description: Filter by sip_username
explode: true
in: query
- name: filter[sip_username]
+ name: "filter[sip_username]"
required: false
schema:
type: string
@@ -22965,48 +24697,23 @@ components:
description: Filter by status
explode: true
in: query
- name: filter[status]
+ name: "filter[status]"
required: false
schema:
type: string
style: form
- FilterStreetAddress:
- description: If present, addresses with street_address containing
- the given value will be returned. Matching is not case-sensitive. Requires
- at least three characters.
- explode: true
- in: query
- name: filter[street_address][contains]
- required: false
- schema:
- default: "null"
- type: string
- style: form
FilterUpdatedAt:
description: Filter by ISO 8601 formatted date-time string matching resource
last update date-time.
explode: true
in: query
- name: filter[updated_at]
+ name: "filter[updated_at]"
required: false
schema:
example: 2018-02-02T22:25:27.521Z
format: datetime
type: string
style: form
- FilterUsedAsEmergency:
- description: 'If set as ''true'', only addresses used as the emergency address
- for at least one active phone-number will be returned. When set to ''false'',
- the opposite happens: only addresses not used as the emergency address from
- phone-numbers will be returned.'
- explode: true
- in: query
- name: filter[used_as_emergency]
- required: false
- schema:
- default: "null"
- type: string
- style: form
FqdnId:
description: Identifies the resource.
explode: false
@@ -23039,16 +24746,26 @@ components:
type: string
style: simple
Id:
- description: Identifies the resource.
+ description: The id of the resource.
explode: false
in: path
name: id
required: true
schema:
- example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
style: simple
+ IncludeCancelledAccounts:
+ description: Specifies if cancelled accounts should be included in the results.
+ explode: true
+ in: query
+ name: include_cancelled_accounts
+ required: false
+ schema:
+ default: false
+ example: true
+ type: boolean
+ style: form
IncludeOTAUpdates:
description: It includes the associated OTA update objects in the response when
present.
@@ -23109,7 +24826,7 @@ components:
description: The `linked_record_type` of the document to filter on.
explode: true
in: query
- name: filter[linked_record_type]
+ name: "filter[linked_record_type]"
required: false
schema:
example: porting_order
@@ -23119,7 +24836,7 @@ components:
description: The `linked_resource_id` of the document to filter on.
explode: true
in: query
- name: filter[linked_resource_id]
+ name: "filter[linked_resource_id]"
required: false
schema:
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
@@ -23176,7 +24893,7 @@ components:
description: Optional filter on outbound voice profile name.
explode: true
in: query
- name: filter[name][contains]
+ name: "filter[name][contains]"
required: false
schema:
example: office-profile
@@ -23186,7 +24903,7 @@ components:
description: Filter by the id of a notification channel
explode: true
in: query
- name: filter[notification_channel][eq]
+ name: "filter[notification_channel][eq]"
required: false
schema:
example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
@@ -23196,7 +24913,7 @@ components:
description: Filter by the id of a notification channel
explode: true
in: query
- name: filter[notification_event_condition_id][eq]
+ name: "filter[notification_event_condition_id][eq]"
required: false
schema:
example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
@@ -23206,7 +24923,7 @@ components:
description: Filter by the id of a notification profile
explode: true
in: query
- name: filter[notification_profile_id][eq]
+ name: "filter[notification_profile_id][eq]"
required: false
schema:
example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
@@ -23228,7 +24945,7 @@ components:
description: Filter by tag
explode: true
in: query
- name: filter[tag]
+ name: "filter[tag]"
required: false
schema:
type: string
@@ -23237,7 +24954,7 @@ components:
description: The page number to load
explode: true
in: query
- name: page[number]
+ name: "page[number]"
required: false
schema:
default: 1
@@ -23248,7 +24965,7 @@ components:
description: The size of the page
explode: true
in: query
- name: page[size]
+ name: "page[size]"
required: false
schema:
default: 20
@@ -23317,7 +25034,7 @@ components:
description: Filters records to those with a specified number.
explode: true
in: query
- name: filter[phone_number][eq]
+ name: "filter[phone_number][eq]"
required: false
schema:
example: +12441239999
@@ -23327,7 +25044,7 @@ components:
description: Filters records to those with at least one number in the list.
explode: true
in: query
- name: filter[phone_number][in][]
+ name: "filter[phone_number][in][]"
required: false
schema:
items:
@@ -23346,10 +25063,10 @@ components:
type: boolean
style: form
RequiredTag:
- description: Filter by tag, required by bulk operations.
+ description: "Filter by tag, required by bulk operations."
explode: true
in: query
- name: filter[tag]
+ name: "filter[tag]"
required: true
schema:
type: string
@@ -23387,19 +25104,13 @@ components:
type: string
style: simple
Sort:
- description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.email: sorts the result by the
- email field in ascending order.
- -email: sorts the result by the
- email field in descending order.
- created_at in descending order.
+ description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.email:\
+ \ sorts the result by the\n email field in ascending order.\n\
+ \ -email: sorts the result by the\n \
+ \ email field in descending order.\n created_at in descending order."
explode: true
in: query
name: sort
@@ -23412,49 +25123,14 @@ components:
example: email
type: string
style: form
- SortAddress:
- description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.street_address: sorts the result by the
- street_address field in ascending order.
- -street_address: sorts the result by the
- street_address field in descending order.
- created_at in descending order.
- explode: true
- in: query
- name: sort
- required: false
- schema:
- default: created_at
- enum:
- - created_at
- - first_name
- - last_name
- - business_name
- - street_address
- example: street_address
- type: string
- style: form
SortAuthenticationProvider:
- description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.name: sorts the result by the
- name field in ascending order.
- -name: sorts the result by the
- name field in descending order.
- created_at in descending order.
+ description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.name:\
+ \ sorts the result by the\n name field in ascending order.\n\
+ \ -name: sorts the result by the\n name\
+ \ field in descending order.\n created_at in descending order."
explode: true
in: query
name: sort
@@ -23476,19 +25152,14 @@ components:
type: string
style: form
SortConnection:
- description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the
- connection_name field in ascending order.
- -connection_name: sorts the result by the
- connection_name field in descending order.
- created_at in descending order.
+ description: "Specifies the sort order for results. By default sorting direction\
+ \ is ascending. To have the results sorted in descending order add the \
+ \ - prefix.connection_name:\
+ \ sorts the result by the\n connection_name field in ascending\
+ \ order.\n -connection_name: sorts the\
+ \ result by the\n connection_name field in descending order.\n\
+ \ created_at\
+ \ in descending order."
explode: true
in: query
name: sort
@@ -23503,19 +25174,12 @@ components:
type: string
style: form
SortOutboundVoiceProfile:
- description: |-
- Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.name: sorts the result by the
- name field in ascending order.
- -name: sorts the result by the
- name field in descending order.
- -\
+ \ prefix.name: sorts the\
+ \ result by the\n name field in ascending order.\n -name: sorts the result by the\n name\
+ \ field in descending order.\n /v2/documents
- endpoint.
- example: 5f940c35-ef28-4408-bb95-af73b047d589
- type: string
- required:
- - document_id
- - document_type
- type: object
- type: array
- required:
- - documents
- title: Create Porting Order Documents
- type: object
- required: true
- VerifyCustomerServiceRequestPhoneNumberCoverage:
- content:
- application/json:
- schema:
- properties:
- phone_numbers:
- description: The phone numbers list to be verified.
- items:
- description: A valid US phone number in E164 format.
- example: +1234567890
- pattern: ^\+1\d{10}$
- type: string
- type: array
- required:
- - phone_numbers
- title: Verify Customer Service Request Phone Number Coverage
- type: object
+ $ref: '#/components/schemas/uploadPortingOrderDocuments_request'
required: true
- Bulk_Update_Sim_Network_Preference:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Bulk_Update_Sim_Network_Preference'
- Update_Channel_Zone:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Update_Channel_Zone'
- required: true
- List_Channel_Zones_by_Phone_Number:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/List_Channel_Zones_by_Phone_Number'
- required: true
- Update_Inbound_Channels:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Update_Inbound_Channels'
- required: true
- Create_Portability_Check_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_Portability_Check_Request'
- required: true
- Create_Comment_Portout_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_Comment_Portout_Request'
- required: true
- Create_Porting_Supporting_Docs_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_Porting_Supporting_Docs_Request'
- required: true
- Update_Portout_Status_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Update_Portout_Status_Request'
- required: true
- Create_Private_Wireless_Gatweway_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_Private_Wireless_Gatweway_Request'
- required: true
- Create_SIM_Card_Data_Usage_Notification_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_SIM_Card_Data_Usage_Notification_Request'
- required: true
- Create_Private_Wireless_Gatweway_Request_1:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_Private_Wireless_Gatweway_Request_1'
- required: true
- CreateSimCardOrderPreview:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CreateSimCardOrderPreview'
- Create_SIM_Card_Validate_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Create_SIM_Card_Validate_Request'
- required: true
- Put_Network_Preference_Request:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Put_Network_Preference_Request'
- Create_Verify_Profile_Request:
+ DialogflowConnectionRequest:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Verify_Profile_Request'
+ $ref: '#/components/schemas/DialogflowConnection'
+ description: The params expected to create/update a Dialogflow Connection for
+ given connection_id.
required: true
- Update_Verify_Profile_Request:
+ VerifyCustomerServiceRequestPhoneNumberCoverage:
content:
application/json:
schema:
- $ref: '#/components/schemas/Update_Verify_Profile_Request'
+ $ref: '#/components/schemas/verifyPhoneNumberCoverage_request'
required: true
responses:
- AccessControlIpResponse:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Access_Control_Ip_Response'
- description: Successful response
ActionSuccessResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Action_Success_Response'
+ $ref: '#/components/schemas/EndSession_200_response'
description: Success Action Response
- AddressResponse:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Address_Response'
- description: Successful response
AuthenticationProviderResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Authentication_Provider_Response'
+ $ref: '#/components/schemas/CreateAuthenticationProvider_200_response'
description: Successful response
BulkCredentialResponse:
content:
@@ -23806,11 +25321,30 @@ components:
schema:
$ref: '#/components/schemas/Bulk_Room_Recordings_Delete_Response'
description: Successful response for Bulk Delete Room recordings requests
+ BulkSIMCardActionCollectionResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListBulkSIMCardActions_200_response'
+ description: Successful response
+ BulkSIMCardActionDetailedResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/BulkSimCardActionGet_200_response'
+ description: Successful Response
+ BulkSIMCardActionResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/BulkSetPublicIPs_202_response'
+ description: Successful Response
BulkSIMCardNetworkPreferenceResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Bulk_SIM_Card_Network_Preference_Response'
+ $ref: '#/components/schemas/BulkSIMCardNetworkPreferences_202_response'
+ description: ""
BulkUploadDocServiceDocumentsResponse:
content:
application/json:
@@ -23820,7 +25354,6 @@ components:
items:
$ref: '#/components/schemas/DocServiceDocument'
type: array
- title: Bulk Upload Doc Service Documents Response
type: object
description: Successful response
CallControlApplicationResponse:
@@ -23835,6 +25368,18 @@ components:
schema:
$ref: '#/components/schemas/Call_Control_Command_Response'
description: Successful response upon making a call control command.
+ CancelFaxResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Successful_response_upon_accepting_cancel_fax_command'
+ description: Successful response upon accepting cancel fax command
+ CancelPortingOrderResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/cancelPortingOrder_200_response'
+ description: Successful response
CheckContactResponse:
content:
application/json:
@@ -23845,7 +25390,7 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/Comment_Response'
+ $ref: '#/components/schemas/createComment_200_response'
description: A Comment Response
ConferenceCommandResponse:
content:
@@ -23859,6 +25404,12 @@ components:
schema:
$ref: '#/components/schemas/Conference_Response'
description: Successful response with details about a conference.
+ ConfirmPortingOrderResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/confirmPortingOrder_200_response'
+ description: Successful response
ConnectionResponse:
content:
application/json:
@@ -23869,67 +25420,67 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Billing_Group_Response'
+ $ref: '#/components/schemas/createBillingGroup_200_response'
description: Expected billing group response to a valid request
CreateLedgerBillingGroupReportResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Ledger_Billing_Group_Report_Response'
+ $ref: '#/components/schemas/createLedgerBillingGroupReport_200_response'
description: Expected ledger billing group report response to a valid request
CreatePortOutSupportingDocumentsResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_PortOut_Supporting_Documents_Response'
+ $ref: '#/components/schemas/getPortRequestSupportingDocuments_201_response'
description: Portout Supporting Documents
CreatePrivateWirelessGatewayResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Private_Wireless_Gateway_Response'
+ $ref: '#/components/schemas/createPrivateWirelessGateway_202_response'
description: Successful response
CreateRoomClientTokenResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Room_Client_Token_Response'
+ $ref: '#/components/schemas/CreateRoomClientToken_201_response'
description: Create room client token response.
CreateRoomCompositionResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Room_Composition_Response'
+ $ref: '#/components/schemas/CreateRoomComposition_202_response'
description: Create room composition response.
CreateRoomResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Room_Response'
+ $ref: '#/components/schemas/CreateRoom_201_response'
description: Create room response.
CreateSimCardDataUsageNotificationResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Sim_Card_Data_Usage_Notification_Response'
+ $ref: '#/components/schemas/SimCardDataUsageNotificationsPost_201_response'
description: Successful response
CreateSimCardGroupResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Sim_Card_Group_Response'
+ $ref: '#/components/schemas/SimCardGroupsPost_200_response'
description: Successful Response
CreateSimCardOrderResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Sim_Card_Order_Response'
+ $ref: '#/components/schemas/SimCardOrdersPost_200_response'
description: Successful Response
CreateWdrReportResponse:
content:
application/json:
schema:
- $ref: '#/components/schemas/Create_Wdr_Report_Response'
+ $ref: '#/components/schemas/createWdrReport_201_response'
description: Successful response
CredentialConnectionResponse:
content:
@@ -23953,15 +25504,18 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/Delete_SIM_Card_Network_Preference_Response'
- description: |-
- A successful network preferences deletion response. bulk_set_public_ips - set a public IP for each\
+ \ specified SIM cardbulk_set_public_ips - set a public IP for each\
+ \ specified SIM cardandroid
+ here
+ enum:
+ - android
+ type: string
server_key:
description: Server key as received from Google firebase
- example: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja9L8B1FrxJbc1z2btoiFYkda9Simkkda_0SJNidSan9-jkda-nieD3js9SdhfazonSbLN5VXQDqXFRuPW4kdo_fdnaxdai3y9z9DKXie0
+ example: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja...
type: string
alias:
description: Alias to uniquely identify the credential
@@ -30349,6 +31906,7 @@ components:
required:
- alias
- server_key
+ - type
title: Create Android Push Credential Request
type: object
CreateCallControlApplicationRequest:
@@ -30376,8 +31934,8 @@ components:
example: call-router
type: string
webhook_event_url:
- description: The URL where webhooks related to this connection will be sent.
- Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this connection will be\
+ \ sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
@@ -30391,10 +31949,10 @@ components:
Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
enum:
- '"Latency"'
- - '"Chicago, IL"'
- - '"Ashburn, VA"'
- - '"San Jose, CA"'
- example: '"Amsterdam, Netherlands"'
+ - "\"Chicago, IL\""
+ - "\"Ashburn, VA\""
+ - "\"San Jose, CA\""
+ example: "\"Amsterdam, Netherlands\""
type: string
dtmf_type:
default: RFC 2833
@@ -30424,8 +31982,8 @@ components:
$ref: '#/components/schemas/CallControlApplicationOutbound'
webhook_api_version:
default: "1"
- description: Determines which webhook format will be used, Telnyx API v1
- or v2.
+ description: "Determines which webhook format will be used, Telnyx API v1\
+ \ or v2."
enum:
- "1"
- "2"
@@ -30433,9 +31991,9 @@ components:
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this connection
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this connection\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -30612,9 +32170,9 @@ components:
type: string
default_on_hold_comfort_noise_enabled:
default: false
- description: When enabled, Telnyx will generate comfort noise when you place
- the call on hold. If disabled, you will need to generate comfort noise
- or on hold music to avoid RTP timeout.
+ description: "When enabled, Telnyx will generate comfort noise when you\
+ \ place the call on hold. If disabled, you will need to generate comfort\
+ \ noise or on hold music to avoid RTP timeout."
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
@@ -30627,30 +32185,30 @@ components:
$ref: '#/components/schemas/EncryptedMedia'
onnet_t38_passthrough_enabled:
default: false
- description: Enable on-net T38 if you prefer the sender and receiver negotiating
- T38 directly if both are on the Telnyx network. If this is disabled, Telnyx
- will be able to use T38 on just one leg of the call depending on each
- leg's settings.
+ description: "Enable on-net T38 if you prefer the sender and receiver negotiating\
+ \ T38 directly if both are on the Telnyx network. If this is disabled,\
+ \ Telnyx will be able to use T38 on just one leg of the call depending\
+ \ on each leg's settings."
type: boolean
webhook_event_url:
- description: The URL where webhooks related to this connection will be sent.
- Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this connection will be\
+ \ sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this connection
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this connection\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
type: string
webhook_api_version:
default: "1"
- description: Determines which webhook format will be used, Telnyx API v1
- or v2.
+ description: "Determines which webhook format will be used, Telnyx API v1\
+ \ or v2."
enum:
- "1"
- "2"
@@ -30683,7 +32241,7 @@ components:
example:
application_name: fax-router
active: false
- anchorsite_override: Amsterdam, Netherlands
+ anchorsite_override: "Amsterdam, Netherlands"
webhook_event_url: https://example.com
webhook_event_failover_url: https://failover.example.com
webhook_timeout_secs: 25
@@ -30709,17 +32267,17 @@ components:
anchorsite_override:
$ref: '#/components/schemas/AnchorsiteOverride'
webhook_event_url:
- description: The URL where webhooks related to this connection will be sent.
- Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this connection will be\
+ \ sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
title: Webhook Event URL
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this connection
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this connection\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -30791,9 +32349,9 @@ components:
$ref: '#/components/schemas/FqdnConnectionTransportProtocol'
default_on_hold_comfort_noise_enabled:
default: true
- description: When enabled, Telnyx will generate comfort noise when you place
- the call on hold. If disabled, you will need to generate comfort noise
- or on hold music to avoid RTP timeout.
+ description: "When enabled, Telnyx will generate comfort noise when you\
+ \ place the call on hold. If disabled, you will need to generate comfort\
+ \ noise or on hold music to avoid RTP timeout."
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
@@ -30806,30 +32364,30 @@ components:
$ref: '#/components/schemas/EncryptedMedia'
onnet_t38_passthrough_enabled:
default: false
- description: Enable on-net T38 if you prefer the sender and receiver negotiating
- T38 directly if both are on the Telnyx network. If this is disabled, Telnyx
- will be able to use T38 on just one leg of the call depending on each
- leg's settings.
+ description: "Enable on-net T38 if you prefer the sender and receiver negotiating\
+ \ T38 directly if both are on the Telnyx network. If this is disabled,\
+ \ Telnyx will be able to use T38 on just one leg of the call depending\
+ \ on each leg's settings."
type: boolean
webhook_event_url:
- description: The URL where webhooks related to this connection will be sent.
- Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this connection will be\
+ \ sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this connection
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this connection\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
type: string
webhook_api_version:
default: "1"
- description: Determines which webhook format will be used, Telnyx API v1
- or v2.
+ description: "Determines which webhook format will be used, Telnyx API v1\
+ \ or v2."
enum:
- "1"
- "2"
@@ -30870,10 +32428,10 @@ components:
nullable: true
type: integer
dns_record_type:
- description: The DNS record type for the FQDN. For cases where a port is
- not set, the DNS record type must be 'srv'. For cases where a port is
- set, the DNS record type must be 'a'. If the DNS record type is 'a' and
- a port is not specified, 5060 will be used.
+ description: "The DNS record type for the FQDN. For cases where a port is\
+ \ not set, the DNS record type must be 'srv'. For cases where a port is\
+ \ set, the DNS record type must be 'a'. If the DNS record type is 'a'\
+ \ and a port is not specified, 5060 will be used."
example: a
type: string
required:
@@ -30926,25 +32484,25 @@ components:
- G729
- OPUS
- H.264
- description: 'Defines the list of codecs that Telnyx will send for inbound
- calls to a specific number on your portal account, in priority order.
- This only works when the Connection the number is assigned to uses Media
- Handling mode: default. OPUS and H.264 codecs are available only when
- using TCP or TLS transport for SIP.'
+ description: "Defines the list of codecs that Telnyx will send for inbound\
+ \ calls to a specific number on your portal account, in priority order.\
+ \ This only works when the Connection the number is assigned to uses Media\
+ \ Handling mode: default. OPUS and H.264 codecs are available only when\
+ \ using TCP or TLS transport for SIP."
items:
type: string
type: array
default_routing_method:
- description: Default routing method to be used when a number is associated
- with the connection. Must be one of the routing method types or left blank,
- other values are not allowed.
+ description: "Default routing method to be used when a number is associated\
+ \ with the connection. Must be one of the routing method types or left\
+ \ blank, other values are not allowed."
enum:
- sequential
- round-robin
type: string
channel_limit:
- description: When set, this will limit the total number of inbound calls
- to phone numbers associated with this connection.
+ description: "When set, this will limit the total number of inbound calls\
+ \ to phone numbers associated with this connection."
type: integer
generate_ringback_tone:
default: false
@@ -30953,8 +32511,9 @@ components:
type: boolean
isup_headers_enabled:
default: false
- description: When set, inbound phone calls will receive ISUP parameters
- via SIP headers. (Only when available and only when using TCP or TLS transport.)
+ description: "When set, inbound phone calls will receive ISUP parameters\
+ \ via SIP headers. (Only when available and only when using TCP or TLS\
+ \ transport.)"
type: boolean
prack_enabled:
default: false
@@ -30962,10 +32521,10 @@ components:
type: boolean
privacy_zone_enabled:
default: false
- description: By default, Telnyx does not send caller-id information when
- the caller has chosen to hide this information. When this option is enabled,
- Telnyx will send the SIP header Privacy:id plus the caller-id information
- so that the receiver side can choose when to hide it.
+ description: "By default, Telnyx does not send caller-id information when\
+ \ the caller has chosen to hide this information. When this option is\
+ \ enabled, Telnyx will send the SIP header Privacy:id plus the caller-id\
+ \ information so that the receiver side can choose when to hide it."
type: boolean
sip_compact_headers_enabled:
default: true
@@ -30973,25 +32532,25 @@ components:
type: boolean
sip_region:
default: US
- description: Selects which `sip_region` to receive inbound calls from. If
- null, the default region (US) will be used.
+ description: "Selects which `sip_region` to receive inbound calls from.\
+ \ If null, the default region (US) will be used."
enum:
- US
- Europe
- Australia
type: string
sip_subdomain:
- description: 'Specifies a subdomain that can be used to receive Inbound
- calls to a Connection, in the same way a phone number is used, from a
- SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called
- from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com"
- where the user part can be any alphanumeric value. Please note TLS encrypted
- calls are not allowed for subdomain calls.'
+ description: "Specifies a subdomain that can be used to receive Inbound\
+ \ calls to a Connection, in the same way a phone number is used, from\
+ \ a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can\
+ \ be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\"\
+ \ where the user part can be any alphanumeric value. Please note TLS encrypted\
+ \ calls are not allowed for subdomain calls."
type: string
sip_subdomain_receive_settings:
- description: 'This option can be enabled to receive calls from: "Anyone"
- (any SIP endpoint in the public Internet) or "Only my connections" (any
- connection assigned to the same Telnyx user).'
+ description: "This option can be enabled to receive calls from: \"Anyone\"\
+ \ (any SIP endpoint in the public Internet) or \"Only my connections\"\
+ \ (any connection assigned to the same Telnyx user)."
enum:
- only_my_connections
- from_anyone
@@ -31004,82 +32563,29 @@ components:
type: integer
timeout_2xx_secs:
default: 90
- description: 'Time(sec) before aborting if call is unanswered (min: 1, max:
- 600).'
+ description: "Time(sec) before aborting if call is unanswered (min: 1, max:\
+ \ 600)."
type: integer
title: Create Inbound Ip Request
type: object
CreateIosPushCredentialRequest:
properties:
+ type:
+ description: Type of mobile push credential. Should be ios
+ here
+ enum:
+ - ios
+ type: string
certificate:
description: Certificate as received from APNs
- example: |
- Bag Attributes
- friendlyName: VoIP Services: com.telnyx.webrtcapp
- localKeyID: AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA
- subject=/UID=com.telnyx.webrtcapp.voip/CN=VoIP Services: com.telnyx.webrtcapp/OU=YKUVNPU9FS/O=Telnyx LLC/C=US
- issuer=/C=US/O=Apple Inc./OU=Apple Worldwide Developer Relations/CN=Apple Worldwide Developer Relations Certification Authority
- -----BEGIN CERTIFICATE-----
- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ
- DbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H
- FsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM
- UNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcH6HpirBQkrjJkak
- qqk5bC8Ye2PIcY0+nVFNWCoQqJadGduy1kHFmEsvkmaemfQdRIwn9q5lpNUnMSo3
- o6Cx0igYEHryauzg2hv14ylyvoCBxPOvl95NO86s9XS0CB2Qq6t9V59qkJiCPgKt
- hRtU70gavh5L0K/FPEO2FnjaNa/2kVeU8LWgqxH8dhIl/QQSipS49PDQR7DIJUWQ
- cakwR34j97t6UTxz7Yx05uUhjlcB4+hq2+RLA6LOOEcGnpECAwEAAaOCAqgwggKk
- MAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUiCcXCam2GGCL7Ou69kdZxVJUo7cw
- PwYIKwYBBQUHAQEEMzAxMC8GCCsGAQUFBzABhiNodHRwOi8vb2NzcC5hcHBsZS5j
- b20vb2NzcDAzLXd3ZHIwMTCCAR0GA1UdIASCARQwggEQMIIBDAbWVudHMuMDYGCC
- DRHGx1ngGt7fn3aobpf0CL+k8F1CcwkL8GZaAf3Pe6nxxWaTyaIU/LoBd8OU4aHq
- dGacHGp5tlgli8WhXNJuvHFmNnm0prQUeWjfTrHvAV2fEYJKoZIhvdjZAUBGAQUF
- MIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNh
- dGUgYnkgYW55IHaiZDeWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhaiZDeaiZDeaiZD
- Isit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P
- 5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5
- dnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3
- rpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9
- vG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjkknqoojqpiu109
- CfO37+af5amMDmgKHLWYqpIuF856urhODCRuprjCYwkyHX+cDbuB7E6BKjtyUCRx
- cHBsaWNhYmxlIHN0OIIJDKDAU094NOJujfoLmFwcGxlLmNvbS99w0BAQsFAAOCAQ
- Y2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0
- YXRlpX2LTQJsyzUjVKmbCjyATg5Y4QCqgDzrYUOBjL79dJzGwPKNQYG8YW5kYXJk
- LLuJX3jda0o393hnz03nz0jdah+m30lcS/iZkGAutno3MPd0EU9q3HyjyE0MjpHj
- /xXNgBL6zty06oXzUF+wXy1yNhUfouDLA3Yhv/uAbxN0NDart5s4kT/E3AAKIX3d
- BPYcCd3ran8CHgFW+dt3AIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwg==
- -----END CERTIFICATE-----
+ example: '-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs...
+ -----END CERTIFICATE-----'
type: string
private_key:
description: Corresponding private key to the certificate as received from
APNs
- example: |-
- -----BEGIN RSA PRIVATE KEY-----
- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ
- DbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H
- FsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM
- UNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcw6HpirBQkrjJkak
- qqk5bC8Ye2PIcY0+nVFNWCoQqxuFc9/xYtCzPhd7SLfj+sDp4ZU1u18WYAoD5E3u
- Isit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P
- 5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5
- dnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3
- rpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9
- vG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjk+pMugWkBGwJ9r
- B8AfqXwV4qalv7/DPVj72OtBi79oiOltNsHWp4cChGkp8FxEaMhy5d6tT7lz/jY2
- Zgu2Jz2pAoGBANuey3lj6dgTPc7ZDgcUKVz96aC1dDzrqBRKrIPsodFTVUSdiZP4
- 3TLrD4niE0+yVD/9YvohdIlczWEQwvTy4feBcubkbKeU0LiAaAILfY1x/2twPuvG
- wfYU1uVpxUxYcKvrCxHVEBbw8iuf6PABaROZItM2MMrJy+sWf9SQ2rwdAoGBAM4k
- wsJSER7NNGw08L1QhmSYqNzxZtd2sOqJJXny32zOOW4c2UUbdqoXmfAgPceeAec0
- cE1W0SOzi06aNSjI1LQf5mKN4nFIt1Nw19zl9/YDZgbNkysuwsSlBQhZz+TwembC
- 3icGC8dLMLTpZPrXZ+bsmbj5QO5B0DY8hgXpzZn/AoGASr1Eo6AD8bvCmgU2B+St
- mu7yNfXqg9zyy00KXq8F9rW0W/B85HWZ2X0zQYpFZibbExfJOjRuc1y4rCLHJhMO
- IWvVTYxJCdLUISXZv3Bnnt4/vTFqyFRQp805wML5GN00It2PW9c1bYk78OqvnBXu
- y3Oe7WAQxMJd+jgi8pUFS2UCgYEAnr92cDjM0GCMn0vBnLi3Vh6t47/PR9wyb9r/
- zkK3xk2lsmNq+iolHuWf+WiKyv+mTYt3dEeINSsd+4ELsQW/r5rlSz4ihMTP0OUU
- hxtd8ck6N8D2NYoEGXVPQ9gOHisGx74HYBvq1CXWM2uNBRL/A7luxCDG3PQ3yJyh
- RUqAt7cCgYEAmp5WdnTZJxkYFwaQ/MYebU4KAMMsvGoMkF+x7MJuB/0oXdpJnMyV
- QOwLXF/NZrWCyEqstGRN+rSKJXF/slD4wgAZBjfRkXMeYcsCEEPXQLLnj8SF5QIv
- 8+rvyN9fX+MnxRY9PqCXRaXRl7G/3ORxbPRPsefQAsDQ5NsN5lay2l4=
- -----END RSA PRIVATE KEY-----
+ example: '-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs...
+ -----END RSA PRIVATE KEY-----'
type: string
alias:
description: Alias to uniquely identify the credential
@@ -31089,7 +32595,8 @@ components:
- alias
- certificate
- private_key
- title: Create IOS Push Credential Request
+ - type
+ title: Create iOS push credential request
type: object
CreateIpConnectionRequest:
example:
@@ -31154,8 +32661,8 @@ components:
type: string
transport_protocol:
default: UDP
- description: One of UDP, TLS, or TCP. Applies only to connections with IP
- authentication or FQDN authentication.
+ description: "One of UDP, TLS, or TCP. Applies only to connections with\
+ \ IP authentication or FQDN authentication."
enum:
- UDP
- TCP
@@ -31164,9 +32671,9 @@ components:
type: string
default_on_hold_comfort_noise_enabled:
default: true
- description: When enabled, Telnyx will generate comfort noise when you place
- the call on hold. If disabled, you will need to generate comfort noise
- or on hold music to avoid RTP timeout.
+ description: "When enabled, Telnyx will generate comfort noise when you\
+ \ place the call on hold. If disabled, you will need to generate comfort\
+ \ noise or on hold music to avoid RTP timeout."
example: true
type: boolean
dtmf_type:
@@ -31181,31 +32688,31 @@ components:
$ref: '#/components/schemas/EncryptedMedia'
onnet_t38_passthrough_enabled:
default: false
- description: Enable on-net T38 if you prefer the sender and receiver negotiating
- T38 directly if both are on the Telnyx network. If this is disabled, Telnyx
- will be able to use T38 on just one leg of the call depending on each
- leg's settings.
+ description: "Enable on-net T38 if you prefer the sender and receiver negotiating\
+ \ T38 directly if both are on the Telnyx network. If this is disabled,\
+ \ Telnyx will be able to use T38 on just one leg of the call depending\
+ \ on each leg's settings."
example: false
type: boolean
webhook_event_url:
- description: The URL where webhooks related to this connection will be sent.
- Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this connection will be\
+ \ sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this connection
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this connection\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
type: string
webhook_api_version:
default: "1"
- description: Determines which webhook format will be used, Telnyx API v1
- or v2.
+ description: "Determines which webhook format will be used, Telnyx API v1\
+ \ or v2."
enum:
- "1"
- "2"
@@ -31251,7 +32758,7 @@ components:
example:
from: +18445550001
to: +13125550002
- text: Hello, World!
+ text: "Hello, World!"
subject: From Telnyx!
media_urls:
- http://example.com
@@ -31261,7 +32768,7 @@ components:
type: MMS
properties:
from:
- description: Phone number, in +E.164 format, used to send the message.
+ description: "Phone number, in +E.164 format, used to send the message."
format: address
type: string
to:
@@ -31270,10 +32777,8 @@ components:
format: address
type: string
text:
- description: |-
- Message body (i.e., content) as a non-empty string.
-
- **Required for SMS**
+ description: "Message body (i.e., content) as a non-empty string.\n\n**Required\
+ \ for SMS**"
type: string
subject:
description: Subject of multimedia message
@@ -31298,12 +32803,13 @@ components:
type: string
use_profile_webhooks:
default: true
- description: If the profile this number is associated with has webhooks,
- use them for delivery notifications. If webhooks are also specified on
- the message itself, they will be attempted first, then those on the profile.
+ description: "If the profile this number is associated with has webhooks,\
+ \ use them for delivery notifications. If webhooks are also specified\
+ \ on the message itself, they will be attempted first, then those on the\
+ \ profile."
type: boolean
type:
- description: The protocol for sending the message, either SMS or MMS.
+ description: "The protocol for sending the message, either SMS or MMS."
enum:
- SMS
- MMS
@@ -31326,38 +32832,38 @@ components:
rollup_billing: false
properties:
email:
- description: The email address for the managed account. If not provided,
- the email address will be generated based on the email address of the
- manager account.
+ description: "The email address for the managed account. If not provided,\
+ \ the email address will be generated based on the email address of the\
+ \ manager account."
example: new_managed_account@customer.org
type: string
password:
- description: Password for the managed account. If a password is not supplied,
- the account will not be able to be signed into directly. (A password reset
- may still be performed later to enable sign-in via password.)
+ description: "Password for the managed account. If a password is not supplied,\
+ \ the account will not be able to be signed into directly. (A password\
+ \ reset may still be performed later to enable sign-in via password.)"
example: 3jVjLq!tMuWKyWx4NN*CvhnB
type: string
business_name:
- description: The name of the business for which the new managed account
- is being created, that will be used as the managed accounts's organization's
- name.
+ description: "The name of the business for which the new managed account\
+ \ is being created, that will be used as the managed accounts's organization's\
+ \ name."
example: Larry's Cat Food Inc
type: string
managed_account_allow_custom_pricing:
- description: Boolean value that indicates if the managed account is able
- to have custom pricing set for it or not. If false, uses the pricing of
- the manager account. Defaults to false. This value may be changed after
- creation, but there may be time lag between when the value is changed
- and pricing changes take effect.
+ description: "Boolean value that indicates if the managed account is able\
+ \ to have custom pricing set for it or not. If false, uses the pricing\
+ \ of the manager account. Defaults to false. This value may be changed\
+ \ after creation, but there may be time lag between when the value is\
+ \ changed and pricing changes take effect."
example: false
type: boolean
rollup_billing:
- description: Boolean value that indicates if the billing information and
- charges to the managed account "roll up" to the manager account. If true,
- the managed account will not have its own balance and will use the shared
- balance with the manager account. This value cannot be changed after account
- creation without going through Telnyx support as changes require manual
- updates to the account ledger. Defaults to false.
+ description: "Boolean value that indicates if the billing information and\
+ \ charges to the managed account \"roll up\" to the manager account. If\
+ \ true, the managed account will not have its own balance and will use\
+ \ the shared balance with the manager account. This value cannot be changed\
+ \ after account creation without going through Telnyx support as changes\
+ \ require manual updates to the account ledger. Defaults to false."
example: false
type: boolean
required:
@@ -31368,7 +32874,7 @@ components:
from: +18445550001
messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
to: +18445550001
- text: Hello, World!
+ text: "Hello, World!"
subject: From Telnyx!
media_urls:
- http://example.com
@@ -31378,10 +32884,9 @@ components:
type: MMS
properties:
from:
- description: |
- Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
-
- **Required if sending with a phone number, short code, or alphanumeric sender ID.**
+ description: "Sending address (+E.164 formatted phone number, alphanumeric\
+ \ sender ID, or short code).\n\n**Required if sending with a phone number,\
+ \ short code, or alphanumeric sender ID.**\n"
format: address
type: string
messaging_profile_id:
@@ -31396,10 +32901,8 @@ components:
format: address
type: string
text:
- description: |-
- Message body (i.e., content) as a non-empty string.
-
- **Required for SMS**
+ description: "Message body (i.e., content) as a non-empty string.\n\n**Required\
+ \ for SMS**"
type: string
subject:
description: Subject of multimedia message
@@ -31424,12 +32927,13 @@ components:
type: string
use_profile_webhooks:
default: true
- description: If the profile this number is associated with has webhooks,
- use them for delivery notifications. If webhooks are also specified on
- the message itself, they will be attempted first, then those on the profile.
+ description: "If the profile this number is associated with has webhooks,\
+ \ use them for delivery notifications. If webhooks are also specified\
+ \ on the message itself, they will be attempted first, then those on the\
+ \ profile."
type: boolean
type:
- description: The protocol for sending the message, either SMS or MMS.
+ description: "The protocol for sending the message, either SMS or MMS."
enum:
- SMS
- MMS
@@ -31502,8 +33006,8 @@ components:
type: string
webhook_api_version:
default: "2"
- description: Determines which webhook format will be used, Telnyx API v1,
- v2, or a legacy 2010-04-01 format.
+ description: "Determines which webhook format will be used, Telnyx API v1,\
+ \ v2, or a legacy 2010-04-01 format."
enum:
- "1"
- "2"
@@ -31516,24 +33020,6 @@ components:
required:
- name
type: object
- CreateMobileApplicationRequest:
- example:
- application_name: FlashEmergency
- type: android
- properties:
- application_name:
- description: Name of the appplication to be created
- example: FlashEmergency
- type: string
- type:
- description: Type of application to be created (IOS or Android)
- example: android
- type: string
- required:
- - application_name
- - type
- title: Create Mobile Application Request
- type: object
CreateMultiPartDocServiceDocumentRequest:
properties:
file:
@@ -31610,8 +33096,8 @@ components:
readOnly: true
type: string
requirements_met:
- description: True if all requirements are met for every phone number, false
- otherwise.
+ description: "True if all requirements are met for every phone number, false\
+ \ otherwise."
example: true
readOnly: true
type: boolean
@@ -31753,8 +33239,8 @@ components:
readOnly: true
type: string
requirements_met:
- description: True if all requirements are met for every phone number, false
- otherwise.
+ description: "True if all requirements are met for every phone number, false\
+ \ otherwise."
example: true
readOnly: true
type: boolean
@@ -31764,7 +33250,7 @@ components:
messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
to:
- +13125550002
- text: Hello, World!
+ text: "Hello, World!"
subject: From Telnyx!
media_urls:
- http://example.com
@@ -31782,10 +33268,8 @@ components:
format: address
type: string
text:
- description: |-
- Message body (i.e., content) as a non-empty string.
-
- **Required for SMS**
+ description: "Message body (i.e., content) as a non-empty string.\n\n**Required\
+ \ for SMS**"
type: string
subject:
description: Subject of multimedia message
@@ -31810,12 +33294,13 @@ components:
type: string
use_profile_webhooks:
default: true
- description: If the profile this number is associated with has webhooks,
- use them for delivery notifications. If webhooks are also specified on
- the message itself, they will be attempted first, then those on the profile.
+ description: "If the profile this number is associated with has webhooks,\
+ \ use them for delivery notifications. If webhooks are also specified\
+ \ on the message itself, they will be attempted first, then those on the\
+ \ profile."
type: boolean
type:
- description: The protocol for sending the message, either SMS or MMS.
+ description: "The protocol for sending the message, either SMS or MMS."
enum:
- SMS
- MMS
@@ -31917,10 +33402,7 @@ components:
business_email:
$ref: '#/components/schemas/BusinessIdentity/properties/business_email'
business_name:
- description: The business name associated with the address. An address must
- have either a first last name or a business name.
- example: Toy-O'Kon
- type: string
+ $ref: '#/components/schemas/BusinessIdentity/properties/business_name'
business_phone_number:
$ref: '#/components/schemas/BusinessIdentity/properties/business_phone_number'
business_description:
@@ -32003,9 +33485,9 @@ components:
when making outbound calls.
type: number
daily_spend_limit:
- description: The maximum amount of usage charges, in USD, you want Telnyx
- to allow on this outbound voice profile in a day before disallowing new
- calls.
+ description: "The maximum amount of usage charges, in USD, you want Telnyx\
+ \ to allow on this outbound voice profile in a day before disallowing\
+ \ new calls."
example: "100.00"
type: string
daily_spend_limit_enabled:
@@ -32049,10 +33531,10 @@ components:
type: object
CreatePortingOrderComment:
example:
- body: Please, let me know when the port completes
+ body: "Please, let me know when the port completes"
properties:
body:
- example: Please, let me know when the port completes
+ example: "Please, let me know when the port completes"
type: string
type: object
CreateRoomClientTokenRequest:
@@ -32062,17 +33544,17 @@ components:
properties:
token_ttl_secs:
default: 600
- description: The time to live in seconds of the Client Token, after that
- time the Client Token is invalid and can't be used to join a Room.
+ description: "The time to live in seconds of the Client Token, after that\
+ \ time the Client Token is invalid and can't be used to join a Room."
example: 600
maximum: 3600
minimum: 10
type: integer
refresh_token_ttl_secs:
default: 3600
- description: The time to live in seconds of the Refresh Token, after that
- time the Refresh Token is invalid and can't be used to refresh Client
- Token.
+ description: "The time to live in seconds of the Refresh Token, after that\
+ \ time the Refresh Token is invalid and can't be used to refresh Client\
+ \ Token."
example: 3600
maximum: 86400
minimum: 60
@@ -32126,16 +33608,16 @@ components:
of regions.
type: object
webhook_event_url:
- description: The URL where webhooks related to this room composition will
- be sent. Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this room composition will\
+ \ be sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this room composition
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this room composition\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -32163,9 +33645,9 @@ components:
type: string
max_participants:
default: 10
- description: The maximum amount of participants allowed in a room. If new
- participants try to join after that limit is reached, their request will
- be rejected.
+ description: "The maximum amount of participants allowed in a room. If new\
+ \ participants try to join after that limit is reached, their request\
+ \ will be rejected."
example: 10
maximum: 50
minimum: 2
@@ -32176,16 +33658,16 @@ components:
example: true
type: boolean
webhook_event_url:
- description: The URL where webhooks related to this room will be sent. Must
- include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this room will be sent.\
+ \ Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this room will be
- sent if sending to the primary URL fails. Must include a scheme, such
- as 'https'.
+ description: "The failover URL where webhooks related to this room will\
+ \ be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -32202,7 +33684,7 @@ components:
example:
from: +18445550001
to: +18445550001
- text: Hello, World!
+ text: "Hello, World!"
subject: From Telnyx!
media_urls:
- http://example.com
@@ -32212,7 +33694,7 @@ components:
type: MMS
properties:
from:
- description: Phone number, in +E.164 format, used to send the message.
+ description: "Phone number, in +E.164 format, used to send the message."
format: address
type: string
to:
@@ -32221,10 +33703,8 @@ components:
format: address
type: string
text:
- description: |-
- Message body (i.e., content) as a non-empty string.
-
- **Required for SMS**
+ description: "Message body (i.e., content) as a non-empty string.\n\n**Required\
+ \ for SMS**"
type: string
subject:
description: Subject of multimedia message
@@ -32249,12 +33729,13 @@ components:
type: string
use_profile_webhooks:
default: true
- description: If the profile this number is associated with has webhooks,
- use them for delivery notifications. If webhooks are also specified on
- the message itself, they will be attempted first, then those on the profile.
+ description: "If the profile this number is associated with has webhooks,\
+ \ use them for delivery notifications. If webhooks are also specified\
+ \ on the message itself, they will be attempted first, then those on the\
+ \ profile."
type: boolean
type:
- description: The protocol for sending the message, either SMS or MMS.
+ description: "The protocol for sending the message, either SMS or MMS."
enum:
- SMS
- MMS
@@ -32272,7 +33753,7 @@ components:
example:
friendly_name: call-router
active: false
- anchorsite_override: Amsterdam, Netherlands
+ anchorsite_override: "Amsterdam, Netherlands"
dtmf_type: Inband
first_command_timeout: true
first_command_timeout_secs: 10
@@ -32324,7 +33805,6 @@ components:
format: url
type: string
voice_fallback_url:
- default: "null"
description: URL to which Telnyx will deliver your XML Translator webhooks
if we get an error response from your voice_url.
example: https://fallback.example.com
@@ -32340,7 +33820,6 @@ components:
example: get
type: string
status_callback:
- default: "null"
description: URL for Telnyx to send requests to containing information about
call progress events.
example: https://example.com
@@ -32386,8 +33865,8 @@ components:
example: 300
type: integer
call_timeout_secs:
- description: Must be less than the profile's default_verification_timeout_secs
- or timeout_secs, whichever is lesser.
+ description: "Must be less than the profile's default_verification_timeout_secs\
+ \ or timeout_secs, whichever is lesser."
example: 30
type: integer
required:
@@ -32564,15 +34043,15 @@ components:
CreateVerifyProfileCallRequest:
properties:
speech_template:
- description: Optionally sets a speech text template when sending the verification
- code. Uses `{code}` to template in the actual verification code.
- example: 'Hello, this is the Acme Inc verification code you requested: {code}.'
+ description: "Optionally sets a speech text template when sending the verification\
+ \ code. Uses `{code}` to template in the actual verification code."
+ example: "Hello, this is the Acme Inc verification code you requested: {code}."
type: string
default_verification_timeout_secs:
- description: For every request that is initiated via this Verify profile,
- this sets the number of seconds before a verification request code expires.
- Once the verification request expires, the user cannot use the code to
- verify their identity.
+ description: "For every request that is initiated via this Verify profile,\
+ \ this sets the number of seconds before a verification request code expires.\
+ \ Once the verification request expires, the user cannot use the code\
+ \ to verify their identity."
example: 300
type: integer
default_call_timeout_secs:
@@ -32587,10 +34066,10 @@ components:
CreateVerifyProfileFlashcallRequest:
properties:
default_verification_timeout_secs:
- description: For every request that is initiated via this Verify profile,
- this sets the number of seconds before a verification request code expires.
- Once the verification request expires, the user cannot use the code to
- verify their identity.
+ description: "For every request that is initiated via this Verify profile,\
+ \ this sets the number of seconds before a verification request code expires.\
+ \ Once the verification request expires, the user cannot use the code\
+ \ to verify their identity."
example: 300
type: integer
required:
@@ -32600,10 +34079,10 @@ components:
CreateVerifyProfilePSD2Request:
properties:
default_verification_timeout_secs:
- description: For every request that is initiated via this Verify profile,
- this sets the number of seconds before a verification request code expires.
- Once the verification request expires, the user cannot use the code to
- verify their identity.
+ description: "For every request that is initiated via this Verify profile,\
+ \ this sets the number of seconds before a verification request code expires.\
+ \ Once the verification request expires, the user cannot use the code\
+ \ to verify their identity."
example: 300
type: integer
title: CreateVerifyProfilePSD2Request
@@ -32619,16 +34098,16 @@ components:
example: true
type: boolean
messaging_template:
- description: Optionally sets a messaging text template when sending the
- verification code. Uses `{code}` to template in the actual verification
- code.
- example: 'Hello, this is the Acme Inc verification code you requested: {code}.'
+ description: "Optionally sets a messaging text template when sending the\
+ \ verification code. Uses `{code}` to template in the actual verification\
+ \ code."
+ example: "Hello, this is the Acme Inc verification code you requested: {code}."
type: string
default_verification_timeout_secs:
- description: For every request that is initiated via this Verify profile,
- this sets the number of seconds before a verification request code expires.
- Once the verification request expires, the user cannot use the code to
- verify their identity.
+ description: "For every request that is initiated via this Verify profile,\
+ \ this sets the number of seconds before a verification request code expires.\
+ \ Once the verification request expires, the user cannot use the code\
+ \ to verify their identity."
example: 300
type: integer
vsms_enabled:
@@ -32640,10 +34119,10 @@ components:
CreateVerifyProfileWhatsappRequest:
properties:
default_verification_timeout_secs:
- description: For every request that is initiated via this Verify profile,
- this sets the number of seconds before a verification request code expires.
- Once the verification request expires, the user cannot use the code to
- verify their identity.
+ description: "For every request that is initiated via this Verify profile,\
+ \ this sets the number of seconds before a verification request code expires.\
+ \ Once the verification request expires, the user cannot use the code\
+ \ to verify their identity."
example: 300
type: integer
app_name:
@@ -32659,7 +34138,7 @@ components:
to: "15125557878"
type: text
text:
- body: 'Check out this site: http://www.telnyx.com'
+ body: "Check out this site: http://www.telnyx.com"
properties:
whatsapp_user_id:
description: The sender's WhatsApp ID.
@@ -32679,18 +34158,13 @@ components:
$ref: '#/components/schemas/Document'
video:
$ref: '#/components/schemas/Video'
- hsm:
- $ref: '#/components/schemas/Hsm'
- contacts:
- items:
- $ref: '#/components/schemas/Contact'
- type: array
location:
$ref: '#/components/schemas/Location'
preview_url:
- description: |-
- Specifying preview_url in the request is optional when not including a URL in your message.
- To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://.
+ description: "Specifying preview_url in the request is optional when not\
+ \ including a URL in your message.\nTo include a URL preview, set preview_url\
+ \ to true in the message body and make sure the URL begins with http://\
+ \ or https://."
type: boolean
template:
$ref: '#/components/schemas/Template'
@@ -32699,10 +34173,118 @@ components:
- whatsapp_user_id
title: Send Message Request Body
type: object
+ CreateWhatsappMessageTemplateRequestBody:
+ example:
+ components: components
+ name: name
+ language: af
+ category: ACCOUNT_UPDATE
+ properties:
+ category:
+ description: The template category
+ enum:
+ - ACCOUNT_UPDATE
+ - PAYMENT_UPDATE
+ - PERSONAL_FINANCE_UPDATE
+ - SHIPPING_UPDATE
+ - RESERVATION_UPDATE
+ - ISSUE_RESOLUTION
+ - APPOINTMENT_UPDATE
+ - TRANSPORTATION_UPDATE
+ - TICKET_UPDATE
+ - ALERT_UPDATE
+ - AUTO_REPLY
+ type: string
+ language:
+ description: The language of the whatsapp message template
+ enum:
+ - af
+ - sq
+ - ar
+ - az
+ - bn
+ - bg
+ - ca
+ - zh_CN
+ - zh_HK
+ - zh_TW
+ - hr
+ - cs
+ - da
+ - nl
+ - en
+ - en_GB
+ - en_US
+ - et
+ - fil
+ - fi
+ - fr
+ - ka
+ - de
+ - el
+ - gu
+ - ha
+ - he
+ - hi
+ - hu
+ - id
+ - ga
+ - it
+ - ja
+ - kn
+ - kk
+ - rw_RW
+ - ko
+ - ky_KG
+ - lo
+ - lv
+ - lt
+ - mk
+ - ms
+ - ml
+ - mr
+ - nb
+ - fa
+ - pl
+ - pt_BR
+ - pt_PT
+ - pa
+ - ro
+ - ru
+ - sr
+ - sk
+ - sl
+ - es
+ - es_AR
+ - es_ES
+ - es_MX
+ - sw
+ - sv
+ - ta
+ - te
+ - th
+ - tr
+ - uk
+ - ur
+ - uz
+ - vi
+ - zu
+ type: string
+ name:
+ description: A name identifying this whatsapp message template
+ type: string
+ components:
+ description: "The JSON-formatted components for the this whatsapp message\
+ \ template, please refer to whatsapp documentation on the correct structure\
+ \ for this field"
+ format: json
+ type: string
+ title: Create WhatsApp Message Template Request Body
+ type: object
CreatedAt:
- description: ISO 8601 formatted date indicating when the resource was created.
- example: 2020-02-02T22:25:27.521Z
- title: Created At
+ description: ISO 8601 formatted date-time indicating when the resource was created.
+ example: 2018-02-02T22:25:27.521Z
+ readOnly: true
type: string
CredentialConnection:
example:
@@ -32789,7 +34371,6 @@ components:
connection_name:
type: string
sip_uri_calling_preference:
- default: "null"
description: This feature enables inbound SIP URI calls to your Credential
Auth Connection. If enabled for all (unrestricted) then anyone who calls
the SIP URI ios or
+ android
+ example: ios
+ type: string
record_type:
example: push_credential
readOnly: true
@@ -42404,85 +44591,15 @@ components:
- private_key
- record_type
- server_key
+ - type
- updated_at
title: Successful response with details about a push credential
type: object
- PushCredentialResponse:
- description: Success response with details about a push credential
- example:
- data:
- updated_at: 2021-03-26T17:51:59.588408Z
- certificate: |
- Bag Attributes
- friendlyName: VoIP Services: com.telnyx.webrtcapp
- localKeyID: AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA
- subject=/UID=com.telnyx.webrtcapp.voip/CN=VoIP Services: com.telnyx.webrtcapp/OU=YKUVNPU9FS/O=Telnyx LLC/C=US
- issuer=/C=US/O=Apple Inc./OU=Apple Worldwide Developer Relations/CN=Apple Worldwide Developer Relations Certification Authority
- -----BEGIN CERTIFICATE-----
- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ
- DbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H
- FsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM
- UNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcH6HpirBQkrjJkak
- qqk5bC8Ye2PIcY0+nVFNWCoQqJadGduy1kHFmEsvkmaemfQdRIwn9q5lpNUnMSo3
- o6Cx0igYEHryauzg2hv14ylyvoCBxPOvl95NO86s9XS0CB2Qq6t9V59qkJiCPgKt
- hRtU70gavh5L0K/FPEO2FnjaNa/2kVeU8LWgqxH8dhIl/QQSipS49PDQR7DIJUWQ
- cakwR34j97t6UTxz7Yx05uUhjlcB4+hq2+RLA6LOOEcGnpECAwEAAaOCAqgwggKk
- MAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUiCcXCam2GGCL7Ou69kdZxVJUo7cw
- PwYIKwYBBQUHAQEEMzAxMC8GCCsGAQUFBzABhiNodHRwOi8vb2NzcC5hcHBsZS5j
- b20vb2NzcDAzLXd3ZHIwMTCCAR0GA1UdIASCARQwggEQMIIBDAbWVudHMuMDYGCC
- DRHGx1ngGt7fn3aobpf0CL+k8F1CcwkL8GZaAf3Pe6nxxWaTyaIU/LoBd8OU4aHq
- dGacHGp5tlgli8WhXNJuvHFmNnm0prQUeWjfTrHvAV2fEYJKoZIhvdjZAUBGAQUF
- MIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNh
- dGUgYnkgYW55IHaiZDeWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhaiZDeaiZDeaiZD
- Isit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P
- 5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5
- dnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3
- rpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9
- vG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjkknqoojqpiu109
- CfO37+af5amMDmgKHLWYqpIuF856urhODCRuprjCYwkyHX+cDbuB7E6BKjtyUCRx
- cHBsaWNhYmxlIHN0OIIJDKDAU094NOJujfoLmFwcGxlLmNvbS99w0BAQsFAAOCAQ
- Y2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0
- YXRlpX2LTQJsyzUjVKmbCjyATg5Y4QCqgDzrYUOBjL79dJzGwPKNQYG8YW5kYXJk
- LLuJX3jda0o393hnz03nz0jdah+m30lcS/iZkGAutno3MPd0EU9q3HyjyE0MjpHj
- /xXNgBL6zty06oXzUF+wXy1yNhUfouDLA3Yhv/uAbxN0NDart5s4kT/E3AAKIX3d
- BPYcCd3ran8CHgFW+dt3AIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwg==
- -----END CERTIFICATE-----
- alias: LucyCredential
- created_at: 2021-03-26T17:51:59.588408Z
- private_key: |-
- -----BEGIN RSA PRIVATE KEY-----
- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ
- DbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H
- FsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM
- UNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcw6HpirBQkrjJkak
- qqk5bC8Ye2PIcY0+nVFNWCoQqxuFc9/xYtCzPhd7SLfj+sDp4ZU1u18WYAoD5E3u
- Isit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P
- 5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5
- dnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3
- rpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9
- vG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjk+pMugWkBGwJ9r
- B8AfqXwV4qalv7/DPVj72OtBi79oiOltNsHWp4cChGkp8FxEaMhy5d6tT7lz/jY2
- Zgu2Jz2pAoGBANuey3lj6dgTPc7ZDgcUKVz96aC1dDzrqBRKrIPsodFTVUSdiZP4
- 3TLrD4niE0+yVD/9YvohdIlczWEQwvTy4feBcubkbKeU0LiAaAILfY1x/2twPuvG
- wfYU1uVpxUxYcKvrCxHVEBbw8iuf6PABaROZItM2MMrJy+sWf9SQ2rwdAoGBAM4k
- wsJSER7NNGw08L1QhmSYqNzxZtd2sOqJJXny32zOOW4c2UUbdqoXmfAgPceeAec0
- cE1W0SOzi06aNSjI1LQf5mKN4nFIt1Nw19zl9/YDZgbNkysuwsSlBQhZz+TwembC
- 3icGC8dLMLTpZPrXZ+bsmbj5QO5B0DY8hgXpzZn/AoGASr1Eo6AD8bvCmgU2B+St
- mu7yNfXqg9zyy00KXq8F9rW0W/B85HWZ2X0zQYpFZibbExfJOjRuc1y4rCLHJhMO
- IWvVTYxJCdLUISXZv3Bnnt4/vTFqyFRQp805wML5GN00It2PW9c1bYk78OqvnBXu
- y3Oe7WAQxMJd+jgi8pUFS2UCgYEAnr92cDjM0GCMn0vBnLi3Vh6t47/PR9wyb9r/
- zkK3xk2lsmNq+iolHuWf+WiKyv+mTYt3dEeINSsd+4ELsQW/r5rlSz4ihMTP0OUU
- hxtd8ck6N8D2NYoEGXVPQ9gOHisGx74HYBvq1CXWM2uNBRL/A7luxCDG3PQ3yJyh
- RUqAt7cCgYEAmp5WdnTZJxkYFwaQ/MYebU4KAMMsvGoMkF+x7MJuB/0oXdpJnMyV
- QOwLXF/NZrWCyEqstGRN+rSKJXF/slD4wgAZBjfRkXMeYcsCEEPXQLLnj8SF5QIv
- 8+rvyN9fX+MnxRY9PqCXRaXRl7G/3ORxbPRPsefQAsDQ5NsN5lay2l4=
- -----END RSA PRIVATE KEY-----
- id: 0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7
- server_key: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja9L8B1FrxJbc1z2btoiFYkda9Simkkda_0SJNidSan9-jkda-nieD3js9SdhfazonSbLN5VXQDqXFRuPW4kdo_fdnaxdai3y9z9DKXie0
- record_type: push_credential
- properties:
- data:
- $ref: '#/components/schemas/PushCredential'
+ Quality:
+ default: high
+ description: "The quality of the fax. Can be normal, high, very_high"
+ example: high
+ type: string
Queue:
example:
record_type: queue
@@ -42524,8 +44641,8 @@ components:
example: 50
type: integer
average_wait_time_secs:
- description: The average time that the calls currently in the queue have
- spent waiting, given in seconds.
+ description: "The average time that the calls currently in the queue have\
+ \ spent waiting, given in seconds."
example: 175
type: integer
required:
@@ -42559,10 +44676,10 @@ components:
example: queue_call
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call"
example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1
type: string
call_leg_id:
@@ -42591,7 +44708,8 @@ components:
example: 2019-01-23T18:10:02.574Z
type: string
wait_time_secs:
- description: The time the call has been waiting in the queue, given in seconds
+ description: "The time the call has been waiting in the queue, given in\
+ \ seconds"
example: 272
type: integer
queue_position:
@@ -42621,6 +44739,32 @@ components:
allOf:
- $ref: '#/components/schemas/Comment'
- $ref: '#/components/schemas/ReadComment_allOf'
+ Record:
+ properties:
+ id:
+ description: Identifies the resource.
+ example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
+ format: uuid
+ readOnly: true
+ type: string
+ record_type:
+ description: Identifies the type of the resource.
+ example: sample_record_type
+ readOnly: true
+ type: string
+ created_at:
+ description: ISO 8601 formatted date-time indicating when the resource was
+ created.
+ example: 2018-02-02T22:25:27.521Z
+ readOnly: true
+ type: string
+ updated_at:
+ description: ISO 8601 formatted date-time indicating when the resource was
+ updated.
+ example: 2018-02-02T22:25:27.521Z
+ readOnly: true
+ type: string
+ type: object
RecordType:
description: Identifies record type.
pattern: custom_storage_credentials
@@ -42681,8 +44825,8 @@ components:
example: completed
type: string
channels:
- description: When `dual`, final audio file has the first leg on channel
- A, and the rest on channel B.
+ description: "When `dual`, final audio file has the first leg on channel\
+ \ A, and the rest on channel B."
enum:
- single
- dual
@@ -42696,18 +44840,18 @@ components:
example: conference
type: string
conference_id:
- description: If a conference recording, uniquely identifies the recorded
- conference
+ description: "If a conference recording, uniquely identifies the recorded\
+ \ conference"
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type: string
call_leg_id:
- description: If a call recording, uniquely identifies the recorded call
- leg
+ description: "If a call recording, uniquely identifies the recorded call\
+ \ leg"
example: 11111111-5717-4562-b3fc-2c963f66afa6
type: string
call_session_id:
- description: If a call recording, uniquely identifies the recorded call
- session
+ description: "If a call recording, uniquely identifies the recorded call\
+ \ session"
example: 22222222-5717-4562-b3fc-2c963f66afa6
type: string
download_urls:
@@ -42866,8 +45010,8 @@ components:
properties:
token_ttl_secs:
default: 600
- description: The time to live in seconds of the Client Token, after that
- time the Client Token is invalid and can't be used to join a Room.
+ description: "The time to live in seconds of the Client Token, after that\
+ \ time the Client Token is invalid and can't be used to join a Room."
example: 600
maximum: 3600
minimum: 10
@@ -42879,6 +45023,57 @@ components:
required:
- refresh_token
type: object
+ Region:
+ example:
+ code: ashburn-va
+ updated_at: 2018-02-02T22:25:27.521Z
+ name: Ashburn
+ created_at: 2018-02-02T22:25:27.521Z
+ supported_interfaces:
+ - wireguard_interface
+ - wireguard_interface
+ record_type: region
+ properties:
+ record_type:
+ description: Identifies the type of the resource.
+ example: region
+ readOnly: true
+ type: string
+ code:
+ description: A code for the region.
+ example: ashburn-va
+ type: string
+ name:
+ description: A name for the region.
+ example: Ashburn
+ type: string
+ supported_interfaces:
+ description: List of interface types supported in this region.
+ items:
+ example: wireguard_interface
+ type: string
+ type: array
+ created_at:
+ description: ISO 8601 formatted date-time indicating when the resource was
+ created.
+ example: 2018-02-02T22:25:27.521Z
+ readOnly: true
+ type: string
+ updated_at:
+ description: ISO 8601 formatted date-time indicating when the resource was
+ updated.
+ example: 2018-02-02T22:25:27.521Z
+ readOnly: true
+ type: string
+ title: Region
+ type: object
+ RegionIn:
+ properties:
+ region_code:
+ description: The region the interface should be deployed to.
+ example: ashburn-va
+ type: string
+ type: object
RegionInformation:
example:
region_type: country_code
@@ -42895,6 +45090,15 @@ components:
region_name:
example: US
type: string
+ RegionOut:
+ properties:
+ region_code:
+ description: The region interface is deployed to.
+ example: ashburn-va
+ type: string
+ region:
+ $ref: '#/components/schemas/RegionOut_region'
+ type: object
RegisterCallRequest:
example:
to: +18005550100
@@ -42923,8 +45127,8 @@ components:
RegulatoryRequirements:
example:
regulatory_requirements:
- - description: Address matching the DID area code (street, building number,
- postal code, city and country)
+ - description: "Address matching the DID area code (street, building number,\
+ \ postal code, city and country)"
id: 12ade33a-21c0-473b-b055-b3c836e1c292
label: Address matching the DID area code
field_type: address_id
@@ -42933,9 +45137,9 @@ components:
locality_limit: Identical locality as the numbers desired
field_type: address
record_type: regulatory_requirement
- example: 311 W Superior St, Chicago, IL 60654
- - description: Address matching the DID area code (street, building number,
- postal code, city and country)
+ example: "311 W Superior St, Chicago, IL 60654"
+ - description: "Address matching the DID area code (street, building number,\
+ \ postal code, city and country)"
id: 12ade33a-21c0-473b-b055-b3c836e1c292
label: Address matching the DID area code
field_type: address_id
@@ -42944,7 +45148,7 @@ components:
locality_limit: Identical locality as the numbers desired
field_type: address
record_type: regulatory_requirement
- example: 311 W Superior St, Chicago, IL 60654
+ example: "311 W Superior St, Chicago, IL 60654"
phone_number_type: local
region_information:
- region_name: CH
@@ -42964,7 +45168,7 @@ components:
type: string
region_information:
items:
- $ref: '#/components/schemas/RegulatoryRequirements_region_information'
+ $ref: '#/components/schemas/RegulatoryRequirements_region_information_inner'
type: array
record_type:
example: phone_number_regulatory_requirements
@@ -42972,7 +45176,7 @@ components:
type: string
regulatory_requirements:
items:
- $ref: '#/components/schemas/RegulatoryRequirements_regulatory_requirements'
+ $ref: '#/components/schemas/RegulatoryRequirements_regulatory_requirements_inner'
type: array
RejectRequest:
example:
@@ -43018,8 +45222,8 @@ components:
example: link_clicked
type: string
to:
- description: Sending address (+E.164 formatted phone number, alphanumeric
- sender ID, or short code).
+ description: "Sending address (+E.164 formatted phone number, alphanumeric\
+ \ sender ID, or short code)."
format: address
type: string
message_id:
@@ -43198,16 +45402,16 @@ components:
example: true
type: boolean
webhook_event_url:
- description: The URL where webhooks related to this room will be sent. Must
- include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this room will be sent.\
+ \ Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this room will be
- sent if sending to the primary URL fails. Must include a scheme, such
- as 'https'.
+ description: "The failover URL where webhooks related to this room will\
+ \ be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -43330,16 +45534,16 @@ components:
of regions. Limited to 2 regions.
type: object
webhook_event_url:
- description: The URL where webhooks related to this room composition will
- be sent. Must include a scheme, such as 'https'.
+ description: "The URL where webhooks related to this room composition will\
+ \ be sent. Must include a scheme, such as 'https'."
example: https://example.com
format: url
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this room composition
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this room composition\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -43555,6 +45759,7 @@ components:
data_limit:
amount: "2048.1"
unit: MB
+ current_imei: "457032284023794"
current_mnc: "260"
created_at: 2018-02-02T22:25:27.521Z
imsi: "081932214823362973"
@@ -43562,7 +45767,7 @@ components:
accuracy_unit: m
latitude: "41.143"
accuracy: 1250
- longitude: -8.605
+ longitude: "-8.605"
record_type: sim_card
tags:
- personal
@@ -43573,6 +45778,11 @@ components:
updated_at: 2018-02-02T22:25:27.521Z
ipv4: 192.168.0.0
ipv6: 2001:cdba:0000:0000:0000:0000:3257:9652
+ live_data_session: connected
+ authorized_imeis:
+ - "106516771852751"
+ - "534051870479563"
+ - "508821468377961"
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
msisdn: +13109976224
current_mcc: "410"
@@ -43580,8 +45790,8 @@ components:
amount: "2049.0"
unit: MB
status:
- reason: The SIM card is active, ready to connect to networks and consume
- data.
+ reason: "The SIM card is active, ready to connect to networks and consume\
+ \ data."
value: enabled
properties:
id:
@@ -43635,6 +45845,23 @@ components:
$ref: '#/components/schemas/SIMCard_data_limit'
current_billing_period_consumed_data:
$ref: '#/components/schemas/SIMCard_current_billing_period_consumed_data'
+ authorized_imeis:
+ description: List of IMEIs authorized to use a given SIM card.
+ example:
+ - "106516771852751"
+ - "534051870479563"
+ - "508821468377961"
+ items:
+ format: int64
+ type: string
+ type: array
+ current_imei:
+ description: IMEI of the device where a given SIM card is currently being
+ used.
+ example: "457032284023794"
+ format: int64
+ readOnly: true
+ type: string
created_at:
description: ISO 8601 formatted date-time indicating when the resource was
created.
@@ -43648,14 +45875,16 @@ components:
readOnly: true
type: string
ipv4:
- description: |
- The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.
+ description: "The SIM's address in the currently connected network. This\
+ \ IPv4 address is usually obtained dynamically, so it may vary according\
+ \ to the location or new connections.\n"
example: 192.168.0.0
readOnly: true
type: string
ipv6:
- description: |
- The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.
+ description: "The SIM's address in the currently connected network. This\
+ \ IPv6 address is usually obtained dynamically, so it may vary according\
+ \ to the location or new connections.\n"
example: 2001:cdba:0000:0000:0000:0000:3257:9652
readOnly: true
type: string
@@ -43675,6 +45904,16 @@ components:
example: "410"
readOnly: true
type: string
+ live_data_session:
+ description: Indicates whether the device is actively connected to a network
+ and able to run data.
+ enum:
+ - connected
+ - disconnected
+ - unknown
+ example: connected
+ readOnly: true
+ type: string
title: SIMCard
type: object
SIMCardAction:
@@ -43683,9 +45922,9 @@ components:
example:
sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
settings: {}
- updated_at: 2020-02-03T22:25:27.521Z
+ updated_at: 2018-02-02T22:25:27.521Z
action_type: enable
- created_at: 2020-02-02T22:25:27.521Z
+ created_at: 2018-02-02T22:25:27.521Z
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: sim_card_action
status:
@@ -43709,14 +45948,13 @@ components:
readOnly: true
type: string
action_type:
- description: |-
- The operation type. It can be one of the following: enable - move the SIM card to the enabled statusenable_standby_sim_card - move a SIM card previously on the standby status to the enabled status after it consumes data.disable - move the SIM card to the disabled statusset_standby - move the SIM card to the standby statusenable - move the SIM card to the enabled\
+ \ statusenable_standby_sim_card - move a SIM\
+ \ card previously on the standby status to the enabled\
+ \ status after it consumes data.disable - move\
+ \ the SIM card to the disabled statusset_standby\
+ \ - move the SIM card to the standby statusregistering - the card is being registeredenabling - the card is being enabledenabled - the card is enabled and ready for usedisabling - the card is being disableddisabled - the card has been disabled and cannot be useddata_limit_exceeded - the card has exceeded its data consumption limitsetting_standby - the process to set the card in stand by is in progressstandby - the card is in stand byregistering - the card is\
+ \ being registeredenabling - the card is being\
+ \ enabledenabled - the card is enabled and ready\
+ \ for usedisabling - the card is being disableddisabled - the card has been disabled and cannot be\
+ \ useddata_limit_exceeded - the card has exceeded\
+ \ its data consumption limitsetting_standby -\
+ \ the process to set the card in stand by is in progressstandby\
+ \ - the card is in stand byLatency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
enum:
- '"Latency"'
- - '"Chicago, IL"'
- - '"Ashburn, VA"'
- - '"San Jose, CA"'
- example: '"Amsterdam, Netherlands"'
+ - "\"Chicago, IL\""
+ - "\"Ashburn, VA\""
+ - "\"San Jose, CA\""
+ example: "\"Amsterdam, Netherlands\""
type: string
dtmf_type:
default: RFC 2833
@@ -46062,8 +48493,8 @@ components:
$ref: '#/components/schemas/CallControlApplicationOutbound'
webhook_api_version:
default: "1"
- description: Determines which webhook format will be used, Telnyx API v1
- or v2.
+ description: "Determines which webhook format will be used, Telnyx API v1\
+ \ or v2."
enum:
- "1"
- "2"
@@ -46071,9 +48502,9 @@ components:
type: string
webhook_event_failover_url:
default: ""
- description: The failover URL where webhooks related to this connection
- will be sent if sending to the primary URL fails. Must include a scheme,
- such as 'https'.
+ description: "The failover URL where webhooks related to this connection\
+ \ will be sent if sending to the primary URL fails. Must include a scheme,\
+ \ such as 'https'."
example: https://failover.example.com
format: url
nullable: true
@@ -46090,6 +48521,70 @@ components:
- webhook_event_url
title: Update Call Control Application Request
type: object
+ UpdateCallRequest:
+ example:
+ Status: completed
+ properties:
+ Status:
+ description: The value to set the call status to. Setting the status to
+ completed ends the call.
+ example: completed
+ type: string
+ Url:
+ description: The URL where TeXML will make a request to retrieve a new set
+ of TeXML instructions to continue the call flow.
+ example: https://www.example.com/intruction-b.xml
+ type: string
+ Method:
+ description: HTTP request type used for `Url`.
+ enum:
+ - GET
+ - POST
+ example: GET
+ type: string
+ FallbackUrl:
+ description: A failover URL for which Telnyx will retrieve the TeXML call
+ instructions if the Url is not responding.
+ example: https://www.example.com/intruction-c.xml
+ type: string
+ FallbackMethod:
+ description: HTTP request type used for `FallbackUrl`.
+ enum:
+ - GET
+ - POST
+ example: GET
+ type: string
+ StatusCallback:
+ description: URL destination for Telnyx to send status callback events to
+ for the call.
+ example: https://www.example.com/callback
+ type: string
+ StatusCallbackMethod:
+ description: HTTP request type used for `StatusCallback`.
+ enum:
+ - GET
+ - POST
+ example: GET
+ type: string
+ Texml:
+ description: TeXml to replace the current one with.
+ example: /v2/documents
+ endpoint.
+ example: 5f940c35-ef28-4408-bb95-af73b047d589
+ type: string
+ required:
+ - document_id
+ - document_type
+ type: object
+ uploadPortingOrderDocuments_request:
+ properties:
+ documents:
+ description: A list of documents to be associated with a porting order.
+ items:
+ $ref: '#/components/schemas/uploadPortingOrderDocuments_request_documents_inner'
+ type: array
+ required:
+ - documents
+ type: object
+ uploadPortingOrderDocuments_201_response:
example:
data:
- created_at: 2020-03-19T10:07:15.527Z
@@ -54701,9 +57274,48 @@ components:
items:
$ref: '#/components/schemas/PortingOrderDocument'
type: array
- title: Porting Order Documents Created
type: object
- Sub_Request_By_Porting_Order:
+ ListPortingOrderRequirements_200_response:
+ example:
+ data:
+ - requirement_type:
+ name: Latest Invoice
+ description: A copy of the latest phone bill from the current provider
+ id: 53970723-fbff-4f46-a975-f62be6c1a585
+ type: document
+ acceptance_criteria:
+ acceptable_values: []
+ example: Most recent phone bill
+ field_value: 9787fb5f-cbe5-4de4-b765-3303774ee9fe
+ requirement_status: approved
+ field_type: document
+ record_type: porting_requirement
+ - requirement_type:
+ name: Latest Invoice
+ description: A copy of the latest phone bill from the current provider
+ id: 53970723-fbff-4f46-a975-f62be6c1a585
+ type: document
+ acceptance_criteria:
+ acceptable_values: []
+ example: Most recent phone bill
+ field_value: 9787fb5f-cbe5-4de4-b765-3303774ee9fe
+ requirement_status: approved
+ field_type: document
+ record_type: porting_requirement
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/PortingOrderRequirementDetail'
+ type: array
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
+ type: object
+ getPortingOrderSubRequest_200_response:
example:
data:
sub_request_id: 9787fb5f-cbe5-4de4-b765-3303774ee9fe
@@ -54711,9 +57323,8 @@ components:
properties:
data:
$ref: '#/components/schemas/GetSubRequestByPortingOrder'
- title: Sub Request By Porting Order
type: object
- List_Porting_Phone_Numbers:
+ listPortingPhoneNumbers_200_response:
example:
data:
- activation_status: Active
@@ -54746,33 +57357,64 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Porting Phone Numbers
type: object
- List_Portout_Response:
+ listPortoutRequest_200_response:
example:
data:
- - id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ - reason: reason
+ support_key: PO_764725
+ city: Chicago
+ created_at: 2018-02-02T22:25:27.521Z
+ lsr:
+ - https://example.com/files/lsr.pdf
+ end_user_name: McPortersen
+ service_address: 000 Example Street
+ spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ pon: "00000000"
+ updated_at: 2018-02-02T22:25:27.521Z
+ vendor: 0e66ed3b-37e6-4fed-93d6-a30ce2493661
+ id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ state: IL
+ carrier_name: test
+ inserted_at: 2018-02-02T22:25:27.521Z
+ authorized_name: McPortersen
+ zip: "00000"
+ current_carrier: telnyx
+ already_ported: false
record_type: portout
phone_numbers:
- +35312345678
- carrier_name: test
- foc_date: 2018-02-02T22:25:27.521Z
requested_foc_date: 2018-02-02T22:25:27.521Z
- spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- status: pending
+ user_id: 7865816a-ee85-4e50-b19e-52983dcc6d4a
+ foc_date: 2018-02-02T22:25:27.521Z
+ status: rejected
+ - reason: reason
+ support_key: PO_764725
+ city: Chicago
created_at: 2018-02-02T22:25:27.521Z
+ lsr:
+ - https://example.com/files/lsr.pdf
+ end_user_name: McPortersen
+ service_address: 000 Example Street
+ spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ pon: "00000000"
updated_at: 2018-02-02T22:25:27.521Z
- - id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ vendor: 0e66ed3b-37e6-4fed-93d6-a30ce2493661
+ id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ state: IL
+ carrier_name: test
+ inserted_at: 2018-02-02T22:25:27.521Z
+ authorized_name: McPortersen
+ zip: "00000"
+ current_carrier: telnyx
+ already_ported: false
record_type: portout
phone_numbers:
- +35312345678
- carrier_name: test
- foc_date: 2018-02-02T22:25:27.521Z
requested_foc_date: 2018-02-02T22:25:27.521Z
- spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- status: pending
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
+ user_id: 7865816a-ee85-4e50-b19e-52983dcc6d4a
+ foc_date: 2018-02-02T22:25:27.521Z
+ status: rejected
meta:
page_number: 3
total_pages: 13
@@ -54785,28 +57427,42 @@ components:
type: array
meta:
$ref: '#/components/schemas/Metadata'
- title: List Portout Response
type: object
- Portout_Response:
+ findPortoutRequest_200_response:
example:
data:
+ reason: reason
+ support_key: PO_764725
+ city: Chicago
+ created_at: 2018-02-02T22:25:27.521Z
+ lsr:
+ - https://example.com/files/lsr.pdf
+ end_user_name: McPortersen
+ service_address: 000 Example Street
+ spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ pon: "00000000"
+ updated_at: 2018-02-02T22:25:27.521Z
+ vendor: 0e66ed3b-37e6-4fed-93d6-a30ce2493661
id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
+ state: IL
+ carrier_name: test
+ inserted_at: 2018-02-02T22:25:27.521Z
+ authorized_name: McPortersen
+ zip: "00000"
+ current_carrier: telnyx
+ already_ported: false
record_type: portout
phone_numbers:
- +35312345678
- carrier_name: test
- foc_date: 2018-02-02T22:25:27.521Z
requested_foc_date: 2018-02-02T22:25:27.521Z
- spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- status: pending
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
+ user_id: 7865816a-ee85-4e50-b19e-52983dcc6d4a
+ foc_date: 2018-02-02T22:25:27.521Z
+ status: rejected
properties:
data:
$ref: '#/components/schemas/PortoutDetails'
- title: Portout Response
type: object
- List_Portout_Comments:
+ findPortoutComments_200_response:
example:
data:
- id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
@@ -54833,16 +57489,14 @@ components:
type: array
meta:
$ref: '#/components/schemas/Metadata'
- title: List Portout Comments
type: object
- Create_Comment_Portout_Request:
+ postPortRequestComment_request:
properties:
body:
description: Comment to post on this portout request
type: string
- title: Create Comment Portout Request
type: object
- Portout_Comment_Resposne:
+ postPortRequestComment_201_response:
example:
data:
id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
@@ -54854,9 +57508,8 @@ components:
properties:
data:
$ref: '#/components/schemas/PortoutComment'
- title: Portout Comment Resposne
type: object
- PortOut_List_Supporting_Documents_Response:
+ getPortRequestSupportingDocuments_201_response:
example:
data:
- id: 5a16902a-2ee9-4882-a247-420fc6627b62
@@ -54878,9 +57531,8 @@ components:
items:
$ref: '#/components/schemas/PortOutSupportingDocument'
type: array
- title: PortOut List Supporting Documents Response
type: object
- _portouts__id__supporting_documents_documents:
+ postPortRequestSupportingDocuments_request_documents_inner:
properties:
type:
description: Identifies the type of the document
@@ -54898,50 +57550,24 @@ components:
- document_id
- type
type: object
- Create_Porting_Supporting_Docs_Request:
+ postPortRequestSupportingDocuments_request:
properties:
documents:
description: List of supporting documents parameters
items:
- $ref: '#/components/schemas/_portouts__id__supporting_documents_documents'
+ $ref: '#/components/schemas/postPortRequestSupportingDocuments_request_documents_inner'
maxItems: 10
minItems: 1
type: array
- title: Create Porting Supporting Docs Request
- type: object
- Create_PortOut_Supporting_Documents_Response:
- example:
- data:
- - id: 5a16902a-2ee9-4882-a247-420fc6627b62
- record_type: supporting_document
- type: loa
- portout_id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- document_id: f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- - id: 5a16902a-2ee9-4882-a247-420fc6627b62
- record_type: supporting_document
- type: loa
- portout_id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
- document_id: f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- properties:
- data:
- items:
- $ref: '#/components/schemas/PortOutSupportingDocument'
- type: array
- title: Create PortOut Supporting Documents Response
type: object
- Update_Portout_Status_Request:
+ updatePortoutRequest_request:
properties:
reason:
description: Provide a reason if rejecting the port out request
example: I do not recognize this transaction
type: string
- title: Update Portout Status Request
type: object
- Get_All_Private_Wireless_Gateways_Response:
+ getPrivateWirelessGateways_200_response:
example:
data:
- ip_range: 100.64.1.0/24
@@ -54949,24 +57575,34 @@ components:
updated_at: 2018-02-02T22:25:27.521Z
name: My private wireless gateway
created_at: 2018-02-02T22:25:27.521Z
+ assigned_resources:
+ - count: 1
+ record_type: sim_card_group
+ - count: 1
+ record_type: sim_card_group
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: private_wireless_gateway
region_code: ashburn-va
status:
- error_description: "null"
- error_code: "null"
+ error_description: error_description
+ error_code: error_code
value: provisioned
- ip_range: 100.64.1.0/24
network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
updated_at: 2018-02-02T22:25:27.521Z
name: My private wireless gateway
created_at: 2018-02-02T22:25:27.521Z
+ assigned_resources:
+ - count: 1
+ record_type: sim_card_group
+ - count: 1
+ record_type: sim_card_group
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: private_wireless_gateway
region_code: ashburn-va
status:
- error_description: "null"
- error_code: "null"
+ error_description: error_description
+ error_code: error_code
value: provisioned
meta:
page_number: 2
@@ -54980,9 +57616,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: Get All Private Wireless Gateways Response
type: object
- Create_Private_Wireless_Gatweway_Request:
+ createPrivateWirelessGateway_request:
properties:
network_id:
description: The identification of the related network resource.
@@ -54996,9 +57631,8 @@ components:
required:
- name
- network_id
- title: Create Private Wireless Gatweway Request
type: object
- Create_Private_Wireless_Gateway_Response:
+ createPrivateWirelessGateway_202_response:
example:
data:
ip_range: 100.64.1.0/24
@@ -55006,57 +57640,46 @@ components:
updated_at: 2018-02-02T22:25:27.521Z
name: My private wireless gateway
created_at: 2018-02-02T22:25:27.521Z
+ assigned_resources:
+ - count: 1
+ record_type: sim_card_group
+ - count: 1
+ record_type: sim_card_group
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: private_wireless_gateway
region_code: ashburn-va
status:
- error_description: "null"
- error_code: "null"
+ error_description: error_description
+ error_code: error_code
value: provisioned
properties:
data:
$ref: '#/components/schemas/PrivateWirelessGateway'
- title: Create Private Wireless Gateway Response
type: object
- Get_Private_Wireless_Gateway_Response:
+ PublicInternetGatewayList_200_response:
example:
data:
- ip_range: 100.64.1.0/24
- network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- updated_at: 2018-02-02T22:25:27.521Z
- name: My private wireless gateway
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: private_wireless_gateway
- region_code: ashburn-va
- status:
- error_description: "null"
- error_code: "null"
- value: provisioned
+ - null
+ - null
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
properties:
data:
- $ref: '#/components/schemas/PrivateWirelessGateway'
- title: Get Private Wireless Gateway Response
+ items:
+ $ref: '#/components/schemas/PublicInternetGatewayRead'
+ type: array
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
type: object
- Delete_Private_Wireless_Gateway_Response:
+ PublicInternetGatewayCreate_202_response:
example:
- data:
- ip_range: 100.64.1.0/24
- network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- updated_at: 2018-02-02T22:25:27.521Z
- name: My private wireless gateway
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: private_wireless_gateway
- region_code: ashburn-va
- status:
- error_description: "null"
- error_code: "null"
- value: provisioned
+ data: null
properties:
data:
- $ref: '#/components/schemas/PrivateWirelessGateway'
- title: Delete Private Wireless Gateway Response
+ $ref: '#/components/schemas/PublicInternetGatewayRead'
type: object
Queue_Response:
example:
@@ -55202,7 +57825,32 @@ components:
$ref: '#/components/schemas/Recording'
title: Get Recording Response
type: object
- Doc_Reqs_List_Requirement_Types_Response:
+ RegionList_200_response:
+ example:
+ data:
+ - code: ashburn-va
+ updated_at: 2018-02-02T22:25:27.521Z
+ name: Ashburn
+ created_at: 2018-02-02T22:25:27.521Z
+ supported_interfaces:
+ - wireguard_interface
+ - wireguard_interface
+ record_type: region
+ - code: ashburn-va
+ updated_at: 2018-02-02T22:25:27.521Z
+ name: Ashburn
+ created_at: 2018-02-02T22:25:27.521Z
+ supported_interfaces:
+ - wireguard_interface
+ - wireguard_interface
+ record_type: region
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/Region'
+ type: array
+ type: object
+ docReqsListRequirementTypes_200_response:
example:
data:
- updated_at: 2021-04-12T20:20:20.020Z
@@ -55217,7 +57865,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
- updated_at: 2021-04-12T20:20:20.020Z
name: Proof of Address
description: Proves the customer has a physical address in the same locality
@@ -55230,7 +57878,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
meta:
page_number: 2
total_pages: 3
@@ -55243,9 +57891,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: Doc Reqs List Requirement Types Response
type: object
- Doc_Reqs_Requirement_Type_Response:
+ docReqsRetrieveRequirementType_200_response:
example:
data:
updated_at: 2021-04-12T20:20:20.020Z
@@ -55260,13 +57907,12 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
properties:
data:
$ref: '#/components/schemas/DocReqsRequirementType'
- title: Doc Reqs Requirement Type Response
type: object
- List_Requirements_Response:
+ listRequirements_200_response:
example:
data:
- requirements_types:
@@ -55282,7 +57928,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
- updated_at: 2021-04-12T20:20:20.020Z
name: Proof of Address
description: Proves the customer has a physical address in the same locality
@@ -55295,7 +57941,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
country_code: FR
phone_number_type: local
updated_at: 2021-04-12T20:20:20.020Z
@@ -55317,7 +57963,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
- updated_at: 2021-04-12T20:20:20.020Z
name: Proof of Address
description: Proves the customer has a physical address in the same locality
@@ -55330,7 +57976,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
country_code: FR
phone_number_type: local
updated_at: 2021-04-12T20:20:20.020Z
@@ -55351,9 +57997,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Requirements Response
type: object
- Doc_Reqs_Requirement_Response:
+ docReqsRetrieveDocumentRequirements_200_response:
example:
data:
requirements_types:
@@ -55369,7 +58014,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
- updated_at: 2021-04-12T20:20:20.020Z
name: Proof of Address
description: Proves the customer has a physical address in the same locality
@@ -55382,7 +58027,7 @@ components:
locality_limit: Issued by the same country that the phone number belongs
to
record_type: requirement_type
- example: Utility bill, internet bill, phone bill, or lease
+ example: "Utility bill, internet bill, phone bill, or lease"
country_code: FR
phone_number_type: local
updated_at: 2021-04-12T20:20:20.020Z
@@ -55394,9 +58039,8 @@ components:
properties:
data:
$ref: '#/components/schemas/DocReqsRequirement'
- title: Doc Reqs Requirement Response
type: object
- List_Room_Compositions_Response:
+ ListRoomCompositions_200_response:
example:
data:
- completed_at: 2022-02-25T05:39:56.377426Z
@@ -55459,41 +58103,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Room Compositions Response
- type: object
- Create_Room_Composition_Response:
- example:
- data:
- completed_at: 2022-02-25T05:39:56.377426Z
- download_url: null
- duration_secs: 84
- ended_at: 2022-02-24T23:22:24.577677Z
- format: mp4
- id: 7103dc53-ee59-4b54-a58b-c77d99ceb037
- record_type: composition
- resolution: 1280x720
- room_id: f981dbb3-228a-44e9-ac54-e87f0e2658b0
- session_id: 8f728d7b-00e2-4c59-8c27-f564b828df87
- size_mb: 6
- started_at: 2022-02-24T23:21:00.077209Z
- status: enqueued
- user_id: 12a04ec9-0f91-4a91-9f3a-a19d9931182e
- video_layout:
- first:
- height: 720
- video_sources:
- - '*'
- width: 1280
- x_pos: 0
- y_pos: 0
- z_pos: 0
- webhook_event_url: https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02
- properties:
- data:
- $ref: '#/components/schemas/RoomComposition'
- title: Create Room Composition Response
type: object
- Get_Room_Composition_Response:
+ CreateRoomComposition_202_response:
example:
data:
completed_at: 2022-02-25T05:39:56.377426Z
@@ -55523,9 +58134,8 @@ components:
properties:
data:
$ref: '#/components/schemas/RoomComposition'
- title: Get Room Composition Response
type: object
- List_Room_Participants_Response:
+ ListRoomParticipants_200_response:
example:
data:
- id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55554,9 +58164,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Room Participants Response
type: object
- Get_Room_Participant_Response:
+ ViewRoomParticipant_200_response:
example:
data:
id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55569,9 +58178,8 @@ components:
properties:
data:
$ref: '#/components/schemas/RoomParticipant'
- title: Get Room Participant Response
type: object
- List_Room_Recordings_Response:
+ ListRoomRecordings_200_response:
example:
data:
- id: 6b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55618,7 +58226,6 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Room Recordings Response
type: object
Bulk_Room_Recordings_Delete_Response_data:
example:
@@ -55638,7 +58245,7 @@ components:
$ref: '#/components/schemas/Bulk_Room_Recordings_Delete_Response_data'
title: Bulk Room Recordings Delete Response
type: object
- Get_Room_Recording_Response:
+ ViewRoomRecording_200_response:
example:
data:
id: 6b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55660,9 +58267,8 @@ components:
properties:
data:
$ref: '#/components/schemas/RoomRecording'
- title: Get Room Recording Response
type: object
- List_Room_Sessions_Response:
+ ListRoomSessions_200_response:
example:
data:
- id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55693,9 +58299,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Room Sessions Response
type: object
- Get_Room_Session_Response:
+ ViewRoomSession_200_response:
example:
data:
id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55709,9 +58314,8 @@ components:
properties:
data:
$ref: '#/components/schemas/RoomSession'
- title: Get Room Session Response
type: object
- Action_Success_Response_data:
+ EndSession_200_response_data:
example:
result: ok
properties:
@@ -55719,16 +58323,15 @@ components:
example: ok
type: string
type: object
- Action_Success_Response:
+ EndSession_200_response:
example:
data:
result: ok
properties:
data:
- $ref: '#/components/schemas/Action_Success_Response_data'
- title: Action Success Response
+ $ref: '#/components/schemas/EndSession_200_response_data'
type: object
- List_Rooms_Response:
+ ListRooms_200_response:
example:
data:
- id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55781,9 +58384,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: List Rooms Response
type: object
- Create_Room_Response:
+ CreateRoom_201_response:
example:
data:
id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
@@ -55808,63 +58410,8 @@ components:
properties:
data:
$ref: '#/components/schemas/Room'
- title: Create Room Response
type: object
- Get_Room_Response:
- example:
- data:
- id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
- max_participants: 50
- unique_name: My Room
- created_at: 2021-04-16T09:46:20.954863Z
- updated_at: 2021-04-16T10:24:55.962200Z
- active_session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e74
- enable_recording: true
- webhook_event_failover_url: https://failover.example.com
- webhook_timeout_secs: 25
- webhook_event_url: https://www.example.com
- sessions:
- - id: 7b61621f-62e0-4aad-ab11-9fd19e272e74
- room_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
- active: true
- created_at: 2021-04-16T09:46:20.954863Z
- updated_at: 2021-04-16T10:24:55.962200Z
- participants: []
- record_type: room_session
- record_type: room
- properties:
- data:
- $ref: '#/components/schemas/Room'
- title: Get Room Response
- type: object
- Patch_Room_Response:
- example:
- data:
- id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
- max_participants: 50
- unique_name: My Room
- created_at: 2021-04-16T09:46:20.954863Z
- updated_at: 2021-04-16T10:24:55.962200Z
- active_session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e74
- enable_recording: true
- webhook_event_failover_url: https://failover.example.com
- webhook_timeout_secs: 25
- webhook_event_url: https://www.example.com
- sessions:
- - id: 7b61621f-62e0-4aad-ab11-9fd19e272e74
- room_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
- active: true
- created_at: 2021-04-16T09:46:20.954863Z
- updated_at: 2021-04-16T10:24:55.962200Z
- participants: []
- record_type: room_session
- record_type: room
- properties:
- data:
- $ref: '#/components/schemas/Room'
- title: Patch Room Response
- type: object
- Create_Room_Client_Token_Response_data:
+ CreateRoomClientToken_201_response_data:
example:
token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA
token_expires_at: 2021-04-22T12:24:55Z
@@ -55890,7 +58437,7 @@ components:
format: datetime
type: string
type: object
- Create_Room_Client_Token_Response:
+ CreateRoomClientToken_201_response:
example:
data:
token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA
@@ -55899,10 +58446,9 @@ components:
refresh_token_expires_at: 2021-04-22T12:15:05Z
properties:
data:
- $ref: '#/components/schemas/Create_Room_Client_Token_Response_data'
- title: Create Room Client Token Response
+ $ref: '#/components/schemas/CreateRoomClientToken_201_response_data'
type: object
- Refresh_Room_Client_Token_Response_data:
+ RefreshRoomClientToken_201_response_data:
example:
token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA
token_expires_at: 2021-04-22T12:24:55Z
@@ -55917,15 +58463,14 @@ components:
format: datetime
type: string
type: object
- Refresh_Room_Client_Token_Response:
+ RefreshRoomClientToken_201_response:
example:
data:
token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA
token_expires_at: 2021-04-22T12:24:55Z
properties:
data:
- $ref: '#/components/schemas/Refresh_Room_Client_Token_Response_data'
- title: Refresh Room Client Token Response
+ $ref: '#/components/schemas/RefreshRoomClientToken_201_response_data'
type: object
List_Short_Codes_Response:
example:
@@ -55973,14 +58518,14 @@ components:
$ref: '#/components/schemas/ShortCode'
title: Short Code Response
type: object
- SimCard_Action_Collection_Response:
+ ListSIMCardActions_200_response:
example:
data:
- sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
settings: {}
- updated_at: 2020-02-03T22:25:27.521Z
+ updated_at: 2018-02-02T22:25:27.521Z
action_type: enable
- created_at: 2020-02-02T22:25:27.521Z
+ created_at: 2018-02-02T22:25:27.521Z
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: sim_card_action
status:
@@ -55988,9 +58533,9 @@ components:
value: completed
- sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
settings: {}
- updated_at: 2020-02-03T22:25:27.521Z
+ updated_at: 2018-02-02T22:25:27.521Z
action_type: enable
- created_at: 2020-02-02T22:25:27.521Z
+ created_at: 2018-02-02T22:25:27.521Z
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: sim_card_action
status:
@@ -56008,16 +58553,15 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: SimCard Action Collection Response
type: object
- SIM_Card_Action_Response:
+ SimCardActionGet_200_response:
example:
data:
sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
settings: {}
- updated_at: 2020-02-03T22:25:27.521Z
+ updated_at: 2018-02-02T22:25:27.521Z
action_type: enable
- created_at: 2020-02-02T22:25:27.521Z
+ created_at: 2018-02-02T22:25:27.521Z
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: sim_card_action
status:
@@ -56026,9 +58570,8 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardAction'
- title: SIM Card Action Response
type: object
- SimCard_Data_Usage_Notification_Collection:
+ ListSimCardDataUsageNotifications_200_response:
example:
data:
- id: 79228acc-3f08-4e70-ac68-cb5aae8b537a
@@ -56057,9 +58600,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: SimCard Data Usage Notification Collection
type: object
- _sim_card_data_usage_notifications_threshold:
+ SimCardDataUsageNotificationsPost_request_threshold:
description: Data usage threshold that will trigger the notification.
properties:
amount:
@@ -56073,7 +58615,7 @@ components:
example: MB
type: string
type: object
- Create_SIM_Card_Data_Usage_Notification_Request:
+ SimCardDataUsageNotificationsPost_request:
properties:
sim_card_id:
description: The identification UUID of the related SIM card resource.
@@ -56081,43 +58623,12 @@ components:
format: uuid
type: string
threshold:
- $ref: '#/components/schemas/_sim_card_data_usage_notifications_threshold'
+ $ref: '#/components/schemas/SimCardDataUsageNotificationsPost_request_threshold'
required:
- sim_card_id
- threshold
- title: Create SIM Card Data Usage Notification Request
- type: object
- Create_Sim_Card_Data_Usage_Notification_Response:
- example:
- data:
- id: 79228acc-3f08-4e70-ac68-cb5aae8b537a
- sim_card_id: b34c1683-cd85-4493-b9a5-315eb4bc5e19
- threshold:
- amount: "2048.0"
- unit: MB
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- properties:
- data:
- $ref: '#/components/schemas/SimCardDataUsageNotification'
- title: Create Sim Card Data Usage Notification Response
- type: object
- Get_Sim_Card_Data_Usage_Notification_Response:
- example:
- data:
- id: 79228acc-3f08-4e70-ac68-cb5aae8b537a
- sim_card_id: b34c1683-cd85-4493-b9a5-315eb4bc5e19
- threshold:
- amount: "2048.0"
- unit: MB
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- properties:
- data:
- $ref: '#/components/schemas/SimCardDataUsageNotification'
- title: Get Sim Card Data Usage Notification Response
type: object
- Delete_Sim_Card_Data_Usage_Notification_Response:
+ SimCardDataUsageNotificationsPost_201_response:
example:
data:
id: 79228acc-3f08-4e70-ac68-cb5aae8b537a
@@ -56130,24 +58641,8 @@ components:
properties:
data:
$ref: '#/components/schemas/SimCardDataUsageNotification'
- title: Delete Sim Card Data Usage Notification Response
type: object
- Update_Sim_Card_Data_Usage_Notification_Response:
- example:
- data:
- id: 79228acc-3f08-4e70-ac68-cb5aae8b537a
- sim_card_id: b34c1683-cd85-4493-b9a5-315eb4bc5e19
- threshold:
- amount: "2048.0"
- unit: MB
- created_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- properties:
- data:
- $ref: '#/components/schemas/SimCardDataUsageNotification'
- title: Update Sim Card Data Usage Notification Response
- type: object
- SimCard_Group_Action_Collection_Response:
+ SimCardGroupActionsGet_200_response:
example:
data:
- sim_card_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
@@ -56180,9 +58675,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: SimCard Group Action Collection Response
type: object
- SIM_Card_Group_Action_Response:
+ SimCardGroupActionGet_200_response:
example:
data:
sim_card_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
@@ -56197,9 +58691,8 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardGroupAction'
- title: SIM Card Group Action Response
type: object
- Get_All_Sim_Card_Groups_Response:
+ SimCardGroupsGetAll_200_response:
example:
data:
- default: true
@@ -56207,6 +58700,7 @@ components:
amount: "2048.1"
unit: MB
updated_at: 2018-02-02T22:25:27.521Z
+ sim_card_count: 10
private_wireless_gateway_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
name: My Test Group
created_at: 2018-02-02T22:25:27.521Z
@@ -56220,6 +58714,7 @@ components:
amount: "2048.1"
unit: MB
updated_at: 2018-02-02T22:25:27.521Z
+ sim_card_count: 10
private_wireless_gateway_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
name: My Test Group
created_at: 2018-02-02T22:25:27.521Z
@@ -56236,76 +58731,12 @@ components:
properties:
data:
items:
- $ref: '#/components/schemas/SIMCardGroup'
+ $ref: '#/components/schemas/SearchedSIMCardGroup'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: Get All Sim Card Groups Response
- type: object
- Create_Sim_Card_Group_Response:
- example:
- data:
- default: true
- data_limit:
- amount: "2048.1"
- unit: MB
- updated_at: 2018-02-02T22:25:27.521Z
- private_wireless_gateway_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- name: My Test Group
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: sim_card_group
- consumed_data:
- unit: MB
- amount: "2048.1"
- properties:
- data:
- $ref: '#/components/schemas/SIMCardGroup'
- title: Create Sim Card Group Response
- type: object
- Get_Sim_Card_Group_Response:
- example:
- data:
- default: true
- data_limit:
- amount: "2048.1"
- unit: MB
- updated_at: 2018-02-02T22:25:27.521Z
- private_wireless_gateway_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- name: My Test Group
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: sim_card_group
- consumed_data:
- unit: MB
- amount: "2048.1"
- properties:
- data:
- $ref: '#/components/schemas/SIMCardGroup'
- title: Get Sim Card Group Response
- type: object
- Delete_Sim_Card_Group_Response:
- example:
- data:
- default: true
- data_limit:
- amount: "2048.1"
- unit: MB
- updated_at: 2018-02-02T22:25:27.521Z
- private_wireless_gateway_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- name: My Test Group
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: sim_card_group
- consumed_data:
- unit: MB
- amount: "2048.1"
- properties:
- data:
- $ref: '#/components/schemas/SIMCardGroup'
- title: Delete Sim Card Group Response
type: object
- Update_SimCard_Group_Response:
+ SimCardGroupsPost_200_response:
example:
data:
default: true
@@ -56324,9 +58755,8 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardGroup'
- title: Update SimCard Group Response
type: object
- Create_Private_Wireless_Gatweway_Request_1:
+ SetSIMCardGroupPrivateWirelessGateway_request:
properties:
private_wireless_gateway_id:
description: The identification of the related Private Wireless Gateway
@@ -56336,12 +58766,8 @@ components:
type: string
required:
- private_wireless_gateway_id
- title: Create Private Wireless Gatweway Request
type: object
- CreateSimCardOrderPreview:
- example:
- quantity: 21
- address_id: "1293384261075731499"
+ SimCardOrdersPreview_request:
properties:
quantity:
description: The amount of SIM cards that the user would like to purchase
@@ -56357,9 +58783,8 @@ components:
required:
- address_id
- quantity
- title: CreateSimCardOrderPreview
type: object
- SIMCard_Orders_Preview_Response:
+ SimCardOrdersPreview_202_response:
example:
data:
sim_cards_cost:
@@ -56376,9 +58801,8 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardOrderPreview'
- title: SIMCard Orders Preview Response
type: object
- Get_All_Sim_Card_Order_Response:
+ SimCardOrdersGet_200_response:
example:
data:
- quantity: 21
@@ -56429,9 +58853,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: Get All Sim Card Order Response
type: object
- Create_Sim_Card_Order_Response:
+ SimCardOrdersPost_200_response:
example:
data:
quantity: 21
@@ -56455,35 +58878,8 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardOrder'
- title: Create Sim Card Order Response
type: object
- Get_Sim_Card_Order_Response:
- example:
- data:
- quantity: 21
- cost:
- amount: "2.52"
- currency: USD
- updated_at: 2018-02-02T22:25:27.521Z
- order_address:
- id: "1293384261075731499"
- street_address: 311 W Superior St
- extended_address: Suite 504
- locality: Chicago
- administrative_area: IL
- country_code: US
- postal_code: "60654"
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- tracking_url: http://www.example.com/
- record_type: sim_card_order
- status: pending
- properties:
- data:
- $ref: '#/components/schemas/SIMCardOrder'
- title: Get Sim Card Order Response
- type: object
- Search_SimCards_Response:
+ SimCardsGet_200_response:
example:
data:
- sim_card_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
@@ -56501,8 +58897,8 @@ components:
unit: MB
record_type: sim_card
status:
- reason: The SIM card is active, ready to connect to networks and consume
- data.
+ reason: "The SIM card is active, ready to connect to networks and consume\
+ \ data."
value: enabled
tags:
- personal
@@ -56523,8 +58919,8 @@ components:
unit: MB
record_type: sim_card
status:
- reason: The SIM card is active, ready to connect to networks and consume
- data.
+ reason: "The SIM card is active, ready to connect to networks and consume\
+ \ data."
value: enabled
tags:
- personal
@@ -56542,105 +58938,50 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: Search SimCards Response
type: object
- Create_SIM_Card_Validate_Request:
- description: The object containing the Array of SIM card registration codes.
- example:
- registration_codes:
- - "123456780"
- - "1231231230"
+ BulkSetPublicIPs_request:
properties:
- registration_codes:
+ sim_card_ids:
+ example:
+ - 6b14e151-8493-4fa1-8664-1cc4e6d14158
items:
- type: string
+ $ref: '#/components/schemas/Id'
type: array
- title: Create SIM Card Validate Request
+ required:
+ - sim_card_ids
type: object
- Get_Sim_Card_Response:
+ BulkSetPublicIPs_202_response:
example:
data:
- data_limit:
- amount: "2048.1"
- unit: MB
- current_mnc: "260"
- created_at: 2018-02-02T22:25:27.521Z
- imsi: "081932214823362973"
- current_device_location:
- accuracy_unit: m
- latitude: "41.143"
- accuracy: 1250
- longitude: -8.605
- record_type: sim_card
- tags:
- - personal
- - customers
- - active-customers
- sim_card_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- iccid: "89310410106543789301"
+ settings: {}
updated_at: 2018-02-02T22:25:27.521Z
- ipv4: 192.168.0.0
- ipv6: 2001:cdba:0000:0000:0000:0000:3257:9652
+ action_type: bulk_set_public_ips
+ created_at: 2018-02-02T22:25:27.521Z
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- msisdn: +13109976224
- current_mcc: "410"
- current_billing_period_consumed_data:
- amount: "2049.0"
- unit: MB
- status:
- reason: The SIM card is active, ready to connect to networks and consume
- data.
- value: enabled
+ record_type: bulk_sim_card_action
properties:
data:
- $ref: '#/components/schemas/SIMCard'
- title: Get Sim Card Response
+ $ref: '#/components/schemas/BulkSIMCardAction'
type: object
- Delete_Sim_Card_Response:
+ postValidateRegistrationCodes_request:
+ description: The object containing the Array of SIM card registration codes.
example:
- data:
- data_limit:
- amount: "2048.1"
- unit: MB
- current_mnc: "260"
- created_at: 2018-02-02T22:25:27.521Z
- imsi: "081932214823362973"
- current_device_location:
- accuracy_unit: m
- latitude: "41.143"
- accuracy: 1250
- longitude: -8.605
- record_type: sim_card
- tags:
- - personal
- - customers
- - active-customers
- sim_card_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- iccid: "89310410106543789301"
- updated_at: 2018-02-02T22:25:27.521Z
- ipv4: 192.168.0.0
- ipv6: 2001:cdba:0000:0000:0000:0000:3257:9652
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- msisdn: +13109976224
- current_mcc: "410"
- current_billing_period_consumed_data:
- amount: "2049.0"
- unit: MB
- status:
- reason: The SIM card is active, ready to connect to networks and consume
- data.
- value: enabled
+ registration_codes:
+ - "123456780"
+ - "1231231230"
properties:
- data:
- $ref: '#/components/schemas/SIMCard'
- title: Delete Sim Card Response
+ registration_codes:
+ items:
+ type: string
+ type: array
type: object
- Update_SimCard_Response:
+ SimCardGet_200_response:
example:
data:
data_limit:
amount: "2048.1"
unit: MB
+ current_imei: "457032284023794"
current_mnc: "260"
created_at: 2018-02-02T22:25:27.521Z
imsi: "081932214823362973"
@@ -56648,7 +58989,7 @@ components:
accuracy_unit: m
latitude: "41.143"
accuracy: 1250
- longitude: -8.605
+ longitude: "-8.605"
record_type: sim_card
tags:
- personal
@@ -56659,6 +59000,11 @@ components:
updated_at: 2018-02-02T22:25:27.521Z
ipv4: 192.168.0.0
ipv6: 2001:cdba:0000:0000:0000:0000:3257:9652
+ live_data_session: connected
+ authorized_imeis:
+ - "106516771852751"
+ - "534051870479563"
+ - "508821468377961"
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
msisdn: +13109976224
current_mcc: "410"
@@ -56666,113 +59012,27 @@ components:
amount: "2049.0"
unit: MB
status:
- reason: The SIM card is active, ready to connect to networks and consume
- data.
+ reason: "The SIM card is active, ready to connect to networks and consume\
+ \ data."
value: enabled
properties:
data:
$ref: '#/components/schemas/SIMCard'
- title: Update SimCard Response
type: object
- SIM_Card_Network_Preference_With_OTA_Updates_Response:
+ SIMCardDeviceDetailsGet_200_response:
example:
data:
- sim_card_id: 6b14e151-8493-4fa1-8664-1cc4e6d14158
- mobile_operator_networks_preferences:
- - mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- - mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- ota_updates:
- - created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: ota_update
- settings:
- mobile_operator_networks_preferences:
- - mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- status: in-progress
- type: sim_card_network_preferences
- updated_at: 2018-02-02T22:25:27.521Z
- - created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: ota_update
- settings:
- mobile_operator_networks_preferences:
- - mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- status: in-progress
- type: sim_card_network_preferences
- updated_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- created_at: 2018-02-02T22:25:27.521Z
- record_type: sim_card_network_preferences
+ model_name: iPad Pro 11 2020 Cellular
+ imei: "457032284023794"
+ operating_system: iOS 12
+ brand_name: Apple
+ device_type: Tablet
+ record_type: device_details
properties:
data:
- $ref: '#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates'
- title: SIM Card Network Preference With OTA Updates Response
- type: object
- Put_Network_Preference_Request:
- properties:
- mobile_operator_networks_preferences:
- description: A list of mobile operator networks and the priority that should
- be applied when the SIM is connecting to the network.
- items:
- $ref: '#/components/schemas/MobileOperatorNetworkPreferencesRequest'
- type: array
- title: Put Network Preference Request
- type: object
- PUT_SIM_Card_Network_Preference_Response:
- example:
- data:
- sim_card_id: 6b14e151-8493-4fa1-8664-1cc4e6d14158
- mobile_operator_networks_preferences:
- - mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- - mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- ota_updates:
- - created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: ota_update
- settings:
- mobile_operator_networks_preferences:
- - mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- status: in-progress
- type: sim_card_network_preferences
- updated_at: 2018-02-02T22:25:27.521Z
- - created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: ota_update
- settings:
- mobile_operator_networks_preferences:
- - mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- mobile_operator_network_name: AT&T Mobility (USACG)
- priority: 0
- sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- status: in-progress
- type: sim_card_network_preferences
- updated_at: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- created_at: 2018-02-02T22:25:27.521Z
- record_type: sim_card_network_preferences
- properties:
- data:
- $ref: '#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates'
- title: PUT SIM Card Network Preference Response
+ $ref: '#/components/schemas/SIMCardDeviceDetails'
type: object
- Delete_SIM_Card_Network_Preference_Response:
+ SIMCardNetworkPreferencesGet_200_response:
example:
data:
sim_card_id: 6b14e151-8493-4fa1-8664-1cc4e6d14158
@@ -56814,9 +59074,17 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates'
- title: Delete SIM Card Network Preference Response
type: object
- SIMCard_Public_IP_Response:
+ SIMCardNetworkPreferencesPut_request:
+ properties:
+ mobile_operator_networks_preferences:
+ description: A list of mobile operator networks and the priority that should
+ be applied when the SIM is connecting to the network.
+ items:
+ $ref: '#/components/schemas/MobileOperatorNetworkPreferencesRequest'
+ type: array
+ type: object
+ SIMCardPublicIPGet_200_response:
example:
data:
sim_card_id: 6b14e151-8493-4fa1-8664-1cc4e6d14158
@@ -56828,12 +59096,13 @@ components:
properties:
data:
$ref: '#/components/schemas/SIMCardPublicIP'
- title: SIMCard Public IP Response
type: object
- Wireless_Connectivity_Log_Collection_Response:
+ WirelessConnectivityLogsGet_200_response:
example:
data:
- stop_time: 2018-02-02T22:25:27.521Z
+ last_seen: 2018-02-02T22:25:27.521Z
+ created_at: 2018-02-02T22:25:27.521Z
imsi: "081932214823362973"
mobile_country_code: "310"
record_type: wireless_connectivity_log
@@ -56850,6 +59119,8 @@ components:
apn: data00.telnyx
cell_id: 311210-6813
- stop_time: 2018-02-02T22:25:27.521Z
+ last_seen: 2018-02-02T22:25:27.521Z
+ created_at: 2018-02-02T22:25:27.521Z
imsi: "081932214823362973"
mobile_country_code: "310"
record_type: wireless_connectivity_log
@@ -56877,7 +59148,6 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
- title: Wireless Connectivity Log Collection Response
type: object
List_Sub_Number_Orders_Response:
example:
@@ -57013,7 +59283,7 @@ components:
$ref: '#/components/schemas/TelephonyCredential'
title: Telephony Credential Response
type: object
- List_Tags_Response_data:
+ List_Tags_Response_data_inner:
example:
amount: 1
tag: a_tag
@@ -57040,12 +59310,22 @@ components:
properties:
data:
items:
- $ref: '#/components/schemas/List_Tags_Response_data'
+ $ref: '#/components/schemas/List_Tags_Response_data_inner'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Tags Response
type: object
+ TeXml_REST_Command_Response:
+ example:
+ data:
+ sid: c46e06d7-b78f-4b13-96b6-c576af9640ff
+ status: accepted
+ properties:
+ data:
+ $ref: '#/components/schemas/UpdateCommandResult'
+ title: TeXml REST Command Response
+ type: object
Get_All_Texml_Applications_Response:
example:
data:
@@ -57053,7 +59333,7 @@ components:
record_type: texml_application
active: false
friendly_name: call-router
- anchorsite_override: Amsterdam, Netherlands
+ anchorsite_override: "Amsterdam, Netherlands"
dtmf_type: Inband
first_command_timeout: true
first_command_timeout_secs: 10
@@ -57075,7 +59355,7 @@ components:
record_type: texml_application
active: false
friendly_name: call-router
- anchorsite_override: Amsterdam, Netherlands
+ anchorsite_override: "Amsterdam, Netherlands"
dtmf_type: Inband
first_command_timeout: true
first_command_timeout_secs: 10
@@ -57114,7 +59394,7 @@ components:
record_type: texml_application
active: false
friendly_name: call-router
- anchorsite_override: Amsterdam, Netherlands
+ anchorsite_override: "Amsterdam, Netherlands"
dtmf_type: Inband
first_command_timeout: true
first_command_timeout_secs: 10
@@ -57282,7 +59562,57 @@ components:
type: string
title: Update Verify Profile Request
type: object
- List_Webhook_Deliveries_Response:
+ VirtaulCrossConnectRegionList_200_response:
+ example:
+ data:
+ - null
+ - null
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/VirtualCrossConnectRegion'
+ type: array
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
+ type: object
+ VirtualCrossConnectRegionGet_200_response:
+ example:
+ data: null
+ properties:
+ data:
+ $ref: '#/components/schemas/VirtualCrossConnectRegion'
+ type: object
+ VirtaulCrossConnectList_200_response:
+ example:
+ data:
+ - null
+ - null
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/VirtualCrossConnectCombined'
+ type: array
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
+ type: object
+ VirtualCrossConnectCreate_200_response:
+ example:
+ data: null
+ properties:
+ data:
+ $ref: '#/components/schemas/VirtualCrossConnectCombined'
+ type: object
+ getWebhookDeliveries_200_response:
example:
data:
- webhook:
@@ -57306,11 +59636,11 @@ components:
request:
url: https://fallback.example.com/webhooks
headers:
- - 'Accept: */*'
+ - "Accept: */*"
response:
status: 200
headers:
- - 'Content-Type: text/html'
+ - "Content-Type: text/html"
body: All good.
- status: failed
started_at: 2020-08-10T14:00:05.004Z
@@ -57319,12 +59649,12 @@ components:
request:
url: https://typo.example.com/webhooks
headers:
- - 'Accept: */*'
+ - "Accept: */*"
response:
status: 404
headers:
- - 'Content-Type: text/html'
- - 'Pragma: no-cache'
+ - "Content-Type: text/html"
+ - "Pragma: no-cache"
body: Oops. Not found.
errors:
- code: "75499"
@@ -57351,11 +59681,11 @@ components:
request:
url: https://fallback.example.com/webhooks
headers:
- - 'Accept: */*'
+ - "Accept: */*"
response:
status: 200
headers:
- - 'Content-Type: text/html'
+ - "Content-Type: text/html"
body: All good.
- status: failed
started_at: 2020-08-10T14:00:05.004Z
@@ -57364,12 +59694,12 @@ components:
request:
url: https://typo.example.com/webhooks
headers:
- - 'Accept: */*'
+ - "Accept: */*"
response:
status: 404
headers:
- - 'Content-Type: text/html'
- - 'Pragma: no-cache'
+ - "Content-Type: text/html"
+ - "Pragma: no-cache"
body: Oops. Not found.
errors:
- code: "75499"
@@ -57387,9 +59717,8 @@ components:
type: array
meta:
$ref: '#/components/schemas/PaginationMetaSimple'
- title: List Webhook Deliveries Response
type: object
- Retrieve_Webhook_Delivery:
+ getWebhookDelivery_200_response:
example:
data:
webhook:
@@ -57413,11 +59742,11 @@ components:
request:
url: https://fallback.example.com/webhooks
headers:
- - 'Accept: */*'
+ - "Accept: */*"
response:
status: 200
headers:
- - 'Content-Type: text/html'
+ - "Content-Type: text/html"
body: All good.
- status: failed
started_at: 2020-08-10T14:00:05.004Z
@@ -57426,12 +59755,12 @@ components:
request:
url: https://typo.example.com/webhooks
headers:
- - 'Accept: */*'
+ - "Accept: */*"
response:
status: 404
headers:
- - 'Content-Type: text/html'
- - 'Pragma: no-cache'
+ - "Content-Type: text/html"
+ - "Pragma: no-cache"
body: Oops. Not found.
errors:
- code: "75499"
@@ -57440,7 +59769,6 @@ components:
properties:
data:
$ref: '#/components/schemas/webhook_delivery'
- title: Retrieve Webhook Delivery
type: object
List_WhatsApp_Business_Accounts_Response:
example:
@@ -57489,7 +59817,7 @@ components:
$ref: '#/components/schemas/PaginationMeta'
title: List WhatsApp Business Accounts Response
type: object
- Retrieve_WhatsApp_Business_Account:
+ WhatsApp_Business_Account:
example:
data:
record_type: whatsapp_business_account
@@ -57510,7 +59838,7 @@ components:
properties:
data:
$ref: '#/components/schemas/WhatsappBusinessAccount'
- title: Retrieve WhatsApp Business Account
+ title: WhatsApp Business Account
type: object
List_WhatsApp_Phone_Numbers_Response:
example:
@@ -57559,6 +59887,69 @@ components:
$ref: '#/components/schemas/PaginationMeta'
title: List WhatsApp Phone Numbers Response
type: object
+ WhatsApp_Message_Template:
+ example:
+ data:
+ - components:
+ - format: VIDEO
+ text: "Hello, {{1}}! Your appointment with {{2}} has been updated."
+ type: text
+ - format: VIDEO
+ text: "Hello, {{1}}! Your appointment with {{2}} has been updated."
+ type: text
+ rejected_reason: NONE
+ quality_score:
+ score: UNKNOWN
+ name: sample_happy_hour_announcement
+ language: en_US
+ id: "23492349423"
+ category: APPOINTMENT_UPDATE
+ record_type: whatsapp_message_template
+ status: APPROVED
+ - components:
+ - format: VIDEO
+ text: "Hello, {{1}}! Your appointment with {{2}} has been updated."
+ type: text
+ - format: VIDEO
+ text: "Hello, {{1}}! Your appointment with {{2}} has been updated."
+ type: text
+ rejected_reason: NONE
+ quality_score:
+ score: UNKNOWN
+ name: sample_happy_hour_announcement
+ language: en_US
+ id: "23492349423"
+ category: APPOINTMENT_UPDATE
+ record_type: whatsapp_message_template
+ status: APPROVED
+ meta:
+ cursors:
+ after: MQZDZD
+ before: MQZDZD
+ next: "/v2/whatsapp_business_accounts/4444451-4222-9222-3bd5555501c0/whatsapp_message_templates?page[after]=MQZDZD&page[limit]=1"
+ previous: "/v2/whatsapp_business_accounts/4444451-4222-9222-3bd5555501c0/whatsapp_message_templates?page[before]=MQZDZD&page[limit]=1"
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/WhatsappMessageTemplate'
+ type: array
+ meta:
+ $ref: '#/components/schemas/CursorPagination'
+ title: WhatsApp Message Template
+ type: object
+ WhatsApp_Message_Template_1:
+ example:
+ id: 12ac836e1c292
+ record_type: whatsapp_message_template
+ properties:
+ id:
+ example: 12ac836e1c292
+ type: string
+ record_type:
+ example: whatsapp_message_template
+ type: string
+ title: WhatsApp Message Template
+ type: object
Check_Contact_Response:
example:
data:
@@ -57577,7 +59968,7 @@ components:
type: array
title: Check Contact Response
type: object
- Upload_Media:
+ Upload_Media_:
example:
data:
- record_type: whatsapp_media_id
@@ -57589,9 +59980,9 @@ components:
items:
$ref: '#/components/schemas/UploadMedia'
type: array
- title: Upload Media
+ title: Upload Media.
type: object
- WhatsApp_Message_Response:
+ Successful_response_with_details_about_the_WhatsApp_message_sent_:
example:
data:
record_type: whatsapp_message_id
@@ -57599,9 +59990,9 @@ components:
properties:
data:
$ref: '#/components/schemas/Message'
- title: WhatsApp Message Response
+ title: Successful response with details about the WhatsApp message sent.
type: object
- Retrieve_WhatsApp_Phone_Number:
+ WhatsApp_Phone_Number:
example:
data:
record_type: whatsapp_phone_number
@@ -57622,32 +60013,9 @@ components:
properties:
data:
$ref: '#/components/schemas/WhatsappPhoneNumber'
- title: Retrieve WhatsApp Phone Number
+ title: WhatsApp Phone Number
type: object
- Update_WhatsApp_Phone_Number:
- example:
- data:
- record_type: whatsapp_phone_number
- id: 2ade33a-21c0-473b-b055-b3c836e1c292
- organization_id: 29f187ff-6f27-449f-a2d3-d7188a50008c
- about: This is our about section
- phone_number: +1879832178
- whatsapp_user_id: "1879832178"
- status: pending
- webhook_url: http://www.myurl.com/webhook
- whatsapp_settings:
- id: "487117329074690"
- display_name: Acme Inc.
- display_name_status: APPROVED
- quality_rating: UNKNOWN
- created_at: 2020-01-01T00:00:00.000000Z
- updated_at: 2020-01-01T00:00:00.000000Z
- properties:
- data:
- $ref: '#/components/schemas/WhatsappPhoneNumber'
- title: Update WhatsApp Phone Number
- type: object
- Retrieve_WhatsApp_Profile_Photo:
+ WhatsApp_Profile_Photo:
example:
data:
phone_number_id: 12ade33a-21c0-473b-b055-b3c836e1c292
@@ -57657,50 +60025,87 @@ components:
properties:
data:
$ref: '#/components/schemas/WhatsappProfilePhoto'
- title: Retrieve WhatsApp Profile Photo
+ title: WhatsApp Profile Photo
type: object
- Update_WhatsApp_Profile_Photo:
+ WireguardInterfaceList_200_response:
example:
data:
- phone_number_id: 12ade33a-21c0-473b-b055-b3c836e1c292
- thumbnail_photo_url: https://pps.whatsapp.net/v/t61.24694-24/11111111_2222222222222222_3333333_n.jpg?oh=f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8&oe=5E5E5E5E
- whatsapp_user_id: "123456789"
- record_type: whatsapp_profile_photo
+ - null
+ - null
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
properties:
data:
- $ref: '#/components/schemas/WhatsappProfilePhoto'
- title: Update WhatsApp Profile Photo
+ items:
+ $ref: '#/components/schemas/WireguardInterfaceRead'
+ type: array
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
type: object
- Get_Wdr_Reports_Response:
+ WireguardInterfaceCreate_202_response:
example:
+ data: null
+ properties:
data:
- - start_time: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- report_url: http://example.com
- end_time: 2018-02-02T22:25:27.521Z
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: detail_records_report
- status: pending
- - start_time: 2018-02-02T22:25:27.521Z
- updated_at: 2018-02-02T22:25:27.521Z
- report_url: http://example.com
- end_time: 2018-02-02T22:25:27.521Z
- created_at: 2018-02-02T22:25:27.521Z
- id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
- record_type: detail_records_report
- status: pending
+ $ref: '#/components/schemas/WireguardInterfaceRead'
+ type: object
+ WireguardPeerList_200_response:
+ example:
+ data:
+ - null
+ - null
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
properties:
data:
items:
- $ref: '#/components/schemas/WdrReport'
+ $ref: '#/components/schemas/WireguardPeer'
type: array
- title: Get Wdr Reports Response
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
type: object
- Create_Wdr_Report_Response:
+ WireguardPeerCreate_202_response:
example:
+ data: null
+ properties:
data:
- start_time: 2018-02-02T22:25:27.521Z
+ $ref: '#/components/schemas/WireguardPeer'
+ type: object
+ WireguardPeerAllowedIPList_200_response:
+ example:
+ data:
+ - null
+ - null
+ meta:
+ page_number: 2
+ total_pages: 3
+ total_results: 55
+ page_size: 25
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/WireguardPeerAllowedIP'
+ type: array
+ meta:
+ $ref: '#/components/schemas/PaginationMeta'
+ type: object
+ WireguardPeerAllowedIPGet_200_response:
+ example:
+ data: null
+ properties:
+ data:
+ $ref: '#/components/schemas/WireguardPeerAllowedIP'
+ type: object
+ getWdrReports_200_response:
+ example:
+ data:
+ - start_time: 2018-02-02T22:25:27.521Z
updated_at: 2018-02-02T22:25:27.521Z
report_url: http://example.com
end_time: 2018-02-02T22:25:27.521Z
@@ -57708,15 +60113,7 @@ components:
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: detail_records_report
status: pending
- properties:
- data:
- $ref: '#/components/schemas/WdrReport'
- title: Create Wdr Report Response
- type: object
- Get_Wdr_Report_Response:
- example:
- data:
- start_time: 2018-02-02T22:25:27.521Z
+ - start_time: 2018-02-02T22:25:27.521Z
updated_at: 2018-02-02T22:25:27.521Z
report_url: http://example.com
end_time: 2018-02-02T22:25:27.521Z
@@ -57726,10 +60123,11 @@ components:
status: pending
properties:
data:
- $ref: '#/components/schemas/WdrReport'
- title: Get Wdr Report Response
+ items:
+ $ref: '#/components/schemas/WdrReport'
+ type: array
type: object
- Delete_Wdr_Report_Response:
+ createWdrReport_201_response:
example:
data:
start_time: 2018-02-02T22:25:27.521Z
@@ -57743,8 +60141,20 @@ components:
properties:
data:
$ref: '#/components/schemas/WdrReport'
- title: Delete Wdr Report Response
type: object
+ ActionsParticipantsRequest_participants:
+ description: "Either a list of participant id to perform the action on, or the\
+ \ keyword \"all\" to perform the action on all participant."
+ oneOf:
+ - enum:
+ - all
+ example: all
+ type: string
+ - items:
+ example: 7b61621f-62e0-4aad-ab11-9fd19e272e73
+ format: uuid
+ type: string
+ type: array
AuthenticationProvider_settings:
description: The settings associated with the authentication provider.
example:
@@ -57826,7 +60236,7 @@ components:
example: 311 W. Superior St
type: string
type: object
- BusinessIdentity_contacts:
+ BusinessIdentity_contacts_inner:
description: A contact person for the business
properties:
record_type:
@@ -57871,10 +60281,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -57913,10 +60323,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -57939,9 +60349,6 @@ components:
type: string
type: object
CallCost_meta_meta:
- example:
- delivered_to: https://example.com
- attempt: 1
properties:
attempt:
description: The number of attempts made to deliver the webhook
@@ -57954,21 +60361,11 @@ components:
type: string
type: object
CallCost_meta:
- example:
- meta:
- delivered_to: https://example.com
- attempt: 1
properties:
meta:
$ref: '#/components/schemas/CallCost_meta_meta'
type: object
- CallCost_payload_cost_parts:
- example:
- call_part: call-control
- cost: 0.0
- rate: 0.001
- billed_duration_secs: 0
- currency: USD
+ CallCost_payload_cost_parts_inner:
properties:
billed_duration_secs:
description: The number of seconds for which this item will be billed
@@ -57980,8 +60377,8 @@ components:
example: call-control
type: string
cost:
- description: The billed cost of the item, in currency shown in the `currency`
- field
+ description: "The billed cost of the item, in currency shown in the `currency`\
+ \ field"
example: 0.0
minimum: 0.0
type: number
@@ -57996,26 +60393,6 @@ components:
type: number
type: object
CallCost_payload:
- example:
- call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
- total_cost: 0.0
- client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
- connection_id: 7267xxxxxxxxxxxxxx
- call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
- billed_duration_secs: 0
- call_session_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
- cost_parts:
- - call_part: call-control
- cost: 0.0
- rate: 0.001
- billed_duration_secs: 0
- currency: USD
- - call_part: call-control
- cost: 0.0
- rate: 0.001
- billed_duration_secs: 0
- currency: USD
- status: valid
properties:
billed_duration_secs:
description: The number of seconds for which this call will be billed
@@ -58032,10 +60409,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58048,7 +60425,7 @@ components:
type: string
cost_parts:
items:
- $ref: '#/components/schemas/CallCost_payload_cost_parts'
+ $ref: '#/components/schemas/CallCost_payload_cost_parts_inner'
type: array
total_cost:
description: The billed cost of the call
@@ -58082,10 +60459,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58121,10 +60498,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58147,18 +60524,33 @@ components:
the call.
example: 7267xxxxxxxxxxxxxx
type: string
+ call_control_id:
+ description: Unique ID for controlling the call.
+ example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
+ type: string
call_leg_id:
description: ID that is unique to the call and can be used to correlate
webhook events.
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
+ client_state:
+ description: State received from a command.
+ example: aGF2ZSBhIG5pY2UgZGF5ID1d
+ type: string
+ stream_type:
+ description: Type of media streamed. It can be either 'raw' or 'decrypted'.
+ enum:
+ - raw
+ - decrypted
+ example: raw
+ type: string
type: object
CallGatherEnded_payload:
properties:
@@ -58177,10 +60569,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58207,6 +60599,7 @@ components:
- call_hangup
- cancelled
- cancelled_amd
+ - timeout
example: valid
type: string
type: object
@@ -58227,10 +60620,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58257,9 +60650,9 @@ components:
example: hangup
type: string
hangup_cause:
- description: The reason the call was ended (`call_rejected`, `normal_clearing`,
- `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found`
- or `unspecified`).
+ description: "The reason the call was ended (`call_rejected`, `normal_clearing`,\
+ \ `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found`\
+ \ or `unspecified`)."
enum:
- call_rejected
- normal_clearing
@@ -58272,7 +60665,7 @@ components:
example: call_rejected
type: string
hangup_source:
- description: The party who ended the call (`callee`, `caller`, `unknown`).
+ description: "The party who ended the call (`callee`, `caller`, `unknown`)."
enum:
- caller
- callee
@@ -58303,10 +60696,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58352,10 +60745,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58398,10 +60791,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58442,10 +60835,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58485,10 +60878,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58496,13 +60889,13 @@ components:
example: aGF2ZSBhIG5pY2UgZGF5ID1d
type: string
media_url:
- description: The audio URL being played back, if audio_url has been used
- to start.
+ description: "The audio URL being played back, if audio_url has been used\
+ \ to start."
example: http://example.com/audio.wav
type: string
media_name:
- description: The name of the audio media file being played back, if media_name
- has been used to start.
+ description: "The name of the audio media file being played back, if media_name\
+ \ has been used to start."
example: my_media_uploaded_to_media_storage_api
type: string
overlay:
@@ -58539,10 +60932,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58550,13 +60943,13 @@ components:
example: aGF2ZSBhIG5pY2UgZGF5ID1d
type: string
media_url:
- description: The audio URL being played back, if audio_url has been used
- to start.
+ description: "The audio URL being played back, if audio_url has been used\
+ \ to start."
example: http://example.com/audio.wav
type: string
media_name:
- description: The name of the audio media file being played back, if media_name
- has been used to start.
+ description: "The name of the audio media file being played back, if media_name\
+ \ has been used to start."
example: my_media_uploaded_to_media_storage_api
type: string
overlay:
@@ -58566,10 +60959,10 @@ components:
type: boolean
type: object
CallRecordingSaved_payload_recording_urls:
- description: Recording URLs in requested format. These URLs are valid for 10
- minutes. After 10 minutes, you may retrieve recordings via API using Reports
- -> Call Recordings documentation, or via Mission Control under Reporting ->
- Recordings.
+ description: "Recording URLs in requested format. These URLs are valid for 10\
+ \ minutes. After 10 minutes, you may retrieve recordings via API using Reports\
+ \ -> Call Recordings documentation, or via Mission Control under Reporting\
+ \ -> Recordings."
properties:
mp3:
description: Recording URL in requested `mp3` format.
@@ -58583,10 +60976,10 @@ components:
type: string
type: object
CallRecordingSaved_payload_public_recording_urls:
- description: Recording URLs in requested format. The URL is valid for as long
- as the file exists. For security purposes, this feature is activated on a
- per request basis. Please contact customer support with your Account ID to
- request activation.
+ description: "Recording URLs in requested format. The URL is valid for as long\
+ \ as the file exists. For security purposes, this feature is activated on\
+ \ a per request basis. Please contact customer support with your Account\
+ \ ID to request activation."
properties:
mp3:
description: Recording URL in requested `mp3` format.
@@ -58607,10 +61000,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
connection_id:
@@ -58656,10 +61049,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
connection_id:
@@ -58696,10 +61089,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
connection_id:
@@ -58736,10 +61129,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
connection_id:
@@ -58764,6 +61157,16 @@ components:
example: +13129457420
type: string
type: object
+ CallRequest_to:
+ description: The DID or SIP URI to dial out to. Multiple DID or SIP URIs can
+ be provided using an array of strings
+ oneOf:
+ - example: +18005550100 or sip:username@sip.telnyx.com
+ type: string
+ - example: "[\"+18005550100\", \"sip:username@sip.telnyx.com\"]"
+ items:
+ type: string
+ type: array
CallRequest_answering_machine_detection_config:
description: Optional configuration parameters to modify 'answering_machine_detection'
performance.
@@ -58789,29 +61192,29 @@ components:
type: integer
greeting_duration_millis:
default: 3500
- description: Maximum threshold of a human greeting. If greeting longer than
- this value, considered machine.
+ description: "Maximum threshold of a human greeting. If greeting longer\
+ \ than this value, considered machine."
example: 1500
format: int32
type: integer
initial_silence_millis:
default: 3500
- description: If initial silence duration is greater than this value, consider
- it a machine.
+ description: "If initial silence duration is greater than this value, consider\
+ \ it a machine."
example: 1800
format: int32
type: integer
maximum_number_of_words:
default: 5
- description: If number of detected words is greater than this value, consder
- it a machine.
+ description: "If number of detected words is greater than this value, consder\
+ \ it a machine."
example: 3
format: int32
type: integer
maximum_word_length_millis:
default: 3500
- description: If a single word lasts longer than this threshold, consider
- it a machine.
+ description: "If a single word lasts longer than this threshold, consider\
+ \ it a machine."
example: 2000
format: int32
type: integer
@@ -58823,15 +61226,15 @@ components:
type: integer
greeting_total_analysis_time_millis:
default: 5000
- description: If machine already detected, maximum timeout threshold to determine
- the end of the machine greeting.
+ description: "If machine already detected, maximum timeout threshold to\
+ \ determine the end of the machine greeting."
example: 7500
format: int32
type: integer
greeting_silence_duration_millis:
default: 1500
- description: If machine already detected, maximum threshold for silence
- between words. If exceeded, the greeting is considered ended.
+ description: "If machine already detected, maximum threshold for silence\
+ \ between words. If exceeded, the greeting is considered ended."
example: 2000
format: int32
type: integer
@@ -58853,10 +61256,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58889,10 +61292,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -58900,6 +61303,71 @@ components:
example: aGF2ZSBhIG5pY2UgZGF5ID1d
type: string
type: object
+ CallStreamingFailed_payload_stream_params:
+ description: Streaming parameters as they were originally given to the Call
+ Control API.
+ properties:
+ stream_url:
+ description: The destination WebSocket address where the stream is going
+ to be delivered.
+ example: wss://www.example.com/websocket
+ type: string
+ track:
+ default: inbound_track
+ description: Specifies which track should be streamed.
+ enum:
+ - inbound_track
+ - outbound_track
+ - both_tracks
+ example: inbound_track
+ type: string
+ type: object
+ CallStreamingFailed_payload:
+ properties:
+ call_control_id:
+ description: Call ID used to issue commands via Call Control API.
+ example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
+ type: string
+ connection_id:
+ description: Call Control App ID (formerly Telnyx connection ID) used in
+ the call.
+ example: 7267xxxxxxxxxxxxxx
+ type: string
+ call_leg_id:
+ description: ID that is unique to the call and can be used to correlate
+ webhook events.
+ example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
+ type: string
+ call_session_id:
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
+ example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
+ type: string
+ client_state:
+ description: State received from a command.
+ example: aGF2ZSBhIG5pY2UgZGF5ID1d
+ type: string
+ failure_reason:
+ description: A short description explaning why the media streaming failed.
+ example: connection_failed
+ type: string
+ stream_id:
+ description: Identifies the streaming.
+ example: 1edb94f9-7ef0-4150-b502-e0ebadfd9491
+ format: uuid
+ type: string
+ stream_params:
+ $ref: '#/components/schemas/CallStreamingFailed_payload_stream_params'
+ stream_type:
+ description: The type of stream connection the stream is performing.
+ enum:
+ - websocket
+ - dialogflow
+ example: websocket
+ type: string
+ type: object
CallStreamingStarted_payload:
properties:
call_control_id:
@@ -58917,10 +61385,10 @@ components:
example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
type: string
client_state:
@@ -59013,10 +61481,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -59050,10 +61518,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -59126,10 +61594,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -59154,10 +61622,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -59178,13 +61646,13 @@ components:
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
media_url:
- description: The audio URL being played back, if audio_url has been used
- to start.
+ description: "The audio URL being played back, if audio_url has been used\
+ \ to start."
example: http://example.com/audio.wav
type: string
media_name:
- description: The name of the audio media file being played back, if media_name
- has been used to start.
+ description: "The name of the audio media file being played back, if media_name\
+ \ has been used to start."
example: my_media_uploaded_to_media_storage_api
type: string
occurred_at:
@@ -59206,10 +61674,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -59251,13 +61719,13 @@ components:
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
media_url:
- description: The audio URL being played back, if audio_url has been used
- to start.
+ description: "The audio URL being played back, if audio_url has been used\
+ \ to start."
example: http://example.com/audio.wav
type: string
media_name:
- description: The name of the audio media file being played back, if media_name
- has been used to start.
+ description: "The name of the audio media file being played back, if media_name\
+ \ has been used to start."
example: my_media_uploaded_to_media_storage_api
type: string
occurred_at:
@@ -59274,10 +61742,10 @@ components:
example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -59353,25 +61821,24 @@ components:
CreateFaxApplicationRequest_inbound:
properties:
channel_limit:
- description: When set, this will limit the number of concurrent inbound
- calls to phone numbers associated with this connection.
+ description: "When set, this will limit the number of concurrent inbound\
+ \ calls to phone numbers associated with this connection."
example: 10
type: integer
sip_subdomain:
- default: "null"
- description: 'Specifies a subdomain that can be used to receive Inbound
- calls to a Connection, in the same way a phone number is used, from a
- SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called
- from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com"
- where the user part can be any alphanumeric value. Please note TLS encrypted
- calls are not allowed for subdomain calls.'
+ description: "Specifies a subdomain that can be used to receive Inbound\
+ \ calls to a Connection, in the same way a phone number is used, from\
+ \ a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can\
+ \ be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\"\
+ \ where the user part can be any alphanumeric value. Please note TLS encrypted\
+ \ calls are not allowed for subdomain calls."
example: example
type: string
sip_subdomain_receive_settings:
default: from_anyone
- description: 'This option can be enabled to receive calls from: "Anyone"
- (any SIP endpoint in the public Internet) or "Only my connections" (any
- connection assigned to the same Telnyx user).'
+ description: "This option can be enabled to receive calls from: \"Anyone\"\
+ \ (any SIP endpoint in the public Internet) or \"Only my connections\"\
+ \ (any connection assigned to the same Telnyx user)."
enum:
- only_my_connections
- from_anyone
@@ -59381,8 +61848,8 @@ components:
CreateFaxApplicationRequest_outbound:
properties:
channel_limit:
- description: When set, this will limit the number of concurrent outbound
- calls to phone numbers associated with this connection.
+ description: "When set, this will limit the number of concurrent outbound\
+ \ calls to phone numbers associated with this connection."
example: 10
type: integer
outbound_voice_profile_id:
@@ -59395,25 +61862,24 @@ components:
CreateTexmlApplicationRequest_inbound:
properties:
channel_limit:
- description: When set, this will limit the total number of inbound calls
- to phone numbers associated with this connection.
+ description: "When set, this will limit the total number of inbound calls\
+ \ to phone numbers associated with this connection."
example: 10
type: integer
sip_subdomain:
- default: "null"
- description: 'Specifies a subdomain that can be used to receive Inbound
- calls to a Connection, in the same way a phone number is used, from a
- SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called
- from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com"
- where the user part can be any alphanumeric value. Please note TLS encrypted
- calls are not allowed for subdomain calls.'
+ description: "Specifies a subdomain that can be used to receive Inbound\
+ \ calls to a Connection, in the same way a phone number is used, from\
+ \ a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can\
+ \ be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\"\
+ \ where the user part can be any alphanumeric value. Please note TLS encrypted\
+ \ calls are not allowed for subdomain calls."
example: example
type: string
sip_subdomain_receive_settings:
default: from_anyone
- description: 'This option can be enabled to receive calls from: "Anyone"
- (any SIP endpoint in the public Internet) or "Only my connections" (any
- connection assigned to the same Telnyx user).'
+ description: "This option can be enabled to receive calls from: \"Anyone\"\
+ \ (any SIP endpoint in the public Internet) or \"Only my connections\"\
+ \ (any connection assigned to the same Telnyx user)."
enum:
- only_my_connections
- from_anyone
@@ -59423,8 +61889,8 @@ components:
CreateTexmlApplicationRequest_outbound:
properties:
channel_limit:
- description: When set, this will limit the total number of outbound calls
- to phone numbers associated with this connection.
+ description: "When set, this will limit the total number of outbound calls\
+ \ to phone numbers associated with this connection."
example: 10
type: integer
outbound_voice_profile_id:
@@ -59434,6 +61900,15 @@ components:
title: Outbound Voice Profile ID
type: string
type: object
+ CursorPagination_cursors:
+ properties:
+ before:
+ description: A cursor to use for paginating results.
+ type: string
+ after:
+ description: A cursor to use for paginating results.
+ type: string
+ type: object
CustomerServiceRequest_address:
description: The address of the customer service request
example:
@@ -59485,6 +61960,36 @@ components:
format: date-time
type: string
type: object
+ Dialogflow_Connection:
+ example:
+ conversation_profile_id: a-VMHLWzTmKjiJw5S6O0-w
+ service_account: '****'
+ environment: development
+ connection_id: "1234541231"
+ record_type: dialogflow_connections
+ properties:
+ record_type:
+ example: dialogflow_connections
+ type: string
+ connection_id:
+ description: Uniquely identifies a Telnyx application (Call Control).
+ example: "1234541231"
+ type: string
+ conversation_profile_id:
+ description: "The id of a configured conversation profile on your Dialogflow\
+ \ account. (If you use Dialogflow CX, this param is required)"
+ example: a-VMHLWzTmKjiJw5S6O0-w
+ type: string
+ environment:
+ description: Which Dialogflow environment will be used.
+ example: development
+ type: string
+ service_account:
+ description: The JSON map to connect your Dialoglow account.
+ example: '****'
+ type: string
+ title: Dialogflow Connection
+ type: object
DocReqsRequirementType_acceptance_criteria:
description: Specifies objective criteria for acceptance
example:
@@ -59579,19 +62084,6 @@ components:
readOnly: true
type: string
type: object
- Error_source:
- example:
- pointer: pointer
- parameter: parameter
- properties:
- pointer:
- description: JSON pointer (RFC6901) to the offending entity.
- format: json-pointer
- type: string
- parameter:
- description: Indicates which query parameter caused the error.
- type: string
- type: object
FaxDelivered_payload:
properties:
call_duration_secs:
@@ -59599,38 +62091,34 @@ components:
example: 25
type: integer
connection_id:
- description: The ID of the connection that was used to send the fax.
+ description: The ID of the connection used to send the fax.
example: "234423"
type: string
direction:
- description: The direction of the fax.
- enum:
- - inbound
- - outbound
- example: outbound
- type: string
+ $ref: '#/components/schemas/Direction'
fax_id:
description: Identifies the fax.
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
format: uuid
type: string
original_media_url:
- description: The original URL to the PDF used for the fax's media. If media_name
- was supplied, this is omitted
+ description: "The original URL to the PDF used for the fax's media. If media_name\
+ \ was supplied, this is omitted"
example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
type: string
media_name:
description: The media_name used for the fax's media. Must point to a file
- previously uploaded to api.telnyx.com/v2/media by the same user/organization
+ previously uploaded to api.telnyx.com/v2/media by the same user/organization.
+ media_name and media_url/contents can't be submitted together.
example: my_media_uploaded_to_media_storage_api
type: string
to:
- description: The phone number, in E.164 format, the fax will be sent to
- or SIP URI
+ description: "The phone number, in E.164 format, the fax will be sent to\
+ \ or SIP URI"
example: +13127367276
type: string
from:
- description: The phone number, in E.164 format, the fax will be sent from.
+ description: "The phone number, in E.164 format, the fax will be sent from."
example: +13125790015
type: string
user_id:
@@ -59651,38 +62139,34 @@ components:
FaxFailed_payload:
properties:
connection_id:
- description: The ID of the connection that was used to send the fax.
+ description: The ID of the connection used to send the fax.
example: "234423"
type: string
direction:
- description: The direction of the fax.
- enum:
- - inbound
- - outbound
- example: outbound
- type: string
+ $ref: '#/components/schemas/Direction'
fax_id:
description: Identifies the fax.
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
format: uuid
type: string
original_media_url:
- description: The original URL to the PDF used for the fax's media. If media_name
- was supplied, this is omitted
+ description: "The original URL to the PDF used for the fax's media. If media_name\
+ \ was supplied, this is omitted"
example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
type: string
media_name:
description: The media_name used for the fax's media. Must point to a file
- previously uploaded to api.telnyx.com/v2/media by the same user/organization
+ previously uploaded to api.telnyx.com/v2/media by the same user/organization.
+ media_name and media_url/contents can't be submitted together.
example: my_media_uploaded_to_media_storage_api
type: string
to:
- description: The phone number, in E.164 format, the fax will be sent to
- or SIP URI
+ description: "The phone number, in E.164 format, the fax will be sent to\
+ \ or SIP URI"
example: +13127367276
type: string
from:
- description: The phone number, in E.164 format, the fax will be sent from.
+ description: "The phone number, in E.164 format, the fax will be sent from."
example: +13125790015
type: string
user_id:
@@ -59704,38 +62188,34 @@ components:
FaxMediaProcessed_payload:
properties:
connection_id:
- description: The ID of the connection that was used to send the fax.
+ description: The ID of the connection used to send the fax.
example: "234423"
type: string
direction:
- description: The direction of the fax.
- enum:
- - inbound
- - outbound
- example: outbound
- type: string
+ $ref: '#/components/schemas/Direction'
fax_id:
description: Identifies the fax.
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
format: uuid
type: string
original_media_url:
- description: The original URL to the PDF used for the fax's media. If media_name
- was supplied, this is omitted
+ description: "The original URL to the PDF used for the fax's media. If media_name\
+ \ was supplied, this is omitted"
example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
type: string
media_name:
description: The media_name used for the fax's media. Must point to a file
- previously uploaded to api.telnyx.com/v2/media by the same user/organization
+ previously uploaded to api.telnyx.com/v2/media by the same user/organization.
+ media_name and media_url/contents can't be submitted together.
example: my_media_uploaded_to_media_storage_api
type: string
to:
- description: The phone number, in E.164 format, the fax will be sent to
- or SIP URI
+ description: "The phone number, in E.164 format, the fax will be sent to\
+ \ or SIP URI"
example: +13127367276
type: string
from:
- description: The phone number, in E.164 format, the fax will be sent from.
+ description: "The phone number, in E.164 format, the fax will be sent from."
example: +13125790015
type: string
user_id:
@@ -59752,38 +62232,34 @@ components:
FaxQueued_payload:
properties:
connection_id:
- description: The ID of the connection that was used to send the fax.
+ description: The ID of the connection used to send the fax.
example: "234423"
type: string
direction:
- description: The direction of the fax.
- enum:
- - inbound
- - outbound
- example: outbound
- type: string
+ $ref: '#/components/schemas/Direction'
fax_id:
description: Identifies the fax.
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
format: uuid
type: string
original_media_url:
- description: The original URL to the PDF used for the fax's media. If media_name
- was supplied, this is omitted
+ description: "The original URL to the PDF used for the fax's media. If media_name\
+ \ was supplied, this is omitted"
example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
type: string
media_name:
description: The media_name used for the fax's media. Must point to a file
- previously uploaded to api.telnyx.com/v2/media by the same user/organization
+ previously uploaded to api.telnyx.com/v2/media by the same user/organization.
+ media_name and media_url/contents can't be submitted together.
example: my_media_uploaded_to_media_storage_api
type: string
to:
- description: The phone number, in E.164 format, the fax will be sent to
- or SIP URI
+ description: "The phone number, in E.164 format, the fax will be sent to\
+ \ or SIP URI"
example: +13127367276
type: string
from:
- description: The phone number, in E.164 format, the fax will be sent from.
+ description: "The phone number, in E.164 format, the fax will be sent from."
example: +13125790015
type: string
user_id:
@@ -59800,38 +62276,34 @@ components:
FaxSendingStarted_payload:
properties:
connection_id:
- description: The ID of the connection that was used to send the fax.
+ description: The ID of the connection used to send the fax.
example: "234423"
type: string
direction:
- description: The direction of the fax.
- enum:
- - inbound
- - outbound
- example: outbound
- type: string
+ $ref: '#/components/schemas/Direction'
fax_id:
description: Identifies the fax.
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
format: uuid
type: string
original_media_url:
- description: The original URL to the PDF used for the fax's media. If media_name
- was supplied, this is omitted
+ description: "The original URL to the PDF used for the fax's media. If media_name\
+ \ was supplied, this is omitted"
example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
type: string
media_name:
description: The media_name used for the fax's media. Must point to a file
- previously uploaded to api.telnyx.com/v2/media by the same user/organization
+ previously uploaded to api.telnyx.com/v2/media by the same user/organization.
+ media_name and media_url/contents can't be submitted together.
example: my_media_uploaded_to_media_storage_api
type: string
to:
- description: The phone number, in E.164 format, the fax will be sent to
- or SIP URI
+ description: "The phone number, in E.164 format, the fax will be sent to\
+ \ or SIP URI"
example: +13127367276
type: string
from:
- description: The phone number, in E.164 format, the fax will be sent from.
+ description: "The phone number, in E.164 format, the fax will be sent from."
example: +13125790015
type: string
user_id:
@@ -59862,7 +62334,7 @@ components:
specified resource or resources.
meta:
$ref: '#/components/schemas/ForbiddenError_allOf_meta'
- InboundMessagePayload_to:
+ InboundMessagePayload_to_inner:
properties:
phone_number:
description: Receiving address (+E.164 formatted phone number or short code).
@@ -59893,7 +62365,7 @@ components:
- ""
type: string
type: object
- InboundMessagePayload_cc:
+ InboundMessagePayload_cc_inner:
properties:
phone_number:
description: Receiving address (+E.164 formatted phone number or short code).
@@ -59926,8 +62398,8 @@ components:
InboundMessagePayload_from:
properties:
phone_number:
- description: Sending address (+E.164 formatted phone number, alphanumeric
- sender ID, or short code).
+ description: "Sending address (+E.164 formatted phone number, alphanumeric\
+ \ sender ID, or short code)."
format: address
type: string
status:
@@ -59949,7 +62421,7 @@ components:
- ""
type: string
type: object
- InboundMessagePayload_media:
+ InboundMessagePayload_media_inner:
properties:
url:
description: The url of the media requested to be sent.
@@ -59980,6 +62452,49 @@ components:
format: iso4217
type: string
type: object
+ Header:
+ allOf:
+ - $ref: '#/components/schemas/InteractiveHeader'
+ description: Header content displayed on top of a message. See header object
+ for more information. You cannot set a header if your interactive object is
+ of product type. Required for type product_list. Optional for other types.
+ title: Header
+ Body:
+ allOf:
+ - $ref: '#/components/schemas/InteractiveBody'
+ description: The body of the message. Emojis and markdown are supported. Optional
+ for type product. Required for other message types.
+ title: Body
+ Footer:
+ allOf:
+ - $ref: '#/components/schemas/InteractiveFooter'
+ description: The footer of the message. Emojis and markdown are supported.
+ title: Footer
+ Action:
+ allOf:
+ - $ref: '#/components/schemas/InteractiveAction'
+ description: Action you want the user to perform after reading the message.
+ title: Action
+ Reply:
+ allOf:
+ - $ref: '#/components/schemas/InteractiveButtonReply'
+ description: Reply button details.
+ title: Reply
+ Video_1:
+ allOf:
+ - $ref: '#/components/schemas/Video'
+ description: Contains the media object for this video.
+ title: Video
+ Image_1:
+ allOf:
+ - $ref: '#/components/schemas/Image'
+ description: Contains the media object for this image.
+ title: Image
+ Document_1:
+ allOf:
+ - $ref: '#/components/schemas/Document'
+ description: Contains the media object for this document.
+ title: Document
MessagingProfileHighLevelMetrics_outbound:
properties:
sent:
@@ -60002,7 +62517,34 @@ components:
readOnly: true
type: number
type: object
- NotificationEventCondition_parameters:
+ Network_1:
+ properties:
+ record_type:
+ description: Identifies the type of the resource.
+ example: network
+ readOnly: true
+ type: string
+ name:
+ description: A user specified name for the network.
+ example: test network
+ type: string
+ title: Network
+ type: object
+ NetworkInterface_1:
+ properties:
+ record_type:
+ description: Identifies the type of the resource.
+ example: network_interface
+ readOnly: true
+ type: string
+ type:
+ description: Identifies the type of the interface.
+ example: wireguard_interface
+ readOnly: true
+ type: string
+ title: NetworkInterface
+ type: object
+ NotificationEventCondition_parameters_inner:
example:
name: phone_number
data_type: string
@@ -60018,7 +62560,7 @@ components:
example: string
type: string
type: object
- NotificationSetting_parameters:
+ NotificationSetting_parameters_inner:
example:
name: phone_number
value: +13125550000
@@ -60055,8 +62597,8 @@ components:
OutboundMessagePayload_from:
properties:
phone_number:
- description: Sending address (+E.164 formatted phone number, alphanumeric
- sender ID, or short code).
+ description: "Sending address (+E.164 formatted phone number, alphanumeric\
+ \ sender ID, or short code)."
format: address
type: string
carrier:
@@ -60073,7 +62615,7 @@ components:
- ""
type: string
type: object
- OutboundMessagePayload_to:
+ OutboundMessagePayload_to_inner:
properties:
phone_number:
description: Receiving address (+E.164 formatted phone number or short code).
@@ -60105,7 +62647,7 @@ components:
- ""
type: string
type: object
- OutboundMessagePayload_media:
+ OutboundMessagePayload_media_inner:
properties:
url:
description: The url of the media requested to be sent.
@@ -60196,8 +62738,8 @@ components:
PhoneNumberRegulatoryRequirement_allOf:
properties:
field_value:
- description: The value of the requirement, this could be an id to a resource
- or a string value.
+ description: "The value of the requirement, this could be an id to a resource\
+ \ or a string value."
example: 45f45a04-b4be-4592-95b1-9306b9db2b21
type: string
type: object
@@ -60209,6 +62751,57 @@ components:
$ref: '#/components/schemas/MessagingFeatureSet'
readOnly: true
type: object
+ PortingOrderRequirementDetail_requirement_type:
+ description: Identifies the requirement type that meets this requirement
+ example:
+ name: Latest Invoice
+ description: A copy of the latest phone bill from the current provider
+ id: 53970723-fbff-4f46-a975-f62be6c1a585
+ type: document
+ acceptance_criteria:
+ acceptable_values: []
+ example: Most recent phone bill
+ properties:
+ acceptance_criteria:
+ description: The acceptance criteria for the requirement type
+ example:
+ acceptable_values: []
+ type: object
+ description:
+ description: A description of the requirement type
+ example: A copy of the latest phone bill from the current provider
+ type: string
+ example:
+ description: An example of the requirement type
+ example: Most recent phone bill
+ type: string
+ id:
+ description: Identifies the requirement type
+ example: 53970723-fbff-4f46-a975-f62be6c1a585
+ type: string
+ name:
+ description: The name of the requirement type
+ example: Latest Invoice
+ type: string
+ type:
+ description: The type of the requirement type
+ example: document
+ type: string
+ type: object
+ PublicInternetGateway_1:
+ properties:
+ record_type:
+ description: Identifies the type of the resource.
+ example: public_internet_gateway
+ readOnly: true
+ type: string
+ public_ip:
+ description: The publically accessible ip for this interface.
+ example: 127.0.0.1
+ readOnly: true
+ type: string
+ title: PublicInternetGateway
+ type: object
ReadComment_allOf:
properties:
read_at:
@@ -60305,7 +62898,23 @@ components:
example: audio
type: string
type: object
- RegulatoryRequirements_region_information:
+ RegionOut_region:
+ properties:
+ code:
+ description: Region code of the interface.
+ example: ashburn-va
+ type: string
+ name:
+ description: Region name of the interface.
+ example: Ashburn
+ type: string
+ record_type:
+ description: Identifies the type of the resource.
+ example: region
+ readOnly: true
+ type: string
+ type: object
+ RegulatoryRequirements_region_information_inner:
example:
region_name: CH
region_type: country_code
@@ -60317,7 +62926,7 @@ components:
example: country_code
type: string
type: object
- RegulatoryRequirements_acceptance_criteria:
+ RegulatoryRequirements_regulatory_requirements_inner_acceptance_criteria:
example:
field_value: 45f45a04-b4be-4592-95b1-9306b9db2b21
locality_limit: Identical locality as the numbers desired
@@ -60333,10 +62942,10 @@ components:
example: address
type: string
type: object
- RegulatoryRequirements_regulatory_requirements:
+ RegulatoryRequirements_regulatory_requirements_inner:
example:
- description: Address matching the DID area code (street, building number,
- postal code, city and country)
+ description: "Address matching the DID area code (street, building number,\
+ \ postal code, city and country)"
id: 12ade33a-21c0-473b-b055-b3c836e1c292
label: Address matching the DID area code
field_type: address_id
@@ -60345,11 +62954,11 @@ components:
locality_limit: Identical locality as the numbers desired
field_type: address
record_type: regulatory_requirement
- example: 311 W Superior St, Chicago, IL 60654
+ example: "311 W Superior St, Chicago, IL 60654"
properties:
description:
- example: Address matching the DID area code (street, building number, postal
- code, city and country)
+ example: "Address matching the DID area code (street, building number, postal\
+ \ code, city and country)"
readOnly: true
type: string
id:
@@ -60358,7 +62967,7 @@ components:
readOnly: true
type: string
example:
- example: 311 W Superior St, Chicago, IL 60654
+ example: "311 W Superior St, Chicago, IL 60654"
readOnly: true
type: string
label:
@@ -60368,7 +62977,7 @@ components:
example: address_id
type: string
acceptance_criteria:
- $ref: '#/components/schemas/RegulatoryRequirements_acceptance_criteria'
+ $ref: '#/components/schemas/RegulatoryRequirements_regulatory_requirements_inner_acceptance_criteria'
record_type:
example: regulatory_requirement
readOnly: true
@@ -60430,14 +63039,14 @@ components:
accuracy_unit: m
latitude: "41.143"
accuracy: 1250
- longitude: -8.605
+ longitude: "-8.605"
properties:
latitude:
example: "41.143"
format: float
type: string
longitude:
- example: -8.605
+ example: "-8.605"
format: float
type: string
accuracy:
@@ -60465,17 +63074,17 @@ components:
readOnly: true
type: string
reason:
- description: It describes why the SIM card action is in the current status.
- This will be null for self-explanatory statuses, such as
- in-progress and completed but will include further
- information on statuses like interrupted and failed.
+ description: "It describes why the SIM card action is in the current status.\
+ \ This will be null for self-explanatory statuses, such as\
+ \ in-progress and completed but will include\
+ \ further information on statuses like interrupted and failed."
example: The data limit was exceeded.
readOnly: true
type: string
type: object
SIMCardGroup_data_limit:
- description: Upper limit on the amount of data the SIM cards, within the group,
- can use.
+ description: "Upper limit on the amount of data the SIM cards, within the group,\
+ \ can use."
example:
amount: "2048.1"
unit: MB
@@ -60627,6 +63236,57 @@ components:
type: string
readOnly: true
type: object
+ Template_Components:
+ anyOf:
+ - $ref: '#/components/schemas/TemplateComponent'
+ - $ref: '#/components/schemas/TemplateButtonComponent'
+ description: ""
+ properties:
+ type:
+ description: Describes the component type.
+ enum:
+ - header
+ - body
+ - footer
+ type: string
+ parameters:
+ items:
+ $ref: '#/components/schemas/Template_Parameters'
+ title: Template Component Parameters
+ type: array
+ required:
+ - type
+ title: Template Components
+ type: object
+ Template_Parameters:
+ description: Array containing the content of the message.
+ properties:
+ type:
+ description: Describes the parameter type.
+ enum:
+ - text
+ - currency
+ - date_time
+ - image
+ - document
+ - video
+ type: string
+ text:
+ type: string
+ currency:
+ $ref: '#/components/schemas/Currency'
+ date_time:
+ $ref: '#/components/schemas/DateTimeObject'
+ image:
+ $ref: '#/components/schemas/Image'
+ document:
+ $ref: '#/components/schemas/Document'
+ video:
+ $ref: '#/components/schemas/Video'
+ required:
+ - type
+ title: Template Parameters
+ type: object
Transcription_payload_transcription_data:
properties:
confidence:
@@ -60635,7 +63295,7 @@ components:
format: double
type: number
is_final:
- description: When false, it means that this is an interim result.
+ description: "When false, it means that this is an interim result."
example: true
type: boolean
transcript:
@@ -60655,10 +63315,10 @@ components:
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
type: string
call_session_id:
- description: ID that is unique to the call session and can be used to correlate
- webhook events. Call session is a group of related call legs that logically
- belong to the same phone call, e.g. an inbound and outbound leg of a transferred
- call.
+ description: "ID that is unique to the call session and can be used to correlate\
+ \ webhook events. Call session is a group of related call legs that logically\
+ \ belong to the same phone call, e.g. an inbound and outbound leg of a\
+ \ transferred call."
example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
type: string
client_state:
@@ -60751,7 +63411,7 @@ components:
example: Telnyx
type: string
type: object
- VerifiedCallsDisplayProfile_phone_numbers:
+ VerifiedCallsDisplayProfile_phone_numbers_inner:
description: A Phone Number that can make phone calls displaying the configured
brand information
properties:
@@ -60780,7 +63440,7 @@ components:
readOnly: true
type: string
google_approval_info:
- description: Additional information about the decision, if available.
+ description: "Additional information about the decision, if available."
readOnly: true
type: string
display_profile_id:
@@ -60792,7 +63452,7 @@ components:
description: Marks the Phone Number to be removed from the Display Profile
type: boolean
type: object
- VerifiedCallsDisplayProfile_call_reasons:
+ VerifiedCallsDisplayProfile_call_reasons_inner:
description: The Call Reason to be displayed to the call recipient
properties:
record_type:
@@ -60819,7 +63479,7 @@ components:
readOnly: true
type: string
google_approval_info:
- description: Additional information about the decision, if available.
+ description: "Additional information about the decision, if available."
readOnly: true
type: string
display_profile_id:
@@ -60851,6 +63511,177 @@ components:
- phone_number
- response_code
type: object
+ VirtualCrossConnect_1:
+ properties:
+ record_type:
+ description: Identifies the type of the resource.
+ example: virtual_cross_connect
+ readOnly: true
+ type: string
+ cloud_provider:
+ description: The Virtual Private Cloud with which you would like to establish
+ a cross connect.
+ enum:
+ - aws
+ - azure
+ - gce
+ example: aws
+ type: string
+ cloud_region:
+ description: The region where your Virtual Private Cloud hosts are located.PENDINGThe
- account is waiting for review by the WhatsApp team. At this stage, the
- account is allowed only to send messages using the pre-approved messaging
- templates, from a single verified phone-number.APPROVEDThe
- WhatsApp team demeed the account as valid and now it has access to all
- capabilities that the WhatsApp integration offers.REJECTEDThe
- account was rejected by the WhatsApp team. It will need to re-submit its
- business information to resume the approval process.PENDINGThe\
+ \ account is waiting for review by the WhatsApp team. At this stage, the\
+ \ account is allowed only to send messages using the pre-approved messaging\
+ \ templates, from a single verified phone-number.APPROVEDThe\
+ \ WhatsApp team demeed the account as valid and now it has access to all\
+ \ capabilities that the WhatsApp integration offers.REJECTEDThe\
+ \ account was rejected by the WhatsApp team. It will need to re-submit\
+ \ its business information to resume the approval process. - prefix.name: sorts the result by the name field in ascending order. -name: sorts the result by the name field in descending order. created_at in descending order.
try {
- GetAllAuthenticationProvidersResponse result = apiInstance.findAuthenticationProviders(pageNumber, pageSize, sort);
+ FindAuthenticationProviders200Response result = apiInstance.findAuthenticationProviders(pageNumber, pageSize, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationProvidersApi#findAuthenticationProviders");
@@ -213,7 +213,7 @@ Name | Type | Description | Notes
### Return type
-[**GetAllAuthenticationProvidersResponse**](GetAllAuthenticationProvidersResponse.md)
+[**FindAuthenticationProviders200Response**](FindAuthenticationProviders200Response.md)
### Authorization
@@ -235,7 +235,7 @@ Name | Type | Description | Notes
## getAuthenticationProvider
-> AuthenticationProviderResponse getAuthenticationProvider(id)
+> CreateAuthenticationProvider200Response getAuthenticationProvider(id)
Retrieve an authentication provider
@@ -264,7 +264,7 @@ public class Example {
AuthenticationProvidersApi apiInstance = new AuthenticationProvidersApi(defaultClient);
String id = "id_example"; // String | authentication provider ID
try {
- AuthenticationProviderResponse result = apiInstance.getAuthenticationProvider(id);
+ CreateAuthenticationProvider200Response result = apiInstance.getAuthenticationProvider(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationProvidersApi#getAuthenticationProvider");
@@ -286,7 +286,7 @@ Name | Type | Description | Notes
### Return type
-[**AuthenticationProviderResponse**](AuthenticationProviderResponse.md)
+[**CreateAuthenticationProvider200Response**](CreateAuthenticationProvider200Response.md)
### Authorization
@@ -308,7 +308,7 @@ Name | Type | Description | Notes
## updateAuthenticationProvider
-> AuthenticationProviderResponse updateAuthenticationProvider(id, updateAuthenticationProviderRequest)
+> CreateAuthenticationProvider200Response updateAuthenticationProvider(id, updateAuthenticationProviderRequest)
Update a authentication provider
@@ -338,7 +338,7 @@ public class Example {
String id = "id_example"; // String | Identifies the resource.
UpdateAuthenticationProviderRequest updateAuthenticationProviderRequest = new UpdateAuthenticationProviderRequest(); // UpdateAuthenticationProviderRequest | Parameters that can be updated in a authentication provider
try {
- AuthenticationProviderResponse result = apiInstance.updateAuthenticationProvider(id, updateAuthenticationProviderRequest);
+ CreateAuthenticationProvider200Response result = apiInstance.updateAuthenticationProvider(id, updateAuthenticationProviderRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationProvidersApi#updateAuthenticationProvider");
@@ -361,7 +361,7 @@ Name | Type | Description | Notes
### Return type
-[**AuthenticationProviderResponse**](AuthenticationProviderResponse.md)
+[**CreateAuthenticationProvider200Response**](CreateAuthenticationProvider200Response.md)
### Authorization
diff --git a/docs/AvailablePhoneNumber.md b/docs/AvailablePhoneNumber.md
index 51ca3735..d4b55156 100644
--- a/docs/AvailablePhoneNumber.md
+++ b/docs/AvailablePhoneNumber.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | [optional]
-**phoneNumber** | **String** | | [optional]
-**vanityFormat** | **String** | | [optional]
-**bestEffort** | **Boolean** | Specifies whether the phone number is an exact match based on the search criteria or not. | [optional]
-**quickship** | **Boolean** | Specifies whether the phone number can receive calls immediately after purchase or not. | [optional]
-**reservable** | **Boolean** | Specifies whether the phone number can be reserved before purchase or not. | [optional]
-**regionInformation** | [**List<RegionInformation>**](RegionInformation.md) | | [optional]
-**costInformation** | [**CostInformation**](CostInformation.md) | | [optional]
-**features** | [**List<Feature>**](Feature.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | [optional] |
+|**phoneNumber** | **String** | | [optional] |
+|**vanityFormat** | **String** | | [optional] |
+|**bestEffort** | **Boolean** | Specifies whether the phone number is an exact match based on the search criteria or not. | [optional] |
+|**quickship** | **Boolean** | Specifies whether the phone number can receive calls immediately after purchase or not. | [optional] |
+|**reservable** | **Boolean** | Specifies whether the phone number can be reserved before purchase or not. | [optional] |
+|**regionInformation** | [**List<RegionInformation>**](RegionInformation.md) | | [optional] |
+|**costInformation** | [**CostInformation**](CostInformation.md) | | [optional] |
+|**features** | [**List<Feature>**](Feature.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-AVAILABLE_PHONE_NUMBER | "available_phone_number"
+| Name | Value |
+|---- | -----|
+| AVAILABLE_PHONE_NUMBER | "available_phone_number" |
diff --git a/docs/AvailablePhoneNumberBlock.md b/docs/AvailablePhoneNumberBlock.md
index e2cd9c46..abef84bb 100644
--- a/docs/AvailablePhoneNumberBlock.md
+++ b/docs/AvailablePhoneNumberBlock.md
@@ -5,22 +5,22 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | [optional]
-**startingNumber** | **String** | | [optional]
-**range** | **Integer** | | [optional]
-**regionInformation** | [**List<RegionInformation>**](RegionInformation.md) | | [optional]
-**costInformation** | [**CostInformation**](CostInformation.md) | | [optional]
-**features** | [**List<Feature>**](Feature.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | [optional] |
+|**startingNumber** | **String** | | [optional] |
+|**range** | **Integer** | | [optional] |
+|**regionInformation** | [**List<RegionInformation>**](RegionInformation.md) | | [optional] |
+|**costInformation** | [**CostInformation**](CostInformation.md) | | [optional] |
+|**features** | [**List<Feature>**](Feature.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-AVAILABLE_PHONE_NUMBER_BLOCK | "available_phone_number_block"
+| Name | Value |
+|---- | -----|
+| AVAILABLE_PHONE_NUMBER_BLOCK | "available_phone_number_block" |
diff --git a/docs/AvailablePhoneNumbersMetadata.md b/docs/AvailablePhoneNumbersMetadata.md
index fccce4de..11a22187 100644
--- a/docs/AvailablePhoneNumbersMetadata.md
+++ b/docs/AvailablePhoneNumbersMetadata.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalResults** | **Integer** | | [optional]
-**bestEffortResults** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalResults** | **Integer** | | [optional] |
+|**bestEffortResults** | **Integer** | | [optional] |
diff --git a/docs/BillingApi.md b/docs/BillingApi.md
index 2eabd9cb..191c1429 100644
--- a/docs/BillingApi.md
+++ b/docs/BillingApi.md
@@ -10,7 +10,7 @@ Method | HTTP request | Description
## getUserBalance
-> UserBalanceResponse getUserBalance()
+> GetUserBalance200Response getUserBalance()
Retrieve user balance details
@@ -36,7 +36,7 @@ public class Example {
BillingApi apiInstance = new BillingApi(defaultClient);
try {
- UserBalanceResponse result = apiInstance.getUserBalance();
+ GetUserBalance200Response result = apiInstance.getUserBalance();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BillingApi#getUserBalance");
@@ -55,7 +55,7 @@ This endpoint does not need any parameter.
### Return type
-[**UserBalanceResponse**](UserBalanceResponse.md)
+[**GetUserBalance200Response**](GetUserBalance200Response.md)
### Authorization
diff --git a/docs/BillingGroup.md b/docs/BillingGroup.md
index 0a3f311b..ae58a443 100644
--- a/docs/BillingGroup.md
+++ b/docs/BillingGroup.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**organizationId** | **UUID** | Identifies the organization that owns the resource. | [optional]
-**name** | **String** | A user-specified name for the billing group | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
-**deletedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was removed. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**organizationId** | **UUID** | Identifies the organization that owns the resource. | [optional] |
+|**name** | **String** | A user-specified name for the billing group | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] |
+|**deletedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was removed. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-BILLING_GROUP | "billing_group"
+| Name | Value |
+|---- | -----|
+| BILLING_GROUP | "billing_group" |
diff --git a/docs/BillingGroupsApi.md b/docs/BillingGroupsApi.md
index 8656d2e8..daca008a 100644
--- a/docs/BillingGroupsApi.md
+++ b/docs/BillingGroupsApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
## createBillingGroup
-> CreateBillingGroupResponse createBillingGroup(newBillingGroup)
+> CreateBillingGroup200Response createBillingGroup(newBillingGroup)
Create a billing group
@@ -41,7 +41,7 @@ public class Example {
BillingGroupsApi apiInstance = new BillingGroupsApi(defaultClient);
NewBillingGroup newBillingGroup = new NewBillingGroup(); // NewBillingGroup | New billing group object
try {
- CreateBillingGroupResponse result = apiInstance.createBillingGroup(newBillingGroup);
+ CreateBillingGroup200Response result = apiInstance.createBillingGroup(newBillingGroup);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BillingGroupsApi#createBillingGroup");
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
### Return type
-[**CreateBillingGroupResponse**](CreateBillingGroupResponse.md)
+[**CreateBillingGroup200Response**](CreateBillingGroup200Response.md)
### Authorization
@@ -83,7 +83,7 @@ Name | Type | Description | Notes
## deleteBillingGroup
-> DeleteBillingGroupResponse deleteBillingGroup(id)
+> CreateBillingGroup200Response deleteBillingGroup(id)
Delete a billing group
@@ -111,7 +111,7 @@ public class Example {
BillingGroupsApi apiInstance = new BillingGroupsApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | The id of the billing group
try {
- DeleteBillingGroupResponse result = apiInstance.deleteBillingGroup(id);
+ CreateBillingGroup200Response result = apiInstance.deleteBillingGroup(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BillingGroupsApi#deleteBillingGroup");
@@ -133,7 +133,7 @@ Name | Type | Description | Notes
### Return type
-[**DeleteBillingGroupResponse**](DeleteBillingGroupResponse.md)
+[**CreateBillingGroup200Response**](CreateBillingGroup200Response.md)
### Authorization
@@ -153,7 +153,7 @@ Name | Type | Description | Notes
## listBillingGroups
-> ListBillingGroupsResponse listBillingGroups(pageNumber, pageSize)
+> ListBillingGroups200Response listBillingGroups(pageNumber, pageSize)
List all billing groups
@@ -181,7 +181,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListBillingGroupsResponse result = apiInstance.listBillingGroups(pageNumber, pageSize);
+ ListBillingGroups200Response result = apiInstance.listBillingGroups(pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BillingGroupsApi#listBillingGroups");
@@ -204,7 +204,7 @@ Name | Type | Description | Notes
### Return type
-[**ListBillingGroupsResponse**](ListBillingGroupsResponse.md)
+[**ListBillingGroups200Response**](ListBillingGroups200Response.md)
### Authorization
@@ -224,7 +224,7 @@ Name | Type | Description | Notes
## retrieveBillingGroup
-> RetrieveBillingGroupResponse retrieveBillingGroup(id)
+> CreateBillingGroup200Response retrieveBillingGroup(id)
Retrieve a billing group
@@ -252,7 +252,7 @@ public class Example {
BillingGroupsApi apiInstance = new BillingGroupsApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | The id of the billing group
try {
- RetrieveBillingGroupResponse result = apiInstance.retrieveBillingGroup(id);
+ CreateBillingGroup200Response result = apiInstance.retrieveBillingGroup(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BillingGroupsApi#retrieveBillingGroup");
@@ -274,7 +274,7 @@ Name | Type | Description | Notes
### Return type
-[**RetrieveBillingGroupResponse**](RetrieveBillingGroupResponse.md)
+[**CreateBillingGroup200Response**](CreateBillingGroup200Response.md)
### Authorization
@@ -294,7 +294,7 @@ Name | Type | Description | Notes
## updateBillingGroup
-> UpdateBillingGroupResponse updateBillingGroup(id, updateBillingGroup)
+> CreateBillingGroup200Response updateBillingGroup(id, updateBillingGroup)
Update a billing group
@@ -323,7 +323,7 @@ public class Example {
UUID id = UUID.randomUUID(); // UUID | The id of the billing group
UpdateBillingGroup updateBillingGroup = new UpdateBillingGroup(); // UpdateBillingGroup | Update billing group object
try {
- UpdateBillingGroupResponse result = apiInstance.updateBillingGroup(id, updateBillingGroup);
+ CreateBillingGroup200Response result = apiInstance.updateBillingGroup(id, updateBillingGroup);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BillingGroupsApi#updateBillingGroup");
@@ -346,7 +346,7 @@ Name | Type | Description | Notes
### Return type
-[**UpdateBillingGroupResponse**](UpdateBillingGroupResponse.md)
+[**CreateBillingGroup200Response**](CreateBillingGroup200Response.md)
### Authorization
diff --git a/docs/Body.md b/docs/Body.md
new file mode 100644
index 00000000..409289eb
--- /dev/null
+++ b/docs/Body.md
@@ -0,0 +1,14 @@
+
+
+# Body
+
+The body of the message. Emojis and markdown are supported. Optional for type product. Required for other message types.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**text** | **String** | The body content of the message. Emojis and markdown are supported. Links are supported. | |
+
+
+
diff --git a/docs/BridgeRequest.md b/docs/BridgeRequest.md
index 21260577..db85da52 100644
--- a/docs/BridgeRequest.md
+++ b/docs/BridgeRequest.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | The Call Control ID of the call you want to bridge with. |
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
-**queue** | **String** | The name of the queue you want to bridge with, can't be used together with call_control_id parameter. Bridging with a queue means bridging with the first call in the queue. The call will always be removed from the queue regardless of whether bridging succeeds. Returns an error when the queue is empty. | [optional]
-**parkAfterUnbridge** | **String** | Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up or is transferred). If supplied with the value `self`, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | The Call Control ID of the call you want to bridge with. | |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
+|**queue** | **String** | The name of the queue you want to bridge with, can't be used together with call_control_id parameter. Bridging with a queue means bridging with the first call in the queue. The call will always be removed from the queue regardless of whether bridging succeeds. Returns an error when the queue is empty. | [optional] |
+|**parkAfterUnbridge** | **String** | Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up or is transferred). If supplied with the value `self`, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg. | [optional] |
diff --git a/docs/BulkCredentialRequest.md b/docs/BulkCredentialRequest.md
index 6f99b38c..653b3dcd 100644
--- a/docs/BulkCredentialRequest.md
+++ b/docs/BulkCredentialRequest.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A default name for all credentials. | [optional]
-**tag** | **String** | Tags a credential for bulk operations. A single tag can hold at maximum 1000 credentials. |
-**amount** | **Integer** | Amount of credentials to be created. A single tag can hold at maximum 1000 credentials | [optional]
-**connectionId** | **String** | Identifies the connection this credential is associated with. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | A default name for all credentials. | [optional] |
+|**tag** | **String** | Tags a credential for bulk operations. A single tag can hold at maximum 1000 credentials. | |
+|**amount** | **Integer** | Amount of credentials to be created. A single tag can hold at maximum 1000 credentials | [optional] |
+|**connectionId** | **String** | Identifies the connection this credential is associated with. | |
diff --git a/docs/BulkCredentialResponse.md b/docs/BulkCredentialResponse.md
index 6951700b..5e5b12f2 100644
--- a/docs/BulkCredentialResponse.md
+++ b/docs/BulkCredentialResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**BulkCredentialResponseData**](BulkCredentialResponseData.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**BulkCredentialResponseData**](BulkCredentialResponseData.md) | | [optional] |
diff --git a/docs/BulkCredentialResponseData.md b/docs/BulkCredentialResponseData.md
index 2d0a9f0b..5d748665 100644
--- a/docs/BulkCredentialResponseData.md
+++ b/docs/BulkCredentialResponseData.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**credentials** | **Integer** | Amount of credentials affected | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**credentials** | **Integer** | Amount of credentials affected | [optional] |
diff --git a/docs/BulkRoomRecordingsDeleteResponse.md b/docs/BulkRoomRecordingsDeleteResponse.md
index d4b59d0e..aea3acdd 100644
--- a/docs/BulkRoomRecordingsDeleteResponse.md
+++ b/docs/BulkRoomRecordingsDeleteResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**BulkRoomRecordingsDeleteResponseData**](BulkRoomRecordingsDeleteResponseData.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**BulkRoomRecordingsDeleteResponseData**](BulkRoomRecordingsDeleteResponseData.md) | | [optional] |
diff --git a/docs/BulkRoomRecordingsDeleteResponseData.md b/docs/BulkRoomRecordingsDeleteResponseData.md
index 81932007..dd725134 100644
--- a/docs/BulkRoomRecordingsDeleteResponseData.md
+++ b/docs/BulkRoomRecordingsDeleteResponseData.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**roomRecordings** | **Integer** | Amount of room recordings affected | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**roomRecordings** | **Integer** | Amount of room recordings affected | [optional] |
diff --git a/docs/BulkSIMCardAction.md b/docs/BulkSIMCardAction.md
new file mode 100644
index 00000000..1d96ff42
--- /dev/null
+++ b/docs/BulkSIMCardAction.md
@@ -0,0 +1,27 @@
+
+
+# BulkSIMCardAction
+
+This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**actionType** | [**ActionTypeEnum**](#ActionTypeEnum) | The operation type. It can be one of the following: <br/> <ul> <li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM card</li> </ul> | [optional] [readonly] |
+|**settings** | **Object** | A JSON object representation of the bulk action payload. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+
+
+
+## Enum: ActionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| BULK_SET_PUBLIC_IPS | "bulk_set_public_ips" |
+
+
+
diff --git a/docs/BulkSIMCardActionDetailed.md b/docs/BulkSIMCardActionDetailed.md
new file mode 100644
index 00000000..be997c4d
--- /dev/null
+++ b/docs/BulkSIMCardActionDetailed.md
@@ -0,0 +1,27 @@
+
+
+# BulkSIMCardActionDetailed
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**actionType** | [**ActionTypeEnum**](#ActionTypeEnum) | The operation type. It can be one of the following: <br/> <ul> <li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM card</li> </ul> | [optional] [readonly] |
+|**settings** | **Object** | A JSON object representation of the bulk action payload. | [optional] [readonly] |
+|**simCardActionsSummary** | [**List<SIMCardActionsSummary>**](SIMCardActionsSummary.md) | | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+
+
+
+## Enum: ActionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| BULK_SET_PUBLIC_IPS | "bulk_set_public_ips" |
+
+
+
diff --git a/docs/BulkSIMCardNetworkPreferences202Response.md b/docs/BulkSIMCardNetworkPreferences202Response.md
new file mode 100644
index 00000000..bf50ad93
--- /dev/null
+++ b/docs/BulkSIMCardNetworkPreferences202Response.md
@@ -0,0 +1,14 @@
+
+
+# BulkSIMCardNetworkPreferences202Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<SIMCardNetworkPreferenceWithOTAUpdates>**](SIMCardNetworkPreferenceWithOTAUpdates.md) | Multi requested SIM cards network preferences. | [optional] |
+|**errors** | [**List<Error>**](Error.md) | | [optional] |
+
+
+
diff --git a/docs/BulkSIMCardNetworkPreferencesRequest.md b/docs/BulkSIMCardNetworkPreferencesRequest.md
new file mode 100644
index 00000000..aec999b3
--- /dev/null
+++ b/docs/BulkSIMCardNetworkPreferencesRequest.md
@@ -0,0 +1,14 @@
+
+
+# BulkSIMCardNetworkPreferencesRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**simCardIds** | **List<UUID>** | | [optional] |
+|**mobileOperatorNetworksPreferences** | [**List<MobileOperatorNetworkPreferencesRequest>**](MobileOperatorNetworkPreferencesRequest.md) | A list of mobile operator networks and the priority that should be applied when the SIM is connecting to the network. | [optional] |
+
+
+
diff --git a/docs/BulkSetPublicIPs202Response.md b/docs/BulkSetPublicIPs202Response.md
new file mode 100644
index 00000000..232a0827
--- /dev/null
+++ b/docs/BulkSetPublicIPs202Response.md
@@ -0,0 +1,13 @@
+
+
+# BulkSetPublicIPs202Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**BulkSIMCardAction**](BulkSIMCardAction.md) | | [optional] |
+
+
+
diff --git a/docs/BulkSetPublicIPsRequest.md b/docs/BulkSetPublicIPsRequest.md
new file mode 100644
index 00000000..b93d769a
--- /dev/null
+++ b/docs/BulkSetPublicIPsRequest.md
@@ -0,0 +1,13 @@
+
+
+# BulkSetPublicIPsRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**simCardIds** | **List<UUID>** | | |
+
+
+
diff --git a/docs/BulkSimCardActionGet200Response.md b/docs/BulkSimCardActionGet200Response.md
new file mode 100644
index 00000000..1c16a9b1
--- /dev/null
+++ b/docs/BulkSimCardActionGet200Response.md
@@ -0,0 +1,13 @@
+
+
+# BulkSimCardActionGet200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**BulkSIMCardActionDetailed**](BulkSIMCardActionDetailed.md) | | [optional] |
+
+
+
diff --git a/docs/BusinessIdentity.md b/docs/BusinessIdentity.md
index ab83d91a..8a0ab5aa 100644
--- a/docs/BusinessIdentity.md
+++ b/docs/BusinessIdentity.md
@@ -5,22 +5,22 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional] [readonly]
-**id** | **UUID** | | [optional] [readonly]
-**organizationId** | **UUID** | The ID of the organization that owns the record | [optional] [readonly]
-**name** | **String** | The name of the business identity on the telnyx platform | [optional]
-**businessEmail** | **String** | The email of the business | [optional]
-**businessName** | **String** | The name of the business | [optional]
-**businessPhoneNumber** | **String** | | [optional]
-**businessDescription** | **String** | | [optional]
-**submissionAcknowledgement** | **Boolean** | User acceptance of the terms of submission | [optional]
-**websiteUrl** | **List<String>** | | [optional]
-**address** | [**BusinessIdentityAddress**](BusinessIdentityAddress.md) | | [optional]
-**contacts** | [**List<BusinessIdentityContacts>**](BusinessIdentityContacts.md) | | [optional]
-**createdAt** | **String** | An ISO 8601 datetime string for when the business identity was added to the Telnyx platform | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8601 datetime string for when the business identity was updated | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**id** | **UUID** | | [optional] [readonly] |
+|**organizationId** | **UUID** | The ID of the organization that owns the record | [optional] [readonly] |
+|**name** | **String** | The name of the business identity on the telnyx platform | [optional] |
+|**businessEmail** | **String** | The email of the business | [optional] |
+|**businessName** | **String** | The name of the business | [optional] |
+|**businessPhoneNumber** | **String** | | [optional] |
+|**businessDescription** | **String** | | [optional] |
+|**submissionAcknowledgement** | **Boolean** | User acceptance of the terms of submission | [optional] |
+|**websiteUrl** | **List<String>** | | [optional] |
+|**address** | [**BusinessIdentityAddress**](BusinessIdentityAddress.md) | | [optional] |
+|**contacts** | [**List<BusinessIdentityContactsInner>**](BusinessIdentityContactsInner.md) | | [optional] |
+|**createdAt** | **String** | An ISO 8601 datetime string for when the business identity was added to the Telnyx platform | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8601 datetime string for when the business identity was updated | [optional] [readonly] |
diff --git a/docs/BusinessIdentityAddress.md b/docs/BusinessIdentityAddress.md
index 10bf9532..d3bc6c0f 100644
--- a/docs/BusinessIdentityAddress.md
+++ b/docs/BusinessIdentityAddress.md
@@ -6,16 +6,16 @@ The primary address of the business
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional] [readonly]
-**id** | **UUID** | | [optional] [readonly]
-**city** | **String** | | [optional]
-**country** | **String** | | [optional]
-**extendedAddress** | **String** | | [optional]
-**postalCode** | **String** | | [optional]
-**state** | **String** | | [optional]
-**street** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**id** | **UUID** | | [optional] [readonly] |
+|**city** | **String** | | [optional] |
+|**country** | **String** | | [optional] |
+|**extendedAddress** | **String** | | [optional] |
+|**postalCode** | **String** | | [optional] |
+|**state** | **String** | | [optional] |
+|**street** | **String** | | [optional] |
diff --git a/docs/BusinessIdentityContactsInner.md b/docs/BusinessIdentityContactsInner.md
new file mode 100644
index 00000000..68081ee7
--- /dev/null
+++ b/docs/BusinessIdentityContactsInner.md
@@ -0,0 +1,20 @@
+
+
+# BusinessIdentityContactsInner
+
+A contact person for the business
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**id** | **UUID** | | [optional] [readonly] |
+|**email** | **String** | | [optional] |
+|**firstName** | **String** | | [optional] |
+|**jobTitle** | **String** | | [optional] |
+|**lastName** | **String** | | [optional] |
+|**phoneNumber** | **String** | | [optional] |
+
+
+
diff --git a/docs/Button.md b/docs/Button.md
new file mode 100644
index 00000000..d0aa3bbd
--- /dev/null
+++ b/docs/Button.md
@@ -0,0 +1,15 @@
+
+
+# Button
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**subType** | **Object** | Type of button being created. | |
+|**index** | **Integer** | Position index of the button. You can have up to 3 buttons using index values of 0-2. | |
+|**parameters** | [**List<ButtonParameter>**](ButtonParameter.md) | The parameters for the button, which are set at creation time in your Business Manager. | |
+
+
+
diff --git a/docs/ButtonComponentType.md b/docs/ButtonComponentType.md
new file mode 100644
index 00000000..96fe3d89
--- /dev/null
+++ b/docs/ButtonComponentType.md
@@ -0,0 +1,11 @@
+
+
+# ButtonComponentType
+
+## Enum
+
+
+* `BUTTON` (value: `"button"`)
+
+
+
diff --git a/docs/ButtonParameter.md b/docs/ButtonParameter.md
new file mode 100644
index 00000000..7eb4fbee
--- /dev/null
+++ b/docs/ButtonParameter.md
@@ -0,0 +1,15 @@
+
+
+# ButtonParameter
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **Object** | Indicates the type of parameter for the button. | |
+|**payload** | **Object** | Developer-defined payload that will be returned when the button is clicked in addition to the display text on the button. Required for quick_reply buttons. | [optional] |
+|**text** | **Object** | Developer provided suffix that will be appended to a previously created dynamic URL button. Required for url buttons. | [optional] |
+
+
+
diff --git a/docs/ButtonParameterType.md b/docs/ButtonParameterType.md
new file mode 100644
index 00000000..e013003d
--- /dev/null
+++ b/docs/ButtonParameterType.md
@@ -0,0 +1,13 @@
+
+
+# ButtonParameterType
+
+## Enum
+
+
+* `PAYLOAD` (value: `"payload"`)
+
+* `TEXT` (value: `"text"`)
+
+
+
diff --git a/docs/ButtonSubtype.md b/docs/ButtonSubtype.md
new file mode 100644
index 00000000..cfd82769
--- /dev/null
+++ b/docs/ButtonSubtype.md
@@ -0,0 +1,13 @@
+
+
+# ButtonSubtype
+
+## Enum
+
+
+* `QUICK_REPLY` (value: `"quick_reply"`)
+
+* `URL` (value: `"url"`)
+
+
+
diff --git a/docs/CSVDownloadResponse.md b/docs/CSVDownloadResponse.md
index 8d29a17a..9ad154b5 100644
--- a/docs/CSVDownloadResponse.md
+++ b/docs/CSVDownloadResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<CsvDownload>**](CsvDownload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CsvDownload>**](CsvDownload.md) | | [optional] |
diff --git a/docs/Call.md b/docs/Call.md
index 1c203eac..652fbbf2 100644
--- a/docs/Call.md
+++ b/docs/Call.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | |
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call |
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events |
-**callControlId** | **String** | Unique identifier and token for controlling the call. |
-**isAlive** | **Boolean** | Indicates whether the call is alive or not. For Dial command it will always be `false` (dialing is asynchronous). |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call | |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events | |
+|**callControlId** | **String** | Unique identifier and token for controlling the call. | |
+|**isAlive** | **Boolean** | Indicates whether the call is alive or not. For Dial command it will always be `false` (dialing is asynchronous). | |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-CALL | "call"
+| Name | Value |
+|---- | -----|
+| CALL | "call" |
diff --git a/docs/CallAnswered.md b/docs/CallAnswered.md
index baeb3c7a..01b5c896 100644
--- a/docs/CallAnswered.md
+++ b/docs/CallAnswered.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallAnsweredPayload**](CallAnsweredPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallAnsweredPayload**](CallAnsweredPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_ANSWERED | "call.answered"
+| Name | Value |
+|---- | -----|
+| CALL_ANSWERED | "call.answered" |
diff --git a/docs/CallAnsweredEvent.md b/docs/CallAnsweredEvent.md
index ec029c1c..22f84996 100644
--- a/docs/CallAnsweredEvent.md
+++ b/docs/CallAnsweredEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallAnswered**](CallAnswered.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallAnswered**](CallAnswered.md) | | [optional] |
diff --git a/docs/CallAnsweredPayload.md b/docs/CallAnsweredPayload.md
index 4c6e29c7..44e490a8 100644
--- a/docs/CallAnsweredPayload.md
+++ b/docs/CallAnsweredPayload.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional] |
## Enum: StateEnum
-Name | Value
----- | -----
-ANSWERED | "answered"
+| Name | Value |
+|---- | -----|
+| ANSWERED | "answered" |
diff --git a/docs/CallBridged.md b/docs/CallBridged.md
index d8a42660..b2fae1f4 100644
--- a/docs/CallBridged.md
+++ b/docs/CallBridged.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallBridgedPayload**](CallBridgedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallBridgedPayload**](CallBridgedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_BRIDGED | "call.bridged"
+| Name | Value |
+|---- | -----|
+| CALL_BRIDGED | "call.bridged" |
diff --git a/docs/CallBridgedEvent.md b/docs/CallBridgedEvent.md
index e61047b3..8fd5db37 100644
--- a/docs/CallBridgedEvent.md
+++ b/docs/CallBridgedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallBridged**](CallBridged.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallBridged**](CallBridged.md) | | [optional] |
diff --git a/docs/CallBridgedPayload.md b/docs/CallBridgedPayload.md
index 6133d9c6..741428ca 100644
--- a/docs/CallBridgedPayload.md
+++ b/docs/CallBridgedPayload.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional] |
## Enum: StateEnum
-Name | Value
----- | -----
-BRIDGED | "bridged"
+| Name | Value |
+|---- | -----|
+| BRIDGED | "bridged" |
diff --git a/docs/CallCommandsApi.md b/docs/CallCommandsApi.md
index 8da24e7d..bbf413a6 100644
--- a/docs/CallCommandsApi.md
+++ b/docs/CallCommandsApi.md
@@ -10,6 +10,7 @@ Method | HTTP request | Description
[**callEnqueue**](CallCommandsApi.md#callEnqueue) | **POST** /calls/{call_control_id}/actions/enqueue | Enqueue call
[**callForkStart**](CallCommandsApi.md#callForkStart) | **POST** /calls/{call_control_id}/actions/fork_start | Forking start
[**callForkStop**](CallCommandsApi.md#callForkStop) | **POST** /calls/{call_control_id}/actions/fork_stop | Forking stop
+[**callGather**](CallCommandsApi.md#callGather) | **POST** /calls/{call_control_id}/actions/gather | Gather
[**callGatherStop**](CallCommandsApi.md#callGatherStop) | **POST** /calls/{call_control_id}/actions/gather_stop | Gather stop
[**callGatherUsingAudio**](CallCommandsApi.md#callGatherUsingAudio) | **POST** /calls/{call_control_id}/actions/gather_using_audio | Gather using audio
[**callGatherUsingSpeak**](CallCommandsApi.md#callGatherUsingSpeak) | **POST** /calls/{call_control_id}/actions/gather_using_speak | Gather using speak
@@ -24,11 +25,11 @@ Method | HTTP request | Description
[**callReject**](CallCommandsApi.md#callReject) | **POST** /calls/{call_control_id}/actions/reject | Reject a call
[**callSendDTMF**](CallCommandsApi.md#callSendDTMF) | **POST** /calls/{call_control_id}/actions/send_dtmf | Send DTMF
[**callSpeak**](CallCommandsApi.md#callSpeak) | **POST** /calls/{call_control_id}/actions/speak | Speak text
-[**callStreamingStart**](CallCommandsApi.md#callStreamingStart) | **POST** /calls/{call_control_id}/actions/streaming_start | Streaming start
[**callStreamingStop**](CallCommandsApi.md#callStreamingStop) | **POST** /calls/{call_control_id}/actions/streaming_stop | Streaming stop
[**callTranscriptionStart**](CallCommandsApi.md#callTranscriptionStart) | **POST** /calls/{call_control_id}/actions/transcription_start | Transcription start
[**callTranscriptionStop**](CallCommandsApi.md#callTranscriptionStop) | **POST** /calls/{call_control_id}/actions/transcription_stop | Transcription stop
[**callTransfer**](CallCommandsApi.md#callTransfer) | **POST** /calls/{call_control_id}/actions/transfer | Transfer call
+[**callsCallControlIdActionsStreamingStartPost**](CallCommandsApi.md#callsCallControlIdActionsStreamingStartPost) | **POST** /calls/{call_control_id}/actions/streaming_start | Streaming start
[**clientStateUpdate**](CallCommandsApi.md#clientStateUpdate) | **PUT** /calls/{call_control_id}/actions/client_state_update | Update client state
[**leaveQueue**](CallCommandsApi.md#leaveQueue) | **POST** /calls/{call_control_id}/actions/leave_queue | Remove call from a queue
@@ -45,7 +46,8 @@ Answer an incoming call. You must issue this command before executing subsequent
**Expected Webhooks:**
- `call.answered`
-- `streaming.started` and `streaming.stopped` if `stream_url` was set
+- `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set
+
### Example
@@ -204,8 +206,10 @@ Dial a number or SIP URI from a given connection. A successful response will inc
- `call.initiated`
- `call.answered` or `call.hangup`
- `call.machine.detection.ended` if `answering_machine_detection` was requested
-- `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
-- `streaming.started` and `streaming.stopped` if `stream_url` was set
+- `call.machine.greeting.ended` if `answering_machine_detection` was requested to detect the end of machine greeting
+- `call.machine.premium.detection.ended` if `answering_machine_detection=premium` was requested
+- `call.machine.premium.greeting.ended` if `answering_machine_detection=premium` was requested and a beep was detected
+- `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set
### Example
@@ -576,6 +580,87 @@ Name | Type | Description | Notes
| **0** | Unexpected error | - |
+## callGather
+
+> CallControlCommandResponse callGather(callControlId, gatherRequest)
+
+Gather
+
+Gather DTMF signals to build interactive menus.
+
+You can pass a list of valid digits. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer) command must be issued before the `gather` command.
+
+**Expected Webhooks:**
+
+- `call.dtmf.received` (you may receive many of these webhooks)
+- `call.gather.ended`
+
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.CallCommandsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ CallCommandsApi apiInstance = new CallCommandsApi(defaultClient);
+ String callControlId = "callControlId_example"; // String | Unique identifier and token for controlling the call
+ GatherRequest gatherRequest = new GatherRequest(); // GatherRequest | Gather
+ try {
+ CallControlCommandResponse result = apiInstance.callGather(callControlId, gatherRequest);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CallCommandsApi#callGather");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **callControlId** | **String**| Unique identifier and token for controlling the call |
+ **gatherRequest** | [**GatherRequest**](GatherRequest.md)| Gather |
+
+### Return type
+
+[**CallControlCommandResponse**](CallControlCommandResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response upon making a call control command. | - |
+| **0** | Unexpected error | - |
+
+
## callGatherStop
> CallControlCommandResponse callGatherStop(callControlId, stopGatherRequest)
@@ -1687,75 +1772,18 @@ Name | Type | Description | Notes
| **0** | Unexpected error | - |
-## callStreamingStart
+## callStreamingStop
-> CallControlCommandResponse callStreamingStart(callControlId, startStreamingRequest)
+> CallControlCommandResponse callStreamingStop(callControlId, stopStreamingRequest)
-Streaming start
+Streaming stop
-Start streaming the media from a call to a specific WebSocket address in near-realtime.
-Audio will be delivered as base64-encoded RTP packets, wrapped in JSON payloads.
+Stop streaming a call to a WebSocket.
**Expected Webhooks:**
-- `streaming.started`
- `streaming.stopped`
-**WebSocket events**
-
-When the WebSocket connection is established, the following event is being sent over it:
-```
-{
- "event": "connected",
- "version": "1.0.0"
-}
-```
-And when the call is started, an event which contains information about the encoding and `stream_id` that identifies a particular stream:
-```
-{
- "event": "start",
- "sequence_number": "1",
- "start": {
- "user_id": "3E6F995F-85F7-4705-9741-53B116D28237",
- "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
- "media_format": {
- "encoding": "audio/x-mulaw",
- "sample_rate": 8000,
- "channels": 1
- }
- },
- "stream_id": "32DE0DEA-53CB-4B21-89A4-9E1819C043BC"
-}
-```
-The start event is followed by the following media events that contain base64-encoded RTP packets as their payloads:
-```
-{
- "event": "media",
- "sequence_number": "4",
- "media": {
- "track": "inbound/outbound",
- "chunk": "2",
- "timestamp": "5",
- "payload": "no+JhoaJjpzSHxAKBgYJD...IsSbjomGhoqQn1Ic"
- },
- "stream_id": "32DE0DEA-53CB-4B21-89A4-9E1819C043BC"
-}
-```
-Please note that the order of events is not guaranteed and the chunk number can be used to reorder the events.
-
-When the call ends, the stop event over WebSockets connection is sent:
-```
-{
- "event": "stop",
- "sequence_number": "5",
- "stop": {
- "user_id": "3E6F995F-85F7-4705-9741-53B116D28237",
- "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ"
- },
- "stream_id": "32DE0DEA-53CB-4B21-89A4-9E1819C043BC"
- }
-```
-
### Example
@@ -1779,12 +1807,12 @@ public class Example {
CallCommandsApi apiInstance = new CallCommandsApi(defaultClient);
String callControlId = "callControlId_example"; // String | Unique identifier and token for controlling the call
- StartStreamingRequest startStreamingRequest = new StartStreamingRequest(); // StartStreamingRequest | Start streaming media request
+ StopStreamingRequest stopStreamingRequest = new StopStreamingRequest(); // StopStreamingRequest | Stop streaming media request
try {
- CallControlCommandResponse result = apiInstance.callStreamingStart(callControlId, startStreamingRequest);
+ CallControlCommandResponse result = apiInstance.callStreamingStop(callControlId, stopStreamingRequest);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallCommandsApi#callStreamingStart");
+ System.err.println("Exception when calling CallCommandsApi#callStreamingStop");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1800,7 +1828,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**callControlId** | **String**| Unique identifier and token for controlling the call |
- **startStreamingRequest** | [**StartStreamingRequest**](StartStreamingRequest.md)| Start streaming media request |
+ **stopStreamingRequest** | [**StopStreamingRequest**](StopStreamingRequest.md)| Stop streaming media request |
### Return type
@@ -1822,17 +1850,17 @@ Name | Type | Description | Notes
| **0** | Unexpected error | - |
-## callStreamingStop
+## callTranscriptionStart
-> CallControlCommandResponse callStreamingStop(callControlId, stopStreamingRequest)
+> CallControlCommandResponse callTranscriptionStart(callControlId, transcriptionStartRequest)
-Streaming stop
+Transcription start
-Stop streaming a call to a WebSocket.
+Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command.
**Expected Webhooks:**
-- `streaming.stopped`
+- `call.transcription`
### Example
@@ -1857,12 +1885,12 @@ public class Example {
CallCommandsApi apiInstance = new CallCommandsApi(defaultClient);
String callControlId = "callControlId_example"; // String | Unique identifier and token for controlling the call
- StopStreamingRequest stopStreamingRequest = new StopStreamingRequest(); // StopStreamingRequest | Stop streaming media request
+ TranscriptionStartRequest transcriptionStartRequest = new TranscriptionStartRequest(); // TranscriptionStartRequest | Transcription start request
try {
- CallControlCommandResponse result = apiInstance.callStreamingStop(callControlId, stopStreamingRequest);
+ CallControlCommandResponse result = apiInstance.callTranscriptionStart(callControlId, transcriptionStartRequest);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallCommandsApi#callStreamingStop");
+ System.err.println("Exception when calling CallCommandsApi#callTranscriptionStart");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1878,7 +1906,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**callControlId** | **String**| Unique identifier and token for controlling the call |
- **stopStreamingRequest** | [**StopStreamingRequest**](StopStreamingRequest.md)| Stop streaming media request |
+ **transcriptionStartRequest** | [**TranscriptionStartRequest**](TranscriptionStartRequest.md)| Transcription start request |
### Return type
@@ -1900,18 +1928,13 @@ Name | Type | Description | Notes
| **0** | Unexpected error | - |
-## callTranscriptionStart
-
-> CallControlCommandResponse callTranscriptionStart(callControlId, transcriptionStartRequest)
-
-Transcription start
-
-Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command.
+## callTranscriptionStop
-**Expected Webhooks:**
+> CallControlCommandResponse callTranscriptionStop(callControlId, transcriptionStopRequest)
-- `call.transcription`
+Transcription stop
+Stop real-time transcription.
### Example
@@ -1935,12 +1958,12 @@ public class Example {
CallCommandsApi apiInstance = new CallCommandsApi(defaultClient);
String callControlId = "callControlId_example"; // String | Unique identifier and token for controlling the call
- TranscriptionStartRequest transcriptionStartRequest = new TranscriptionStartRequest(); // TranscriptionStartRequest | Transcription start request
+ TranscriptionStopRequest transcriptionStopRequest = new TranscriptionStopRequest(); // TranscriptionStopRequest | Transcription stop request
try {
- CallControlCommandResponse result = apiInstance.callTranscriptionStart(callControlId, transcriptionStartRequest);
+ CallControlCommandResponse result = apiInstance.callTranscriptionStop(callControlId, transcriptionStopRequest);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallCommandsApi#callTranscriptionStart");
+ System.err.println("Exception when calling CallCommandsApi#callTranscriptionStop");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -1956,7 +1979,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**callControlId** | **String**| Unique identifier and token for controlling the call |
- **transcriptionStartRequest** | [**TranscriptionStartRequest**](TranscriptionStartRequest.md)| Transcription start request |
+ **transcriptionStopRequest** | [**TranscriptionStopRequest**](TranscriptionStopRequest.md)| Transcription stop request |
### Return type
@@ -1978,13 +2001,21 @@ Name | Type | Description | Notes
| **0** | Unexpected error | - |
-## callTranscriptionStop
+## callTransfer
-> CallControlCommandResponse callTranscriptionStop(callControlId, transcriptionStopRequest)
+> CallControlCommandResponse callTransfer(callControlId, transferCallRequest)
-Transcription stop
+Transfer call
-Stop real-time transcription.
+Transfer a call to a new destination. If the transfer is unsuccessful, a `call.hangup` webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination.
+
+**Expected Webhooks:**
+
+- `call.initiated`
+- `call.bridged` to Leg B
+- `call.answered` or `call.hangup`
+- `call.machine.detection.ended` if `answering_machine_detection` was requested
+- `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
### Example
@@ -2008,12 +2039,12 @@ public class Example {
CallCommandsApi apiInstance = new CallCommandsApi(defaultClient);
String callControlId = "callControlId_example"; // String | Unique identifier and token for controlling the call
- TranscriptionStopRequest transcriptionStopRequest = new TranscriptionStopRequest(); // TranscriptionStopRequest | Transcription stop request
+ TransferCallRequest transferCallRequest = new TransferCallRequest(); // TransferCallRequest | Transfer call request
try {
- CallControlCommandResponse result = apiInstance.callTranscriptionStop(callControlId, transcriptionStopRequest);
+ CallControlCommandResponse result = apiInstance.callTransfer(callControlId, transferCallRequest);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallCommandsApi#callTranscriptionStop");
+ System.err.println("Exception when calling CallCommandsApi#callTransfer");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2029,7 +2060,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**callControlId** | **String**| Unique identifier and token for controlling the call |
- **transcriptionStopRequest** | [**TranscriptionStopRequest**](TranscriptionStopRequest.md)| Transcription stop request |
+ **transferCallRequest** | [**TransferCallRequest**](TransferCallRequest.md)| Transfer call request |
### Return type
@@ -2051,21 +2082,109 @@ Name | Type | Description | Notes
| **0** | Unexpected error | - |
-## callTransfer
+## callsCallControlIdActionsStreamingStartPost
-> CallControlCommandResponse callTransfer(callControlId, transferCallRequest)
+> CallControlCommandResponse callsCallControlIdActionsStreamingStartPost(callControlId, startStreamingRequest)
-Transfer call
+Streaming start
-Transfer a call to a new destination. If the transfer is unsuccessful, a `call.hangup` webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination.
+Start streaming the media from a call to a specific WebSocket address or Dialogflow connection in near-realtime. Audio will be delivered as base64-encoded RTP payload (raw audio), wrapped in JSON payloads.
+
+**Example: Starting a stream to a Websocket address**
+
+ The `stream_url` param is mandatory.
+
+```
+curl -X POST \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --header "Authorization: Bearer YOUR_API_KEY" \
+ --data '{
+ "stream_url": "wss://www.example.com/websocket",\
+"client_state":"aGF2ZSBhIG5pY2UgZGF5ID1d",\
+"command_id":"891510ac-f3e4-11e8-af5b-de00688a4901" \
+}' \
+ https://api.telnyx.com/v2/calls/{call_control_id}/actions/streaming_start
+```
+
+ **Example: Starting a stream to a Dialogflow connection**
+
+ Enable the Dialogflow integration by sending `"enable_dialogflow": true` in the request. You need to have a Dialogflow connection associated with your Call Control application first, [click here for instructions](https://developers.telnyx.com/docs/v2/call-control/tutorials/dialogflow-es).
+```
+curl -X POST \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --header "Authorization: Bearer YOUR_API_KEY" \
+ --data '{
+ "client_state":"aGF2ZSBhIG5pY2UgZGF5ID1d", \
+"command_id":"891510ac-f3e4-11e8-af5b-de00688a4901", \
+"enable_dialogflow": true \
+}' \
+ https://api.telnyx.com/v2/calls/{call_control_id}/actions/streaming_start
+```
**Expected Webhooks:**
-- `call.initiated`
-- `call.bridged` to Leg B
-- `call.answered` or `call.hangup`
-- `call.machine.detection.ended` if `answering_machine_detection` was requested
-- `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
+- `streaming.started`
+- `streaming.stopped`
+- `streaming.failed`
+
+**WebSocket events**
+
+When the WebSocket connection is established, the following event is being sent over it:
+```
+{
+ "event": "connected",
+ "version": "1.0.0"
+}
+```
+And when the call is started, an event which contains information about the encoding and `stream_id` that identifies a particular stream:
+```
+{
+ "event": "start",
+ "sequence_number": "1",
+ "start": {
+ "user_id": "3e6f995f-85f7-4705-9741-53b116d28237",
+ "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
+ "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
+ "media_format": {
+ "encoding": "audio/x-mulaw",
+ "sample_rate": 8000,
+ "channels": 1
+ }
+ },
+ "stream_id": "32de0dea-53cb-4b21-89a4-9e1819c043bc"
+}
+```
+The start event is followed by the following media events that contain base64-encoded RTP payload (raw audio, no RTP headers) (:
+```
+{
+ "event": "media",
+ "sequence_number": "4",
+ "media": {
+ "track": "inbound/outbound",
+ "chunk": "2",
+ "timestamp": "5",
+ "payload": "no+JhoaJjpzSHxAKBgYJD...IsSbjomGhoqQn1Ic"
+ },
+ "stream_id": "32de0dea-53cb-4b21-89a4-9e1819c043bc"
+}
+```
+Please note that the order of events is not guaranteed and the chunk number can be used to reorder the events.
+
+When the call ends, the stop event over WebSockets connection is sent:
+```
+{
+ "event": "stop",
+ "sequence_number": "5",
+ "stop": {
+ "user_id": "3e6f995f-85f7-4705-9741-53b116d28237",
+ "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ"
+ },
+ "stream_id": "32de0dea-53cb-4b21-89a4-9e1819c043bc"
+ }
+```
+
### Example
@@ -2089,12 +2208,12 @@ public class Example {
CallCommandsApi apiInstance = new CallCommandsApi(defaultClient);
String callControlId = "callControlId_example"; // String | Unique identifier and token for controlling the call
- TransferCallRequest transferCallRequest = new TransferCallRequest(); // TransferCallRequest | Transfer call request
+ StartStreamingRequest startStreamingRequest = new StartStreamingRequest(); // StartStreamingRequest | Start streaming media request
try {
- CallControlCommandResponse result = apiInstance.callTransfer(callControlId, transferCallRequest);
+ CallControlCommandResponse result = apiInstance.callsCallControlIdActionsStreamingStartPost(callControlId, startStreamingRequest);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallCommandsApi#callTransfer");
+ System.err.println("Exception when calling CallCommandsApi#callsCallControlIdActionsStreamingStartPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -2110,7 +2229,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**callControlId** | **String**| Unique identifier and token for controlling the call |
- **transferCallRequest** | [**TransferCallRequest**](TransferCallRequest.md)| Transfer call request |
+ **startStreamingRequest** | [**StartStreamingRequest**](StartStreamingRequest.md)| Start streaming media request |
### Return type
diff --git a/docs/CallControlApplication.md b/docs/CallControlApplication.md
index fd0e87f9..1cbf5d3e 100644
--- a/docs/CallControlApplication.md
+++ b/docs/CallControlApplication.md
@@ -5,62 +5,62 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | [**AnchorsiteOverrideEnum**](#AnchorsiteOverrideEnum) | `Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media. | [optional]
-**applicationName** | **String** | A user-assigned name to help manage the application. | [optional]
-**createdAt** | **String** | ISO 8601 formatted date of when the resource was created | [optional]
-**dtmfType** | [**DtmfTypeEnum**](#DtmfTypeEnum) | Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats. | [optional]
-**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional]
-**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional]
-**id** | **String** | | [optional]
-**inbound** | [**CallControlApplicationInbound**](CallControlApplicationInbound.md) | | [optional]
-**outbound** | [**CallControlApplicationOutbound**](CallControlApplicationOutbound.md) | | [optional]
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date of when the resource was last updated | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as `https`. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as `https`. | [optional]
-**webhookTimeoutSecs** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | [**AnchorsiteOverrideEnum**](#AnchorsiteOverrideEnum) | `Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media. | [optional] |
+|**applicationName** | **String** | A user-assigned name to help manage the application. | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date of when the resource was created | [optional] |
+|**dtmfType** | [**DtmfTypeEnum**](#DtmfTypeEnum) | Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats. | [optional] |
+|**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional] |
+|**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional] |
+|**id** | **String** | | [optional] |
+|**inbound** | [**CallControlApplicationInbound**](CallControlApplicationInbound.md) | | [optional] |
+|**outbound** | [**CallControlApplicationOutbound**](CallControlApplicationOutbound.md) | | [optional] |
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date of when the resource was last updated | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as `https`. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as `https`. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | | [optional] |
## Enum: AnchorsiteOverrideEnum
-Name | Value
----- | -----
-LATENCY_ | "\"Latency\""
-CHICAGO_IL_ | "\"Chicago, IL\""
-ASHBURN_VA_ | "\"Ashburn, VA\""
-SAN_JOSE_CA_ | "\"San Jose, CA\""
+| Name | Value |
+|---- | -----|
+| LATENCY_ | "\"Latency\"" |
+| CHICAGO_IL_ | "\"Chicago, IL\"" |
+| ASHBURN_VA_ | "\"Ashburn, VA\"" |
+| SAN_JOSE_CA_ | "\"San Jose, CA\"" |
## Enum: DtmfTypeEnum
-Name | Value
----- | -----
-RFC_2833 | "RFC 2833"
-INBAND | "Inband"
-SIP_INFO | "SIP INFO"
+| Name | Value |
+|---- | -----|
+| RFC_2833 | "RFC 2833" |
+| INBAND | "Inband" |
+| SIP_INFO | "SIP INFO" |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-CALL_CONTROL_APPLICATION | "call_control_application"
+| Name | Value |
+|---- | -----|
+| CALL_CONTROL_APPLICATION | "call_control_application" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/CallControlApplicationInbound.md b/docs/CallControlApplicationInbound.md
index 5200c8aa..70de2e0e 100644
--- a/docs/CallControlApplicationInbound.md
+++ b/docs/CallControlApplicationInbound.md
@@ -5,20 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional]
-**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional]
-**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional] |
+|**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional] |
+|**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional] |
## Enum: SipSubdomainReceiveSettingsEnum
-Name | Value
----- | -----
-ONLY_MY_CONNECTIONS | "only_my_connections"
-FROM_ANYONE | "from_anyone"
+| Name | Value |
+|---- | -----|
+| ONLY_MY_CONNECTIONS | "only_my_connections" |
+| FROM_ANYONE | "from_anyone" |
diff --git a/docs/CallControlApplicationOutbound.md b/docs/CallControlApplicationOutbound.md
index 6c1c7943..bfeb08a5 100644
--- a/docs/CallControlApplicationOutbound.md
+++ b/docs/CallControlApplicationOutbound.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional]
-**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional] |
+|**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional] |
diff --git a/docs/CallControlApplicationResponse.md b/docs/CallControlApplicationResponse.md
index ba5712da..a8bb9128 100644
--- a/docs/CallControlApplicationResponse.md
+++ b/docs/CallControlApplicationResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallControlApplication**](CallControlApplication.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallControlApplication**](CallControlApplication.md) | | [optional] |
diff --git a/docs/CallControlApplicationsApi.md b/docs/CallControlApplicationsApi.md
index 185ec5a2..caee4c2d 100644
--- a/docs/CallControlApplicationsApi.md
+++ b/docs/CallControlApplicationsApi.md
@@ -151,14 +151,14 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with details about a call control application. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
| **422** | Bad request | - |
## listCallControlApplications
-> ListCallControlApplicationsResponse listCallControlApplications().pageNumber(pageNumber).pageSize(pageSize).filterApplicationNameContains(filterApplicationNameContains).filterOutboundOutboundVoiceProfileId(filterOutboundOutboundVoiceProfileId).sort(sort).execute();
+> ListCallControlApplicationsResponse listCallControlApplications().pageNumber(pageNumber).pageSize(pageSize).filterApplicationNameContains(filterApplicationNameContains).filterOutboundVoiceProfileId(filterOutboundVoiceProfileId).sort(sort).execute();
List call control applications
@@ -188,14 +188,14 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
String filterApplicationNameContains = "null"; // String | If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
- String filterOutboundOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
+ String filterOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
ListCallControlApplicationsResponse result = api.listCallControlApplications()
.pageNumber(pageNumber)
.pageSize(pageSize)
.filterApplicationNameContains(filterApplicationNameContains)
- .filterOutboundOutboundVoiceProfileId(filterOutboundOutboundVoiceProfileId)
+ .filterOutboundVoiceProfileId(filterOutboundVoiceProfileId)
.sort(sort)
.execute();
System.out.println(result);
@@ -218,7 +218,7 @@ Name | Type | Description | Notes
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
**filterApplicationNameContains** | **String**| If present, applications with <code>application_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
- **filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
+ **filterOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
### Return type
@@ -239,7 +239,7 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
| **200** | Successful response with a list of call control applications. | - |
| **400** | Bad request | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
@@ -311,7 +311,7 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with details about a call control application. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
| **422** | Bad request | - |
@@ -386,7 +386,7 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with details about a call control application. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
| **422** | Bad request | - |
diff --git a/docs/CallControlCommandResponse.md b/docs/CallControlCommandResponse.md
index 2d7e4928..d4a81776 100644
--- a/docs/CallControlCommandResponse.md
+++ b/docs/CallControlCommandResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallControlCommandResult**](CallControlCommandResult.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallControlCommandResult**](CallControlCommandResult.md) | | [optional] |
diff --git a/docs/CallControlCommandResult.md b/docs/CallControlCommandResult.md
index af8b6098..f61a9372 100644
--- a/docs/CallControlCommandResult.md
+++ b/docs/CallControlCommandResult.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**result** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **String** | | [optional] |
diff --git a/docs/CallCost.md b/docs/CallCost.md
index e88f533f..fb6d0ae3 100644
--- a/docs/CallCost.md
+++ b/docs/CallCost.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of the event being delivered | [optional]
-**id** | **UUID** | Uniquely identifies a webhook | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**meta** | [**CallCostMeta**](CallCostMeta.md) | | [optional]
-**payload** | [**CallCostPayload**](CallCostPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of the event being delivered | [optional] |
+|**id** | **UUID** | Uniquely identifies a webhook | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**meta** | [**CallCostMeta**](CallCostMeta.md) | | [optional] |
+|**payload** | [**CallCostPayload**](CallCostPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_COST | "call.cost"
+| Name | Value |
+|---- | -----|
+| CALL_COST | "call.cost" |
diff --git a/docs/CallCostMeta.md b/docs/CallCostMeta.md
index e9c1b084..d9ed94e9 100644
--- a/docs/CallCostMeta.md
+++ b/docs/CallCostMeta.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**meta** | [**CallCostMetaMeta**](CallCostMetaMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**meta** | [**CallCostMetaMeta**](CallCostMetaMeta.md) | | [optional] |
diff --git a/docs/CallCostMetaMeta.md b/docs/CallCostMetaMeta.md
index 52c83cc5..b8a519d3 100644
--- a/docs/CallCostMetaMeta.md
+++ b/docs/CallCostMetaMeta.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**attempt** | **Integer** | The number of attempts made to deliver the webhook | [optional]
-**deliveredTo** | **String** | The URL where webhook was sent | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**attempt** | **Integer** | The number of attempts made to deliver the webhook | [optional] |
+|**deliveredTo** | **String** | The URL where webhook was sent | [optional] |
diff --git a/docs/CallCostPayload.md b/docs/CallCostPayload.md
index c4378d3e..26137cbb 100644
--- a/docs/CallCostPayload.md
+++ b/docs/CallCostPayload.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**billedDurationSecs** | **Integer** | The number of seconds for which this call will be billed | [optional]
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**connectionId** | **String** | Identifies the type of resource. | [optional]
-**costParts** | [**List<CallCostPayloadCostParts>**](CallCostPayloadCostParts.md) | | [optional]
-**totalCost** | **BigDecimal** | The billed cost of the call | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Reflects how command ended. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**billedDurationSecs** | **Integer** | The number of seconds for which this call will be billed | [optional] |
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**connectionId** | **String** | Identifies the type of resource. | [optional] |
+|**costParts** | [**List<CallCostPayloadCostPartsInner>**](CallCostPayloadCostPartsInner.md) | | [optional] |
+|**totalCost** | **BigDecimal** | The billed cost of the call | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Reflects how command ended. | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-VALID | "valid"
-INVALID | "invalid"
-CALL_HANGUP | "call_hangup"
-CANCELLED | "cancelled"
-CANCELLED_AMD | "cancelled_amd"
+| Name | Value |
+|---- | -----|
+| VALID | "valid" |
+| INVALID | "invalid" |
+| CALL_HANGUP | "call_hangup" |
+| CANCELLED | "cancelled" |
+| CANCELLED_AMD | "cancelled_amd" |
diff --git a/docs/CallCostPayloadCostPartsInner.md b/docs/CallCostPayloadCostPartsInner.md
new file mode 100644
index 00000000..8c6d906a
--- /dev/null
+++ b/docs/CallCostPayloadCostPartsInner.md
@@ -0,0 +1,17 @@
+
+
+# CallCostPayloadCostPartsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**billedDurationSecs** | **Integer** | The number of seconds for which this item will be billed | [optional] |
+|**callPart** | **String** | The service incurring a charge | [optional] |
+|**cost** | **BigDecimal** | The billed cost of the item, in currency shown in the `currency` field | [optional] |
+|**currency** | **String** | The currency in which `cost` is measured | [optional] |
+|**rate** | **BigDecimal** | The cost per unit of the item incurring a charge | [optional] |
+
+
+
diff --git a/docs/CallDtmfReceived.md b/docs/CallDtmfReceived.md
index 39b93040..aa190efe 100644
--- a/docs/CallDtmfReceived.md
+++ b/docs/CallDtmfReceived.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallDtmfReceivedPayload**](CallDtmfReceivedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallDtmfReceivedPayload**](CallDtmfReceivedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_DTMF_RECEIVED | "call.dtmf.received"
+| Name | Value |
+|---- | -----|
+| CALL_DTMF_RECEIVED | "call.dtmf.received" |
diff --git a/docs/CallDtmfReceivedEvent.md b/docs/CallDtmfReceivedEvent.md
index a20ccc17..ea031521 100644
--- a/docs/CallDtmfReceivedEvent.md
+++ b/docs/CallDtmfReceivedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallDtmfReceived**](CallDtmfReceived.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallDtmfReceived**](CallDtmfReceived.md) | | [optional] |
diff --git a/docs/CallDtmfReceivedPayload.md b/docs/CallDtmfReceivedPayload.md
index 043b68bc..429eea0a 100644
--- a/docs/CallDtmfReceivedPayload.md
+++ b/docs/CallDtmfReceivedPayload.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Identifies the type of resource. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**digit** | **String** | The received DTMF digit or symbol. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Identifies the type of resource. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**digit** | **String** | The received DTMF digit or symbol. | [optional] |
diff --git a/docs/CallEnqueued.md b/docs/CallEnqueued.md
index 1ddf726a..d4ada028 100644
--- a/docs/CallEnqueued.md
+++ b/docs/CallEnqueued.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallEnqueuedPayload**](CallEnqueuedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallEnqueuedPayload**](CallEnqueuedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_ENQUEUED | "call.enqueued"
+| Name | Value |
+|---- | -----|
+| CALL_ENQUEUED | "call.enqueued" |
diff --git a/docs/CallEnqueuedEvent.md b/docs/CallEnqueuedEvent.md
index 1c025a56..f25209cd 100644
--- a/docs/CallEnqueuedEvent.md
+++ b/docs/CallEnqueuedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallEnqueued**](CallEnqueued.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallEnqueued**](CallEnqueued.md) | | [optional] |
diff --git a/docs/CallEnqueuedPayload.md b/docs/CallEnqueuedPayload.md
index 6484d82f..c26637d1 100644
--- a/docs/CallEnqueuedPayload.md
+++ b/docs/CallEnqueuedPayload.md
@@ -5,15 +5,15 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Telnyx connection ID used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**queue** | **String** | The name of the queue | [optional]
-**currentPosition** | **Integer** | Current position of the call in the queue. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Telnyx connection ID used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**queue** | **String** | The name of the queue | [optional] |
+|**currentPosition** | **Integer** | Current position of the call in the queue. | [optional] |
diff --git a/docs/CallEvent.md b/docs/CallEvent.md
index b5c3e863..5b56b350 100644
--- a/docs/CallEvent.md
+++ b/docs/CallEvent.md
@@ -5,32 +5,32 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | |
-**callLegId** | **String** | Uniquely identifies an individual call leg. |
-**callSessionId** | **String** | Uniquely identifies the call control session. A session may include multiple call leg events. |
-**eventTimestamp** | **String** | Event timestamp |
-**name** | **String** | Event name |
-**type** | [**TypeEnum**](#TypeEnum) | Event type |
-**metadata** | **Object** | Event metadata, which includes raw event, and extra information based on event type |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | |
+|**callLegId** | **String** | Uniquely identifies an individual call leg. | |
+|**callSessionId** | **String** | Uniquely identifies the call control session. A session may include multiple call leg events. | |
+|**eventTimestamp** | **String** | Event timestamp | |
+|**name** | **String** | Event name | |
+|**type** | [**TypeEnum**](#TypeEnum) | Event type | |
+|**metadata** | **Object** | Event metadata, which includes raw event, and extra information based on event type | |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-CALL_EVENT | "call_event"
+| Name | Value |
+|---- | -----|
+| CALL_EVENT | "call_event" |
## Enum: TypeEnum
-Name | Value
----- | -----
-COMMAND | "command"
-WEBHOOK | "webhook"
+| Name | Value |
+|---- | -----|
+| COMMAND | "command" |
+| WEBHOOK | "webhook" |
diff --git a/docs/CallForkStarted.md b/docs/CallForkStarted.md
index 54d42c56..3dfb218c 100644
--- a/docs/CallForkStarted.md
+++ b/docs/CallForkStarted.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallForkStartedPayload**](CallForkStartedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallForkStartedPayload**](CallForkStartedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_FORK_STARTED | "call.fork.started"
+| Name | Value |
+|---- | -----|
+| CALL_FORK_STARTED | "call.fork.started" |
diff --git a/docs/CallForkStartedEvent.md b/docs/CallForkStartedEvent.md
index 6cf972d2..3c3d97d6 100644
--- a/docs/CallForkStartedEvent.md
+++ b/docs/CallForkStartedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallForkStarted**](CallForkStarted.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallForkStarted**](CallForkStarted.md) | | [optional] |
diff --git a/docs/CallForkStartedPayload.md b/docs/CallForkStartedPayload.md
index 603d3b24..537b5dda 100644
--- a/docs/CallForkStartedPayload.md
+++ b/docs/CallForkStartedPayload.md
@@ -5,11 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callControlId** | **String** | Unique ID for controlling the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**streamType** | [**StreamTypeEnum**](#StreamTypeEnum) | Type of media streamed. It can be either 'raw' or 'decrypted'. | [optional] |
+
+
+
+## Enum: StreamTypeEnum
+
+| Name | Value |
+|---- | -----|
+| RAW | "raw" |
+| DECRYPTED | "decrypted" |
diff --git a/docs/CallForkStopped.md b/docs/CallForkStopped.md
index 21e420af..8f595b91 100644
--- a/docs/CallForkStopped.md
+++ b/docs/CallForkStopped.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallForkStartedPayload**](CallForkStartedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallForkStartedPayload**](CallForkStartedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_FORK_STOPPED | "call.fork.stopped"
+| Name | Value |
+|---- | -----|
+| CALL_FORK_STOPPED | "call.fork.stopped" |
diff --git a/docs/CallForkStoppedEvent.md b/docs/CallForkStoppedEvent.md
index 5b7a4885..9ca88f28 100644
--- a/docs/CallForkStoppedEvent.md
+++ b/docs/CallForkStoppedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallForkStopped**](CallForkStopped.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallForkStopped**](CallForkStopped.md) | | [optional] |
diff --git a/docs/CallForwarding.md b/docs/CallForwarding.md
index ceb8869a..fd2e1e8b 100644
--- a/docs/CallForwarding.md
+++ b/docs/CallForwarding.md
@@ -6,20 +6,20 @@ The call forwarding settings for a phone number.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callForwardingEnabled** | **Boolean** | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional]
-**forwardsTo** | **String** | The phone number to which inbound calls to this number are forwarded. Inbound calls will not be forwarded if this field is left blank. If set, must be a +E.164-formatted phone number. | [optional]
-**forwardingType** | [**ForwardingTypeEnum**](#ForwardingTypeEnum) | Call forwarding type. 'forwards_to' must be set for this to have an effect. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callForwardingEnabled** | **Boolean** | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional] |
+|**forwardsTo** | **String** | The phone number to which inbound calls to this number are forwarded. Inbound calls will not be forwarded if this field is left blank. If set, must be a +E.164-formatted phone number. | [optional] |
+|**forwardingType** | [**ForwardingTypeEnum**](#ForwardingTypeEnum) | Call forwarding type. 'forwards_to' must be set for this to have an effect. | [optional] |
## Enum: ForwardingTypeEnum
-Name | Value
----- | -----
-ALWAYS | "always"
-ON_FAILURE | "on_failure"
+| Name | Value |
+|---- | -----|
+| ALWAYS | "always" |
+| ON_FAILURE | "on_failure" |
diff --git a/docs/CallGatherEnded.md b/docs/CallGatherEnded.md
index 872d33e9..520219fc 100644
--- a/docs/CallGatherEnded.md
+++ b/docs/CallGatherEnded.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallGatherEndedPayload**](CallGatherEndedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallGatherEndedPayload**](CallGatherEndedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_GATHER_ENDED | "call.gather.ended"
+| Name | Value |
+|---- | -----|
+| CALL_GATHER_ENDED | "call.gather.ended" |
diff --git a/docs/CallGatherEndedEvent.md b/docs/CallGatherEndedEvent.md
index af95f890..19ae42f4 100644
--- a/docs/CallGatherEndedEvent.md
+++ b/docs/CallGatherEndedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallGatherEnded**](CallGatherEnded.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallGatherEnded**](CallGatherEnded.md) | | [optional] |
diff --git a/docs/CallGatherEndedPayload.md b/docs/CallGatherEndedPayload.md
index a77ef832..0dcf4961 100644
--- a/docs/CallGatherEndedPayload.md
+++ b/docs/CallGatherEndedPayload.md
@@ -5,29 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**digits** | **String** | The received DTMF digit or symbol. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Reflects how command ended. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**digits** | **String** | The received DTMF digit or symbol. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Reflects how command ended. | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-VALID | "valid"
-INVALID | "invalid"
-CALL_HANGUP | "call_hangup"
-CANCELLED | "cancelled"
-CANCELLED_AMD | "cancelled_amd"
+| Name | Value |
+|---- | -----|
+| VALID | "valid" |
+| INVALID | "invalid" |
+| CALL_HANGUP | "call_hangup" |
+| CANCELLED | "cancelled" |
+| CANCELLED_AMD | "cancelled_amd" |
+| TIMEOUT | "timeout" |
diff --git a/docs/CallHangup.md b/docs/CallHangup.md
index 53db1b53..fa37c002 100644
--- a/docs/CallHangup.md
+++ b/docs/CallHangup.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallHangupPayload**](CallHangupPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallHangupPayload**](CallHangupPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_HANGUP | "call.hangup"
+| Name | Value |
+|---- | -----|
+| CALL_HANGUP | "call.hangup" |
diff --git a/docs/CallHangupEvent.md b/docs/CallHangupEvent.md
index 86a3ea6f..e27fb40e 100644
--- a/docs/CallHangupEvent.md
+++ b/docs/CallHangupEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallHangup**](CallHangup.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallHangup**](CallHangup.md) | | [optional] |
diff --git a/docs/CallHangupPayload.md b/docs/CallHangupPayload.md
index b0c53a9f..a3529eb0 100644
--- a/docs/CallHangupPayload.md
+++ b/docs/CallHangupPayload.md
@@ -5,53 +5,53 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**startTime** | **OffsetDateTime** | ISO 8601 datetime of when the call started. | [optional]
-**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional]
-**hangupCause** | [**HangupCauseEnum**](#HangupCauseEnum) | The reason the call was ended (`call_rejected`, `normal_clearing`, `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or `unspecified`). | [optional]
-**hangupSource** | [**HangupSourceEnum**](#HangupSourceEnum) | The party who ended the call (`callee`, `caller`, `unknown`). | [optional]
-**sipHangupCause** | **String** | The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to `unspecified`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**startTime** | **OffsetDateTime** | ISO 8601 datetime of when the call started. | [optional] |
+|**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional] |
+|**hangupCause** | [**HangupCauseEnum**](#HangupCauseEnum) | The reason the call was ended (`call_rejected`, `normal_clearing`, `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or `unspecified`). | [optional] |
+|**hangupSource** | [**HangupSourceEnum**](#HangupSourceEnum) | The party who ended the call (`callee`, `caller`, `unknown`). | [optional] |
+|**sipHangupCause** | **String** | The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to `unspecified`. | [optional] |
## Enum: StateEnum
-Name | Value
----- | -----
-HANGUP | "hangup"
+| Name | Value |
+|---- | -----|
+| HANGUP | "hangup" |
## Enum: HangupCauseEnum
-Name | Value
----- | -----
-CALL_REJECTED | "call_rejected"
-NORMAL_CLEARING | "normal_clearing"
-ORIGINATOR_CANCEL | "originator_cancel"
-TIMEOUT | "timeout"
-TIME_LIMIT | "time_limit"
-USER_BUSY | "user_busy"
-NOT_FOUND | "not_found"
-UNSPECIFIED | "unspecified"
+| Name | Value |
+|---- | -----|
+| CALL_REJECTED | "call_rejected" |
+| NORMAL_CLEARING | "normal_clearing" |
+| ORIGINATOR_CANCEL | "originator_cancel" |
+| TIMEOUT | "timeout" |
+| TIME_LIMIT | "time_limit" |
+| USER_BUSY | "user_busy" |
+| NOT_FOUND | "not_found" |
+| UNSPECIFIED | "unspecified" |
## Enum: HangupSourceEnum
-Name | Value
----- | -----
-CALLER | "caller"
-CALLEE | "callee"
-UNKNOWN | "unknown"
+| Name | Value |
+|---- | -----|
+| CALLER | "caller" |
+| CALLEE | "callee" |
+| UNKNOWN | "unknown" |
diff --git a/docs/CallInitiated.md b/docs/CallInitiated.md
index 5ad3b117..55072ded 100644
--- a/docs/CallInitiated.md
+++ b/docs/CallInitiated.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallInitiatedPayload**](CallInitiatedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallInitiatedPayload**](CallInitiatedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_INITIATED | "call.initiated"
+| Name | Value |
+|---- | -----|
+| CALL_INITIATED | "call.initiated" |
diff --git a/docs/CallInitiatedEvent.md b/docs/CallInitiatedEvent.md
index c33d31a3..aade01ec 100644
--- a/docs/CallInitiatedEvent.md
+++ b/docs/CallInitiatedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallInitiated**](CallInitiated.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallInitiated**](CallInitiated.md) | | [optional] |
diff --git a/docs/CallInitiatedPayload.md b/docs/CallInitiatedPayload.md
index 50468adb..dad6a874 100644
--- a/docs/CallInitiatedPayload.md
+++ b/docs/CallInitiatedPayload.md
@@ -5,35 +5,35 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**direction** | [**DirectionEnum**](#DirectionEnum) | Whether the call is `incoming` or `outgoing`. | [optional]
-**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**direction** | [**DirectionEnum**](#DirectionEnum) | Whether the call is `incoming` or `outgoing`. | [optional] |
+|**state** | [**StateEnum**](#StateEnum) | State received from a command. | [optional] |
## Enum: DirectionEnum
-Name | Value
----- | -----
-INCOMING | "incoming"
-OUTGOING | "outgoing"
+| Name | Value |
+|---- | -----|
+| INCOMING | "incoming" |
+| OUTGOING | "outgoing" |
## Enum: StateEnum
-Name | Value
----- | -----
-PARKED | "parked"
-BRIDGING | "bridging"
+| Name | Value |
+|---- | -----|
+| PARKED | "parked" |
+| BRIDGING | "bridging" |
diff --git a/docs/CallLeftQueue.md b/docs/CallLeftQueue.md
index 86577c25..994d959d 100644
--- a/docs/CallLeftQueue.md
+++ b/docs/CallLeftQueue.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallLeftQueuePayload**](CallLeftQueuePayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallLeftQueuePayload**](CallLeftQueuePayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_DEQUEUED | "call.dequeued"
+| Name | Value |
+|---- | -----|
+| CALL_DEQUEUED | "call.dequeued" |
diff --git a/docs/CallLeftQueueEvent.md b/docs/CallLeftQueueEvent.md
index d95e700b..7cca334f 100644
--- a/docs/CallLeftQueueEvent.md
+++ b/docs/CallLeftQueueEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallLeftQueue**](CallLeftQueue.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallLeftQueue**](CallLeftQueue.md) | | [optional] |
diff --git a/docs/CallLeftQueuePayload.md b/docs/CallLeftQueuePayload.md
index 0dc687cd..e9511a3e 100644
--- a/docs/CallLeftQueuePayload.md
+++ b/docs/CallLeftQueuePayload.md
@@ -5,28 +5,28 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Telnyx connection ID used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**queue** | **String** | The name of the queue | [optional]
-**queuePosition** | **Integer** | Last position of the call in the queue. | [optional]
-**reason** | [**ReasonEnum**](#ReasonEnum) | The reason for leaving the queue | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Telnyx connection ID used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**queue** | **String** | The name of the queue | [optional] |
+|**queuePosition** | **Integer** | Last position of the call in the queue. | [optional] |
+|**reason** | [**ReasonEnum**](#ReasonEnum) | The reason for leaving the queue | [optional] |
## Enum: ReasonEnum
-Name | Value
----- | -----
-BRIDGED | "bridged"
-BRIDGING_IN_PROCESS | "bridging-in-process"
-HANGUP | "hangup"
-LEAVE | "leave"
-TIMEOUT | "timeout"
+| Name | Value |
+|---- | -----|
+| BRIDGED | "bridged" |
+| BRIDGING_IN_PROCESS | "bridging-in-process" |
+| HANGUP | "hangup" |
+| LEAVE | "leave" |
+| TIMEOUT | "timeout" |
diff --git a/docs/CallMachineDetectionEnded.md b/docs/CallMachineDetectionEnded.md
index 9f7cc1cc..433d62f3 100644
--- a/docs/CallMachineDetectionEnded.md
+++ b/docs/CallMachineDetectionEnded.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallMachineDetectionEndedPayload**](CallMachineDetectionEndedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallMachineDetectionEndedPayload**](CallMachineDetectionEndedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_MACHINE_DETECTION_ENDED | "call.machine.detection.ended"
+| Name | Value |
+|---- | -----|
+| CALL_MACHINE_DETECTION_ENDED | "call.machine.detection.ended" |
diff --git a/docs/CallMachineDetectionEndedEvent.md b/docs/CallMachineDetectionEndedEvent.md
index ee8975a2..a3366b55 100644
--- a/docs/CallMachineDetectionEndedEvent.md
+++ b/docs/CallMachineDetectionEndedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallMachineDetectionEnded**](CallMachineDetectionEnded.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallMachineDetectionEnded**](CallMachineDetectionEnded.md) | | [optional] |
diff --git a/docs/CallMachineDetectionEndedPayload.md b/docs/CallMachineDetectionEndedPayload.md
index 67914f08..1c063a2f 100644
--- a/docs/CallMachineDetectionEndedPayload.md
+++ b/docs/CallMachineDetectionEndedPayload.md
@@ -5,26 +5,26 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**result** | [**ResultEnum**](#ResultEnum) | Answering machine detection result. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**result** | [**ResultEnum**](#ResultEnum) | Answering machine detection result. | [optional] |
## Enum: ResultEnum
-Name | Value
----- | -----
-HUMAN | "human"
-MACHINE | "machine"
-NOT_SURE | "not_sure"
+| Name | Value |
+|---- | -----|
+| HUMAN | "human" |
+| MACHINE | "machine" |
+| NOT_SURE | "not_sure" |
diff --git a/docs/CallMachineGreetingEnded.md b/docs/CallMachineGreetingEnded.md
index d2c94692..f180e860 100644
--- a/docs/CallMachineGreetingEnded.md
+++ b/docs/CallMachineGreetingEnded.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallMachineGreetingEndedPayload**](CallMachineGreetingEndedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallMachineGreetingEndedPayload**](CallMachineGreetingEndedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_MACHINE_GREETING_ENDED | "call.machine.greeting.ended"
+| Name | Value |
+|---- | -----|
+| CALL_MACHINE_GREETING_ENDED | "call.machine.greeting.ended" |
diff --git a/docs/CallMachineGreetingEndedEvent.md b/docs/CallMachineGreetingEndedEvent.md
index 8b467904..3251769f 100644
--- a/docs/CallMachineGreetingEndedEvent.md
+++ b/docs/CallMachineGreetingEndedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallMachineGreetingEnded**](CallMachineGreetingEnded.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallMachineGreetingEnded**](CallMachineGreetingEnded.md) | | [optional] |
diff --git a/docs/CallMachineGreetingEndedPayload.md b/docs/CallMachineGreetingEndedPayload.md
index 1dd7a030..4d956286 100644
--- a/docs/CallMachineGreetingEndedPayload.md
+++ b/docs/CallMachineGreetingEndedPayload.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
-**result** | [**ResultEnum**](#ResultEnum) | Answering machine greeting ended result. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
+|**result** | [**ResultEnum**](#ResultEnum) | Answering machine greeting ended result. | [optional] |
## Enum: ResultEnum
-Name | Value
----- | -----
-ENDED | "ended"
-NOT_SURE | "not_sure"
+| Name | Value |
+|---- | -----|
+| ENDED | "ended" |
+| NOT_SURE | "not_sure" |
diff --git a/docs/CallPlaybackEnded.md b/docs/CallPlaybackEnded.md
index 4ce2b599..d44d0a32 100644
--- a/docs/CallPlaybackEnded.md
+++ b/docs/CallPlaybackEnded.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallPlaybackEndedPayload**](CallPlaybackEndedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallPlaybackEndedPayload**](CallPlaybackEndedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_PLAYBACK_ENDED | "call.playback.ended"
+| Name | Value |
+|---- | -----|
+| CALL_PLAYBACK_ENDED | "call.playback.ended" |
diff --git a/docs/CallPlaybackEndedEvent.md b/docs/CallPlaybackEndedEvent.md
index bf3519cd..da35dfa6 100644
--- a/docs/CallPlaybackEndedEvent.md
+++ b/docs/CallPlaybackEndedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallPlaybackEnded**](CallPlaybackEnded.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallPlaybackEnded**](CallPlaybackEnded.md) | | [optional] |
diff --git a/docs/CallPlaybackEndedPayload.md b/docs/CallPlaybackEndedPayload.md
index 8237d285..11e4ca9d 100644
--- a/docs/CallPlaybackEndedPayload.md
+++ b/docs/CallPlaybackEndedPayload.md
@@ -5,31 +5,31 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**mediaUrl** | **String** | The audio URL being played back, if audio_url has been used to start. | [optional]
-**mediaName** | **String** | The name of the audio media file being played back, if media_name has been used to start. | [optional]
-**overlay** | **Boolean** | Whether the stopped audio was in overlay mode or not. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Reflects how command ended. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**mediaUrl** | **String** | The audio URL being played back, if audio_url has been used to start. | [optional] |
+|**mediaName** | **String** | The name of the audio media file being played back, if media_name has been used to start. | [optional] |
+|**overlay** | **Boolean** | Whether the stopped audio was in overlay mode or not. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Reflects how command ended. | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-FILE_NOT_FOUND | "file_not_found"
-CALL_HANGUP | "call_hangup"
-UNKNOWN | "unknown"
-FAILED | "failed"
-CANCELLED_AMD | "cancelled_amd"
-COMPLETED | "completed"
-FAILED | "failed"
+| Name | Value |
+|---- | -----|
+| FILE_NOT_FOUND | "file_not_found" |
+| CALL_HANGUP | "call_hangup" |
+| UNKNOWN | "unknown" |
+| FAILED | "failed" |
+| CANCELLED_AMD | "cancelled_amd" |
+| COMPLETED | "completed" |
+| FAILED | "failed" |
diff --git a/docs/CallPlaybackStarted.md b/docs/CallPlaybackStarted.md
index 2b5e9fa3..d40047dd 100644
--- a/docs/CallPlaybackStarted.md
+++ b/docs/CallPlaybackStarted.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallPlaybackStartedPayload**](CallPlaybackStartedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallPlaybackStartedPayload**](CallPlaybackStartedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_PLAYBACK_STARTED | "call.playback.started"
+| Name | Value |
+|---- | -----|
+| CALL_PLAYBACK_STARTED | "call.playback.started" |
diff --git a/docs/CallPlaybackStartedEvent.md b/docs/CallPlaybackStartedEvent.md
index 47d66750..fcbc78b3 100644
--- a/docs/CallPlaybackStartedEvent.md
+++ b/docs/CallPlaybackStartedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallPlaybackStarted**](CallPlaybackStarted.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallPlaybackStarted**](CallPlaybackStarted.md) | | [optional] |
diff --git a/docs/CallPlaybackStartedPayload.md b/docs/CallPlaybackStartedPayload.md
index 138282c1..da544db2 100644
--- a/docs/CallPlaybackStartedPayload.md
+++ b/docs/CallPlaybackStartedPayload.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**mediaUrl** | **String** | The audio URL being played back, if audio_url has been used to start. | [optional]
-**mediaName** | **String** | The name of the audio media file being played back, if media_name has been used to start. | [optional]
-**overlay** | **Boolean** | Whether the audio is going to be played in overlay mode or not. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**mediaUrl** | **String** | The audio URL being played back, if audio_url has been used to start. | [optional] |
+|**mediaName** | **String** | The name of the audio media file being played back, if media_name has been used to start. | [optional] |
+|**overlay** | **Boolean** | Whether the audio is going to be played in overlay mode or not. | [optional] |
diff --git a/docs/CallRecording.md b/docs/CallRecording.md
index b13476a8..56b6664b 100644
--- a/docs/CallRecording.md
+++ b/docs/CallRecording.md
@@ -6,29 +6,29 @@ The call recording settings for a phone number.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**inboundCallRecordingEnabled** | **Boolean** | When enabled, any inbound call to this number will be recorded. | [optional]
-**inboundCallRecordingFormat** | [**InboundCallRecordingFormatEnum**](#InboundCallRecordingFormatEnum) | The audio file format for calls being recorded. | [optional]
-**inboundCallRecordingChannels** | [**InboundCallRecordingChannelsEnum**](#InboundCallRecordingChannelsEnum) | When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**inboundCallRecordingEnabled** | **Boolean** | When enabled, any inbound call to this number will be recorded. | [optional] |
+|**inboundCallRecordingFormat** | [**InboundCallRecordingFormatEnum**](#InboundCallRecordingFormatEnum) | The audio file format for calls being recorded. | [optional] |
+|**inboundCallRecordingChannels** | [**InboundCallRecordingChannelsEnum**](#InboundCallRecordingChannelsEnum) | When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B. | [optional] |
## Enum: InboundCallRecordingFormatEnum
-Name | Value
----- | -----
-WAV | "wav"
-MP3 | "mp3"
+| Name | Value |
+|---- | -----|
+| WAV | "wav" |
+| MP3 | "mp3" |
## Enum: InboundCallRecordingChannelsEnum
-Name | Value
----- | -----
-SINGLE | "single"
-DUAL | "dual"
+| Name | Value |
+|---- | -----|
+| SINGLE | "single" |
+| DUAL | "dual" |
diff --git a/docs/CallRecordingError.md b/docs/CallRecordingError.md
index a8d882da..e362a01b 100644
--- a/docs/CallRecordingError.md
+++ b/docs/CallRecordingError.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallRecordingErrorPayload**](CallRecordingErrorPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallRecordingErrorPayload**](CallRecordingErrorPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_RECORDING_ERROR | "call.recording.error"
+| Name | Value |
+|---- | -----|
+| CALL_RECORDING_ERROR | "call.recording.error" |
diff --git a/docs/CallRecordingErrorEvent.md b/docs/CallRecordingErrorEvent.md
index 1f367984..ae730708 100644
--- a/docs/CallRecordingErrorEvent.md
+++ b/docs/CallRecordingErrorEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallRecordingError**](CallRecordingError.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallRecordingError**](CallRecordingError.md) | | [optional] |
diff --git a/docs/CallRecordingErrorPayload.md b/docs/CallRecordingErrorPayload.md
index 51c6bcc0..9b6ab325 100644
--- a/docs/CallRecordingErrorPayload.md
+++ b/docs/CallRecordingErrorPayload.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional]
-**connectionId** | **String** | Telnyx connection ID used in the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**reason** | [**ReasonEnum**](#ReasonEnum) | Indication that there was a problem recording the call. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Call ID used to issue commands via Call Control API. | [optional] |
+|**connectionId** | **String** | Telnyx connection ID used in the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**reason** | [**ReasonEnum**](#ReasonEnum) | Indication that there was a problem recording the call. | [optional] |
## Enum: ReasonEnum
-Name | Value
----- | -----
-FAILED_TO_AUTHORIZE_WITH_STORAGE_USING_CUSTOM_CREDENTIALS | "Failed to authorize with storage using custom credentials"
-INVALID_CREDENTIALS_JSON | "Invalid credentials json"
-UNSUPPORTED_BACKEND | "Unsupported backend"
-INTERNAL_SERVER_ERROR | "Internal server error"
+| Name | Value |
+|---- | -----|
+| FAILED_TO_AUTHORIZE_WITH_STORAGE_USING_CUSTOM_CREDENTIALS | "Failed to authorize with storage using custom credentials" |
+| INVALID_CREDENTIALS_JSON | "Invalid credentials json" |
+| UNSUPPORTED_BACKEND | "Unsupported backend" |
+| INTERNAL_SERVER_ERROR | "Internal server error" |
diff --git a/docs/CallRecordingSaved.md b/docs/CallRecordingSaved.md
index 4d7cc988..d275aefd 100644
--- a/docs/CallRecordingSaved.md
+++ b/docs/CallRecordingSaved.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallRecordingSavedPayload**](CallRecordingSavedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallRecordingSavedPayload**](CallRecordingSavedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_RECORDING_SAVED | "call.recording.saved"
+| Name | Value |
+|---- | -----|
+| CALL_RECORDING_SAVED | "call.recording.saved" |
diff --git a/docs/CallRecordingSavedEvent.md b/docs/CallRecordingSavedEvent.md
index 483da0c5..b7680d70 100644
--- a/docs/CallRecordingSavedEvent.md
+++ b/docs/CallRecordingSavedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallRecordingSaved**](CallRecordingSaved.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallRecordingSaved**](CallRecordingSaved.md) | | [optional] |
diff --git a/docs/CallRecordingSavedPayload.md b/docs/CallRecordingSavedPayload.md
index a01129bb..b7ea33d8 100644
--- a/docs/CallRecordingSavedPayload.md
+++ b/docs/CallRecordingSavedPayload.md
@@ -5,26 +5,26 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**recordingStartedAt** | **OffsetDateTime** | ISO 8601 datetime of when recording started. | [optional]
-**recordingEndedAt** | **OffsetDateTime** | ISO 8601 datetime of when recording ended. | [optional]
-**channels** | [**ChannelsEnum**](#ChannelsEnum) | Whether recording was recorded in `single` or `dual` channel. | [optional]
-**recordingUrls** | [**CallRecordingSavedPayloadRecordingUrls**](CallRecordingSavedPayloadRecordingUrls.md) | | [optional]
-**publicRecordingUrls** | [**CallRecordingSavedPayloadPublicRecordingUrls**](CallRecordingSavedPayloadPublicRecordingUrls.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**recordingStartedAt** | **OffsetDateTime** | ISO 8601 datetime of when recording started. | [optional] |
+|**recordingEndedAt** | **OffsetDateTime** | ISO 8601 datetime of when recording ended. | [optional] |
+|**channels** | [**ChannelsEnum**](#ChannelsEnum) | Whether recording was recorded in `single` or `dual` channel. | [optional] |
+|**recordingUrls** | [**CallRecordingSavedPayloadRecordingUrls**](CallRecordingSavedPayloadRecordingUrls.md) | | [optional] |
+|**publicRecordingUrls** | [**CallRecordingSavedPayloadPublicRecordingUrls**](CallRecordingSavedPayloadPublicRecordingUrls.md) | | [optional] |
## Enum: ChannelsEnum
-Name | Value
----- | -----
-SINGLE | "single"
-DUAL | "dual"
+| Name | Value |
+|---- | -----|
+| SINGLE | "single" |
+| DUAL | "dual" |
diff --git a/docs/CallRecordingSavedPayloadPublicRecordingUrls.md b/docs/CallRecordingSavedPayloadPublicRecordingUrls.md
index 918d2c90..f46a9b70 100644
--- a/docs/CallRecordingSavedPayloadPublicRecordingUrls.md
+++ b/docs/CallRecordingSavedPayloadPublicRecordingUrls.md
@@ -6,10 +6,10 @@ Recording URLs in requested format. The URL is valid for as long as the file exi
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mp3** | **String** | Recording URL in requested `mp3` format. | [optional]
-**wav** | **String** | Recording URL in requested `wav` format. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mp3** | **String** | Recording URL in requested `mp3` format. | [optional] |
+|**wav** | **String** | Recording URL in requested `wav` format. | [optional] |
diff --git a/docs/CallRecordingSavedPayloadRecordingUrls.md b/docs/CallRecordingSavedPayloadRecordingUrls.md
index f04cce19..ecf2f064 100644
--- a/docs/CallRecordingSavedPayloadRecordingUrls.md
+++ b/docs/CallRecordingSavedPayloadRecordingUrls.md
@@ -6,10 +6,10 @@ Recording URLs in requested format. These URLs are valid for 10 minutes. After 1
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mp3** | **String** | Recording URL in requested `mp3` format. | [optional]
-**wav** | **String** | Recording URL in requested `wav` format. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mp3** | **String** | Recording URL in requested `mp3` format. | [optional] |
+|**wav** | **String** | Recording URL in requested `wav` format. | [optional] |
diff --git a/docs/CallRecordingsApi.md b/docs/CallRecordingsApi.md
index 98ad6562..5c57ff35 100644
--- a/docs/CallRecordingsApi.md
+++ b/docs/CallRecordingsApi.md
@@ -40,7 +40,7 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
CallRecordingsApi apiInstance = new CallRecordingsApi(defaultClient);
- String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.
+ String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control).
GCSConfiguration gcSConfiguration = new GCSConfiguration(); // GCSConfiguration | Creates new credentials resource for given connection_id.
try {
CredentialsResponse result = apiInstance.createCustomStorageCredentials(connectionId, gcSConfiguration);
@@ -61,7 +61,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource. |
+ **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control). |
**gcSConfiguration** | [**GCSConfiguration**](GCSConfiguration.md)| Creates new credentials resource for given connection_id. |
### Return type
@@ -113,7 +113,7 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
CallRecordingsApi apiInstance = new CallRecordingsApi(defaultClient);
- String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.
+ String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control).
try {
apiInstance.deleteCustomStorageCredentials(connectionId);
} catch (ApiException e) {
@@ -132,7 +132,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource. |
+ **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control). |
### Return type
@@ -183,7 +183,7 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
CallRecordingsApi apiInstance = new CallRecordingsApi(defaultClient);
- String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.
+ String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control).
try {
CredentialsResponse result = apiInstance.getCustomStorageCredentials(connectionId);
System.out.println(result);
@@ -203,7 +203,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource. |
+ **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control). |
### Return type
@@ -254,7 +254,7 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
CallRecordingsApi apiInstance = new CallRecordingsApi(defaultClient);
- String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.
+ String connectionId = "connectionId_example"; // String | Uniquely identifies a Telnyx application (Call Control).
GCSConfiguration gcSConfiguration = new GCSConfiguration(); // GCSConfiguration | Creates new credentials resource for given connection_id.
try {
CredentialsResponse result = apiInstance.updateCustomStorageCredentials(connectionId, gcSConfiguration);
@@ -275,7 +275,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource. |
+ **connectionId** | **String**| Uniquely identifies a Telnyx application (Call Control). |
**gcSConfiguration** | [**GCSConfiguration**](GCSConfiguration.md)| Creates new credentials resource for given connection_id. |
### Return type
diff --git a/docs/CallReferCompleted.md b/docs/CallReferCompleted.md
index 4fc3b0c1..5eecc65e 100644
--- a/docs/CallReferCompleted.md
+++ b/docs/CallReferCompleted.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallReferCompletedPayload**](CallReferCompletedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallReferCompletedPayload**](CallReferCompletedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_REFER_COMPLETED | "call.refer.completed"
+| Name | Value |
+|---- | -----|
+| CALL_REFER_COMPLETED | "call.refer.completed" |
diff --git a/docs/CallReferCompletedEvent.md b/docs/CallReferCompletedEvent.md
index 616be663..41118b4f 100644
--- a/docs/CallReferCompletedEvent.md
+++ b/docs/CallReferCompletedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallReferCompleted**](CallReferCompleted.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallReferCompleted**](CallReferCompleted.md) | | [optional] |
diff --git a/docs/CallReferCompletedPayload.md b/docs/CallReferCompletedPayload.md
index cc70dd82..96cd78de 100644
--- a/docs/CallReferCompletedPayload.md
+++ b/docs/CallReferCompletedPayload.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique ID for controlling the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**sipNotifyResponse** | **Integer** | SIP NOTIFY event status for tracking the REFER attempt. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique ID for controlling the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**sipNotifyResponse** | **Integer** | SIP NOTIFY event status for tracking the REFER attempt. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
diff --git a/docs/CallReferFailed.md b/docs/CallReferFailed.md
index 832d9064..925b5b4d 100644
--- a/docs/CallReferFailed.md
+++ b/docs/CallReferFailed.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallReferFailedPayload**](CallReferFailedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallReferFailedPayload**](CallReferFailedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_REFER_FAILED | "call.refer.failed"
+| Name | Value |
+|---- | -----|
+| CALL_REFER_FAILED | "call.refer.failed" |
diff --git a/docs/CallReferFailedEvent.md b/docs/CallReferFailedEvent.md
index 61925662..c63fbcba 100644
--- a/docs/CallReferFailedEvent.md
+++ b/docs/CallReferFailedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallReferFailed**](CallReferFailed.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallReferFailed**](CallReferFailed.md) | | [optional] |
diff --git a/docs/CallReferFailedPayload.md b/docs/CallReferFailedPayload.md
index a07d4c92..8677fa9c 100644
--- a/docs/CallReferFailedPayload.md
+++ b/docs/CallReferFailedPayload.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique ID for controlling the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**sipNotifyResponse** | **Integer** | SIP NOTIFY event status for tracking the REFER attempt. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique ID for controlling the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**sipNotifyResponse** | **Integer** | SIP NOTIFY event status for tracking the REFER attempt. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
diff --git a/docs/CallReferStarted.md b/docs/CallReferStarted.md
index c06e9f65..4b7cb2df 100644
--- a/docs/CallReferStarted.md
+++ b/docs/CallReferStarted.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**CallReferStartedPayload**](CallReferStartedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**CallReferStartedPayload**](CallReferStartedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_REFER_STARTED | "call.refer.started"
+| Name | Value |
+|---- | -----|
+| CALL_REFER_STARTED | "call.refer.started" |
diff --git a/docs/CallReferStartedEvent.md b/docs/CallReferStartedEvent.md
index 51f1ff81..278ade7d 100644
--- a/docs/CallReferStartedEvent.md
+++ b/docs/CallReferStartedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CallReferStarted**](CallReferStarted.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CallReferStarted**](CallReferStarted.md) | | [optional] |
diff --git a/docs/CallReferStartedPayload.md b/docs/CallReferStartedPayload.md
index 4aaa7579..dc9efea4 100644
--- a/docs/CallReferStartedPayload.md
+++ b/docs/CallReferStartedPayload.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique ID for controlling the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional]
-**clientState** | **String** | State received from a command. | [optional]
-**from** | **String** | Number or SIP URI placing the call. | [optional]
-**sipNotifyResponse** | **Integer** | SIP NOTIFY event status for tracking the REFER attempt. | [optional]
-**to** | **String** | Destination number or SIP URI of the call. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique ID for controlling the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**connectionId** | **String** | Call Control App ID (formerly Telnyx connection ID) used in the call. | [optional] |
+|**clientState** | **String** | State received from a command. | [optional] |
+|**from** | **String** | Number or SIP URI placing the call. | [optional] |
+|**sipNotifyResponse** | **Integer** | SIP NOTIFY event status for tracking the REFER attempt. | [optional] |
+|**to** | **String** | Destination number or SIP URI of the call. | [optional] |
diff --git a/docs/CallRequest.md b/docs/CallRequest.md
index 25e845b3..44136c02 100644
--- a/docs/CallRequest.md
+++ b/docs/CallRequest.md
@@ -5,62 +5,95 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**to** | [**OneOfstringarray**](OneOfstringarray.md) | The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided using an array of strings |
-**from** | **String** | The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `from` number of the original call if omitted. |
-**fromDisplayName** | **String** | The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field. | [optional]
-**connectionId** | **String** | The ID of the Call Control App (formerly ID of the connection) to be used when dialing the destination. |
-**audioUrl** | **String** | The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional]
-**mediaName** | **String** | The media_name of a file to be played back to the callee when the call is answered. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional]
-**preferredCodecs** | **String** | The list of comma-separated codecs in a preferred order for the forked media to be received. | [optional]
-**timeoutSecs** | **Integer** | The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being called. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds. | [optional]
-**timeLimitSecs** | **Integer** | Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length. | [optional]
-**answeringMachineDetection** | [**AnsweringMachineDetectionEnum**](#AnsweringMachineDetectionEnum) | Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected. | [optional]
-**answeringMachineDetectionConfig** | [**CallRequestAnsweringMachineDetectionConfig**](CallRequestAnsweringMachineDetectionConfig.md) | | [optional]
-**customHeaders** | [**List<CustomSipHeader>**](CustomSipHeader.md) | Custom headers to be added to the SIP INVITE. | [optional]
-**billingGroupId** | **UUID** | Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore others Dial commands with the same `command_id`. | [optional]
-**linkTo** | **String** | Use another call's control id for sharing the same call session id | [optional]
-**sipAuthUsername** | **String** | SIP Authentication username used for SIP challenges. | [optional]
-**sipAuthPassword** | **String** | SIP Authentication password used for SIP challenges. | [optional]
-**soundModifications** | [**SoundModifications**](SoundModifications.md) | | [optional]
-**streamUrl** | **String** | The destination WebSocket address where the stream is going to be delivered. | [optional]
-**streamTrack** | [**StreamTrackEnum**](#StreamTrackEnum) | Specifies which track should be streamed. | [optional]
-**webhookUrl** | **String** | Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call. | [optional]
-**webhookUrlMethod** | [**WebhookUrlMethodEnum**](#WebhookUrlMethodEnum) | HTTP request type used for `webhook_url`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**to** | [**CallRequestTo**](CallRequestTo.md) | | |
+|**from** | **String** | The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `from` number of the original call if omitted. | |
+|**fromDisplayName** | **String** | The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field. | [optional] |
+|**connectionId** | **String** | The ID of the Call Control App (formerly ID of the connection) to be used when dialing the destination. | |
+|**audioUrl** | **String** | The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional] |
+|**mediaName** | **String** | The media_name of a file to be played back to the callee when the call is answered. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional] |
+|**preferredCodecs** | **String** | The list of comma-separated codecs in a preferred order for the forked media to be received. | [optional] |
+|**timeoutSecs** | **Integer** | The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being called. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds. | [optional] |
+|**timeLimitSecs** | **Integer** | Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length. | [optional] |
+|**answeringMachineDetection** | [**AnsweringMachineDetectionEnum**](#AnsweringMachineDetectionEnum) | Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected. | [optional] |
+|**answeringMachineDetectionConfig** | [**CallRequestAnsweringMachineDetectionConfig**](CallRequestAnsweringMachineDetectionConfig.md) | | [optional] |
+|**customHeaders** | [**List<CustomSipHeader>**](CustomSipHeader.md) | Custom headers to be added to the SIP INVITE. | [optional] |
+|**billingGroupId** | **UUID** | Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore others Dial commands with the same `command_id`. | [optional] |
+|**linkTo** | **String** | Use another call's control id for sharing the same call session id | [optional] |
+|**sipAuthUsername** | **String** | SIP Authentication username used for SIP challenges. | [optional] |
+|**sipAuthPassword** | **String** | SIP Authentication password used for SIP challenges. | [optional] |
+|**soundModifications** | [**SoundModifications**](SoundModifications.md) | | [optional] |
+|**streamUrl** | **String** | The destination WebSocket address where the stream is going to be delivered. | [optional] |
+|**streamTrack** | [**StreamTrackEnum**](#StreamTrackEnum) | Specifies which track should be streamed. | [optional] |
+|**webhookUrl** | **String** | Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call. | [optional] |
+|**webhookUrlMethod** | [**WebhookUrlMethodEnum**](#WebhookUrlMethodEnum) | HTTP request type used for `webhook_url`. | [optional] |
+|**record** | [**RecordEnum**](#RecordEnum) | Start recording automatically after an event. Disabled by default. | [optional] |
+|**recordChannels** | [**RecordChannelsEnum**](#RecordChannelsEnum) | Defines which channel should be recorded ('single' or 'dual') when `record` is specified. | [optional] |
+|**recordFormat** | [**RecordFormatEnum**](#RecordFormatEnum) | Defines the format of the recording ('wav' or 'mp3') when `record` is specified. | [optional] |
+|**recordMaxLength** | **Integer** | Defines the maximum length for the recording in seconds when `record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite). | [optional] |
+|**recordTimeoutSecs** | **Integer** | The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when `record` is specified. The timer only starts when the speech is detected. The minimum value is 0. The default value is 0 (infinite). | [optional] |
+|**enableDialogflow** | **Boolean** | Enables Dialogflow for the current call. The default value is false. | [optional] |
+|**dialogflowConfig** | [**DialogflowConfig**](DialogflowConfig.md) | | [optional] |
## Enum: AnsweringMachineDetectionEnum
-Name | Value
----- | -----
-DETECT | "detect"
-DETECT_BEEP | "detect_beep"
-DETECT_WORDS | "detect_words"
-GREETING_END | "greeting_end"
-DISABLED | "disabled"
+| Name | Value |
+|---- | -----|
+| DETECT | "detect" |
+| DETECT_BEEP | "detect_beep" |
+| DETECT_WORDS | "detect_words" |
+| GREETING_END | "greeting_end" |
+| DISABLED | "disabled" |
## Enum: StreamTrackEnum
-Name | Value
----- | -----
-INBOUND_TRACK | "inbound_track"
-OUTBOUND_TRACK | "outbound_track"
-BOTH_TRACKS | "both_tracks"
+| Name | Value |
+|---- | -----|
+| INBOUND_TRACK | "inbound_track" |
+| OUTBOUND_TRACK | "outbound_track" |
+| BOTH_TRACKS | "both_tracks" |
## Enum: WebhookUrlMethodEnum
-Name | Value
----- | -----
-POST | "POST"
-GET | "GET"
+| Name | Value |
+|---- | -----|
+| POST | "POST" |
+| GET | "GET" |
+
+
+
+## Enum: RecordEnum
+
+| Name | Value |
+|---- | -----|
+| RECORD_FROM_ANSWER | "record-from-answer" |
+
+
+
+## Enum: RecordChannelsEnum
+
+| Name | Value |
+|---- | -----|
+| SINGLE | "single" |
+| DUAL | "dual" |
+
+
+
+## Enum: RecordFormatEnum
+
+| Name | Value |
+|---- | -----|
+| WAV | "wav" |
+| MP3 | "mp3" |
diff --git a/docs/CallRequestAnsweringMachineDetectionConfig.md b/docs/CallRequestAnsweringMachineDetectionConfig.md
index 933f9fea..7c6c973a 100644
--- a/docs/CallRequestAnsweringMachineDetectionConfig.md
+++ b/docs/CallRequestAnsweringMachineDetectionConfig.md
@@ -6,18 +6,18 @@ Optional configuration parameters to modify 'answering_machine_detection' perfor
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalAnalysisTimeMillis** | **Integer** | Maximum timeout threshold for overall detection. | [optional]
-**afterGreetingSilenceMillis** | **Integer** | Silence duration threshold after a greeting message or voice for it be considered human. | [optional]
-**betweenWordsSilenceMillis** | **Integer** | Maximum threshold for silence between words. | [optional]
-**greetingDurationMillis** | **Integer** | Maximum threshold of a human greeting. If greeting longer than this value, considered machine. | [optional]
-**initialSilenceMillis** | **Integer** | If initial silence duration is greater than this value, consider it a machine. | [optional]
-**maximumNumberOfWords** | **Integer** | If number of detected words is greater than this value, consder it a machine. | [optional]
-**maximumWordLengthMillis** | **Integer** | If a single word lasts longer than this threshold, consider it a machine. | [optional]
-**silenceThreshold** | **Integer** | Minimum noise threshold for any analysis. | [optional]
-**greetingTotalAnalysisTimeMillis** | **Integer** | If machine already detected, maximum timeout threshold to determine the end of the machine greeting. | [optional]
-**greetingSilenceDurationMillis** | **Integer** | If machine already detected, maximum threshold for silence between words. If exceeded, the greeting is considered ended. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalAnalysisTimeMillis** | **Integer** | Maximum timeout threshold for overall detection. | [optional] |
+|**afterGreetingSilenceMillis** | **Integer** | Silence duration threshold after a greeting message or voice for it be considered human. | [optional] |
+|**betweenWordsSilenceMillis** | **Integer** | Maximum threshold for silence between words. | [optional] |
+|**greetingDurationMillis** | **Integer** | Maximum threshold of a human greeting. If greeting longer than this value, considered machine. | [optional] |
+|**initialSilenceMillis** | **Integer** | If initial silence duration is greater than this value, consider it a machine. | [optional] |
+|**maximumNumberOfWords** | **Integer** | If number of detected words is greater than this value, consder it a machine. | [optional] |
+|**maximumWordLengthMillis** | **Integer** | If a single word lasts longer than this threshold, consider it a machine. | [optional] |
+|**silenceThreshold** | **Integer** | Minimum noise threshold for any analysis. | [optional] |
+|**greetingTotalAnalysisTimeMillis** | **Integer** | If machine already detected, maximum timeout threshold to determine the end of the machine greeting. | [optional] |
+|**greetingSilenceDurationMillis** | **Integer** | If machine already detected, maximum threshold for silence between words. If exceeded, the greeting is considered ended. | [optional] |
diff --git a/docs/CallRequestTo.md b/docs/CallRequestTo.md
new file mode 100644
index 00000000..d61f18c9
--- /dev/null
+++ b/docs/CallRequestTo.md
@@ -0,0 +1,40 @@
+
+
+# CallRequestTo
+
+The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided using an array of strings
+
+## oneOf schemas
+* [Listconnection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
- String filterOutboundOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
+ String filterConnectionNameContains = "filterConnectionNameContains_example"; // String | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
+ String filterOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
ListConnectionsResponse result = api.listConnections()
.pageNumber(pageNumber)
.pageSize(pageSize)
.filterConnectionNameContains(filterConnectionNameContains)
- .filterOutboundOutboundVoiceProfileId(filterOutboundOutboundVoiceProfileId)
+ .filterOutboundVoiceProfileId(filterOutboundVoiceProfileId)
.sort(sort)
.execute();
System.out.println(result);
@@ -70,8 +70,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
- **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
- **filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
+ **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional]
+ **filterOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
### Return type
diff --git a/docs/ConsumedData.md b/docs/ConsumedData.md
index 0a4bdaad..ce673ec9 100644
--- a/docs/ConsumedData.md
+++ b/docs/ConsumedData.md
@@ -6,10 +6,10 @@ Represents the amount of data consumed.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**unit** | **String** | | [optional]
-**amount** | **BigDecimal** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**unit** | **String** | | [optional] |
+|**amount** | **BigDecimal** | | [optional] |
diff --git a/docs/Contact.md b/docs/Contact.md
index 9be754ee..345acec5 100644
--- a/docs/Contact.md
+++ b/docs/Contact.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**addresses** | [**List<WhatsAppContactAddress>**](WhatsAppContactAddress.md) | Full contact address(es) | [optional]
-**birthday** | **String** | YYYY-MM-DD formatted string | [optional]
-**emails** | [**List<Email>**](Email.md) | Contact email address(es) | [optional]
-**ims** | **List<String>** | | [optional]
-**name** | [**Name**](Name.md) | | [optional]
-**org** | [**Organization**](Organization.md) | | [optional]
-**phones** | [**List<Phone>**](Phone.md) | Contact phone number(s) | [optional]
-**urls** | [**List<Url>**](Url.md) | Contact URL(s) | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**addresses** | [**List<WhatsAppContactAddress>**](WhatsAppContactAddress.md) | Full contact address(es) | [optional] |
+|**birthday** | **String** | YYYY-MM-DD formatted string | [optional] |
+|**emails** | [**List<Email>**](Email.md) | Contact email address(es) | [optional] |
+|**ims** | **List<String>** | | [optional] |
+|**name** | [**Name**](Name.md) | | [optional] |
+|**org** | [**Organization**](Organization.md) | | [optional] |
+|**phones** | [**List<Phone>**](Phone.md) | Contact phone number(s) | [optional] |
+|**urls** | [**List<Url>**](Url.md) | Contact URL(s) | [optional] |
diff --git a/docs/CostInformation.md b/docs/CostInformation.md
index d1d6c11d..e3e4270d 100644
--- a/docs/CostInformation.md
+++ b/docs/CostInformation.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**upfrontCost** | **String** | | [optional]
-**monthlyCost** | **String** | | [optional]
-**currency** | **String** | The ISO 4217 code for the currency. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**upfrontCost** | **String** | | [optional] |
+|**monthlyCost** | **String** | | [optional] |
+|**currency** | **String** | The ISO 4217 code for the currency. | [optional] |
diff --git a/docs/CreateAndroidPushCredentialRequest.md b/docs/CreateAndroidPushCredentialRequest.md
index 8c1de469..0aa51bc3 100644
--- a/docs/CreateAndroidPushCredentialRequest.md
+++ b/docs/CreateAndroidPushCredentialRequest.md
@@ -5,10 +5,19 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**serverKey** | **String** | Server key as received from Google firebase |
-**alias** | **String** | Alias to uniquely identify the credential |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | Type of mobile push credential. Should be <code>android</code> here | |
+|**serverKey** | **String** | Server key as received from Google firebase | |
+|**alias** | **String** | Alias to uniquely identify the credential | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ANDROID | "android" |
diff --git a/docs/CreateAuthenticationProvider200Response.md b/docs/CreateAuthenticationProvider200Response.md
new file mode 100644
index 00000000..c9436839
--- /dev/null
+++ b/docs/CreateAuthenticationProvider200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateAuthenticationProvider200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**AuthenticationProvider**](AuthenticationProvider.md) | | [optional] |
+
+
+
diff --git a/docs/CreateBillingGroup200Response.md b/docs/CreateBillingGroup200Response.md
new file mode 100644
index 00000000..dcbac174
--- /dev/null
+++ b/docs/CreateBillingGroup200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateBillingGroup200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**BillingGroup**](BillingGroup.md) | | [optional] |
+
+
+
diff --git a/docs/CreateCallControlApplicationRequest.md b/docs/CreateCallControlApplicationRequest.md
index 49640f21..703da758 100644
--- a/docs/CreateCallControlApplicationRequest.md
+++ b/docs/CreateCallControlApplicationRequest.md
@@ -5,50 +5,50 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**applicationName** | **String** | A user-assigned name to help manage the application. |
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. |
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | [**AnchorsiteOverrideEnum**](#AnchorsiteOverrideEnum) | <code>Latency</code> directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media. | [optional]
-**dtmfType** | [**DtmfTypeEnum**](#DtmfTypeEnum) | Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats. | [optional]
-**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional]
-**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional]
-**inbound** | [**CallControlApplicationInbound**](CallControlApplicationInbound.md) | | [optional]
-**outbound** | [**CallControlApplicationOutbound**](CallControlApplicationOutbound.md) | | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**applicationName** | **String** | A user-assigned name to help manage the application. | |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | [**AnchorsiteOverrideEnum**](#AnchorsiteOverrideEnum) | <code>Latency</code> directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media. | [optional] |
+|**dtmfType** | [**DtmfTypeEnum**](#DtmfTypeEnum) | Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats. | [optional] |
+|**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional] |
+|**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional] |
+|**inbound** | [**CallControlApplicationInbound**](CallControlApplicationInbound.md) | | [optional] |
+|**outbound** | [**CallControlApplicationOutbound**](CallControlApplicationOutbound.md) | | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
## Enum: AnchorsiteOverrideEnum
-Name | Value
----- | -----
-LATENCY_ | "\"Latency\""
-CHICAGO_IL_ | "\"Chicago, IL\""
-ASHBURN_VA_ | "\"Ashburn, VA\""
-SAN_JOSE_CA_ | "\"San Jose, CA\""
+| Name | Value |
+|---- | -----|
+| LATENCY_ | "\"Latency\"" |
+| CHICAGO_IL_ | "\"Chicago, IL\"" |
+| ASHBURN_VA_ | "\"Ashburn, VA\"" |
+| SAN_JOSE_CA_ | "\"San Jose, CA\"" |
## Enum: DtmfTypeEnum
-Name | Value
----- | -----
-RFC_2833 | "RFC 2833"
-INBAND | "Inband"
-SIP_INFO | "SIP INFO"
+| Name | Value |
+|---- | -----|
+| RFC_2833 | "RFC 2833" |
+| INBAND | "Inband" |
+| SIP_INFO | "SIP INFO" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/CreateComment200Response.md b/docs/CreateComment200Response.md
new file mode 100644
index 00000000..2bffc16f
--- /dev/null
+++ b/docs/CreateComment200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateComment200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CreateComment200ResponseData**](CreateComment200ResponseData.md) | | [optional] |
+
+
+
diff --git a/docs/CreateComment200ResponseData.md b/docs/CreateComment200ResponseData.md
new file mode 100644
index 00000000..89ebc43d
--- /dev/null
+++ b/docs/CreateComment200ResponseData.md
@@ -0,0 +1,40 @@
+
+
+# CreateComment200ResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**body** | **String** | | [optional] |
+|**commenter** | **String** | | [optional] [readonly] |
+|**commenterType** | [**CommenterTypeEnum**](#CommenterTypeEnum) | | [optional] [readonly] |
+|**commentRecordType** | [**CommentRecordTypeEnum**](#CommentRecordTypeEnum) | | [optional] |
+|**commentRecordId** | **UUID** | | [optional] |
+|**readAt** | **String** | An ISO 8901 datetime string for when the comment was read. | [optional] [readonly] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the comment was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the comment was updated. | [optional] [readonly] |
+
+
+
+## Enum: CommenterTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ADMIN | "admin" |
+| USER | "user" |
+
+
+
+## Enum: CommentRecordTypeEnum
+
+| Name | Value |
+|---- | -----|
+| NUMBER_ORDER | "number_order" |
+| SUB_NUMBER_ORDER | "sub_number_order" |
+| NUMBER_ORDER_PHONE_NUMBER | "number_order_phone_number" |
+
+
+
diff --git a/docs/CreateConferenceRequest.md b/docs/CreateConferenceRequest.md
index 5bd38239..432c55ce 100644
--- a/docs/CreateConferenceRequest.md
+++ b/docs/CreateConferenceRequest.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique identifier and token for controlling the call |
-**name** | **String** | Name of the conference |
-**beepEnabled** | [**BeepEnabledEnum**](#BeepEnabledEnum) | Whether a beep sound should be played when participants join and/or leave the conference. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. The client_state will be updated for the creator call leg and will be used for all webhooks related to the created conference. | [optional]
-**comfortNoise** | **Boolean** | Toggle background comfort noise. | [optional]
-**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional]
-**durationMinutes** | **Integer** | Time length (minutes) after which the conference will end. | [optional]
-**holdAudioUrl** | **String** | The URL of a file to be played to participants joining the conference. The URL can point to either a WAV or MP3 file. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\". | [optional]
-**holdMediaName** | **String** | The media_name of a file to be played to participants joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\". | [optional]
-**maxParticipants** | **Integer** | The maximum number of active conference participants to allow. Must be between 2 and 800. Defaults to 250 | [optional]
-**startConferenceOnCreate** | **Boolean** | Whether the conference should be started on creation. If the conference isn't started all participants that join are automatically put on hold. Defaults to \"true\". | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique identifier and token for controlling the call | |
+|**name** | **String** | Name of the conference | |
+|**beepEnabled** | [**BeepEnabledEnum**](#BeepEnabledEnum) | Whether a beep sound should be played when participants join and/or leave the conference. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. The client_state will be updated for the creator call leg and will be used for all webhooks related to the created conference. | [optional] |
+|**comfortNoise** | **Boolean** | Toggle background comfort noise. | [optional] |
+|**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional] |
+|**durationMinutes** | **Integer** | Time length (minutes) after which the conference will end. | [optional] |
+|**holdAudioUrl** | **String** | The URL of a file to be played to participants joining the conference. The URL can point to either a WAV or MP3 file. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\". | [optional] |
+|**holdMediaName** | **String** | The media_name of a file to be played to participants joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\". | [optional] |
+|**maxParticipants** | **Integer** | The maximum number of active conference participants to allow. Must be between 2 and 800. Defaults to 250 | [optional] |
+|**startConferenceOnCreate** | **Boolean** | Whether the conference should be started on creation. If the conference isn't started all participants that join are automatically put on hold. Defaults to \"true\". | [optional] |
## Enum: BeepEnabledEnum
-Name | Value
----- | -----
-ALWAYS | "always"
-NEVER | "never"
-ON_ENTER | "on_enter"
-ON_EXIT | "on_exit"
+| Name | Value |
+|---- | -----|
+| ALWAYS | "always" |
+| NEVER | "never" |
+| ON_ENTER | "on_enter" |
+| ON_EXIT | "on_exit" |
diff --git a/docs/CreateCredentialConnectionRequest.md b/docs/CreateCredentialConnectionRequest.md
index 4afdcff6..1aece860 100644
--- a/docs/CreateCredentialConnectionRequest.md
+++ b/docs/CreateCredentialConnectionRequest.md
@@ -5,45 +5,45 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Defaults to true | [optional]
-**userName** | **String** | The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). |
-**password** | **String** | The password to be used as part of the credentials. Must be 8 to 128 characters long. |
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | |
-**sipUriCallingPreference** | [**SipUriCallingPreferenceEnum**](#SipUriCallingPreferenceEnum) | This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**CredentialInbound**](CredentialInbound.md) | | [optional]
-**outbound** | [**CredentialOutbound**](CredentialOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**userName** | **String** | The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). | |
+|**password** | **String** | The password to be used as part of the credentials. Must be 8 to 128 characters long. | |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | |
+|**sipUriCallingPreference** | [**SipUriCallingPreferenceEnum**](#SipUriCallingPreferenceEnum) | This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**CredentialInbound**](CredentialInbound.md) | | [optional] |
+|**outbound** | [**CredentialOutbound**](CredentialOutbound.md) | | [optional] |
## Enum: SipUriCallingPreferenceEnum
-Name | Value
----- | -----
-DISABLED | "disabled"
-UNRESTRICTED | "unrestricted"
-INTERNAL | "internal"
+| Name | Value |
+|---- | -----|
+| DISABLED | "disabled" |
+| UNRESTRICTED | "unrestricted" |
+| INTERNAL | "internal" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/CreateCustomerServiceRequest201Response.md b/docs/CreateCustomerServiceRequest201Response.md
new file mode 100644
index 00000000..fbf3fcf6
--- /dev/null
+++ b/docs/CreateCustomerServiceRequest201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateCustomerServiceRequest201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CustomerServiceRequest**](CustomerServiceRequest.md) | | [optional] |
+
+
+
diff --git a/docs/CreateCustomerServiceRequestRequest.md b/docs/CreateCustomerServiceRequestRequest.md
new file mode 100644
index 00000000..c0a8d7b2
--- /dev/null
+++ b/docs/CreateCustomerServiceRequestRequest.md
@@ -0,0 +1,14 @@
+
+
+# CreateCustomerServiceRequestRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | A valid US phone number in E164 format. | |
+|**webhookUrl** | **String** | Callback URL to receive webhook notifications. | [optional] |
+
+
+
diff --git a/docs/CreateDocument200Response.md b/docs/CreateDocument200Response.md
new file mode 100644
index 00000000..34bef81a
--- /dev/null
+++ b/docs/CreateDocument200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateDocument200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**DocServiceDocument**](DocServiceDocument.md) | | [optional] |
+
+
+
diff --git a/docs/CreateDyanmicEmergencyAddress201Response.md b/docs/CreateDyanmicEmergencyAddress201Response.md
new file mode 100644
index 00000000..640fed57
--- /dev/null
+++ b/docs/CreateDyanmicEmergencyAddress201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateDyanmicEmergencyAddress201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**DynamicEmergencyAddress**](DynamicEmergencyAddress.md) | | [optional] |
+
+
+
diff --git a/docs/CreateDyanmicEmergencyEndpoint201Response.md b/docs/CreateDyanmicEmergencyEndpoint201Response.md
new file mode 100644
index 00000000..7982f6c3
--- /dev/null
+++ b/docs/CreateDyanmicEmergencyEndpoint201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateDyanmicEmergencyEndpoint201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**DynamicEmergencyEndpoint**](DynamicEmergencyEndpoint.md) | | [optional] |
+
+
+
diff --git a/docs/CreateFaxApplicationRequest.md b/docs/CreateFaxApplicationRequest.md
index d4ef4e8f..c0a91f97 100644
--- a/docs/CreateFaxApplicationRequest.md
+++ b/docs/CreateFaxApplicationRequest.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**applicationName** | **String** | A user-assigned name to help manage the application. |
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. |
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**inbound** | [**CreateFaxApplicationRequestInbound**](CreateFaxApplicationRequestInbound.md) | | [optional]
-**outbound** | [**CreateFaxApplicationRequestOutbound**](CreateFaxApplicationRequestOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**applicationName** | **String** | A user-assigned name to help manage the application. | |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**inbound** | [**CreateFaxApplicationRequestInbound**](CreateFaxApplicationRequestInbound.md) | | [optional] |
+|**outbound** | [**CreateFaxApplicationRequestOutbound**](CreateFaxApplicationRequestOutbound.md) | | [optional] |
diff --git a/docs/CreateFaxApplicationRequestInbound.md b/docs/CreateFaxApplicationRequestInbound.md
index efcd11a8..0b98e000 100644
--- a/docs/CreateFaxApplicationRequestInbound.md
+++ b/docs/CreateFaxApplicationRequestInbound.md
@@ -5,20 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**channelLimit** | **Integer** | When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection. | [optional]
-**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional]
-**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channelLimit** | **Integer** | When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection. | [optional] |
+|**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional] |
+|**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional] |
## Enum: SipSubdomainReceiveSettingsEnum
-Name | Value
----- | -----
-ONLY_MY_CONNECTIONS | "only_my_connections"
-FROM_ANYONE | "from_anyone"
+| Name | Value |
+|---- | -----|
+| ONLY_MY_CONNECTIONS | "only_my_connections" |
+| FROM_ANYONE | "from_anyone" |
diff --git a/docs/CreateFaxApplicationRequestOutbound.md b/docs/CreateFaxApplicationRequestOutbound.md
index 3f320f18..e7fb8d07 100644
--- a/docs/CreateFaxApplicationRequestOutbound.md
+++ b/docs/CreateFaxApplicationRequestOutbound.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**channelLimit** | **Integer** | When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection. | [optional]
-**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channelLimit** | **Integer** | When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection. | [optional] |
+|**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional] |
diff --git a/docs/CreateFqdnConnectionRequest.md b/docs/CreateFqdnConnectionRequest.md
index 026b1da4..85dc950c 100644
--- a/docs/CreateFqdnConnectionRequest.md
+++ b/docs/CreateFqdnConnectionRequest.md
@@ -5,32 +5,32 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Defaults to true | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | |
-**transportProtocol** | **FqdnConnectionTransportProtocol** | | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**InboundFqdn**](InboundFqdn.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | |
+|**transportProtocol** | **FqdnConnectionTransportProtocol** | | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**InboundFqdn**](InboundFqdn.md) | | [optional] |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/CreateFqdnRequest.md b/docs/CreateFqdnRequest.md
index 06f1fd72..4dd5721b 100644
--- a/docs/CreateFqdnRequest.md
+++ b/docs/CreateFqdnRequest.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connectionId** | **String** | ID of the FQDN connection to which this IP should be attached. |
-**fqdn** | **String** | FQDN represented by this resource. |
-**port** | **Integer** | Port to use when connecting to this FQDN. | [optional]
-**dnsRecordType** | **String** | The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**connectionId** | **String** | ID of the FQDN connection to which this IP should be attached. | |
+|**fqdn** | **String** | FQDN represented by this resource. | |
+|**port** | **Integer** | Port to use when connecting to this FQDN. | [optional] |
+|**dnsRecordType** | **String** | The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used. | |
diff --git a/docs/CreateInboundIpRequest.md b/docs/CreateInboundIpRequest.md
index af1ce371..82317c5e 100644
--- a/docs/CreateInboundIpRequest.md
+++ b/docs/CreateInboundIpRequest.md
@@ -5,73 +5,73 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional]
-**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional]
-**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional]
-**defaultRoutingMethod** | [**DefaultRoutingMethodEnum**](#DefaultRoutingMethodEnum) | Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed. | [optional]
-**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional]
-**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional]
-**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional]
-**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional]
-**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional]
-**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional]
-**sipRegion** | [**SipRegionEnum**](#SipRegionEnum) | Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. | [optional]
-**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional]
-**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional]
-**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional]
-**timeout2xxSecs** | **Integer** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional] |
+|**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional] |
+|**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional] |
+|**defaultRoutingMethod** | [**DefaultRoutingMethodEnum**](#DefaultRoutingMethodEnum) | Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed. | [optional] |
+|**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional] |
+|**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional] |
+|**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional] |
+|**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional] |
+|**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional] |
+|**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional] |
+|**sipRegion** | [**SipRegionEnum**](#SipRegionEnum) | Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. | [optional] |
+|**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional] |
+|**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional] |
+|**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional] |
+|**timeout2xxSecs** | **Integer** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional] |
## Enum: AniNumberFormatEnum
-Name | Value
----- | -----
-_E_164 | "+E.164"
-E_164 | "E.164"
-_E_164_NATIONAL | "+E.164-national"
-E_164_NATIONAL | "E.164-national"
+| Name | Value |
+|---- | -----|
+| _E_164 | "+E.164" |
+| E_164 | "E.164" |
+| _E_164_NATIONAL | "+E.164-national" |
+| E_164_NATIONAL | "E.164-national" |
## Enum: DnisNumberFormatEnum
-Name | Value
----- | -----
-_E164 | "+e164"
-E164 | "e164"
-NATIONAL | "national"
-SIP_USERNAME | "sip_username"
+| Name | Value |
+|---- | -----|
+| _E164 | "+e164" |
+| E164 | "e164" |
+| NATIONAL | "national" |
+| SIP_USERNAME | "sip_username" |
## Enum: DefaultRoutingMethodEnum
-Name | Value
----- | -----
-SEQUENTIAL | "sequential"
-ROUND_ROBIN | "round-robin"
+| Name | Value |
+|---- | -----|
+| SEQUENTIAL | "sequential" |
+| ROUND_ROBIN | "round-robin" |
## Enum: SipRegionEnum
-Name | Value
----- | -----
-US | "US"
-EUROPE | "Europe"
-AUSTRALIA | "Australia"
+| Name | Value |
+|---- | -----|
+| US | "US" |
+| EUROPE | "Europe" |
+| AUSTRALIA | "Australia" |
## Enum: SipSubdomainReceiveSettingsEnum
-Name | Value
----- | -----
-ONLY_MY_CONNECTIONS | "only_my_connections"
-FROM_ANYONE | "from_anyone"
+| Name | Value |
+|---- | -----|
+| ONLY_MY_CONNECTIONS | "only_my_connections" |
+| FROM_ANYONE | "from_anyone" |
diff --git a/docs/CreateInventoryCoverageRequest200Response.md b/docs/CreateInventoryCoverageRequest200Response.md
new file mode 100644
index 00000000..878f9933
--- /dev/null
+++ b/docs/CreateInventoryCoverageRequest200Response.md
@@ -0,0 +1,14 @@
+
+
+# CreateInventoryCoverageRequest200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<InventoryCoverage>**](InventoryCoverage.md) | | [optional] |
+|**meta** | [**InventoryCoverageMetadata**](InventoryCoverageMetadata.md) | | [optional] |
+
+
+
diff --git a/docs/CreateIosPushCredentialRequest.md b/docs/CreateIosPushCredentialRequest.md
index da6a5336..f0904f4a 100644
--- a/docs/CreateIosPushCredentialRequest.md
+++ b/docs/CreateIosPushCredentialRequest.md
@@ -5,11 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**certificate** | **String** | Certificate as received from APNs |
-**privateKey** | **String** | Corresponding private key to the certificate as received from APNs |
-**alias** | **String** | Alias to uniquely identify the credential |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | Type of mobile push credential. Should be <code>ios</code> here | |
+|**certificate** | **String** | Certificate as received from APNs | |
+|**privateKey** | **String** | Corresponding private key to the certificate as received from APNs | |
+|**alias** | **String** | Alias to uniquely identify the credential | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| IOS | "ios" |
diff --git a/docs/CreateIpConnectionRequest.md b/docs/CreateIpConnectionRequest.md
index c98ce54a..23c7263f 100644
--- a/docs/CreateIpConnectionRequest.md
+++ b/docs/CreateIpConnectionRequest.md
@@ -5,43 +5,43 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Defaults to true | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | | [optional]
-**transportProtocol** | [**TransportProtocolEnum**](#TransportProtocolEnum) | One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication. | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**CreateInboundIpRequest**](CreateInboundIpRequest.md) | | [optional]
-**outbound** | [**OutboundIp**](OutboundIp.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | [optional] |
+|**transportProtocol** | [**TransportProtocolEnum**](#TransportProtocolEnum) | One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication. | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**CreateInboundIpRequest**](CreateInboundIpRequest.md) | | [optional] |
+|**outbound** | [**OutboundIp**](OutboundIp.md) | | [optional] |
## Enum: TransportProtocolEnum
-Name | Value
----- | -----
-UDP | "UDP"
-TCP | "TCP"
-TLS | "TLS"
+| Name | Value |
+|---- | -----|
+| UDP | "UDP" |
+| TCP | "TCP" |
+| TLS | "TLS" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/CreateIpRequest.md b/docs/CreateIpRequest.md
index 5e1375e9..6b235f96 100644
--- a/docs/CreateIpRequest.md
+++ b/docs/CreateIpRequest.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connectionId** | **String** | ID of the IP Connection to which this IP should be attached. | [optional]
-**ipAddress** | **String** | IP adddress represented by this resource. |
-**port** | **Integer** | Port to use when connecting to this IP. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**connectionId** | **String** | ID of the IP Connection to which this IP should be attached. | [optional] |
+|**ipAddress** | **String** | IP adddress represented by this resource. | |
+|**port** | **Integer** | Port to use when connecting to this IP. | [optional] |
diff --git a/docs/CreateLedgerBillingGroupReport200Response.md b/docs/CreateLedgerBillingGroupReport200Response.md
new file mode 100644
index 00000000..b682893a
--- /dev/null
+++ b/docs/CreateLedgerBillingGroupReport200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateLedgerBillingGroupReport200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**LedgerBillingGroupReport**](LedgerBillingGroupReport.md) | | [optional] |
+
+
+
diff --git a/docs/CreateLongCodeMessageRequest.md b/docs/CreateLongCodeMessageRequest.md
index b9531c43..1433e8d3 100644
--- a/docs/CreateLongCodeMessageRequest.md
+++ b/docs/CreateLongCodeMessageRequest.md
@@ -5,27 +5,27 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**from** | **String** | Phone number, in +E.164 format, used to send the message. |
-**to** | **String** | Receiving address (+E.164 formatted phone number or short code). |
-**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional]
-**subject** | **String** | Subject of multimedia message | [optional]
-**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional]
-**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional]
-**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional]
-**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**from** | **String** | Phone number, in +E.164 format, used to send the message. | |
+|**to** | **String** | Receiving address (+E.164 formatted phone number or short code). | |
+|**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional] |
+|**subject** | **String** | Subject of multimedia message | [optional] |
+|**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional] |
+|**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional] |
+|**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional] |
## Enum: TypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/CreateManagedAccount200Response.md b/docs/CreateManagedAccount200Response.md
new file mode 100644
index 00000000..cfc31004
--- /dev/null
+++ b/docs/CreateManagedAccount200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateManagedAccount200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ManagedAccount**](ManagedAccount.md) | | [optional] |
+
+
+
diff --git a/docs/CreateManagedAccount422Response.md b/docs/CreateManagedAccount422Response.md
new file mode 100644
index 00000000..300d8ef0
--- /dev/null
+++ b/docs/CreateManagedAccount422Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateManagedAccount422Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<UnprocessableEntityError>**](UnprocessableEntityError.md) | | [optional] |
+
+
+
diff --git a/docs/CreateManagedAccountRequest.md b/docs/CreateManagedAccountRequest.md
index ae974d4f..5a275c43 100644
--- a/docs/CreateManagedAccountRequest.md
+++ b/docs/CreateManagedAccountRequest.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**email** | **String** | The email address for the managed account. If not provided, the email address will be generated based on the email address of the manager account. | [optional]
-**password** | **String** | Password for the managed account. If a password is not supplied, the account will not be able to be signed into directly. (A password reset may still be performed later to enable sign-in via password.) | [optional]
-**businessName** | **String** | The name of the business for which the new managed account is being created, that will be used as the managed accounts's organization's name. |
-**managedAccountAllowCustomPricing** | **Boolean** | Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed after creation, but there may be time lag between when the value is changed and pricing changes take effect. | [optional]
-**rollupBilling** | **Boolean** | Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**email** | **String** | The email address for the managed account. If not provided, the email address will be generated based on the email address of the manager account. | [optional] |
+|**password** | **String** | Password for the managed account. If a password is not supplied, the account will not be able to be signed into directly. (A password reset may still be performed later to enable sign-in via password.) | [optional] |
+|**businessName** | **String** | The name of the business for which the new managed account is being created, that will be used as the managed accounts's organization's name. | |
+|**managedAccountAllowCustomPricing** | **Boolean** | Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed after creation, but there may be time lag between when the value is changed and pricing changes take effect. | [optional] |
+|**rollupBilling** | **Boolean** | Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. | [optional] |
diff --git a/docs/CreateMessageRequest.md b/docs/CreateMessageRequest.md
index c3f85a5a..5c1deb5b 100644
--- a/docs/CreateMessageRequest.md
+++ b/docs/CreateMessageRequest.md
@@ -5,28 +5,28 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**from** | **String** | Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). **Required if sending with a phone number, short code, or alphanumeric sender ID.** | [optional]
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. **Required if sending via number pool or with an alphanumeric sender ID.** | [optional]
-**to** | **String** | Receiving address (+E.164 formatted phone number or short code). |
-**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional]
-**subject** | **String** | Subject of multimedia message | [optional]
-**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional]
-**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional]
-**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional]
-**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**from** | **String** | Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). **Required if sending with a phone number, short code, or alphanumeric sender ID.** | [optional] |
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. **Required if sending via number pool or with an alphanumeric sender ID.** | [optional] |
+|**to** | **String** | Receiving address (+E.164 formatted phone number or short code). | |
+|**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional] |
+|**subject** | **String** | Subject of multimedia message | [optional] |
+|**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional] |
+|**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional] |
+|**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional] |
## Enum: TypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/CreateMessagingHostedNumberOrderRequest.md b/docs/CreateMessagingHostedNumberOrderRequest.md
index 7067546b..d7a630d4 100644
--- a/docs/CreateMessagingHostedNumberOrderRequest.md
+++ b/docs/CreateMessagingHostedNumberOrderRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumbers** | **List<String>** | Phone numbers to be used for hosted messaging. | [optional]
-**messagingProfileId** | **String** | Automatically associate the number with this messaging profile ID when the order is complete. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | Phone numbers to be used for hosted messaging. | [optional] |
+|**messagingProfileId** | **String** | Automatically associate the number with this messaging profile ID when the order is complete. | [optional] |
diff --git a/docs/CreateMessagingProfileRequest.md b/docs/CreateMessagingProfileRequest.md
index 6c004333..59675dfc 100644
--- a/docs/CreateMessagingProfileRequest.md
+++ b/docs/CreateMessagingProfileRequest.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A user friendly name for the messaging profile. |
-**enabled** | **Boolean** | Specifies whether the messaging profile is enabled or not. | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this messaging profile will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. | [optional]
-**numberPoolSettings** | [**NumberPoolSettings**](NumberPoolSettings.md) | | [optional]
-**urlShortenerSettings** | [**UrlShortenerSettings**](UrlShortenerSettings.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | A user friendly name for the messaging profile. | |
+|**enabled** | **Boolean** | Specifies whether the messaging profile is enabled or not. | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this messaging profile will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. | [optional] |
+|**numberPoolSettings** | [**NumberPoolSettings**](NumberPoolSettings.md) | | [optional] |
+|**urlShortenerSettings** | [**UrlShortenerSettings**](UrlShortenerSettings.md) | | [optional] |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
-_2010_04_01 | "2010-04-01"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
+| _2010_04_01 | "2010-04-01" |
diff --git a/docs/CreateNotificationChannels200Response.md b/docs/CreateNotificationChannels200Response.md
new file mode 100644
index 00000000..3ab4cf89
--- /dev/null
+++ b/docs/CreateNotificationChannels200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateNotificationChannels200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NotificationChannel**](NotificationChannel.md) | | [optional] |
+
+
+
diff --git a/docs/CreateNotificationProfile200Response.md b/docs/CreateNotificationProfile200Response.md
new file mode 100644
index 00000000..5814d9a9
--- /dev/null
+++ b/docs/CreateNotificationProfile200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateNotificationProfile200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NotificationProfile**](NotificationProfile.md) | | [optional] |
+
+
+
diff --git a/docs/CreateNotificationSetting200Response.md b/docs/CreateNotificationSetting200Response.md
new file mode 100644
index 00000000..a81d16ec
--- /dev/null
+++ b/docs/CreateNotificationSetting200Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateNotificationSetting200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NotificationSetting**](NotificationSetting.md) | | [optional] |
+
+
+
diff --git a/docs/CreateNumberBlockOrderRequest.md b/docs/CreateNumberBlockOrderRequest.md
index 3abf7f04..aa1f7951 100644
--- a/docs/CreateNumberBlockOrderRequest.md
+++ b/docs/CreateNumberBlockOrderRequest.md
@@ -5,31 +5,31 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**startingNumber** | **String** | Starting phone number block |
-**range** | **Integer** | The phone number range included in the block. |
-**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly]
-**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly]
-**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly]
-**errors** | **String** | Errors the reservation could happen upon | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**startingNumber** | **String** | Starting phone number block | |
+|**range** | **Integer** | The phone number range included in the block. | |
+|**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly] |
+|**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly] |
+|**errors** | **String** | Errors the reservation could happen upon | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/CreateNumberOrderDocumentRequest.md b/docs/CreateNumberOrderDocumentRequest.md
index 33d184b9..a4e4d620 100644
--- a/docs/CreateNumberOrderDocumentRequest.md
+++ b/docs/CreateNumberOrderDocumentRequest.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**fileId** | **String** | The id of the file to associate as a number order document. | [optional]
-**requirementsId** | **String** | Unique id for a requirement. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**requirementType** | [**RequirementTypeEnum**](#RequirementTypeEnum) | | [optional] [readonly]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order document was uploaded. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**fileId** | **String** | The id of the file to associate as a number order document. | [optional] |
+|**requirementsId** | **String** | Unique id for a requirement. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**requirementType** | [**RequirementTypeEnum**](#RequirementTypeEnum) | | [optional] [readonly] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order document was uploaded. | [optional] [readonly] |
## Enum: RequirementTypeEnum
-Name | Value
----- | -----
-ADDRESS_PROOF | "address_proof"
-IDENTIFICATION | "identification"
-REG_FORM | "reg_form"
+| Name | Value |
+|---- | -----|
+| ADDRESS_PROOF | "address_proof" |
+| IDENTIFICATION | "identification" |
+| REG_FORM | "reg_form" |
diff --git a/docs/CreateNumberOrderRequest.md b/docs/CreateNumberOrderRequest.md
index 8b3c8da6..53718986 100644
--- a/docs/CreateNumberOrderRequest.md
+++ b/docs/CreateNumberOrderRequest.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional]
-**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly]
-**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly]
-**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional] |
+|**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly] |
+|**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/CreateNumberPoolMessageRequest.md b/docs/CreateNumberPoolMessageRequest.md
index 2bddb93e..c29330c6 100644
--- a/docs/CreateNumberPoolMessageRequest.md
+++ b/docs/CreateNumberPoolMessageRequest.md
@@ -5,27 +5,27 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. |
-**to** | **String** | Receiving address (+E.164 formatted phone number or short code). |
-**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional]
-**subject** | **String** | Subject of multimedia message | [optional]
-**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional]
-**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional]
-**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional]
-**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. | |
+|**to** | **String** | Receiving address (+E.164 formatted phone number or short code). | |
+|**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional] |
+|**subject** | **String** | Subject of multimedia message | [optional] |
+|**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional] |
+|**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional] |
+|**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional] |
## Enum: TypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/CreateNumberReservationRequest.md b/docs/CreateNumberReservationRequest.md
index 298c7540..3935f80c 100644
--- a/docs/CreateNumberReservationRequest.md
+++ b/docs/CreateNumberReservationRequest.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumbers** | [**List<ReservedPhoneNumber>**](ReservedPhoneNumber.md) | | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the entire reservation. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the numbers reservation was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number reservation was updated. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumbers** | [**List<ReservedPhoneNumber>**](ReservedPhoneNumber.md) | | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the entire reservation. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the numbers reservation was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number reservation was updated. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/CreateOrUpdateBusinessIdentityRequest.md b/docs/CreateOrUpdateBusinessIdentityRequest.md
index d4b0f012..9fa501cd 100644
--- a/docs/CreateOrUpdateBusinessIdentityRequest.md
+++ b/docs/CreateOrUpdateBusinessIdentityRequest.md
@@ -5,17 +5,17 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name associated with the authentication provider. |
-**businessEmail** | **BusinessEmail** | | [optional]
-**businessName** | **String** | The business name associated with the address. An address must have either a first last name or a business name. | [optional]
-**businessPhoneNumber** | **BusinessPhoneNumber** | | [optional]
-**businessDescription** | **BusinessDescription** | | [optional]
-**submissionAcknowledgement** | **SubmissionAcknowledgement** | | [optional]
-**websiteUrl** | **WebsiteUrl** | | [optional]
-**address** | **Address** | | [optional]
-**contacts** | **Contacts** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name associated with the authentication provider. | |
+|**businessEmail** | **BusinessEmail** | | [optional] |
+|**businessName** | **BusinessName** | | [optional] |
+|**businessPhoneNumber** | **BusinessPhoneNumber** | | [optional] |
+|**businessDescription** | **BusinessDescription** | | [optional] |
+|**submissionAcknowledgement** | **SubmissionAcknowledgement** | | [optional] |
+|**websiteUrl** | **WebsiteUrl** | | [optional] |
+|**address** | **Address** | | [optional] |
+|**contacts** | **Contacts** | | [optional] |
diff --git a/docs/CreateOutboundVoiceProfileRequest.md b/docs/CreateOutboundVoiceProfileRequest.md
index bb86459b..d5aeaa66 100644
--- a/docs/CreateOutboundVoiceProfileRequest.md
+++ b/docs/CreateOutboundVoiceProfileRequest.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A user-supplied name to help with organization. |
-**trafficType** | **TrafficType** | | [optional]
-**servicePlan** | **ServicePlan** | | [optional]
-**concurrentCallLimit** | **Integer** | Must be no more than your global concurrent call limit. Null means no limit. | [optional]
-**enabled** | **Boolean** | Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections. | [optional]
-**tags** | **List<String>** | | [optional]
-**usagePaymentMethod** | **UsagePaymentMethod** | | [optional]
-**whitelistedDestinations** | **List<String>** | The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2. | [optional]
-**maxDestinationRate** | **BigDecimal** | Maximum rate (price per minute) for a Destination to be allowed when making outbound calls. | [optional]
-**dailySpendLimit** | **String** | The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls. | [optional]
-**dailySpendLimitEnabled** | **Boolean** | Specifies whether to enforce the daily_spend_limit on this outbound voice profile. | [optional]
-**callRecording** | [**OutboundCallRecording**](OutboundCallRecording.md) | | [optional]
-**billingGroupId** | **UUID** | The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | A user-supplied name to help with organization. | |
+|**trafficType** | **TrafficType** | | [optional] |
+|**servicePlan** | **ServicePlan** | | [optional] |
+|**concurrentCallLimit** | **Integer** | Must be no more than your global concurrent call limit. Null means no limit. | [optional] |
+|**enabled** | **Boolean** | Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections. | [optional] |
+|**tags** | **List<String>** | | [optional] |
+|**usagePaymentMethod** | **UsagePaymentMethod** | | [optional] |
+|**whitelistedDestinations** | **List<String>** | The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2. | [optional] |
+|**maxDestinationRate** | **BigDecimal** | Maximum rate (price per minute) for a Destination to be allowed when making outbound calls. | [optional] |
+|**dailySpendLimit** | **String** | The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls. | [optional] |
+|**dailySpendLimitEnabled** | **Boolean** | Specifies whether to enforce the daily_spend_limit on this outbound voice profile. | [optional] |
+|**callRecording** | [**OutboundCallRecording**](OutboundCallRecording.md) | | [optional] |
+|**billingGroupId** | **UUID** | The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned). | [optional] |
diff --git a/docs/CreatePortingOrder.md b/docs/CreatePortingOrder.md
index 70ebf302..4c51f22a 100644
--- a/docs/CreatePortingOrder.md
+++ b/docs/CreatePortingOrder.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumbers** | **List<String>** | The list of +E.164 formatted phone numbers |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | The list of +E.164 formatted phone numbers | |
diff --git a/docs/CreatePortingOrder201Response.md b/docs/CreatePortingOrder201Response.md
new file mode 100644
index 00000000..1b724429
--- /dev/null
+++ b/docs/CreatePortingOrder201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreatePortingOrder201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrder>**](PortingOrder.md) | | [optional] |
+
+
+
diff --git a/docs/CreatePortingOrderComment.md b/docs/CreatePortingOrderComment.md
index b2f4331a..717c5a76 100644
--- a/docs/CreatePortingOrderComment.md
+++ b/docs/CreatePortingOrderComment.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**body** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**body** | **String** | | [optional] |
diff --git a/docs/CreatePortingOrderComment201Response.md b/docs/CreatePortingOrderComment201Response.md
new file mode 100644
index 00000000..ffccc0f2
--- /dev/null
+++ b/docs/CreatePortingOrderComment201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreatePortingOrderComment201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PortingOrdersComment**](PortingOrdersComment.md) | | [optional] |
+
+
+
diff --git a/docs/CreatePrivateWirelessGateway202Response.md b/docs/CreatePrivateWirelessGateway202Response.md
new file mode 100644
index 00000000..f2c695d3
--- /dev/null
+++ b/docs/CreatePrivateWirelessGateway202Response.md
@@ -0,0 +1,13 @@
+
+
+# CreatePrivateWirelessGateway202Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PrivateWirelessGateway**](PrivateWirelessGateway.md) | | [optional] |
+
+
+
diff --git a/docs/CreatePrivateWirelessGatewayRequest.md b/docs/CreatePrivateWirelessGatewayRequest.md
new file mode 100644
index 00000000..58df443c
--- /dev/null
+++ b/docs/CreatePrivateWirelessGatewayRequest.md
@@ -0,0 +1,14 @@
+
+
+# CreatePrivateWirelessGatewayRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**networkId** | **UUID** | The identification of the related network resource. | |
+|**name** | **String** | The private wireless gateway name. | |
+
+
+
diff --git a/docs/CreatePushCredentialRequest.md b/docs/CreatePushCredentialRequest.md
new file mode 100644
index 00000000..41d5a40b
--- /dev/null
+++ b/docs/CreatePushCredentialRequest.md
@@ -0,0 +1,37 @@
+
+
+# CreatePushCredentialRequest
+
+## oneOf schemas
+* [CreateAndroidPushCredentialRequest](CreateAndroidPushCredentialRequest.md)
+* [CreateIosPushCredentialRequest](CreateIosPushCredentialRequest.md)
+
+## Example
+```java
+// Import classes:
+import com.telnyx.sdk.model.CreatePushCredentialRequest;
+import com.telnyx.sdk.model.CreateAndroidPushCredentialRequest;
+import com.telnyx.sdk.model.CreateIosPushCredentialRequest;
+
+public class Example {
+ public static void main(String[] args) {
+ CreatePushCredentialRequest exampleCreatePushCredentialRequest = new CreatePushCredentialRequest();
+
+ // create a new CreateAndroidPushCredentialRequest
+ CreateAndroidPushCredentialRequest exampleCreateAndroidPushCredentialRequest = new CreateAndroidPushCredentialRequest();
+ // set CreatePushCredentialRequest to CreateAndroidPushCredentialRequest
+ exampleCreatePushCredentialRequest.setActualInstance(exampleCreateAndroidPushCredentialRequest);
+ // to get back the CreateAndroidPushCredentialRequest set earlier
+ CreateAndroidPushCredentialRequest testCreateAndroidPushCredentialRequest = (CreateAndroidPushCredentialRequest) exampleCreatePushCredentialRequest.getActualInstance();
+
+ // create a new CreateIosPushCredentialRequest
+ CreateIosPushCredentialRequest exampleCreateIosPushCredentialRequest = new CreateIosPushCredentialRequest();
+ // set CreatePushCredentialRequest to CreateIosPushCredentialRequest
+ exampleCreatePushCredentialRequest.setActualInstance(exampleCreateIosPushCredentialRequest);
+ // to get back the CreateIosPushCredentialRequest set earlier
+ CreateIosPushCredentialRequest testCreateIosPushCredentialRequest = (CreateIosPushCredentialRequest) exampleCreatePushCredentialRequest.getActualInstance();
+ }
+}
+```
+
+
diff --git a/docs/CreateRoom201Response.md b/docs/CreateRoom201Response.md
new file mode 100644
index 00000000..54463f1e
--- /dev/null
+++ b/docs/CreateRoom201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateRoom201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Room**](Room.md) | | [optional] |
+
+
+
diff --git a/docs/CreateRoomClientToken201Response.md b/docs/CreateRoomClientToken201Response.md
new file mode 100644
index 00000000..60e4ae0c
--- /dev/null
+++ b/docs/CreateRoomClientToken201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateRoomClientToken201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CreateRoomClientToken201ResponseData**](CreateRoomClientToken201ResponseData.md) | | [optional] |
+
+
+
diff --git a/docs/CreateRoomClientToken201ResponseData.md b/docs/CreateRoomClientToken201ResponseData.md
new file mode 100644
index 00000000..e2155820
--- /dev/null
+++ b/docs/CreateRoomClientToken201ResponseData.md
@@ -0,0 +1,16 @@
+
+
+# CreateRoomClientToken201ResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**token** | **String** | | [optional] |
+|**tokenExpiresAt** | **String** | ISO 8601 timestamp when the token expires. | [optional] |
+|**refreshToken** | **String** | | [optional] |
+|**refreshTokenExpiresAt** | **String** | ISO 8601 timestamp when the refresh token expires. | [optional] |
+
+
+
diff --git a/docs/CreateRoomClientTokenRequest.md b/docs/CreateRoomClientTokenRequest.md
index 36d54b2b..145aff30 100644
--- a/docs/CreateRoomClientTokenRequest.md
+++ b/docs/CreateRoomClientTokenRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tokenTtlSecs** | **Integer** | The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room. | [optional]
-**refreshTokenTtlSecs** | **Integer** | The time to live in seconds of the Refresh Token, after that time the Refresh Token is invalid and can't be used to refresh Client Token. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**tokenTtlSecs** | **Integer** | The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room. | [optional] |
+|**refreshTokenTtlSecs** | **Integer** | The time to live in seconds of the Refresh Token, after that time the Refresh Token is invalid and can't be used to refresh Client Token. | [optional] |
diff --git a/docs/CreateRoomComposition202Response.md b/docs/CreateRoomComposition202Response.md
new file mode 100644
index 00000000..c684cdcf
--- /dev/null
+++ b/docs/CreateRoomComposition202Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateRoomComposition202Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**RoomComposition**](RoomComposition.md) | | [optional] |
+
+
+
diff --git a/docs/CreateRoomCompositionRequest.md b/docs/CreateRoomCompositionRequest.md
index 1d2a2b76..0d9cbe00 100644
--- a/docs/CreateRoomCompositionRequest.md
+++ b/docs/CreateRoomCompositionRequest.md
@@ -5,15 +5,15 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**format** | **String** | The desired format of the room composition. | [optional]
-**resolution** | **String** | The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720 | [optional]
-**sessionId** | **UUID** | id of the room session associated with the room composition. | [optional]
-**videoLayout** | [**Map<String, VideoRegion>**](VideoRegion.md) | Describes the video layout of the room composition in terms of regions. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**format** | **String** | The desired format of the room composition. | [optional] |
+|**resolution** | **String** | The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720 | [optional] |
+|**sessionId** | **UUID** | id of the room session associated with the room composition. | [optional] |
+|**videoLayout** | [**Map<String, VideoRegion>**](VideoRegion.md) | Describes the video layout of the room composition in terms of regions. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
diff --git a/docs/CreateRoomRequest.md b/docs/CreateRoomRequest.md
index 59e991ab..29d92d3a 100644
--- a/docs/CreateRoomRequest.md
+++ b/docs/CreateRoomRequest.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uniqueName** | **String** | The unique (within the Telnyx account scope) name of the room. | [optional]
-**maxParticipants** | **Integer** | The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected. | [optional]
-**enableRecording** | **Boolean** | Enable or disable recording for that room. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**uniqueName** | **String** | The unique (within the Telnyx account scope) name of the room. | [optional] |
+|**maxParticipants** | **Integer** | The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected. | [optional] |
+|**enableRecording** | **Boolean** | Enable or disable recording for that room. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
diff --git a/docs/CreateShortCodeMessageRequest.md b/docs/CreateShortCodeMessageRequest.md
index 1de498eb..aa27f345 100644
--- a/docs/CreateShortCodeMessageRequest.md
+++ b/docs/CreateShortCodeMessageRequest.md
@@ -5,27 +5,27 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**from** | **String** | Phone number, in +E.164 format, used to send the message. |
-**to** | **String** | Receiving address (+E.164 formatted phone number or short code). |
-**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional]
-**subject** | **String** | Subject of multimedia message | [optional]
-**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional]
-**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional]
-**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional]
-**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**from** | **String** | Phone number, in +E.164 format, used to send the message. | |
+|**to** | **String** | Receiving address (+E.164 formatted phone number or short code). | |
+|**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional] |
+|**subject** | **String** | Subject of multimedia message | [optional] |
+|**mediaUrls** | **List<String>** | A list of media URLs. The total media size must be less than 1 MB. **Required for MMS** | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional] |
+|**useProfileWebhooks** | **Boolean** | If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile. | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | The protocol for sending the message, either SMS or MMS. | [optional] |
+|**autoDetect** | **Boolean** | Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts. | [optional] |
## Enum: TypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/CreateTexmlApplicationRequest.md b/docs/CreateTexmlApplicationRequest.md
index ddeff00b..f5a41026 100644
--- a/docs/CreateTexmlApplicationRequest.md
+++ b/docs/CreateTexmlApplicationRequest.md
@@ -5,39 +5,39 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**friendlyName** | **String** | A user-assigned name to help manage the application. |
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional]
-**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional]
-**voiceUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks. |
-**voiceFallbackUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url. | [optional]
-**voiceMethod** | [**VoiceMethodEnum**](#VoiceMethodEnum) | HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'. | [optional]
-**statusCallback** | **String** | URL for Telnyx to send requests to containing information about call progress events. | [optional]
-**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request method Telnyx should use when requesting the status_callback URL. | [optional]
-**inbound** | [**CreateTexmlApplicationRequestInbound**](CreateTexmlApplicationRequestInbound.md) | | [optional]
-**outbound** | [**CreateTexmlApplicationRequestOutbound**](CreateTexmlApplicationRequestOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**friendlyName** | **String** | A user-assigned name to help manage the application. | |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional] |
+|**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional] |
+|**voiceUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks. | |
+|**voiceFallbackUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url. | [optional] |
+|**voiceMethod** | [**VoiceMethodEnum**](#VoiceMethodEnum) | HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'. | [optional] |
+|**statusCallback** | **String** | URL for Telnyx to send requests to containing information about call progress events. | [optional] |
+|**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request method Telnyx should use when requesting the status_callback URL. | [optional] |
+|**inbound** | [**CreateTexmlApplicationRequestInbound**](CreateTexmlApplicationRequestInbound.md) | | [optional] |
+|**outbound** | [**CreateTexmlApplicationRequestOutbound**](CreateTexmlApplicationRequestOutbound.md) | | [optional] |
## Enum: VoiceMethodEnum
-Name | Value
----- | -----
-GET | "get"
-POST | "post"
+| Name | Value |
+|---- | -----|
+| GET | "get" |
+| POST | "post" |
## Enum: StatusCallbackMethodEnum
-Name | Value
----- | -----
-GET | "get"
-POST | "post"
+| Name | Value |
+|---- | -----|
+| GET | "get" |
+| POST | "post" |
diff --git a/docs/CreateTexmlApplicationRequestInbound.md b/docs/CreateTexmlApplicationRequestInbound.md
index 89ac4e23..97aff7c4 100644
--- a/docs/CreateTexmlApplicationRequestInbound.md
+++ b/docs/CreateTexmlApplicationRequestInbound.md
@@ -5,20 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional]
-**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional]
-**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional] |
+|**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional] |
+|**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional] |
## Enum: SipSubdomainReceiveSettingsEnum
-Name | Value
----- | -----
-ONLY_MY_CONNECTIONS | "only_my_connections"
-FROM_ANYONE | "from_anyone"
+| Name | Value |
+|---- | -----|
+| ONLY_MY_CONNECTIONS | "only_my_connections" |
+| FROM_ANYONE | "from_anyone" |
diff --git a/docs/CreateTexmlApplicationRequestOutbound.md b/docs/CreateTexmlApplicationRequestOutbound.md
index 7727b752..3b05e195 100644
--- a/docs/CreateTexmlApplicationRequestOutbound.md
+++ b/docs/CreateTexmlApplicationRequestOutbound.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional]
-**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional] |
+|**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional] |
diff --git a/docs/CreateVerificationRequestCall.md b/docs/CreateVerificationRequestCall.md
index e660c039..cb62e1b4 100644
--- a/docs/CreateVerificationRequestCall.md
+++ b/docs/CreateVerificationRequestCall.md
@@ -6,12 +6,12 @@ The request body when creating a verification.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | +E164 formatted phone number. |
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. |
-**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional]
-**callTimeoutSecs** | **Integer** | Must be less than the profile's default_verification_timeout_secs or timeout_secs, whichever is lesser. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | +E164 formatted phone number. | |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | |
+|**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional] |
+|**callTimeoutSecs** | **Integer** | Must be less than the profile's default_verification_timeout_secs or timeout_secs, whichever is lesser. | [optional] |
diff --git a/docs/CreateVerificationRequestFlashcall.md b/docs/CreateVerificationRequestFlashcall.md
index 6376883b..47e941a0 100644
--- a/docs/CreateVerificationRequestFlashcall.md
+++ b/docs/CreateVerificationRequestFlashcall.md
@@ -6,11 +6,11 @@ The request body when creating a verification.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | +E164 formatted phone number. |
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. |
-**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | +E164 formatted phone number. | |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | |
+|**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional] |
diff --git a/docs/CreateVerificationRequestPSD2.md b/docs/CreateVerificationRequestPSD2.md
index 893675af..f3ed5486 100644
--- a/docs/CreateVerificationRequestPSD2.md
+++ b/docs/CreateVerificationRequestPSD2.md
@@ -6,14 +6,14 @@ The request body when creating a verification.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | +E164 formatted phone number. |
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. |
-**currency** | **Currencies** | |
-**amount** | **String** | |
-**payee** | **String** | |
-**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | +E164 formatted phone number. | |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | |
+|**currency** | **Currencies** | | |
+|**amount** | **String** | | |
+|**payee** | **String** | | |
+|**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional] |
diff --git a/docs/CreateVerificationRequestSMS.md b/docs/CreateVerificationRequestSMS.md
index eec6b36e..e1cc7866 100644
--- a/docs/CreateVerificationRequestSMS.md
+++ b/docs/CreateVerificationRequestSMS.md
@@ -6,11 +6,11 @@ The request body when creating a verification.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | +E164 formatted phone number. |
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. |
-**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | +E164 formatted phone number. | |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | |
+|**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional] |
diff --git a/docs/CreateVerificationRequestWhatsapp.md b/docs/CreateVerificationRequestWhatsapp.md
index 3a6fb871..608c6b14 100644
--- a/docs/CreateVerificationRequestWhatsapp.md
+++ b/docs/CreateVerificationRequestWhatsapp.md
@@ -6,11 +6,11 @@ The request body when creating a verification.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | +E164 formatted phone number. |
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. |
-**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | +E164 formatted phone number. | |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | |
+|**timeoutSecs** | **Integer** | The number of seconds the verification code is valid for. | [optional] |
diff --git a/docs/CreateVerificationResponse.md b/docs/CreateVerificationResponse.md
index 882d2f01..af3a2b05 100644
--- a/docs/CreateVerificationResponse.md
+++ b/docs/CreateVerificationResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Verification**](Verification.md) | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Verification**](Verification.md) | | |
diff --git a/docs/CreateVerifiedCallsDisplayProfileRequest.md b/docs/CreateVerifiedCallsDisplayProfileRequest.md
index 88d7311f..2fff7a2b 100644
--- a/docs/CreateVerifiedCallsDisplayProfileRequest.md
+++ b/docs/CreateVerifiedCallsDisplayProfileRequest.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**businessIdentityId** | **UUID** | The ID of the business identity that owns the record |
-**name** | **String** | The name associated with the authentication provider. |
-**displayName** | **DisplayName** | | [optional]
-**logoUrl** | **LogoUrl** | | [optional]
-**callReasons** | **CallReasons** | | [optional]
-**phoneNumbers** | **PhoneNumbers** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**businessIdentityId** | **UUID** | The ID of the business identity that owns the record | |
+|**name** | **String** | The name associated with the authentication provider. | |
+|**displayName** | **DisplayName** | | [optional] |
+|**logoUrl** | **LogoUrl** | | [optional] |
+|**callReasons** | **CallReasons** | | [optional] |
+|**phoneNumbers** | **PhoneNumbers** | | [optional] |
diff --git a/docs/CreateVerifyProfileCallRequest.md b/docs/CreateVerifyProfileCallRequest.md
index 52306900..f079c126 100644
--- a/docs/CreateVerifyProfileCallRequest.md
+++ b/docs/CreateVerifyProfileCallRequest.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**speechTemplate** | **String** | Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional]
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**defaultCallTimeoutSecs** | **Integer** | Must be less than default_verification_timeout_secs | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**speechTemplate** | **String** | Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional] |
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**defaultCallTimeoutSecs** | **Integer** | Must be less than default_verification_timeout_secs | [optional] |
diff --git a/docs/CreateVerifyProfileFlashcallRequest.md b/docs/CreateVerifyProfileFlashcallRequest.md
index a795a6aa..afa779cb 100644
--- a/docs/CreateVerifyProfileFlashcallRequest.md
+++ b/docs/CreateVerifyProfileFlashcallRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
diff --git a/docs/CreateVerifyProfilePSD2Request.md b/docs/CreateVerifyProfilePSD2Request.md
index 15bebc7b..4a2dcc62 100644
--- a/docs/CreateVerifyProfilePSD2Request.md
+++ b/docs/CreateVerifyProfilePSD2Request.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
diff --git a/docs/CreateVerifyProfileRequest.md b/docs/CreateVerifyProfileRequest.md
index 0702f204..41b26c0f 100644
--- a/docs/CreateVerifyProfileRequest.md
+++ b/docs/CreateVerifyProfileRequest.md
@@ -5,17 +5,17 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | |
-**webhookUrl** | **String** | | [optional]
-**webhookFailoverUrl** | **String** | | [optional]
-**sms** | **CreateVerifyProfileSMSRequest** | | [optional]
-**psd2** | **CreateVerifyProfilePSD2Request** | | [optional]
-**whatsapp** | **CreateVerifyProfileWhatsappRequest** | | [optional]
-**call** | **CreateVerifyProfileCallRequest** | | [optional]
-**flashcall** | **CreateVerifyProfileFlashcallRequest** | | [optional]
-**language** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | |
+|**webhookUrl** | **String** | | [optional] |
+|**webhookFailoverUrl** | **String** | | [optional] |
+|**sms** | **CreateVerifyProfileSMSRequest** | | [optional] |
+|**psd2** | **CreateVerifyProfilePSD2Request** | | [optional] |
+|**whatsapp** | **CreateVerifyProfileWhatsappRequest** | | [optional] |
+|**call** | **CreateVerifyProfileCallRequest** | | [optional] |
+|**flashcall** | **CreateVerifyProfileFlashcallRequest** | | [optional] |
+|**language** | **String** | | [optional] |
diff --git a/docs/CreateVerifyProfileSMSRequest.md b/docs/CreateVerifyProfileSMSRequest.md
index d63d0502..af56cf22 100644
--- a/docs/CreateVerifyProfileSMSRequest.md
+++ b/docs/CreateVerifyProfileSMSRequest.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messagingEnabled** | **Boolean** | Enables SMS text messaging for the Verify profile. | [optional]
-**rcsEnabled** | **Boolean** | Enables RCS messaging for the Verify profile. | [optional]
-**messagingTemplate** | **String** | Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional]
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**vsmsEnabled** | **Boolean** | Enables VSMS for the Verify profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messagingEnabled** | **Boolean** | Enables SMS text messaging for the Verify profile. | [optional] |
+|**rcsEnabled** | **Boolean** | Enables RCS messaging for the Verify profile. | [optional] |
+|**messagingTemplate** | **String** | Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional] |
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**vsmsEnabled** | **Boolean** | Enables VSMS for the Verify profile. | [optional] |
diff --git a/docs/CreateVerifyProfileWhatsappRequest.md b/docs/CreateVerifyProfileWhatsappRequest.md
index dd5b70f4..95ac5948 100644
--- a/docs/CreateVerifyProfileWhatsappRequest.md
+++ b/docs/CreateVerifyProfileWhatsappRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**appName** | **String** | The name that identifies the application requesting 2fa in the verification message. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**appName** | **String** | The name that identifies the application requesting 2fa in the verification message. | [optional] |
diff --git a/docs/CreateWdrReport201Response.md b/docs/CreateWdrReport201Response.md
new file mode 100644
index 00000000..1ec7832d
--- /dev/null
+++ b/docs/CreateWdrReport201Response.md
@@ -0,0 +1,13 @@
+
+
+# CreateWdrReport201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**WdrReport**](WdrReport.md) | | [optional] |
+
+
+
diff --git a/docs/CreateWhatsAppMessageRequest.md b/docs/CreateWhatsAppMessageRequest.md
index 27c30e11..134960d4 100644
--- a/docs/CreateWhatsAppMessageRequest.md
+++ b/docs/CreateWhatsAppMessageRequest.md
@@ -5,21 +5,19 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**whatsappUserId** | **String** | The sender's WhatsApp ID. |
-**to** | **String** | The WhatsApp ID (phone number) returned from contacts endpoint. |
-**type** | **MessageType** | | [optional]
-**text** | [**Text**](Text.md) | | [optional]
-**audio** | [**Audio**](Audio.md) | | [optional]
-**image** | [**Image**](Image.md) | | [optional]
-**document** | [**Document**](Document.md) | | [optional]
-**video** | [**Video**](Video.md) | | [optional]
-**hsm** | [**Hsm**](Hsm.md) | | [optional]
-**contacts** | [**List<Contact>**](Contact.md) | | [optional]
-**location** | [**Location**](Location.md) | | [optional]
-**previewUrl** | **Boolean** | Specifying preview_url in the request is optional when not including a URL in your message. To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://. | [optional]
-**template** | [**Template**](Template.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**whatsappUserId** | **String** | The sender's WhatsApp ID. | |
+|**to** | **String** | The WhatsApp ID (phone number) returned from contacts endpoint. | |
+|**type** | **MessageType** | | [optional] |
+|**text** | [**Text**](Text.md) | | [optional] |
+|**audio** | [**Audio**](Audio.md) | | [optional] |
+|**image** | [**Image**](Image.md) | | [optional] |
+|**document** | [**Document**](Document.md) | | [optional] |
+|**video** | [**Video**](Video.md) | | [optional] |
+|**location** | [**Location**](Location.md) | | [optional] |
+|**previewUrl** | **Boolean** | Specifying preview_url in the request is optional when not including a URL in your message. To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://. | [optional] |
+|**template** | [**Template**](Template.md) | | [optional] |
diff --git a/docs/CreateWhatsappMessageTemplateRequestBody.md b/docs/CreateWhatsappMessageTemplateRequestBody.md
new file mode 100644
index 00000000..9bc580ed
--- /dev/null
+++ b/docs/CreateWhatsappMessageTemplateRequestBody.md
@@ -0,0 +1,112 @@
+
+
+# CreateWhatsappMessageTemplateRequestBody
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**category** | [**CategoryEnum**](#CategoryEnum) | The template category | [optional] |
+|**language** | [**LanguageEnum**](#LanguageEnum) | The language of the whatsapp message template | [optional] |
+|**name** | **String** | A name identifying this whatsapp message template | [optional] |
+|**components** | **String** | The JSON-formatted components for the this whatsapp message template, please refer to whatsapp documentation on the correct structure for this field | [optional] |
+
+
+
+## Enum: CategoryEnum
+
+| Name | Value |
+|---- | -----|
+| ACCOUNT_UPDATE | "ACCOUNT_UPDATE" |
+| PAYMENT_UPDATE | "PAYMENT_UPDATE" |
+| PERSONAL_FINANCE_UPDATE | "PERSONAL_FINANCE_UPDATE" |
+| SHIPPING_UPDATE | "SHIPPING_UPDATE" |
+| RESERVATION_UPDATE | "RESERVATION_UPDATE" |
+| ISSUE_RESOLUTION | "ISSUE_RESOLUTION" |
+| APPOINTMENT_UPDATE | "APPOINTMENT_UPDATE" |
+| TRANSPORTATION_UPDATE | "TRANSPORTATION_UPDATE" |
+| TICKET_UPDATE | "TICKET_UPDATE" |
+| ALERT_UPDATE | "ALERT_UPDATE" |
+| AUTO_REPLY | "AUTO_REPLY" |
+
+
+
+## Enum: LanguageEnum
+
+| Name | Value |
+|---- | -----|
+| AF | "af" |
+| SQ | "sq" |
+| AR | "ar" |
+| AZ | "az" |
+| BN | "bn" |
+| BG | "bg" |
+| CA | "ca" |
+| ZH_CN | "zh_CN" |
+| ZH_HK | "zh_HK" |
+| ZH_TW | "zh_TW" |
+| HR | "hr" |
+| CS | "cs" |
+| DA | "da" |
+| NL | "nl" |
+| EN | "en" |
+| EN_GB | "en_GB" |
+| EN_US | "en_US" |
+| ET | "et" |
+| FIL | "fil" |
+| FI | "fi" |
+| FR | "fr" |
+| KA | "ka" |
+| DE | "de" |
+| EL | "el" |
+| GU | "gu" |
+| HA | "ha" |
+| HE | "he" |
+| HI | "hi" |
+| HU | "hu" |
+| ID | "id" |
+| GA | "ga" |
+| IT | "it" |
+| JA | "ja" |
+| KN | "kn" |
+| KK | "kk" |
+| RW_RW | "rw_RW" |
+| KO | "ko" |
+| KY_KG | "ky_KG" |
+| LO | "lo" |
+| LV | "lv" |
+| LT | "lt" |
+| MK | "mk" |
+| MS | "ms" |
+| ML | "ml" |
+| MR | "mr" |
+| NB | "nb" |
+| FA | "fa" |
+| PL | "pl" |
+| PT_BR | "pt_BR" |
+| PT_PT | "pt_PT" |
+| PA | "pa" |
+| RO | "ro" |
+| RU | "ru" |
+| SR | "sr" |
+| SK | "sk" |
+| SL | "sl" |
+| ES | "es" |
+| ES_AR | "es_AR" |
+| ES_ES | "es_ES" |
+| ES_MX | "es_MX" |
+| SW | "sw" |
+| SV | "sv" |
+| TA | "ta" |
+| TE | "te" |
+| TH | "th" |
+| TR | "tr" |
+| UK | "uk" |
+| UR | "ur" |
+| UZ | "uz" |
+| VI | "vi" |
+| ZU | "zu" |
+
+
+
diff --git a/docs/CredentialConnection.md b/docs/CredentialConnection.md
index cb9dce07..a94d1ed9 100644
--- a/docs/CredentialConnection.md
+++ b/docs/CredentialConnection.md
@@ -5,49 +5,49 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the type of resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**active** | **Boolean** | Defaults to true | [optional]
-**userName** | **String** | The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). | [optional]
-**password** | **String** | The password to be used as part of the credentials. Must be 8 to 128 characters long. | [optional]
-**createdAt** | **String** | ISO-8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **String** | ISO-8601 formatted date indicating when the resource was updated. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | | [optional]
-**sipUriCallingPreference** | [**SipUriCallingPreferenceEnum**](#SipUriCallingPreferenceEnum) | This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**CredentialInbound**](CredentialInbound.md) | | [optional]
-**outbound** | [**CredentialOutbound**](CredentialOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the type of resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**userName** | **String** | The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). | [optional] |
+|**password** | **String** | The password to be used as part of the credentials. Must be 8 to 128 characters long. | [optional] |
+|**createdAt** | **String** | ISO-8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **String** | ISO-8601 formatted date indicating when the resource was updated. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | [optional] |
+|**sipUriCallingPreference** | [**SipUriCallingPreferenceEnum**](#SipUriCallingPreferenceEnum) | This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**CredentialInbound**](CredentialInbound.md) | | [optional] |
+|**outbound** | [**CredentialOutbound**](CredentialOutbound.md) | | [optional] |
## Enum: SipUriCallingPreferenceEnum
-Name | Value
----- | -----
-DISABLED | "disabled"
-UNRESTRICTED | "unrestricted"
-INTERNAL | "internal"
+| Name | Value |
+|---- | -----|
+| DISABLED | "disabled" |
+| UNRESTRICTED | "unrestricted" |
+| INTERNAL | "internal" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/CredentialConnectionResponse.md b/docs/CredentialConnectionResponse.md
index 2734ddfa..b9d23ed6 100644
--- a/docs/CredentialConnectionResponse.md
+++ b/docs/CredentialConnectionResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CredentialConnection**](CredentialConnection.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CredentialConnection**](CredentialConnection.md) | | [optional] |
diff --git a/docs/CredentialConnectionsApi.md b/docs/CredentialConnectionsApi.md
index 1de9fd6f..fdf45517 100644
--- a/docs/CredentialConnectionsApi.md
+++ b/docs/CredentialConnectionsApi.md
@@ -187,7 +187,7 @@ public class Example {
CredentialConnectionsApi apiInstance = new CredentialConnectionsApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
- String filterConnectionNameContains = "null"; // String | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
+ String filterConnectionNameContains = "filterConnectionNameContains_example"; // String | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
String filterOutboundOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
@@ -217,7 +217,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
- **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
+ **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional]
**filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
diff --git a/docs/CredentialInbound.md b/docs/CredentialInbound.md
index f9c2d987..8fa5939a 100644
--- a/docs/CredentialInbound.md
+++ b/docs/CredentialInbound.md
@@ -5,41 +5,41 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional]
-**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional]
-**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional]
-**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional]
-**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional]
-**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional]
-**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional]
-**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional]
-**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional]
-**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional]
-**timeout2xxSecs** | **String** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional] |
+|**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional] |
+|**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional] |
+|**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional] |
+|**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional] |
+|**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional] |
+|**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional] |
+|**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional] |
+|**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional] |
+|**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional] |
+|**timeout2xxSecs** | **String** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional] |
## Enum: AniNumberFormatEnum
-Name | Value
----- | -----
-_E_164 | "+E.164"
-E_164 | "E.164"
-_E_164_NATIONAL | "+E.164-national"
-E_164_NATIONAL | "E.164-national"
+| Name | Value |
+|---- | -----|
+| _E_164 | "+E.164" |
+| E_164 | "E.164" |
+| _E_164_NATIONAL | "+E.164-national" |
+| E_164_NATIONAL | "E.164-national" |
## Enum: DnisNumberFormatEnum
-Name | Value
----- | -----
-_E164 | "+e164"
-E164 | "e164"
-NATIONAL | "national"
-SIP_USERNAME | "sip_username"
+| Name | Value |
+|---- | -----|
+| _E164 | "+e164" |
+| E164 | "e164" |
+| NATIONAL | "national" |
+| SIP_USERNAME | "sip_username" |
diff --git a/docs/CredentialOutbound.md b/docs/CredentialOutbound.md
index 3d7f9e8a..b1228a53 100644
--- a/docs/CredentialOutbound.md
+++ b/docs/CredentialOutbound.md
@@ -5,40 +5,40 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callParkingEnabled** | **Boolean** | Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next. | [optional]
-**aniOverride** | **String** | Set a phone number as the ani_override value to override caller id number on outbound calls. | [optional]
-**aniOverrideType** | [**AniOverrideTypeEnum**](#AniOverrideTypeEnum) | Specifies when we apply your ani_override setting. Only applies when ani_override is not blank. | [optional]
-**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional]
-**instantRingbackEnabled** | **Boolean** | When set, ringback will not wait for indication before sending ringback tone to calling party. | [optional]
-**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional]
-**localization** | **String** | A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default. | [optional]
-**t38ReinviteSource** | [**T38ReinviteSourceEnum**](#T38ReinviteSourceEnum) | This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite. | [optional]
-**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callParkingEnabled** | **Boolean** | Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next. | [optional] |
+|**aniOverride** | **String** | Set a phone number as the ani_override value to override caller id number on outbound calls. | [optional] |
+|**aniOverrideType** | [**AniOverrideTypeEnum**](#AniOverrideTypeEnum) | Specifies when we apply your ani_override setting. Only applies when ani_override is not blank. | [optional] |
+|**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional] |
+|**instantRingbackEnabled** | **Boolean** | When set, ringback will not wait for indication before sending ringback tone to calling party. | [optional] |
+|**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional] |
+|**localization** | **String** | A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default. | [optional] |
+|**t38ReinviteSource** | [**T38ReinviteSourceEnum**](#T38ReinviteSourceEnum) | This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite. | [optional] |
+|**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional] |
## Enum: AniOverrideTypeEnum
-Name | Value
----- | -----
-ALWAYS | "always"
-NORMAL | "normal"
-EMERGENCY | "emergency"
+| Name | Value |
+|---- | -----|
+| ALWAYS | "always" |
+| NORMAL | "normal" |
+| EMERGENCY | "emergency" |
## Enum: T38ReinviteSourceEnum
-Name | Value
----- | -----
-TELNYX | "telnyx"
-CUSTOMER | "customer"
-DISABLED | "disabled"
-PASSTHRU | "passthru"
-CALLER_PASSTHRU | "caller-passthru"
-CALLEE_PASSTHRU | "callee-passthru"
+| Name | Value |
+|---- | -----|
+| TELNYX | "telnyx" |
+| CUSTOMER | "customer" |
+| DISABLED | "disabled" |
+| PASSTHRU | "passthru" |
+| CALLER_PASSTHRU | "caller-passthru" |
+| CALLEE_PASSTHRU | "callee-passthru" |
diff --git a/docs/CredentialsResponse.md b/docs/CredentialsResponse.md
index 75bcbb86..30f757c6 100644
--- a/docs/CredentialsResponse.md
+++ b/docs/CredentialsResponse.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**GCSConfiguration**](GCSConfiguration.md) | |
-**connectionId** | **ConnectionId** | |
-**recordType** | **String** | Identifies record type. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**GCSConfiguration**](GCSConfiguration.md) | | |
+|**connectionId** | **String** | The ID of the connection used to send the fax. | |
+|**recordType** | **String** | Identifies record type. | |
diff --git a/docs/CsvDownload.md b/docs/CsvDownload.md
index e898c84c..9491ee1f 100644
--- a/docs/CsvDownload.md
+++ b/docs/CsvDownload.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the resource. | [optional] [readonly]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**url** | **String** | The URL at which the CSV file can be retrieved. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**url** | **String** | The URL at which the CSV file can be retrieved. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved. | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-COMPLETE | "complete"
-FAILED | "failed"
-EXPIRED | "expired"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| COMPLETE | "complete" |
+| FAILED | "failed" |
+| EXPIRED | "expired" |
diff --git a/docs/Currency.md b/docs/Currency.md
index 2720a23c..b832d188 100644
--- a/docs/Currency.md
+++ b/docs/Currency.md
@@ -3,13 +3,14 @@
# Currency
+
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currencyCode** | **String** | |
-**amount1000** | **Integer** | |
-**fallbackValue** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**currencyCode** | **String** | | |
+|**amount1000** | **Integer** | | |
+|**fallbackValue** | **String** | | [optional] |
diff --git a/docs/CursorPagination.md b/docs/CursorPagination.md
new file mode 100644
index 00000000..5b8065f8
--- /dev/null
+++ b/docs/CursorPagination.md
@@ -0,0 +1,15 @@
+
+
+# CursorPagination
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**cursors** | [**CursorPaginationCursors**](CursorPaginationCursors.md) | | [optional] |
+|**next** | **String** | A URL to the next page of results. | [optional] |
+|**previous** | **String** | A URL to the previous page of results. | [optional] |
+
+
+
diff --git a/docs/CursorPaginationCursors.md b/docs/CursorPaginationCursors.md
new file mode 100644
index 00000000..8cb0ebfb
--- /dev/null
+++ b/docs/CursorPaginationCursors.md
@@ -0,0 +1,14 @@
+
+
+# CursorPaginationCursors
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**before** | **String** | A cursor to use for paginating results. | [optional] |
+|**after** | **String** | A cursor to use for paginating results. | [optional] |
+
+
+
diff --git a/docs/CustomSipHeader.md b/docs/CustomSipHeader.md
index ac697ca6..888c95e4 100644
--- a/docs/CustomSipHeader.md
+++ b/docs/CustomSipHeader.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the header to add. |
-**value** | **String** | The value of the header. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the header to add. | |
+|**value** | **String** | The value of the header. | |
diff --git a/docs/CustomerFacingFQDNsGetIPResponse.md b/docs/CustomerFacingFQDNsGetIPResponse.md
new file mode 100644
index 00000000..52a3266d
--- /dev/null
+++ b/docs/CustomerFacingFQDNsGetIPResponse.md
@@ -0,0 +1,14 @@
+
+
+# CustomerFacingFQDNsGetIPResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<IpItem>**](IpItem.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/CustomerFacingFQDNsListResponse.md b/docs/CustomerFacingFQDNsListResponse.md
new file mode 100644
index 00000000..be027d97
--- /dev/null
+++ b/docs/CustomerFacingFQDNsListResponse.md
@@ -0,0 +1,14 @@
+
+
+# CustomerFacingFQDNsListResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CustomerFacingFQDNsResponseSchema>**](CustomerFacingFQDNsResponseSchema.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/CustomerFacingFQDNsPatch.md b/docs/CustomerFacingFQDNsPatch.md
new file mode 100644
index 00000000..a92db246
--- /dev/null
+++ b/docs/CustomerFacingFQDNsPatch.md
@@ -0,0 +1,13 @@
+
+
+# CustomerFacingFQDNsPatch
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**description** | **String** | | |
+
+
+
diff --git a/docs/CustomerFacingFQDNsPost.md b/docs/CustomerFacingFQDNsPost.md
new file mode 100644
index 00000000..5cdbae39
--- /dev/null
+++ b/docs/CustomerFacingFQDNsPost.md
@@ -0,0 +1,14 @@
+
+
+# CustomerFacingFQDNsPost
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fqdn** | **String** | | |
+|**description** | **String** | | [optional] |
+
+
+
diff --git a/docs/CustomerFacingFQDNsResponseSchema.md b/docs/CustomerFacingFQDNsResponseSchema.md
new file mode 100644
index 00000000..abe391b6
--- /dev/null
+++ b/docs/CustomerFacingFQDNsResponseSchema.md
@@ -0,0 +1,17 @@
+
+
+# CustomerFacingFQDNsResponseSchema
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**fqdn** | **String** | | [optional] |
+|**description** | **String** | | [optional] |
+|**createdAt** | **OffsetDateTime** | | [optional] |
+|**updatedAt** | **OffsetDateTime** | | [optional] |
+
+
+
diff --git a/docs/CustomerServiceRequest.md b/docs/CustomerServiceRequest.md
index 9464689f..4da633f2 100644
--- a/docs/CustomerServiceRequest.md
+++ b/docs/CustomerServiceRequest.md
@@ -5,27 +5,27 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Uniquely identifies this customer service request | [optional] [readonly]
-**phoneNumber** | **String** | The phone number of the customer service request. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the customer service request | [optional]
-**carrierName** | **String** | The name of the carrier that the customer service request is for. | [optional]
-**name** | **String** | The name of the customer service request. | [optional]
-**address** | [**CustomerServiceRequestAddress**](CustomerServiceRequestAddress.md) | | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Uniquely identifies this customer service request | [optional] [readonly] |
+|**phoneNumber** | **String** | The phone number of the customer service request. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the customer service request | [optional] |
+|**carrierName** | **String** | The name of the carrier that the customer service request is for. | [optional] |
+|**name** | **String** | The name of the customer service request. | [optional] |
+|**address** | [**CustomerServiceRequestAddress**](CustomerServiceRequestAddress.md) | | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-COMPLETED | "completed"
-FAILED | "failed"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| COMPLETED | "completed" |
+| FAILED | "failed" |
diff --git a/docs/CustomerServiceRequestAddress.md b/docs/CustomerServiceRequestAddress.md
index 6d1310f8..90eff07c 100644
--- a/docs/CustomerServiceRequestAddress.md
+++ b/docs/CustomerServiceRequestAddress.md
@@ -6,12 +6,12 @@ The address of the customer service request
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**streetAddress** | **String** | The street address | [optional]
-**locality** | **String** | The city of the address | [optional]
-**administrativeArea** | **String** | The state of the address | [optional]
-**postalCode** | **String** | The zip code of the address | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**streetAddress** | **String** | The street address | [optional] |
+|**locality** | **String** | The city of the address | [optional] |
+|**administrativeArea** | **String** | The state of the address | [optional] |
+|**postalCode** | **String** | The zip code of the address | [optional] |
diff --git a/docs/CustomerServiceRequestApi.md b/docs/CustomerServiceRequestApi.md
index 5512b1a8..f43d4037 100644
--- a/docs/CustomerServiceRequestApi.md
+++ b/docs/CustomerServiceRequestApi.md
@@ -4,14 +4,90 @@ All URIs are relative to *https://api.telnyx.com/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
+[**createCustomerServiceRequest**](CustomerServiceRequestApi.md#createCustomerServiceRequest) | **POST** /customer_service_requests | Create a customer service request
[**getCustomerServiceRequest**](CustomerServiceRequestApi.md#getCustomerServiceRequest) | **GET** /customer_service_requests/{customer_service_request_id} | Get a customer service request
+[**listCustomerServiceRequests**](CustomerServiceRequestApi.md#listCustomerServiceRequests) | **GET** /customer_service_requests | List customer service requests
[**verifyPhoneNumberCoverage**](CustomerServiceRequestApi.md#verifyPhoneNumberCoverage) | **POST** /customer_service_requests/phone_number_coverages | Verify CSR phone number coverage
+## createCustomerServiceRequest
+
+> CreateCustomerServiceRequest201Response createCustomerServiceRequest(createCustomerServiceRequestRequest)
+
+Create a customer service request
+
+Create a new customer service request for the provided phone number.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.CustomerServiceRequestApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ CustomerServiceRequestApi apiInstance = new CustomerServiceRequestApi(defaultClient);
+ CreateCustomerServiceRequestRequest createCustomerServiceRequestRequest = new CreateCustomerServiceRequestRequest(); // CreateCustomerServiceRequestRequest |
+ try {
+ CreateCustomerServiceRequest201Response result = apiInstance.createCustomerServiceRequest(createCustomerServiceRequestRequest);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CustomerServiceRequestApi#createCustomerServiceRequest");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **createCustomerServiceRequestRequest** | [**CreateCustomerServiceRequestRequest**](CreateCustomerServiceRequestRequest.md)| |
+
+### Return type
+
+[**CreateCustomerServiceRequest201Response**](CreateCustomerServiceRequest201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Successful Response | - |
+| **401** | The required authentication headers were either invalid or not included in the request. | - |
+| **403** | You do not have permission to perform the requested action on the specified resource or resources. | - |
+| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
+| **500** | An unexpected error occurred. | - |
+
+
## getCustomerServiceRequest
-> ShowCustomerServiceRequest getCustomerServiceRequest(customerServiceRequestId)
+> CreateCustomerServiceRequest201Response getCustomerServiceRequest(customerServiceRequestId)
Get a customer service request
@@ -40,7 +116,7 @@ public class Example {
CustomerServiceRequestApi apiInstance = new CustomerServiceRequestApi(defaultClient);
String customerServiceRequestId = "customerServiceRequestId_example"; // String | The ID of the customer service request
try {
- ShowCustomerServiceRequest result = apiInstance.getCustomerServiceRequest(customerServiceRequestId);
+ CreateCustomerServiceRequest201Response result = apiInstance.getCustomerServiceRequest(customerServiceRequestId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CustomerServiceRequestApi#getCustomerServiceRequest");
@@ -62,7 +138,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowCustomerServiceRequest**](ShowCustomerServiceRequest.md)
+[**CreateCustomerServiceRequest201Response**](CreateCustomerServiceRequest201Response.md)
### Authorization
@@ -83,9 +159,98 @@ Name | Type | Description | Notes
| **500** | An unexpected error occurred. | - |
+## listCustomerServiceRequests
+
+> ListCustomerServiceRequests200Response listCustomerServiceRequests(pageNumber, pageSize, sort, filterPhoneNumberEq, filterPhoneNumberIn, filterStatusEq, filterStatusIn, filterCreatedAtLt)
+
+List customer service requests
+
+List customer service requests.
+
+### Example
+
+```java
+import java.time.OffsetDateTime;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.CustomerServiceRequestApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ CustomerServiceRequestApi apiInstance = new CustomerServiceRequestApi(defaultClient);
+ Integer pageNumber = 1; // Integer | The page number to load
+ Integer pageSize = 20; // Integer | The size of the page
+ String sort = "created_at"; // String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
+ String filterPhoneNumberEq = "+12441239999"; // String | Filters records to those with a specified number.
+ Listconnection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
+ String filterConnectionNameContains = "filterConnectionNameContains_example"; // String | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
ListFQDNConnectionsResponse result = api.listFqdnConnections()
@@ -215,7 +215,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
- **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
+ **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
### Return type
diff --git a/docs/FqdnResponse.md b/docs/FqdnResponse.md
index 0b6ca3a6..94fa3e9a 100644
--- a/docs/FqdnResponse.md
+++ b/docs/FqdnResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Fqdn**](Fqdn.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Fqdn**](Fqdn.md) | | [optional] |
diff --git a/docs/GCSConfiguration.md b/docs/GCSConfiguration.md
index ee3131a0..ba7e2077 100644
--- a/docs/GCSConfiguration.md
+++ b/docs/GCSConfiguration.md
@@ -5,18 +5,18 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**backend** | [**BackendEnum**](#BackendEnum) | |
-**_configuration** | [**GCSConfigurationData**](GCSConfigurationData.md) | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**backend** | [**BackendEnum**](#BackendEnum) | | |
+|**_configuration** | [**GCSConfigurationData**](GCSConfigurationData.md) | | |
## Enum: BackendEnum
-Name | Value
----- | -----
-GCS | "gcs"
+| Name | Value |
+|---- | -----|
+| GCS | "gcs" |
diff --git a/docs/GCSConfigurationData.md b/docs/GCSConfigurationData.md
index eb96d06f..aa7941e8 100644
--- a/docs/GCSConfigurationData.md
+++ b/docs/GCSConfigurationData.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**credentials** | **String** | Opaque credential token used to authenticate and authorize with storage provider | [optional]
-**bucket** | **String** | Name of the bucket to be used to store recording files | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**credentials** | **String** | Opaque credential token used to authenticate and authorize with storage provider | [optional] |
+|**bucket** | **String** | Name of the bucket to be used to store recording files | [optional] |
diff --git a/docs/GatherRequest.md b/docs/GatherRequest.md
new file mode 100644
index 00000000..6de7a27e
--- /dev/null
+++ b/docs/GatherRequest.md
@@ -0,0 +1,21 @@
+
+
+# GatherRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**minimumDigits** | **Integer** | The minimum number of digits to fetch. This parameter has a minimum value of 1. | [optional] |
+|**maximumDigits** | **Integer** | The maximum number of digits to fetch. This parameter has a maximum value of 128. | [optional] |
+|**timeoutMillis** | **Integer** | The number of milliseconds to wait to complete the request. | [optional] |
+|**interDigitTimeoutMillis** | **Integer** | The number of milliseconds to wait for input between digits. | [optional] |
+|**initialTimeoutMillis** | **Integer** | The number of milliseconds to wait for the first DTMF. | [optional] |
+|**terminatingDigit** | **String** | The digit used to terminate input if fewer than `maximum_digits` digits have been gathered. | [optional] |
+|**validDigits** | **String** | A list of all digits accepted as valid. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
+
+
+
diff --git a/docs/GatherUsingAudioRequest.md b/docs/GatherUsingAudioRequest.md
index f7c3996f..15c3d83a 100644
--- a/docs/GatherUsingAudioRequest.md
+++ b/docs/GatherUsingAudioRequest.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**audioUrl** | **String** | The URL of a file to be played back at the beginning of each prompt. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional]
-**mediaName** | **String** | The media_name of a file to be played back at the beginning of each prompt. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional]
-**invalidAudioUrl** | **String** | The URL of a file to play when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The URL can point to either a WAV or MP3 file. invalid_media_name and invalid_audio_url cannot be used together in one request. | [optional]
-**invalidMediaName** | **String** | The media_name of a file to be played back when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional]
-**minimumDigits** | **Integer** | The minimum number of digits to fetch. This parameter has a minimum value of 1. | [optional]
-**maximumDigits** | **Integer** | The maximum number of digits to fetch. This parameter has a maximum value of 128. | [optional]
-**maximumTries** | **Integer** | The maximum number of times the file should be played if there is no input from the user on the call. | [optional]
-**timeoutMillis** | **Integer** | The number of milliseconds to wait for a DTMF response after file playback ends before a replaying the sound file. | [optional]
-**terminatingDigit** | **String** | The digit used to terminate input if fewer than `maximum_digits` digits have been gathered. | [optional]
-**validDigits** | **String** | A list of all digits accepted as valid. | [optional]
-**interDigitTimeoutMillis** | **Integer** | The number of milliseconds to wait for input between digits. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**audioUrl** | **String** | The URL of a file to be played back at the beginning of each prompt. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional] |
+|**mediaName** | **String** | The media_name of a file to be played back at the beginning of each prompt. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional] |
+|**invalidAudioUrl** | **String** | The URL of a file to play when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The URL can point to either a WAV or MP3 file. invalid_media_name and invalid_audio_url cannot be used together in one request. | [optional] |
+|**invalidMediaName** | **String** | The media_name of a file to be played back when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional] |
+|**minimumDigits** | **Integer** | The minimum number of digits to fetch. This parameter has a minimum value of 1. | [optional] |
+|**maximumDigits** | **Integer** | The maximum number of digits to fetch. This parameter has a maximum value of 128. | [optional] |
+|**maximumTries** | **Integer** | The maximum number of times the file should be played if there is no input from the user on the call. | [optional] |
+|**timeoutMillis** | **Integer** | The number of milliseconds to wait for a DTMF response after file playback ends before a replaying the sound file. | [optional] |
+|**terminatingDigit** | **String** | The digit used to terminate input if fewer than `maximum_digits` digits have been gathered. | [optional] |
+|**validDigits** | **String** | A list of all digits accepted as valid. | [optional] |
+|**interDigitTimeoutMillis** | **Integer** | The number of milliseconds to wait for input between digits. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/GatherUsingSpeakRequest.md b/docs/GatherUsingSpeakRequest.md
index 13267756..2d422763 100644
--- a/docs/GatherUsingSpeakRequest.md
+++ b/docs/GatherUsingSpeakRequest.md
@@ -5,86 +5,86 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | **String** | The text or SSML to be converted into speech. There is a 3,000 character limit. |
-**invalidPayload** | **String** | The text or SSML to be converted into speech when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. There is a 3,000 character limit. | [optional]
-**payloadType** | [**PayloadTypeEnum**](#PayloadTypeEnum) | The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML). | [optional]
-**serviceLevel** | [**ServiceLevelEnum**](#ServiceLevelEnum) | This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed. | [optional]
-**voice** | [**VoiceEnum**](#VoiceEnum) | The gender of the voice used to speak back the text. |
-**language** | [**LanguageEnum**](#LanguageEnum) | The language you want spoken. |
-**minimumDigits** | **Integer** | The minimum number of digits to fetch. This parameter has a minimum value of 1. | [optional]
-**maximumDigits** | **Integer** | The maximum number of digits to fetch. This parameter has a maximum value of 128. | [optional]
-**maximumTries** | **Integer** | The maximum number of times that a file should be played back if there is no input from the user on the call. | [optional]
-**timeoutMillis** | **Integer** | The number of milliseconds to wait for a DTMF response after speak ends before a replaying the sound file. | [optional]
-**terminatingDigit** | **String** | The digit used to terminate input if fewer than `maximum_digits` digits have been gathered. | [optional]
-**validDigits** | **String** | A list of all digits accepted as valid. | [optional]
-**interDigitTimeoutMillis** | **Integer** | The number of milliseconds to wait for input between digits. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**payload** | **String** | The text or SSML to be converted into speech. There is a 3,000 character limit. | |
+|**invalidPayload** | **String** | The text or SSML to be converted into speech when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. There is a 3,000 character limit. | [optional] |
+|**payloadType** | [**PayloadTypeEnum**](#PayloadTypeEnum) | The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML). | [optional] |
+|**serviceLevel** | [**ServiceLevelEnum**](#ServiceLevelEnum) | This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed. | [optional] |
+|**voice** | [**VoiceEnum**](#VoiceEnum) | The gender of the voice used to speak back the text. | |
+|**language** | [**LanguageEnum**](#LanguageEnum) | The language you want spoken. | |
+|**minimumDigits** | **Integer** | The minimum number of digits to fetch. This parameter has a minimum value of 1. | [optional] |
+|**maximumDigits** | **Integer** | The maximum number of digits to fetch. This parameter has a maximum value of 128. | [optional] |
+|**maximumTries** | **Integer** | The maximum number of times that a file should be played back if there is no input from the user on the call. | [optional] |
+|**timeoutMillis** | **Integer** | The number of milliseconds to wait for a DTMF response after speak ends before a replaying the sound file. | [optional] |
+|**terminatingDigit** | **String** | The digit used to terminate input if fewer than `maximum_digits` digits have been gathered. | [optional] |
+|**validDigits** | **String** | A list of all digits accepted as valid. | [optional] |
+|**interDigitTimeoutMillis** | **Integer** | The number of milliseconds to wait for input between digits. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
## Enum: PayloadTypeEnum
-Name | Value
----- | -----
-TEXT | "text"
-SSML | "ssml"
+| Name | Value |
+|---- | -----|
+| TEXT | "text" |
+| SSML | "ssml" |
## Enum: ServiceLevelEnum
-Name | Value
----- | -----
-BASIC | "basic"
-PREMIUM | "premium"
+| Name | Value |
+|---- | -----|
+| BASIC | "basic" |
+| PREMIUM | "premium" |
## Enum: VoiceEnum
-Name | Value
----- | -----
-MALE | "male"
-FEMALE | "female"
+| Name | Value |
+|---- | -----|
+| MALE | "male" |
+| FEMALE | "female" |
## Enum: LanguageEnum
-Name | Value
----- | -----
-ARB | "arb"
-CMN_CN | "cmn-CN"
-CY_GB | "cy-GB"
-DA_DK | "da-DK"
-DE_DE | "de-DE"
-EN_AU | "en-AU"
-EN_GB | "en-GB"
-EN_GB_WLS | "en-GB-WLS"
-EN_IN | "en-IN"
-EN_US | "en-US"
-ES_ES | "es-ES"
-ES_MX | "es-MX"
-ES_US | "es-US"
-FR_CA | "fr-CA"
-FR_FR | "fr-FR"
-HI_IN | "hi-IN"
-IS_IS | "is-IS"
-IT_IT | "it-IT"
-JA_JP | "ja-JP"
-KO_KR | "ko-KR"
-NB_NO | "nb-NO"
-NL_NL | "nl-NL"
-PL_PL | "pl-PL"
-PT_BR | "pt-BR"
-PT_PT | "pt-PT"
-RO_RO | "ro-RO"
-RU_RU | "ru-RU"
-SV_SE | "sv-SE"
-TR_TR | "tr-TR"
+| Name | Value |
+|---- | -----|
+| ARB | "arb" |
+| CMN_CN | "cmn-CN" |
+| CY_GB | "cy-GB" |
+| DA_DK | "da-DK" |
+| DE_DE | "de-DE" |
+| EN_AU | "en-AU" |
+| EN_GB | "en-GB" |
+| EN_GB_WLS | "en-GB-WLS" |
+| EN_IN | "en-IN" |
+| EN_US | "en-US" |
+| ES_ES | "es-ES" |
+| ES_MX | "es-MX" |
+| ES_US | "es-US" |
+| FR_CA | "fr-CA" |
+| FR_FR | "fr-FR" |
+| HI_IN | "hi-IN" |
+| IS_IS | "is-IS" |
+| IT_IT | "it-IT" |
+| JA_JP | "ja-JP" |
+| KO_KR | "ko-KR" |
+| NB_NO | "nb-NO" |
+| NL_NL | "nl-NL" |
+| PL_PL | "pl-PL" |
+| PT_BR | "pt-BR" |
+| PT_PT | "pt-PT" |
+| RO_RO | "ro-RO" |
+| RU_RU | "ru-RU" |
+| SV_SE | "sv-SE" |
+| TR_TR | "tr-TR" |
diff --git a/docs/GcbChannelZone.md b/docs/GcbChannelZone.md
index 6f721b58..4f9ec06b 100644
--- a/docs/GcbChannelZone.md
+++ b/docs/GcbChannelZone.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | |
-**countries** | **List<String>** | List of countries (in ISO 3166-2, capitalized) members of the billing channel zone |
-**id** | **String** | |
-**name** | **String** | |
-**channels** | **Long** | |
-**createdAt** | **String** | ISO 8601 formatted date of when the channel zone was created | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date of when the channel zone was updated | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | |
+|**countries** | **List<String>** | List of countries (in ISO 3166-2, capitalized) members of the billing channel zone | |
+|**id** | **String** | | |
+|**name** | **String** | | |
+|**channels** | **Long** | | |
+|**createdAt** | **String** | ISO 8601 formatted date of when the channel zone was created | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date of when the channel zone was updated | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-CHANNEL_ZONE | "channel_zone"
+| Name | Value |
+|---- | -----|
+| CHANNEL_ZONE | "channel_zone" |
diff --git a/docs/GcbPhoneNumber.md b/docs/GcbPhoneNumber.md
index ed4afc6a..8faff76a 100644
--- a/docs/GcbPhoneNumber.md
+++ b/docs/GcbPhoneNumber.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | |
-**channelZoneId** | **String** | |
-**id** | **String** | | [optional]
-**phoneNumber** | **String** | |
-**createdAt** | **String** | ISO 8601 formatted date of when the phone number was created | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | |
+|**channelZoneId** | **String** | | |
+|**id** | **String** | | [optional] |
+|**phoneNumber** | **String** | | |
+|**createdAt** | **String** | ISO 8601 formatted date of when the phone number was created | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-CHANNEL_ZONE_PHONE_NUMBER | "channel_zone_phone_number"
+| Name | Value |
+|---- | -----|
+| CHANNEL_ZONE_PHONE_NUMBER | "channel_zone_phone_number" |
diff --git a/docs/GenericError.md b/docs/GenericError.md
index 39b692ee..669b8dfe 100644
--- a/docs/GenericError.md
+++ b/docs/GenericError.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Integer** | | [optional]
-**title** | **String** | | [optional]
-**detail** | **String** | | [optional]
-**source** | [**ErrorSource**](ErrorSource.md) | | [optional]
-**meta** | **Object** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Integer** | | [optional] |
+|**title** | **String** | | [optional] |
+|**detail** | **String** | | [optional] |
+|**source** | [**UpdateOutboundChannelsDefaultResponseErrorsInnerSource**](UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md) | | [optional] |
+|**meta** | **Object** | | [optional] |
diff --git a/docs/GetAllFaxApplicationsResponse.md b/docs/GetAllFaxApplicationsResponse.md
index 3dba5374..901d95b2 100644
--- a/docs/GetAllFaxApplicationsResponse.md
+++ b/docs/GetAllFaxApplicationsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<FaxApplication>**](FaxApplication.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<FaxApplication>**](FaxApplication.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/GetAllTelephonyCredentialResponse.md b/docs/GetAllTelephonyCredentialResponse.md
index e51bc18e..0c8c2cc7 100644
--- a/docs/GetAllTelephonyCredentialResponse.md
+++ b/docs/GetAllTelephonyCredentialResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<TelephonyCredential>**](TelephonyCredential.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<TelephonyCredential>**](TelephonyCredential.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/GetAllTexmlApplicationsResponse.md b/docs/GetAllTexmlApplicationsResponse.md
index c9011c94..c70d66df 100644
--- a/docs/GetAllTexmlApplicationsResponse.md
+++ b/docs/GetAllTexmlApplicationsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<TexmlApplication>**](TexmlApplication.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<TexmlApplication>**](TexmlApplication.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/GetChannelZones200Response.md b/docs/GetChannelZones200Response.md
new file mode 100644
index 00000000..d4104432
--- /dev/null
+++ b/docs/GetChannelZones200Response.md
@@ -0,0 +1,14 @@
+
+
+# GetChannelZones200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<GcbChannelZone>**](GcbChannelZone.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/GetCustomerServiceRequest404Response.md b/docs/GetCustomerServiceRequest404Response.md
new file mode 100644
index 00000000..7128bac8
--- /dev/null
+++ b/docs/GetCustomerServiceRequest404Response.md
@@ -0,0 +1,13 @@
+
+
+# GetCustomerServiceRequest404Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<ResourceNotFoundError>**](ResourceNotFoundError.md) | | [optional] |
+
+
+
diff --git a/docs/GetFaxResponse.md b/docs/GetFaxResponse.md
index 412d5e3f..c106e7f1 100644
--- a/docs/GetFaxResponse.md
+++ b/docs/GetFaxResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Fax**](Fax.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Fax**](Fax.md) | | [optional] |
diff --git a/docs/GetPhoneNumbers200Response.md b/docs/GetPhoneNumbers200Response.md
new file mode 100644
index 00000000..e9ed2e8b
--- /dev/null
+++ b/docs/GetPhoneNumbers200Response.md
@@ -0,0 +1,14 @@
+
+
+# GetPhoneNumbers200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<GcbPhoneNumber>**](GcbPhoneNumber.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/GetPortRequestSupportingDocuments201Response.md b/docs/GetPortRequestSupportingDocuments201Response.md
new file mode 100644
index 00000000..5a1aaa85
--- /dev/null
+++ b/docs/GetPortRequestSupportingDocuments201Response.md
@@ -0,0 +1,13 @@
+
+
+# GetPortRequestSupportingDocuments201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortOutSupportingDocument>**](PortOutSupportingDocument.md) | | [optional] |
+
+
+
diff --git a/docs/GetPortingOrder200Response.md b/docs/GetPortingOrder200Response.md
new file mode 100644
index 00000000..0600a1e8
--- /dev/null
+++ b/docs/GetPortingOrder200Response.md
@@ -0,0 +1,14 @@
+
+
+# GetPortingOrder200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PortingOrder**](PortingOrder.md) | | [optional] |
+|**meta** | [**GetPortingOrder200ResponseMeta**](GetPortingOrder200ResponseMeta.md) | | [optional] |
+
+
+
diff --git a/docs/GetPortingOrder200ResponseMeta.md b/docs/GetPortingOrder200ResponseMeta.md
new file mode 100644
index 00000000..b31f0cf1
--- /dev/null
+++ b/docs/GetPortingOrder200ResponseMeta.md
@@ -0,0 +1,13 @@
+
+
+# GetPortingOrder200ResponseMeta
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbersUrl** | **String** | Link to list all phone numbers | [optional] |
+
+
+
diff --git a/docs/GetPortingOrderSubRequest200Response.md b/docs/GetPortingOrderSubRequest200Response.md
new file mode 100644
index 00000000..3acd33d1
--- /dev/null
+++ b/docs/GetPortingOrderSubRequest200Response.md
@@ -0,0 +1,13 @@
+
+
+# GetPortingOrderSubRequest200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**GetSubRequestByPortingOrder**](GetSubRequestByPortingOrder.md) | | [optional] |
+
+
+
diff --git a/docs/GetPrivateWirelessGateways200Response.md b/docs/GetPrivateWirelessGateways200Response.md
new file mode 100644
index 00000000..5e3121a5
--- /dev/null
+++ b/docs/GetPrivateWirelessGateways200Response.md
@@ -0,0 +1,14 @@
+
+
+# GetPrivateWirelessGateways200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PrivateWirelessGateway>**](PrivateWirelessGateway.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/GetRecordingResponse.md b/docs/GetRecordingResponse.md
index 59bbad35..b1055b6a 100644
--- a/docs/GetRecordingResponse.md
+++ b/docs/GetRecordingResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Recording**](Recording.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Recording**](Recording.md) | | [optional] |
diff --git a/docs/GetSubRequestByPortingOrder.md b/docs/GetSubRequestByPortingOrder.md
index 1b01fc0f..33fb4947 100644
--- a/docs/GetSubRequestByPortingOrder.md
+++ b/docs/GetSubRequestByPortingOrder.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**subRequestId** | **String** | Identifies the Sub Request associated with the Porting Order | [optional]
-**portRequestId** | **String** | Identifies the Port Request associated with the Porting Order | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**subRequestId** | **String** | Identifies the Sub Request associated with the Porting Order | [optional] |
+|**portRequestId** | **String** | Identifies the Port Request associated with the Porting Order | [optional] |
diff --git a/docs/GetUserBalance200Response.md b/docs/GetUserBalance200Response.md
new file mode 100644
index 00000000..d59a2e85
--- /dev/null
+++ b/docs/GetUserBalance200Response.md
@@ -0,0 +1,13 @@
+
+
+# GetUserBalance200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UserBalance**](UserBalance.md) | | [optional] |
+
+
+
diff --git a/docs/GetWdrReports200Response.md b/docs/GetWdrReports200Response.md
new file mode 100644
index 00000000..90ae0435
--- /dev/null
+++ b/docs/GetWdrReports200Response.md
@@ -0,0 +1,13 @@
+
+
+# GetWdrReports200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<WdrReport>**](WdrReport.md) | | [optional] |
+
+
+
diff --git a/docs/GetWebhookDeliveries200Response.md b/docs/GetWebhookDeliveries200Response.md
new file mode 100644
index 00000000..0f83bca5
--- /dev/null
+++ b/docs/GetWebhookDeliveries200Response.md
@@ -0,0 +1,14 @@
+
+
+# GetWebhookDeliveries200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<WebhookDelivery>**](WebhookDelivery.md) | | [optional] |
+|**meta** | [**PaginationMetaSimple**](PaginationMetaSimple.md) | | [optional] |
+
+
+
diff --git a/docs/GetWebhookDelivery200Response.md b/docs/GetWebhookDelivery200Response.md
new file mode 100644
index 00000000..7515040d
--- /dev/null
+++ b/docs/GetWebhookDelivery200Response.md
@@ -0,0 +1,13 @@
+
+
+# GetWebhookDelivery200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**WebhookDelivery**](WebhookDelivery.md) | | [optional] |
+
+
+
diff --git a/docs/HangupRequest.md b/docs/HangupRequest.md
index d0f8fc58..482cd605 100644
--- a/docs/HangupRequest.md
+++ b/docs/HangupRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/Header.md b/docs/Header.md
new file mode 100644
index 00000000..891e05b6
--- /dev/null
+++ b/docs/Header.md
@@ -0,0 +1,18 @@
+
+
+# Header
+
+Header content displayed on top of a message. See header object for more information. You cannot set a header if your interactive object is of product type. Required for type product_list. Optional for other types.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **String** | The header type you would like to use. | |
+|**text** | **String** | Text for the header. Formatting allows emojis, but not markdown. | [optional] |
+|**video** | [**Video1**](Video1.md) | | [optional] |
+|**image** | [**Image1**](Image1.md) | | [optional] |
+|**document** | [**Document1**](Document1.md) | | [optional] |
+
+
+
diff --git a/docs/HostedNumber.md b/docs/HostedNumber.md
index b9286246..9bbebb1c 100644
--- a/docs/HostedNumber.md
+++ b/docs/HostedNumber.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional] [readonly]
-**phoneNumber** | **String** | The messaging hosted phone number (+E.164 format) | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] [readonly] |
+|**phoneNumber** | **String** | The messaging hosted phone number (+E.164 format) | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-DELETED | "deleted"
-FAILED | "failed"
-PENDING | "pending"
-SUCCESSFUL | "successful"
+| Name | Value |
+|---- | -----|
+| DELETED | "deleted" |
+| FAILED | "failed" |
+| PENDING | "pending" |
+| SUCCESSFUL | "successful" |
diff --git a/docs/Http.md b/docs/Http.md
index 680aa53c..44a2e723 100644
--- a/docs/Http.md
+++ b/docs/Http.md
@@ -6,10 +6,10 @@ HTTP request and response information.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**request** | [**Object**](Object.md) | Request details. | [optional]
-**response** | [**Object**](Object.md) | Response details, optional. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**request** | [**HttpRequest**](HttpRequest.md) | | [optional] |
+|**response** | [**HttpResponse**](HttpResponse.md) | | [optional] |
diff --git a/docs/HttpRequest.md b/docs/HttpRequest.md
new file mode 100644
index 00000000..0fe3bc63
--- /dev/null
+++ b/docs/HttpRequest.md
@@ -0,0 +1,15 @@
+
+
+# HttpRequest
+
+Request details.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | | [optional] |
+|**headers** | **List<String>** | List of headers, limited to 10kB. | [optional] |
+
+
+
diff --git a/docs/HttpResponse.md b/docs/HttpResponse.md
new file mode 100644
index 00000000..9b872d33
--- /dev/null
+++ b/docs/HttpResponse.md
@@ -0,0 +1,16 @@
+
+
+# HttpResponse
+
+Response details, optional.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**status** | **Integer** | | [optional] |
+|**headers** | **List<String>** | List of headers, limited to 10kB. | [optional] |
+|**body** | **String** | Raw response body, limited to 10kB. | [optional] |
+
+
+
diff --git a/docs/Image.md b/docs/Image.md
index 5f63742f..c1715e6a 100644
--- a/docs/Image.md
+++ b/docs/Image.md
@@ -6,11 +6,11 @@ The media object containing an image
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The media object ID returned when the media is successfully uploaded to the media endpoint. | [optional]
-**link** | **String** | The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both. | [optional]
-**caption** | **String** | Describes the specified media. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The media object ID returned when the media is successfully uploaded to the media endpoint. | [optional] |
+|**link** | **String** | The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both. | [optional] |
+|**caption** | **String** | Describes the specified media. | [optional] |
diff --git a/docs/Image1.md b/docs/Image1.md
new file mode 100644
index 00000000..511989f7
--- /dev/null
+++ b/docs/Image1.md
@@ -0,0 +1,16 @@
+
+
+# Image1
+
+Contains the media object for this image.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The media object ID returned when the media is successfully uploaded to the media endpoint. | [optional] |
+|**link** | **String** | The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both. | [optional] |
+|**caption** | **String** | Describes the specified media. | [optional] |
+
+
+
diff --git a/docs/ImmutableSetLong.md b/docs/ImmutableSetLong.md
index 2d0ff561..af00adca 100644
--- a/docs/ImmutableSetLong.md
+++ b/docs/ImmutableSetLong.md
@@ -5,8 +5,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
diff --git a/docs/InboundChannelsApi.md b/docs/InboundChannelsApi.md
index d32c3e06..05bdb62f 100644
--- a/docs/InboundChannelsApi.md
+++ b/docs/InboundChannelsApi.md
@@ -11,7 +11,7 @@ Method | HTTP request | Description
## listOutboundChannels
-> ListInboundChannels listOutboundChannels()
+> ListOutboundChannels200Response listOutboundChannels()
Retrieve your inbound channels
@@ -39,7 +39,7 @@ public class Example {
InboundChannelsApi apiInstance = new InboundChannelsApi(defaultClient);
try {
- ListInboundChannels result = apiInstance.listOutboundChannels();
+ ListOutboundChannels200Response result = apiInstance.listOutboundChannels();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboundChannelsApi#listOutboundChannels");
@@ -58,7 +58,7 @@ This endpoint does not need any parameter.
### Return type
-[**ListInboundChannels**](ListInboundChannels.md)
+[**ListOutboundChannels200Response**](ListOutboundChannels200Response.md)
### Authorization
@@ -80,7 +80,7 @@ This endpoint does not need any parameter.
## updateOutboundChannels
-> UpdateInbouncChannels updateOutboundChannels(updateInboundChannels)
+> UpdateOutboundChannels200Response updateOutboundChannels(updateOutboundChannelsRequest)
Update inbound channels
@@ -107,9 +107,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
InboundChannelsApi apiInstance = new InboundChannelsApi(defaultClient);
- UpdateInboundChannels updateInboundChannels = new UpdateInboundChannels(); // UpdateInboundChannels |
+ UpdateOutboundChannelsRequest updateOutboundChannelsRequest = new UpdateOutboundChannelsRequest(); // UpdateOutboundChannelsRequest | Inbound channels update
try {
- UpdateInbouncChannels result = apiInstance.updateOutboundChannels(updateInboundChannels);
+ UpdateOutboundChannels200Response result = apiInstance.updateOutboundChannels(updateOutboundChannelsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboundChannelsApi#updateOutboundChannels");
@@ -127,11 +127,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **updateInboundChannels** | [**UpdateInboundChannels**](UpdateInboundChannels.md)| |
+ **updateOutboundChannelsRequest** | [**UpdateOutboundChannelsRequest**](UpdateOutboundChannelsRequest.md)| Inbound channels update |
### Return type
-[**UpdateInbouncChannels**](UpdateInbouncChannels.md)
+[**UpdateOutboundChannels200Response**](UpdateOutboundChannels200Response.md)
### Authorization
diff --git a/docs/InboundFqdn.md b/docs/InboundFqdn.md
index 2a568cda..60984cba 100644
--- a/docs/InboundFqdn.md
+++ b/docs/InboundFqdn.md
@@ -5,73 +5,73 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional]
-**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional]
-**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional]
-**defaultRoutingMethod** | [**DefaultRoutingMethodEnum**](#DefaultRoutingMethodEnum) | Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or null, other values are not allowed. | [optional]
-**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional]
-**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional]
-**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional]
-**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional]
-**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional]
-**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional]
-**sipRegion** | [**SipRegionEnum**](#SipRegionEnum) | Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. | [optional]
-**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional]
-**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional]
-**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional]
-**timeout2xxSecs** | **Integer** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional] |
+|**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional] |
+|**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional] |
+|**defaultRoutingMethod** | [**DefaultRoutingMethodEnum**](#DefaultRoutingMethodEnum) | Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or null, other values are not allowed. | [optional] |
+|**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional] |
+|**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional] |
+|**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional] |
+|**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional] |
+|**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional] |
+|**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional] |
+|**sipRegion** | [**SipRegionEnum**](#SipRegionEnum) | Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. | [optional] |
+|**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional] |
+|**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional] |
+|**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional] |
+|**timeout2xxSecs** | **Integer** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional] |
## Enum: AniNumberFormatEnum
-Name | Value
----- | -----
-_E_164 | "+E.164"
-E_164 | "E.164"
-_E_164_NATIONAL | "+E.164-national"
-E_164_NATIONAL | "E.164-national"
+| Name | Value |
+|---- | -----|
+| _E_164 | "+E.164" |
+| E_164 | "E.164" |
+| _E_164_NATIONAL | "+E.164-national" |
+| E_164_NATIONAL | "E.164-national" |
## Enum: DnisNumberFormatEnum
-Name | Value
----- | -----
-_E164 | "+e164"
-E164 | "e164"
-NATIONAL | "national"
-SIP_USERNAME | "sip_username"
+| Name | Value |
+|---- | -----|
+| _E164 | "+e164" |
+| E164 | "e164" |
+| NATIONAL | "national" |
+| SIP_USERNAME | "sip_username" |
## Enum: DefaultRoutingMethodEnum
-Name | Value
----- | -----
-SEQUENTIAL | "sequential"
-ROUND_ROBIN | "round-robin"
+| Name | Value |
+|---- | -----|
+| SEQUENTIAL | "sequential" |
+| ROUND_ROBIN | "round-robin" |
## Enum: SipRegionEnum
-Name | Value
----- | -----
-US | "US"
-EUROPE | "Europe"
-AUSTRALIA | "Australia"
+| Name | Value |
+|---- | -----|
+| US | "US" |
+| EUROPE | "Europe" |
+| AUSTRALIA | "Australia" |
## Enum: SipSubdomainReceiveSettingsEnum
-Name | Value
----- | -----
-ONLY_MY_CONNECTIONS | "only_my_connections"
-FROM_ANYONE | "from_anyone"
+| Name | Value |
+|---- | -----|
+| ONLY_MY_CONNECTIONS | "only_my_connections" |
+| FROM_ANYONE | "from_anyone" |
diff --git a/docs/InboundIp.md b/docs/InboundIp.md
index 46578628..54e9a2c6 100644
--- a/docs/InboundIp.md
+++ b/docs/InboundIp.md
@@ -5,76 +5,76 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional]
-**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional]
-**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional]
-**defaultPrimaryIpId** | **String** | The default primary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. | [optional]
-**defaultSecondaryIpId** | **String** | The default secondary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. | [optional]
-**defaultTertiaryIpId** | **String** | The default tertiary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. | [optional]
-**defaultRoutingMethod** | [**DefaultRoutingMethodEnum**](#DefaultRoutingMethodEnum) | Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed. | [optional]
-**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional]
-**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional]
-**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional]
-**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional]
-**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional]
-**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional]
-**sipRegion** | [**SipRegionEnum**](#SipRegionEnum) | Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. | [optional]
-**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional]
-**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional]
-**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional]
-**timeout2xxSecs** | **Integer** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**aniNumberFormat** | [**AniNumberFormatEnum**](#AniNumberFormatEnum) | This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. | [optional] |
+|**dnisNumberFormat** | [**DnisNumberFormatEnum**](#DnisNumberFormatEnum) | | [optional] |
+|**codecs** | **List<String>** | Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. | [optional] |
+|**defaultPrimaryIpId** | **String** | The default primary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. | [optional] |
+|**defaultSecondaryIpId** | **String** | The default secondary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. | [optional] |
+|**defaultTertiaryIpId** | **String** | The default tertiary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. | [optional] |
+|**defaultRoutingMethod** | [**DefaultRoutingMethodEnum**](#DefaultRoutingMethodEnum) | Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed. | [optional] |
+|**channelLimit** | **Integer** | When set, this will limit the total number of inbound calls to phone numbers associated with this connection. | [optional] |
+|**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional] |
+|**isupHeadersEnabled** | **Boolean** | When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) | [optional] |
+|**prackEnabled** | **Boolean** | Enable PRACK messages as defined in RFC3262. | [optional] |
+|**privacyZoneEnabled** | **Boolean** | By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. | [optional] |
+|**sipCompactHeadersEnabled** | **Boolean** | Defaults to true. | [optional] |
+|**sipRegion** | [**SipRegionEnum**](#SipRegionEnum) | Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. | [optional] |
+|**sipSubdomain** | **String** | Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. | [optional] |
+|**sipSubdomainReceiveSettings** | [**SipSubdomainReceiveSettingsEnum**](#SipSubdomainReceiveSettingsEnum) | This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user). | [optional] |
+|**timeout1xxSecs** | **Integer** | Time(sec) before aborting if connection is not made. | [optional] |
+|**timeout2xxSecs** | **Integer** | Time(sec) before aborting if call is unanswered (min: 1, max: 600). | [optional] |
## Enum: AniNumberFormatEnum
-Name | Value
----- | -----
-_E_164 | "+E.164"
-E_164 | "E.164"
-_E_164_NATIONAL | "+E.164-national"
-E_164_NATIONAL | "E.164-national"
+| Name | Value |
+|---- | -----|
+| _E_164 | "+E.164" |
+| E_164 | "E.164" |
+| _E_164_NATIONAL | "+E.164-national" |
+| E_164_NATIONAL | "E.164-national" |
## Enum: DnisNumberFormatEnum
-Name | Value
----- | -----
-_E164 | "+e164"
-E164 | "e164"
-NATIONAL | "national"
-SIP_USERNAME | "sip_username"
+| Name | Value |
+|---- | -----|
+| _E164 | "+e164" |
+| E164 | "e164" |
+| NATIONAL | "national" |
+| SIP_USERNAME | "sip_username" |
## Enum: DefaultRoutingMethodEnum
-Name | Value
----- | -----
-SEQUENTIAL | "sequential"
-ROUND_ROBIN | "round-robin"
+| Name | Value |
+|---- | -----|
+| SEQUENTIAL | "sequential" |
+| ROUND_ROBIN | "round-robin" |
## Enum: SipRegionEnum
-Name | Value
----- | -----
-US | "US"
-EUROPE | "Europe"
-AUSTRALIA | "Australia"
+| Name | Value |
+|---- | -----|
+| US | "US" |
+| EUROPE | "Europe" |
+| AUSTRALIA | "Australia" |
## Enum: SipSubdomainReceiveSettingsEnum
-Name | Value
----- | -----
-ONLY_MY_CONNECTIONS | "only_my_connections"
-FROM_ANYONE | "from_anyone"
+| Name | Value |
+|---- | -----|
+| ONLY_MY_CONNECTIONS | "only_my_connections" |
+| FROM_ANYONE | "from_anyone" |
diff --git a/docs/InboundMessage.md b/docs/InboundMessage.md
index e84941f8..a9b1ed59 100644
--- a/docs/InboundMessage.md
+++ b/docs/InboundMessage.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**payload** | [**InboundMessagePayload**](InboundMessagePayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**payload** | [**InboundMessagePayload**](InboundMessagePayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-MESSAGE_RECEIVED | "message.received"
+| Name | Value |
+|---- | -----|
+| MESSAGE_RECEIVED | "message.received" |
diff --git a/docs/InboundMessageEvent.md b/docs/InboundMessageEvent.md
index a6ef4b3d..4229a70a 100644
--- a/docs/InboundMessageEvent.md
+++ b/docs/InboundMessageEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**InboundMessage**](InboundMessage.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**InboundMessage**](InboundMessage.md) | | [optional] |
diff --git a/docs/InboundMessagePayload.md b/docs/InboundMessagePayload.md
index 18438b1f..cf385684 100644
--- a/docs/InboundMessagePayload.md
+++ b/docs/InboundMessagePayload.md
@@ -5,54 +5,54 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**direction** | [**DirectionEnum**](#DirectionEnum) | The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**type** | [**TypeEnum**](#TypeEnum) | The type of message. This value can be either 'sms' or 'mms'. | [optional]
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional]
-**to** | [**List<InboundMessagePayloadTo>**](InboundMessagePayloadTo.md) | | [optional]
-**cc** | [**List<InboundMessagePayloadCc>**](InboundMessagePayloadCc.md) | | [optional]
-**from** | [**InboundMessagePayloadFrom**](InboundMessagePayloadFrom.md) | | [optional]
-**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional]
-**media** | [**List<InboundMessagePayloadMedia>**](InboundMessagePayloadMedia.md) | | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional]
-**encoding** | **String** | Encoding scheme used for the message body. | [optional]
-**parts** | **Integer** | Number of parts into which the message's body must be split. | [optional]
-**tags** | **List<String>** | Tags associated with the resource. | [optional]
-**cost** | [**InboundMessagePayloadCost**](InboundMessagePayloadCost.md) | | [optional]
-**receivedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message request was received. | [optional]
-**sentAt** | **OffsetDateTime** | Not used for inbound messages. | [optional]
-**completedAt** | **OffsetDateTime** | Not used for inbound messages. | [optional]
-**validUntil** | **OffsetDateTime** | Not used for inbound messages. | [optional]
-**errors** | [**List<Error>**](Error.md) | These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**direction** | [**DirectionEnum**](#DirectionEnum) | The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | The type of message. This value can be either 'sms' or 'mms'. | [optional] |
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional] |
+|**to** | [**List<InboundMessagePayloadToInner>**](InboundMessagePayloadToInner.md) | | [optional] |
+|**cc** | [**List<InboundMessagePayloadCcInner>**](InboundMessagePayloadCcInner.md) | | [optional] |
+|**from** | [**InboundMessagePayloadFrom**](InboundMessagePayloadFrom.md) | | [optional] |
+|**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional] |
+|**media** | [**List<InboundMessagePayloadMediaInner>**](InboundMessagePayloadMediaInner.md) | | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional] |
+|**encoding** | **String** | Encoding scheme used for the message body. | [optional] |
+|**parts** | **Integer** | Number of parts into which the message's body must be split. | [optional] |
+|**tags** | **List<String>** | Tags associated with the resource. | [optional] |
+|**cost** | [**InboundMessagePayloadCost**](InboundMessagePayloadCost.md) | | [optional] |
+|**receivedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message request was received. | [optional] |
+|**sentAt** | **OffsetDateTime** | Not used for inbound messages. | [optional] |
+|**completedAt** | **OffsetDateTime** | Not used for inbound messages. | [optional] |
+|**validUntil** | **OffsetDateTime** | Not used for inbound messages. | [optional] |
+|**errors** | [**List<Error>**](Error.md) | These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-MESSAGE | "message"
+| Name | Value |
+|---- | -----|
+| MESSAGE | "message" |
## Enum: DirectionEnum
-Name | Value
----- | -----
-INBOUND | "inbound"
+| Name | Value |
+|---- | -----|
+| INBOUND | "inbound" |
## Enum: TypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/InboundMessagePayloadCcInner.md b/docs/InboundMessagePayloadCcInner.md
new file mode 100644
index 00000000..0476b457
--- /dev/null
+++ b/docs/InboundMessagePayloadCcInner.md
@@ -0,0 +1,43 @@
+
+
+# InboundMessagePayloadCcInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | Receiving address (+E.164 formatted phone number or short code). | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**carrier** | **String** | The carrier of the receiver. | [optional] |
+|**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the receiver. | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| QUEUED | "queued" |
+| SENDING | "sending" |
+| SENT | "sent" |
+| DELIVERED | "delivered" |
+| SENDING_FAILED | "sending_failed" |
+| DELIVERY_FAILED | "delivery_failed" |
+| DELIVERY_UNCONFIRMED | "delivery_unconfirmed" |
+
+
+
+## Enum: LineTypeEnum
+
+| Name | Value |
+|---- | -----|
+| WIRELINE | "Wireline" |
+| WIRELESS | "Wireless" |
+| VOWIFI | "VoWiFi" |
+| VOIP | "VoIP" |
+| PRE_PAID_WIRELESS | "Pre-Paid Wireless" |
+| EMPTY | "" |
+
+
+
diff --git a/docs/InboundMessagePayloadCost.md b/docs/InboundMessagePayloadCost.md
index 5abd389a..fc306f9b 100644
--- a/docs/InboundMessagePayloadCost.md
+++ b/docs/InboundMessagePayloadCost.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **BigDecimal** | The amount deducted from your account. | [optional]
-**currency** | **String** | The ISO 4217 currency identifier. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**amount** | **BigDecimal** | The amount deducted from your account. | [optional] |
+|**currency** | **String** | The ISO 4217 currency identifier. | [optional] |
diff --git a/docs/InboundMessagePayloadFrom.md b/docs/InboundMessagePayloadFrom.md
index 2a557dc3..6a0f87d9 100644
--- a/docs/InboundMessagePayloadFrom.md
+++ b/docs/InboundMessagePayloadFrom.md
@@ -5,34 +5,34 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | | [optional]
-**carrier** | **String** | The carrier of the sender. | [optional]
-**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the sender. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**carrier** | **String** | The carrier of the sender. | [optional] |
+|**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the sender. | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-RECEIVED | "received"
-DELIVERED | "delivered"
+| Name | Value |
+|---- | -----|
+| RECEIVED | "received" |
+| DELIVERED | "delivered" |
## Enum: LineTypeEnum
-Name | Value
----- | -----
-WIRELINE | "Wireline"
-WIRELESS | "Wireless"
-VOWIFI | "VoWiFi"
-VOIP | "VoIP"
-PRE_PAID_WIRELESS | "Pre-Paid Wireless"
-EMPTY | ""
+| Name | Value |
+|---- | -----|
+| WIRELINE | "Wireline" |
+| WIRELESS | "Wireless" |
+| VOWIFI | "VoWiFi" |
+| VOIP | "VoIP" |
+| PRE_PAID_WIRELESS | "Pre-Paid Wireless" |
+| EMPTY | "" |
diff --git a/docs/InboundMessagePayloadMediaInner.md b/docs/InboundMessagePayloadMediaInner.md
new file mode 100644
index 00000000..dcd87872
--- /dev/null
+++ b/docs/InboundMessagePayloadMediaInner.md
@@ -0,0 +1,16 @@
+
+
+# InboundMessagePayloadMediaInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | The url of the media requested to be sent. | [optional] |
+|**contentType** | **String** | The MIME type of the requested media. | [optional] |
+|**size** | **Integer** | The size of the requested media. | [optional] |
+|**hashSha256** | **String** | The SHA256 hash of the requested media. | [optional] |
+
+
+
diff --git a/docs/InboundMessagePayloadToInner.md b/docs/InboundMessagePayloadToInner.md
new file mode 100644
index 00000000..7b9fbd47
--- /dev/null
+++ b/docs/InboundMessagePayloadToInner.md
@@ -0,0 +1,44 @@
+
+
+# InboundMessagePayloadToInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | Receiving address (+E.164 formatted phone number or short code). | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**carrier** | **String** | The carrier of the receiver. | [optional] |
+|**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the receiver. | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| QUEUED | "queued" |
+| SENDING | "sending" |
+| SENT | "sent" |
+| DELIVERED | "delivered" |
+| SENDING_FAILED | "sending_failed" |
+| DELIVERY_FAILED | "delivery_failed" |
+| DELIVERY_UNCONFIRMED | "delivery_unconfirmed" |
+| WEBHOOK_DELIVERED | "webhook_delivered" |
+
+
+
+## Enum: LineTypeEnum
+
+| Name | Value |
+|---- | -----|
+| WIRELINE | "Wireline" |
+| WIRELESS | "Wireless" |
+| VOWIFI | "VoWiFi" |
+| VOIP | "VoIP" |
+| PRE_PAID_WIRELESS | "Pre-Paid Wireless" |
+| EMPTY | "" |
+
+
+
diff --git a/docs/Interactive.md b/docs/Interactive.md
new file mode 100644
index 00000000..6239019e
--- /dev/null
+++ b/docs/Interactive.md
@@ -0,0 +1,17 @@
+
+
+# Interactive
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**InteractiveType**](InteractiveType.md) | The type of interactive message you want to send. | |
+|**header** | [**Header**](Header.md) | | [optional] |
+|**body** | [**Body**](Body.md) | | [optional] |
+|**footer** | [**Footer**](Footer.md) | | [optional] |
+|**action** | [**Action**](Action.md) | | |
+
+
+
diff --git a/docs/InteractiveAction.md b/docs/InteractiveAction.md
new file mode 100644
index 00000000..d560e092
--- /dev/null
+++ b/docs/InteractiveAction.md
@@ -0,0 +1,17 @@
+
+
+# InteractiveAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**button** | **String** | Button content. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Required for List Messages. | [optional] |
+|**buttons** | [**List<InteractiveButton>**](InteractiveButton.md) | A list of buttons. Required for Reply Button Messages. | [optional] |
+|**sections** | [**List<InteractiveSection>**](InteractiveSection.md) | Array of section objects. Required for List Messages and Multi-Product Messages. | [optional] |
+|**catalogId** | **String** | Unique identifier of the Facebook catalog linked to your WhatsApp Business Account. This ID can be retrieved via Commerce Manager. Required for Single Product Messages and Multi-Product Messages. | [optional] |
+|**productRetailerId** | **String** | Unique identifier of the product in a catalog. To get this ID, go to Commerce Manager, select your Facebook Business account, and you will see a list of shops connected to your account. Click the shop you want to use. On the left-side panel, click Catalog > Items, and find the item you want to mention. The ID for that item is displayed under the item's name. | [optional] |
+
+
+
diff --git a/docs/InteractiveBody.md b/docs/InteractiveBody.md
new file mode 100644
index 00000000..37040dba
--- /dev/null
+++ b/docs/InteractiveBody.md
@@ -0,0 +1,13 @@
+
+
+# InteractiveBody
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**text** | **String** | The body content of the message. Emojis and markdown are supported. Links are supported. | |
+
+
+
diff --git a/docs/InteractiveButton.md b/docs/InteractiveButton.md
new file mode 100644
index 00000000..2ff78ae2
--- /dev/null
+++ b/docs/InteractiveButton.md
@@ -0,0 +1,14 @@
+
+
+# InteractiveButton
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**InteractiveButtonType**](InteractiveButtonType.md) | The only supported type is reply (for Reply Button Messages). | [optional] |
+|**reply** | [**Reply**](Reply.md) | | |
+
+
+
diff --git a/docs/InteractiveButtonReply.md b/docs/InteractiveButtonReply.md
new file mode 100644
index 00000000..48b25928
--- /dev/null
+++ b/docs/InteractiveButtonReply.md
@@ -0,0 +1,14 @@
+
+
+# InteractiveButtonReply
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**title** | **String** | Button title. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. | |
+|**id** | **String** | Unique identifier for your button. This ID is returned in the webhook when the button is clicked by the user. You cannot have leading or trailing spaces when setting the ID. | |
+
+
+
diff --git a/docs/InteractiveButtonType.md b/docs/InteractiveButtonType.md
new file mode 100644
index 00000000..647da1e2
--- /dev/null
+++ b/docs/InteractiveButtonType.md
@@ -0,0 +1,11 @@
+
+
+# InteractiveButtonType
+
+## Enum
+
+
+* `REPLY` (value: `"reply"`)
+
+
+
diff --git a/docs/InteractiveFooter.md b/docs/InteractiveFooter.md
new file mode 100644
index 00000000..7e46af65
--- /dev/null
+++ b/docs/InteractiveFooter.md
@@ -0,0 +1,13 @@
+
+
+# InteractiveFooter
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**text** | **String** | The footer content. Emojis and markdown are supported. Links are supported. | |
+
+
+
diff --git a/docs/InteractiveHeader.md b/docs/InteractiveHeader.md
new file mode 100644
index 00000000..a1920d3c
--- /dev/null
+++ b/docs/InteractiveHeader.md
@@ -0,0 +1,17 @@
+
+
+# InteractiveHeader
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **String** | The header type you would like to use. | |
+|**text** | **String** | Text for the header. Formatting allows emojis, but not markdown. | [optional] |
+|**video** | [**Video1**](Video1.md) | | [optional] |
+|**image** | [**Image1**](Image1.md) | | [optional] |
+|**document** | [**Document1**](Document1.md) | | [optional] |
+
+
+
diff --git a/docs/InteractiveProduct.md b/docs/InteractiveProduct.md
new file mode 100644
index 00000000..fbfee00b
--- /dev/null
+++ b/docs/InteractiveProduct.md
@@ -0,0 +1,13 @@
+
+
+# InteractiveProduct
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**productRetailerId** | **String** | Unique identifier of the product in a catalog. To get this ID, go to Commerce Manager, select your Facebook Business account, and you will see a list of shops connected to your account. Click the shop you want to use. On the left-side panel, click Catalog > Items, and find the item you want to mention. The ID for that item is displayed under the item's name. | |
+
+
+
diff --git a/docs/InteractiveSection.md b/docs/InteractiveSection.md
new file mode 100644
index 00000000..bb2db9ae
--- /dev/null
+++ b/docs/InteractiveSection.md
@@ -0,0 +1,15 @@
+
+
+# InteractiveSection
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**title** | **String** | Title of the section. Required if the message has more than one section. | [optional] |
+|**rows** | [**List<InteractiveSectionRow>**](InteractiveSectionRow.md) | Contains a list of rows. Limited to 10 rows across all sections. Required for List Messages. | [optional] |
+|**productItems** | [**List<InteractiveProduct>**](InteractiveProduct.md) | Array of product objects. There is a minimum of 1 product per section. There is a maximum of 30 products across all sections. | [optional] |
+
+
+
diff --git a/docs/InteractiveSectionRow.md b/docs/InteractiveSectionRow.md
new file mode 100644
index 00000000..efcd2149
--- /dev/null
+++ b/docs/InteractiveSectionRow.md
@@ -0,0 +1,15 @@
+
+
+# InteractiveSectionRow
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Maximum length: 200 characters | |
+|**title** | **String** | Maximum length: 24 characters | |
+|**description** | **String** | Maximum length: 72 characters | [optional] |
+
+
+
diff --git a/docs/InteractiveType.md b/docs/InteractiveType.md
new file mode 100644
index 00000000..1fec9fa6
--- /dev/null
+++ b/docs/InteractiveType.md
@@ -0,0 +1,17 @@
+
+
+# InteractiveType
+
+## Enum
+
+
+* `LIST` (value: `"list"`)
+
+* `BUTTON` (value: `"button"`)
+
+* `PRODUCT` (value: `"product"`)
+
+* `PRODUCT_LIST` (value: `"product_list"`)
+
+
+
diff --git a/docs/InterfaceStatus.md b/docs/InterfaceStatus.md
new file mode 100644
index 00000000..78f96112
--- /dev/null
+++ b/docs/InterfaceStatus.md
@@ -0,0 +1,17 @@
+
+
+# InterfaceStatus
+
+## Enum
+
+
+* `CREATED` (value: `"created"`)
+
+* `PROVISIONING` (value: `"provisioning"`)
+
+* `PROVISIONED` (value: `"provisioned"`)
+
+* `DELETING` (value: `"deleting"`)
+
+
+
diff --git a/docs/InventoryCoverage.md b/docs/InventoryCoverage.md
index d6c47502..1b46232f 100644
--- a/docs/InventoryCoverage.md
+++ b/docs/InventoryCoverage.md
@@ -5,47 +5,47 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**group** | **String** | | [optional]
-**groupType** | **String** | | [optional]
-**numberRange** | **Integer** | | [optional]
-**numberType** | [**NumberTypeEnum**](#NumberTypeEnum) | | [optional]
-**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | | [optional]
-**coverageType** | [**CoverageTypeEnum**](#CoverageTypeEnum) | | [optional]
-**recordType** | **String** | | [optional]
-**count** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**group** | **String** | | [optional] |
+|**groupType** | **String** | | [optional] |
+|**numberRange** | **Integer** | | [optional] |
+|**numberType** | [**NumberTypeEnum**](#NumberTypeEnum) | | [optional] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | | [optional] |
+|**coverageType** | [**CoverageTypeEnum**](#CoverageTypeEnum) | | [optional] |
+|**recordType** | **String** | | [optional] |
+|**count** | **Integer** | | [optional] |
## Enum: NumberTypeEnum
-Name | Value
----- | -----
-DID | "did"
-TOLL_FREE | "toll-free"
+| Name | Value |
+|---- | -----|
+| DID | "did" |
+| TOLL_FREE | "toll-free" |
## Enum: PhoneNumberTypeEnum
-Name | Value
----- | -----
-LOCAL | "local"
-TOLL_FREE | "toll_free"
-NATIONAL | "national"
-LANDLINE | "landline"
-SHARED_COST | "shared_cost"
-MOBILE | "mobile"
+| Name | Value |
+|---- | -----|
+| LOCAL | "local" |
+| TOLL_FREE | "toll_free" |
+| NATIONAL | "national" |
+| LANDLINE | "landline" |
+| SHARED_COST | "shared_cost" |
+| MOBILE | "mobile" |
## Enum: CoverageTypeEnum
-Name | Value
----- | -----
-NUMBER | "number"
-BLOCK | "block"
+| Name | Value |
+|---- | -----|
+| NUMBER | "number" |
+| BLOCK | "block" |
diff --git a/docs/InventoryCoverageMetadata.md b/docs/InventoryCoverageMetadata.md
index 51554c71..3d845d1a 100644
--- a/docs/InventoryCoverageMetadata.md
+++ b/docs/InventoryCoverageMetadata.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalResults** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalResults** | **Integer** | | [optional] |
diff --git a/docs/InventoryLevelApi.md b/docs/InventoryLevelApi.md
index 73ca9856..12d7ff70 100644
--- a/docs/InventoryLevelApi.md
+++ b/docs/InventoryLevelApi.md
@@ -10,7 +10,7 @@ Method | HTTP request | Description
## createInventoryCoverageRequest
-> InventoryCoverageResponse createInventoryCoverageRequest(filterGroupBy, filterNpa, filterNxx, filterAdministrativeArea, filterPhoneNumberType, filterCountryCode, filterCount)
+> CreateInventoryCoverageRequest200Response createInventoryCoverageRequest(filterGroupBy, filterNpa, filterNxx, filterAdministrativeArea, filterPhoneNumberType, filterCountryCode, filterCount)
Create an inventory coverage request
@@ -45,7 +45,7 @@ public class Example {
String filterCountryCode = "US"; // String |
Boolean filterCount = true; // Boolean |
try {
- InventoryCoverageResponse result = apiInstance.createInventoryCoverageRequest(filterGroupBy, filterNpa, filterNxx, filterAdministrativeArea, filterPhoneNumberType, filterCountryCode, filterCount);
+ CreateInventoryCoverageRequest200Response result = apiInstance.createInventoryCoverageRequest(filterGroupBy, filterNpa, filterNxx, filterAdministrativeArea, filterPhoneNumberType, filterCountryCode, filterCount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InventoryLevelApi#createInventoryCoverageRequest");
@@ -73,7 +73,7 @@ Name | Type | Description | Notes
### Return type
-[**InventoryCoverageResponse**](InventoryCoverageResponse.md)
+[**CreateInventoryCoverageRequest200Response**](CreateInventoryCoverageRequest200Response.md)
### Authorization
diff --git a/docs/Ip.md b/docs/Ip.md
index 458c13ac..a8521a7a 100644
--- a/docs/Ip.md
+++ b/docs/Ip.md
@@ -5,15 +5,15 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the type of resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**connectionId** | **String** | ID of the IP Connection to which this IP should be attached. | [optional]
-**ipAddress** | **String** | IP adddress represented by this resource. | [optional]
-**port** | **Integer** | Port to use when connecting to this IP. | [optional]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the type of resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**connectionId** | **String** | ID of the IP Connection to which this IP should be attached. | [optional] |
+|**ipAddress** | **String** | IP adddress represented by this resource. | [optional] |
+|**port** | **Integer** | Port to use when connecting to this IP. | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional] |
diff --git a/docs/IpAddressesApi.md b/docs/IpAddressesApi.md
index 88834fcd..464822f5 100644
--- a/docs/IpAddressesApi.md
+++ b/docs/IpAddressesApi.md
@@ -5,8 +5,9 @@ All URIs are relative to *https://api.telnyx.com/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**accessIPAddressCreate**](IpAddressesApi.md#accessIPAddressCreate) | **POST** /access_ip_address | Create new Access IP Address
+[**accessIPAddressDelete**](IpAddressesApi.md#accessIPAddressDelete) | **DELETE** /access_ip_address/{access_ip_address_id} | Delete access IP address
+[**accessIPAddressGet**](IpAddressesApi.md#accessIPAddressGet) | **GET** /access_ip_address/{access_ip_address_id} | Retrieve an access IP address
[**accessIPAddressList**](IpAddressesApi.md#accessIPAddressList) | **GET** /access_ip_address | List all Access IP Addresses
-[**accessIpAddressAccessIpAddressIdDelete**](IpAddressesApi.md#accessIpAddressAccessIpAddressIdDelete) | **DELETE** /access_ip_address/{access_ip_address_id} | Delete access IP address
@@ -79,16 +80,15 @@ Name | Type | Description | Notes
| **422** | Validation Error | - |
-## accessIPAddressList
+## accessIPAddressDelete
-> AccessIPAddressListResponseSchema accessIPAddressList(filterIpSource, filterIpAddress, filterStatus, filterCreatedAtGt, filterCreatedAtLt, pageNumber, pageSize)
+> AccessIPAddressResponseSchema accessIPAddressDelete(accessIpAddressId)
-List all Access IP Addresses
+Delete access IP address
### Example
```java
-import java.time.OffsetDateTime;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
@@ -107,18 +107,12 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
IpAddressesApi apiInstance = new IpAddressesApi(defaultClient);
- String filterIpSource = "filterIpSource_example"; // String |
- String filterIpAddress = "filterIpAddress_example"; // String |
- CloudflareSyncStatus filterStatus = CloudflareSyncStatus.fromValue("pending"); // CloudflareSyncStatus |
- OffsetDateTime filterCreatedAtGt = OffsetDateTime.now(); // OffsetDateTime |
- OffsetDateTime filterCreatedAtLt = OffsetDateTime.now(); // OffsetDateTime |
- Integer pageNumber = 1; // Integer |
- Integer pageSize = 20; // Integer |
+ String accessIpAddressId = "accessIpAddressId_example"; // String |
try {
- AccessIPAddressListResponseSchema result = apiInstance.accessIPAddressList(filterIpSource, filterIpAddress, filterStatus, filterCreatedAtGt, filterCreatedAtLt, pageNumber, pageSize);
+ AccessIPAddressResponseSchema result = apiInstance.accessIPAddressDelete(accessIpAddressId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling IpAddressesApi#accessIPAddressList");
+ System.err.println("Exception when calling IpAddressesApi#accessIPAddressDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -133,17 +127,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **filterIpSource** | **String**| | [optional]
- **filterIpAddress** | **String**| | [optional]
- **filterStatus** | **CloudflareSyncStatus**| | [optional] [enum: pending, added]
- **filterCreatedAtGt** | **OffsetDateTime**| | [optional]
- **filterCreatedAtLt** | **OffsetDateTime**| | [optional]
- **pageNumber** | **Integer**| | [optional] [default to 1]
- **pageSize** | **Integer**| | [optional] [default to 20]
+ **accessIpAddressId** | **String**| |
### Return type
-[**AccessIPAddressListResponseSchema**](AccessIPAddressListResponseSchema.md)
+[**AccessIPAddressResponseSchema**](AccessIPAddressResponseSchema.md)
### Authorization
@@ -158,14 +146,13 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful Response | - |
-| **422** | Validation Error | - |
-## accessIpAddressAccessIpAddressIdDelete
+## accessIPAddressGet
-> AccessIPAddressResponseSchema accessIpAddressAccessIpAddressIdDelete(accessIpAddressId)
+> AccessIPAddressResponseSchema accessIPAddressGet(accessIpAddressId)
-Delete access IP address
+Retrieve an access IP address
### Example
@@ -190,10 +177,10 @@ public class Example {
IpAddressesApi apiInstance = new IpAddressesApi(defaultClient);
String accessIpAddressId = "accessIpAddressId_example"; // String |
try {
- AccessIPAddressResponseSchema result = apiInstance.accessIpAddressAccessIpAddressIdDelete(accessIpAddressId);
+ AccessIPAddressResponseSchema result = apiInstance.accessIPAddressGet(accessIpAddressId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling IpAddressesApi#accessIpAddressAccessIpAddressIdDelete");
+ System.err.println("Exception when calling IpAddressesApi#accessIPAddressGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -228,3 +215,85 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
| **200** | Successful Response | - |
+
+## accessIPAddressList
+
+> AccessIPAddressListResponseSchema accessIPAddressList(filterIpSource, filterIpAddress, filterStatus, filterCreatedAtGt, filterCreatedAtLt, pageNumber, pageSize)
+
+List all Access IP Addresses
+
+### Example
+
+```java
+import java.time.OffsetDateTime;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.IpAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ IpAddressesApi apiInstance = new IpAddressesApi(defaultClient);
+ String filterIpSource = "filterIpSource_example"; // String |
+ String filterIpAddress = "filterIpAddress_example"; // String |
+ CloudflareSyncStatus filterStatus = CloudflareSyncStatus.fromValue("pending"); // CloudflareSyncStatus |
+ OffsetDateTime filterCreatedAtGt = OffsetDateTime.now(); // OffsetDateTime |
+ OffsetDateTime filterCreatedAtLt = OffsetDateTime.now(); // OffsetDateTime |
+ Integer pageNumber = 1; // Integer |
+ Integer pageSize = 20; // Integer |
+ try {
+ AccessIPAddressListResponseSchema result = apiInstance.accessIPAddressList(filterIpSource, filterIpAddress, filterStatus, filterCreatedAtGt, filterCreatedAtLt, pageNumber, pageSize);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling IpAddressesApi#accessIPAddressList");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **filterIpSource** | **String**| | [optional]
+ **filterIpAddress** | **String**| | [optional]
+ **filterStatus** | **CloudflareSyncStatus**| | [optional] [enum: pending, added]
+ **filterCreatedAtGt** | **OffsetDateTime**| | [optional]
+ **filterCreatedAtLt** | **OffsetDateTime**| | [optional]
+ **pageNumber** | **Integer**| | [optional] [default to 1]
+ **pageSize** | **Integer**| | [optional] [default to 20]
+
+### Return type
+
+[**AccessIPAddressListResponseSchema**](AccessIPAddressListResponseSchema.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response | - |
+| **422** | Validation Error | - |
+
diff --git a/docs/IpConnection.md b/docs/IpConnection.md
index 8891be83..6a35f0ce 100644
--- a/docs/IpConnection.md
+++ b/docs/IpConnection.md
@@ -5,47 +5,47 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the type of resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**active** | **Boolean** | Defaults to true | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | | [optional]
-**transportProtocol** | [**TransportProtocolEnum**](#TransportProtocolEnum) | One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication. | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
-**inbound** | [**InboundIp**](InboundIp.md) | | [optional]
-**outbound** | [**OutboundIp**](OutboundIp.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the type of resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | [optional] |
+|**transportProtocol** | [**TransportProtocolEnum**](#TransportProtocolEnum) | One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication. | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional] |
+|**inbound** | [**InboundIp**](InboundIp.md) | | [optional] |
+|**outbound** | [**OutboundIp**](OutboundIp.md) | | [optional] |
## Enum: TransportProtocolEnum
-Name | Value
----- | -----
-UDP | "UDP"
-TCP | "TCP"
-TLS | "TLS"
+| Name | Value |
+|---- | -----|
+| UDP | "UDP" |
+| TCP | "TCP" |
+| TLS | "TLS" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/IpConnectionResponse.md b/docs/IpConnectionResponse.md
index 541682ce..37a7c5ca 100644
--- a/docs/IpConnectionResponse.md
+++ b/docs/IpConnectionResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**IpConnection**](IpConnection.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**IpConnection**](IpConnection.md) | | [optional] |
diff --git a/docs/IpConnectionsApi.md b/docs/IpConnectionsApi.md
index 17e337d1..fcd82e57 100644
--- a/docs/IpConnectionsApi.md
+++ b/docs/IpConnectionsApi.md
@@ -187,7 +187,7 @@ public class Example {
IpConnectionsApi apiInstance = new IpConnectionsApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
- String filterConnectionNameContains = "null"; // String | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
+ String filterConnectionNameContains = "filterConnectionNameContains_example"; // String | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
String filterOutboundOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
@@ -217,7 +217,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
- **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
+ **filterConnectionNameContains** | **String**| If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional]
**filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
diff --git a/docs/IpItem.md b/docs/IpItem.md
new file mode 100644
index 00000000..037563b0
--- /dev/null
+++ b/docs/IpItem.md
@@ -0,0 +1,16 @@
+
+
+# IpItem
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ipAddress** | **String** | | [optional] |
+|**fqdn** | **String** | | [optional] |
+|**createdAt** | **OffsetDateTime** | | [optional] |
+|**updatedAt** | **OffsetDateTime** | | [optional] |
+
+
+
diff --git a/docs/IpResponse.md b/docs/IpResponse.md
index bbb42954..c808f775 100644
--- a/docs/IpResponse.md
+++ b/docs/IpResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Ip**](Ip.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Ip**](Ip.md) | | [optional] |
diff --git a/docs/JoinConferenceRequest.md b/docs/JoinConferenceRequest.md
index 57f8f7ed..28fd71bf 100644
--- a/docs/JoinConferenceRequest.md
+++ b/docs/JoinConferenceRequest.md
@@ -5,43 +5,43 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique identifier and token for controlling the call |
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. Please note that the client_state will be updated for the participient call leg and the change will not affect conferencing webhooks unless the participient is the owner of the conference. | [optional]
-**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional]
-**endConferenceOnExit** | **Boolean** | Whether the conference should end and all remaining participants be hung up after the participant leaves the conference. Defaults to \"false\". | [optional]
-**softEndConferenceOnExit** | **Boolean** | Whether the conference should end after the participant leaves the conference. NOTE this doesn't hang up the other participants. Defaults to \"false\". | [optional]
-**hold** | **Boolean** | Whether the participant should be put on hold immediately after joining the conference. Defaults to \"false\". | [optional]
-**holdAudioUrl** | **String** | The URL of a file to be played to the participant when they are put on hold after joining the conference. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\". This property takes effect only if \"hold\" is set to \"true\". | [optional]
-**holdMediaName** | **String** | The media_name of a file to be played to the participant when they are put on hold after joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\". This property takes effect only if \"hold\" is set to \"true\". | [optional]
-**mute** | **Boolean** | Whether the participant should be muted immediately after joining the conference. Defaults to \"false\". | [optional]
-**startConferenceOnEnter** | **Boolean** | Whether the conference should be started after the participant joins the conference. Defaults to \"false\". | [optional]
-**supervisorRole** | [**SupervisorRoleEnum**](#SupervisorRoleEnum) | Sets the joining participant as a supervisor for the conference. A conference can have multiple supervisors. \"barge\" means the supervisor enters the conference as a normal participant. This is the same as \"none\". \"monitor\" means the supervisor is muted but can hear all participants. \"whisper\" means that only the specified \"whisper_call_control_ids\" can hear the supervisor. Defaults to \"none\". | [optional]
-**whisperCallControlIds** | **List<String>** | Array of unique call_control_ids the joining supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only. | [optional]
-**beepEnabled** | [**BeepEnabledEnum**](#BeepEnabledEnum) | Whether a beep sound should be played when the participant joins and/or leaves the conference. Can be used to override the conference-level setting. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique identifier and token for controlling the call | |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. Please note that the client_state will be updated for the participient call leg and the change will not affect conferencing webhooks unless the participient is the owner of the conference. | [optional] |
+|**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional] |
+|**endConferenceOnExit** | **Boolean** | Whether the conference should end and all remaining participants be hung up after the participant leaves the conference. Defaults to \"false\". | [optional] |
+|**softEndConferenceOnExit** | **Boolean** | Whether the conference should end after the participant leaves the conference. NOTE this doesn't hang up the other participants. Defaults to \"false\". | [optional] |
+|**hold** | **Boolean** | Whether the participant should be put on hold immediately after joining the conference. Defaults to \"false\". | [optional] |
+|**holdAudioUrl** | **String** | The URL of a file to be played to the participant when they are put on hold after joining the conference. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\". This property takes effect only if \"hold\" is set to \"true\". | [optional] |
+|**holdMediaName** | **String** | The media_name of a file to be played to the participant when they are put on hold after joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\". This property takes effect only if \"hold\" is set to \"true\". | [optional] |
+|**mute** | **Boolean** | Whether the participant should be muted immediately after joining the conference. Defaults to \"false\". | [optional] |
+|**startConferenceOnEnter** | **Boolean** | Whether the conference should be started after the participant joins the conference. Defaults to \"false\". | [optional] |
+|**supervisorRole** | [**SupervisorRoleEnum**](#SupervisorRoleEnum) | Sets the joining participant as a supervisor for the conference. A conference can have multiple supervisors. \"barge\" means the supervisor enters the conference as a normal participant. This is the same as \"none\". \"monitor\" means the supervisor is muted but can hear all participants. \"whisper\" means that only the specified \"whisper_call_control_ids\" can hear the supervisor. Defaults to \"none\". | [optional] |
+|**whisperCallControlIds** | **List<String>** | Array of unique call_control_ids the joining supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only. | [optional] |
+|**beepEnabled** | [**BeepEnabledEnum**](#BeepEnabledEnum) | Whether a beep sound should be played when the participant joins and/or leaves the conference. Can be used to override the conference-level setting. | [optional] |
## Enum: SupervisorRoleEnum
-Name | Value
----- | -----
-BARGE | "barge"
-MONITOR | "monitor"
-NONE | "none"
-WHISPER | "whisper"
+| Name | Value |
+|---- | -----|
+| BARGE | "barge" |
+| MONITOR | "monitor" |
+| NONE | "none" |
+| WHISPER | "whisper" |
## Enum: BeepEnabledEnum
-Name | Value
----- | -----
-ALWAYS | "always"
-NEVER | "never"
-ON_ENTER | "on_enter"
-ON_EXIT | "on_exit"
+| Name | Value |
+|---- | -----|
+| ALWAYS | "always" |
+| NEVER | "never" |
+| ON_ENTER | "on_enter" |
+| ON_EXIT | "on_exit" |
diff --git a/docs/Language.md b/docs/Language.md
index 41207cbe..52bcdba2 100644
--- a/docs/Language.md
+++ b/docs/Language.md
@@ -5,19 +5,19 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**policy** | [**PolicyEnum**](#PolicyEnum) | The language policy the message should follow |
-**code** | **String** | The code of the language or locale to use — Accepts both language and language_locale formats (e.g., en and en_US). |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**policy** | [**PolicyEnum**](#PolicyEnum) | The language policy the message should follow | |
+|**code** | **String** | The code of the language or locale to use — Accepts both language and language_locale formats (e.g., en and en_US). | |
## Enum: PolicyEnum
-Name | Value
----- | -----
-FALLBACK | "fallback"
-DETERMINISTIC | "deterministic"
+| Name | Value |
+|---- | -----|
+| FALLBACK | "fallback" |
+| DETERMINISTIC | "deterministic" |
diff --git a/docs/LeaveConferenceRequest.md b/docs/LeaveConferenceRequest.md
index 3b81b8c9..6f4c66fe 100644
--- a/docs/LeaveConferenceRequest.md
+++ b/docs/LeaveConferenceRequest.md
@@ -5,22 +5,22 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique identifier and token for controlling the call |
-**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional]
-**beepEnabled** | [**BeepEnabledEnum**](#BeepEnabledEnum) | Whether a beep sound should be played when the participant leaves the conference. Can be used to override the conference-level setting. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique identifier and token for controlling the call | |
+|**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional] |
+|**beepEnabled** | [**BeepEnabledEnum**](#BeepEnabledEnum) | Whether a beep sound should be played when the participant leaves the conference. Can be used to override the conference-level setting. | [optional] |
## Enum: BeepEnabledEnum
-Name | Value
----- | -----
-ALWAYS | "always"
-NEVER | "never"
-ON_ENTER | "on_enter"
-ON_EXIT | "on_exit"
+| Name | Value |
+|---- | -----|
+| ALWAYS | "always" |
+| NEVER | "never" |
+| ON_ENTER | "on_enter" |
+| ON_EXIT | "on_exit" |
diff --git a/docs/LeaveQueueRequest.md b/docs/LeaveQueueRequest.md
index 28c643f1..30e3df94 100644
--- a/docs/LeaveQueueRequest.md
+++ b/docs/LeaveQueueRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/LedgerBillingGroupReport.md b/docs/LedgerBillingGroupReport.md
index 20067852..7042db55 100644
--- a/docs/LedgerBillingGroupReport.md
+++ b/docs/LedgerBillingGroupReport.md
@@ -5,34 +5,34 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**organizationId** | **UUID** | Uniquely identifies the organization that owns the resource. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Status of the ledger billing group report | [optional]
-**reportUrl** | **String** | External url of the ledger billing group report, if the status is complete | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**organizationId** | **UUID** | Uniquely identifies the organization that owns the resource. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Status of the ledger billing group report | [optional] |
+|**reportUrl** | **String** | External url of the ledger billing group report, if the status is complete | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-LEDGER_BILLING_GROUP_REPORT | "ledger_billing_group_report"
+| Name | Value |
+|---- | -----|
+| LEDGER_BILLING_GROUP_REPORT | "ledger_billing_group_report" |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-COMPLETE | "complete"
-FAILED | "failed"
-DELETED | "deleted"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| COMPLETE | "complete" |
+| FAILED | "failed" |
+| DELETED | "deleted" |
diff --git a/docs/ListAllowedFocWindows200Response.md b/docs/ListAllowedFocWindows200Response.md
new file mode 100644
index 00000000..15b4ef94
--- /dev/null
+++ b/docs/ListAllowedFocWindows200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListAllowedFocWindows200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrdersAllowedFocWindow>**](PortingOrdersAllowedFocWindow.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListAvailablePhoneNumbersBlocksResponse.md b/docs/ListAvailablePhoneNumbersBlocksResponse.md
index 8dbecef1..e13eb623 100644
--- a/docs/ListAvailablePhoneNumbersBlocksResponse.md
+++ b/docs/ListAvailablePhoneNumbersBlocksResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<AvailablePhoneNumberBlock>**](AvailablePhoneNumberBlock.md) | | [optional]
-**meta** | [**AvailablePhoneNumbersMetadata**](AvailablePhoneNumbersMetadata.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<AvailablePhoneNumberBlock>**](AvailablePhoneNumberBlock.md) | | [optional] |
+|**meta** | [**AvailablePhoneNumbersMetadata**](AvailablePhoneNumbersMetadata.md) | | [optional] |
diff --git a/docs/ListAvailablePhoneNumbersResponse.md b/docs/ListAvailablePhoneNumbersResponse.md
index 80224987..617059c3 100644
--- a/docs/ListAvailablePhoneNumbersResponse.md
+++ b/docs/ListAvailablePhoneNumbersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<AvailablePhoneNumber>**](AvailablePhoneNumber.md) | | [optional]
-**meta** | [**AvailablePhoneNumbersMetadata**](AvailablePhoneNumbersMetadata.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<AvailablePhoneNumber>**](AvailablePhoneNumber.md) | | [optional] |
+|**meta** | [**AvailablePhoneNumbersMetadata**](AvailablePhoneNumbersMetadata.md) | | [optional] |
diff --git a/docs/ListBillingGroups200Response.md b/docs/ListBillingGroups200Response.md
new file mode 100644
index 00000000..051b0356
--- /dev/null
+++ b/docs/ListBillingGroups200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListBillingGroups200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<BillingGroup>**](BillingGroup.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListBulkSIMCardActions200Response.md b/docs/ListBulkSIMCardActions200Response.md
new file mode 100644
index 00000000..33fa23ba
--- /dev/null
+++ b/docs/ListBulkSIMCardActions200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListBulkSIMCardActions200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<BulkSIMCardActionDetailed>**](BulkSIMCardActionDetailed.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListBusinessIdentitiesResponse.md b/docs/ListBusinessIdentitiesResponse.md
index 10060005..37d71f38 100644
--- a/docs/ListBusinessIdentitiesResponse.md
+++ b/docs/ListBusinessIdentitiesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<BusinessIdentity>**](BusinessIdentity.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<BusinessIdentity>**](BusinessIdentity.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListCallControlApplicationsResponse.md b/docs/ListCallControlApplicationsResponse.md
index 7ba49d15..dbfcc379 100644
--- a/docs/ListCallControlApplicationsResponse.md
+++ b/docs/ListCallControlApplicationsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<CallControlApplication>**](CallControlApplication.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CallControlApplication>**](CallControlApplication.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListCallEventsResponse.md b/docs/ListCallEventsResponse.md
index 192e5ca2..293135bb 100644
--- a/docs/ListCallEventsResponse.md
+++ b/docs/ListCallEventsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<CallEvent>**](CallEvent.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CallEvent>**](CallEvent.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListComments200Response.md b/docs/ListComments200Response.md
new file mode 100644
index 00000000..17c00965
--- /dev/null
+++ b/docs/ListComments200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListComments200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Comment>**](Comment.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListConferencesResponse.md b/docs/ListConferencesResponse.md
index c8870be0..62fd09ec 100644
--- a/docs/ListConferencesResponse.md
+++ b/docs/ListConferencesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Conference>**](Conference.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Conference>**](Conference.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListConnectionsResponse.md b/docs/ListConnectionsResponse.md
index 3fb647cc..53e80b45 100644
--- a/docs/ListConnectionsResponse.md
+++ b/docs/ListConnectionsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Connection>**](Connection.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Connection>**](Connection.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListCredentialConnectionsResponse.md b/docs/ListCredentialConnectionsResponse.md
index aea8a6d6..c4c043b3 100644
--- a/docs/ListCredentialConnectionsResponse.md
+++ b/docs/ListCredentialConnectionsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<CredentialConnection>**](CredentialConnection.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CredentialConnection>**](CredentialConnection.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListCsvDownloadsResponse.md b/docs/ListCsvDownloadsResponse.md
index dc35785f..b7b655a7 100644
--- a/docs/ListCsvDownloadsResponse.md
+++ b/docs/ListCsvDownloadsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<CsvDownload>**](CsvDownload.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CsvDownload>**](CsvDownload.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListCustomerServiceRequests200Response.md b/docs/ListCustomerServiceRequests200Response.md
new file mode 100644
index 00000000..37149cad
--- /dev/null
+++ b/docs/ListCustomerServiceRequests200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListCustomerServiceRequests200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CustomerServiceRequest>**](CustomerServiceRequest.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListCustomerServiceRequests401Response.md b/docs/ListCustomerServiceRequests401Response.md
new file mode 100644
index 00000000..c0ba7ff1
--- /dev/null
+++ b/docs/ListCustomerServiceRequests401Response.md
@@ -0,0 +1,13 @@
+
+
+# ListCustomerServiceRequests401Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<UnauthorizedError>**](UnauthorizedError.md) | | [optional] |
+
+
+
diff --git a/docs/ListCustomerServiceRequests403Response.md b/docs/ListCustomerServiceRequests403Response.md
new file mode 100644
index 00000000..d00a3422
--- /dev/null
+++ b/docs/ListCustomerServiceRequests403Response.md
@@ -0,0 +1,13 @@
+
+
+# ListCustomerServiceRequests403Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<ForbiddenError>**](ForbiddenError.md) | | [optional] |
+
+
+
diff --git a/docs/ListCustomerServiceRequests422Response.md b/docs/ListCustomerServiceRequests422Response.md
new file mode 100644
index 00000000..3432e13b
--- /dev/null
+++ b/docs/ListCustomerServiceRequests422Response.md
@@ -0,0 +1,13 @@
+
+
+# ListCustomerServiceRequests422Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<UnprocessableEntityError>**](UnprocessableEntityError.md) | | [optional] |
+
+
+
diff --git a/docs/ListCustomerServiceRequests500Response.md b/docs/ListCustomerServiceRequests500Response.md
new file mode 100644
index 00000000..97d09e91
--- /dev/null
+++ b/docs/ListCustomerServiceRequests500Response.md
@@ -0,0 +1,13 @@
+
+
+# ListCustomerServiceRequests500Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<UnexpectedError>**](UnexpectedError.md) | | [optional] |
+
+
+
diff --git a/docs/ListDocumentLinks200Response.md b/docs/ListDocumentLinks200Response.md
new file mode 100644
index 00000000..8f75923a
--- /dev/null
+++ b/docs/ListDocumentLinks200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListDocumentLinks200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<DocServiceDocumentLink>**](DocServiceDocumentLink.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListDocuments200Response.md b/docs/ListDocuments200Response.md
new file mode 100644
index 00000000..84f42d56
--- /dev/null
+++ b/docs/ListDocuments200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListDocuments200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<DocServiceDocument>**](DocServiceDocument.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListDyanmicEmergencyAddresses200Response.md b/docs/ListDyanmicEmergencyAddresses200Response.md
new file mode 100644
index 00000000..cf7a8231
--- /dev/null
+++ b/docs/ListDyanmicEmergencyAddresses200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListDyanmicEmergencyAddresses200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<DynamicEmergencyAddress>**](DynamicEmergencyAddress.md) | | [optional] |
+|**meta** | [**Metadata**](Metadata.md) | | [optional] |
+
+
+
diff --git a/docs/ListDyanmicEmergencyEndpoints200Response.md b/docs/ListDyanmicEmergencyEndpoints200Response.md
new file mode 100644
index 00000000..bc094e6d
--- /dev/null
+++ b/docs/ListDyanmicEmergencyEndpoints200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListDyanmicEmergencyEndpoints200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<DynamicEmergencyEndpoint>**](DynamicEmergencyEndpoint.md) | | [optional] |
+|**meta** | [**Metadata**](Metadata.md) | | [optional] |
+
+
+
diff --git a/docs/ListFaxesResponse.md b/docs/ListFaxesResponse.md
index ddc72587..dd01b386 100644
--- a/docs/ListFaxesResponse.md
+++ b/docs/ListFaxesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Fax>**](Fax.md) | | [optional]
-**meta** | **Object** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Fax>**](Fax.md) | | [optional] |
+|**meta** | **Object** | | [optional] |
diff --git a/docs/ListFqdnConnectionsResponse.md b/docs/ListFqdnConnectionsResponse.md
index f251598b..b76677bb 100644
--- a/docs/ListFqdnConnectionsResponse.md
+++ b/docs/ListFqdnConnectionsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<FqdnConnection>**](FqdnConnection.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<FqdnConnection>**](FqdnConnection.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListFqdnsResponse.md b/docs/ListFqdnsResponse.md
index 76939f98..079db8b0 100644
--- a/docs/ListFqdnsResponse.md
+++ b/docs/ListFqdnsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Fqdn>**](Fqdn.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Fqdn>**](Fqdn.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListIpConnectionsResponse.md b/docs/ListIpConnectionsResponse.md
index 05e16c02..844c38fd 100644
--- a/docs/ListIpConnectionsResponse.md
+++ b/docs/ListIpConnectionsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<IpConnection>**](IpConnection.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<IpConnection>**](IpConnection.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListIpsResponse.md b/docs/ListIpsResponse.md
index 637f912d..0cb22d99 100644
--- a/docs/ListIpsResponse.md
+++ b/docs/ListIpsResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Ip>**](Ip.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Ip>**](Ip.md) | | [optional] |
diff --git a/docs/ListManagedAccounts200Response.md b/docs/ListManagedAccounts200Response.md
new file mode 100644
index 00000000..2d67d2df
--- /dev/null
+++ b/docs/ListManagedAccounts200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListManagedAccounts200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<ManagedAccount>**](ManagedAccount.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListMessagingHostedNumberOrderResponse.md b/docs/ListMessagingHostedNumberOrderResponse.md
index 0afdf11a..59ae9bc6 100644
--- a/docs/ListMessagingHostedNumberOrderResponse.md
+++ b/docs/ListMessagingHostedNumberOrderResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MessagingHostedNumberOrder>**](MessagingHostedNumberOrder.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MessagingHostedNumberOrder>**](MessagingHostedNumberOrder.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListMessagingProfileMetricsResponse.md b/docs/ListMessagingProfileMetricsResponse.md
index 7e1705e5..1734bf70 100644
--- a/docs/ListMessagingProfileMetricsResponse.md
+++ b/docs/ListMessagingProfileMetricsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MessagingProfileHighLevelMetrics>**](MessagingProfileHighLevelMetrics.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MessagingProfileHighLevelMetrics>**](MessagingProfileHighLevelMetrics.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListMessagingProfilePhoneNumbersResponse.md b/docs/ListMessagingProfilePhoneNumbersResponse.md
index 3e61428f..1ab14f57 100644
--- a/docs/ListMessagingProfilePhoneNumbersResponse.md
+++ b/docs/ListMessagingProfilePhoneNumbersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<PhoneNumberWithMessagingSettings>**](PhoneNumberWithMessagingSettings.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PhoneNumberWithMessagingSettings>**](PhoneNumberWithMessagingSettings.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListMessagingProfileShortCodesResponse.md b/docs/ListMessagingProfileShortCodesResponse.md
index 8c0bda08..2c08735c 100644
--- a/docs/ListMessagingProfileShortCodesResponse.md
+++ b/docs/ListMessagingProfileShortCodesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<ShortCode>**](ShortCode.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<ShortCode>**](ShortCode.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListMessagingProfileURLDomainsResponse.md b/docs/ListMessagingProfileURLDomainsResponse.md
index a59a75c6..0d8358fa 100644
--- a/docs/ListMessagingProfileURLDomainsResponse.md
+++ b/docs/ListMessagingProfileURLDomainsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MessagingUrlDomain>**](MessagingUrlDomain.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MessagingUrlDomain>**](MessagingUrlDomain.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListMessagingProfilesResponse.md b/docs/ListMessagingProfilesResponse.md
index d56cd1a8..097f0afd 100644
--- a/docs/ListMessagingProfilesResponse.md
+++ b/docs/ListMessagingProfilesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MessagingProfile>**](MessagingProfile.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MessagingProfile>**](MessagingProfile.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListMessagingSettingsResponse.md b/docs/ListMessagingSettingsResponse.md
index 1dd62872..65c59279 100644
--- a/docs/ListMessagingSettingsResponse.md
+++ b/docs/ListMessagingSettingsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<PhoneNumberWithMessagingSettings>**](PhoneNumberWithMessagingSettings.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PhoneNumberWithMessagingSettings>**](PhoneNumberWithMessagingSettings.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListNotificationChannels200Response.md b/docs/ListNotificationChannels200Response.md
new file mode 100644
index 00000000..ca7ac5fd
--- /dev/null
+++ b/docs/ListNotificationChannels200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListNotificationChannels200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NotificationChannel>**](NotificationChannel.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListNotificationSettings200Response.md b/docs/ListNotificationSettings200Response.md
new file mode 100644
index 00000000..c96a59a2
--- /dev/null
+++ b/docs/ListNotificationSettings200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListNotificationSettings200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NotificationSetting>**](NotificationSetting.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListNumberBlockOrdersResponse.md b/docs/ListNumberBlockOrdersResponse.md
index 630c9cbf..981f090f 100644
--- a/docs/ListNumberBlockOrdersResponse.md
+++ b/docs/ListNumberBlockOrdersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<NumberBlockOrder>**](NumberBlockOrder.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NumberBlockOrder>**](NumberBlockOrder.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListNumberOrderDocumentsResponse.md b/docs/ListNumberOrderDocumentsResponse.md
index 8bab08b1..bff568e9 100644
--- a/docs/ListNumberOrderDocumentsResponse.md
+++ b/docs/ListNumberOrderDocumentsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<NumberOrderDocument>**](NumberOrderDocument.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NumberOrderDocument>**](NumberOrderDocument.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListNumberOrderPhoneNumbersResponse.md b/docs/ListNumberOrderPhoneNumbersResponse.md
index d222e30a..7512d43f 100644
--- a/docs/ListNumberOrderPhoneNumbersResponse.md
+++ b/docs/ListNumberOrderPhoneNumbersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<NumberOrderPhoneNumber>**](NumberOrderPhoneNumber.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NumberOrderPhoneNumber>**](NumberOrderPhoneNumber.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListNumberOrdersResponse.md b/docs/ListNumberOrdersResponse.md
index e5618f1d..9d19f50f 100644
--- a/docs/ListNumberOrdersResponse.md
+++ b/docs/ListNumberOrdersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<NumberOrder>**](NumberOrder.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NumberOrder>**](NumberOrder.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListNumberReservationsResponse.md b/docs/ListNumberReservationsResponse.md
index 7e3cd915..fdd762e6 100644
--- a/docs/ListNumberReservationsResponse.md
+++ b/docs/ListNumberReservationsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<NumberReservation>**](NumberReservation.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NumberReservation>**](NumberReservation.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListOfMediaResourcesResponse.md b/docs/ListOfMediaResourcesResponse.md
index 6bfec246..8c0024eb 100644
--- a/docs/ListOfMediaResourcesResponse.md
+++ b/docs/ListOfMediaResourcesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MediaResource>**](MediaResource.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MediaResource>**](MediaResource.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListOutboundChannels200Response.md b/docs/ListOutboundChannels200Response.md
new file mode 100644
index 00000000..2488a82a
--- /dev/null
+++ b/docs/ListOutboundChannels200Response.md
@@ -0,0 +1,13 @@
+
+
+# ListOutboundChannels200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ListOutboundChannels200ResponseData**](ListOutboundChannels200ResponseData.md) | | [optional] |
+
+
+
diff --git a/docs/ListOutboundChannels200ResponseData.md b/docs/ListOutboundChannels200ResponseData.md
new file mode 100644
index 00000000..1b83d92d
--- /dev/null
+++ b/docs/ListOutboundChannels200ResponseData.md
@@ -0,0 +1,14 @@
+
+
+# ListOutboundChannels200ResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channels** | **Integer** | The current number of concurrent channels set for the account | [optional] |
+|**recordType** | **String** | Identifies the type of the response | [optional] |
+
+
+
diff --git a/docs/ListOutboundVoiceProfilesResponse.md b/docs/ListOutboundVoiceProfilesResponse.md
index 24685ce8..fe3c500d 100644
--- a/docs/ListOutboundVoiceProfilesResponse.md
+++ b/docs/ListOutboundVoiceProfilesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<OutboundVoiceProfile>**](OutboundVoiceProfile.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<OutboundVoiceProfile>**](OutboundVoiceProfile.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListParticipantsResponse.md b/docs/ListParticipantsResponse.md
index 9e367e2e..91e081a7 100644
--- a/docs/ListParticipantsResponse.md
+++ b/docs/ListParticipantsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Participant>**](Participant.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Participant>**](Participant.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListPhoneNumberBlocksBackgroundJobsResponse.md b/docs/ListPhoneNumberBlocksBackgroundJobsResponse.md
index d7a1b4eb..8b62e809 100644
--- a/docs/ListPhoneNumberBlocksBackgroundJobsResponse.md
+++ b/docs/ListPhoneNumberBlocksBackgroundJobsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<PhoneNumberBlocksJob>**](PhoneNumberBlocksJob.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PhoneNumberBlocksJob>**](PhoneNumberBlocksJob.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListPhoneNumbersBackgroundJobsResponse.md b/docs/ListPhoneNumbersBackgroundJobsResponse.md
index 903e6b70..4d77b1aa 100644
--- a/docs/ListPhoneNumbersBackgroundJobsResponse.md
+++ b/docs/ListPhoneNumbersBackgroundJobsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<PhoneNumbersJob>**](PhoneNumbersJob.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PhoneNumbersJob>**](PhoneNumbersJob.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListPhoneNumbersResponse.md b/docs/ListPhoneNumbersResponse.md
index 98efe13f..3949e092 100644
--- a/docs/ListPhoneNumbersResponse.md
+++ b/docs/ListPhoneNumbersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<PhoneNumberDetailed>**](PhoneNumberDetailed.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PhoneNumberDetailed>**](PhoneNumberDetailed.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListPhoneNumbersWithVoiceSettingsResponse.md b/docs/ListPhoneNumbersWithVoiceSettingsResponse.md
index e1f6d13c..af151fc9 100644
--- a/docs/ListPhoneNumbersWithVoiceSettingsResponse.md
+++ b/docs/ListPhoneNumbersWithVoiceSettingsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<PhoneNumberWithVoiceSettings>**](PhoneNumberWithVoiceSettings.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PhoneNumberWithVoiceSettings>**](PhoneNumberWithVoiceSettings.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListPortingOrderDocuments200Response.md b/docs/ListPortingOrderDocuments200Response.md
new file mode 100644
index 00000000..da23eeb6
--- /dev/null
+++ b/docs/ListPortingOrderDocuments200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortingOrderDocuments200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrderDocument>**](PortingOrderDocument.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortingOrderRequirements200Response.md b/docs/ListPortingOrderRequirements200Response.md
new file mode 100644
index 00000000..58056e90
--- /dev/null
+++ b/docs/ListPortingOrderRequirements200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortingOrderRequirements200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrderRequirementDetail>**](PortingOrderRequirementDetail.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortingOrders200Response.md b/docs/ListPortingOrders200Response.md
new file mode 100644
index 00000000..1e7350cf
--- /dev/null
+++ b/docs/ListPortingOrders200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortingOrders200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrder>**](PortingOrder.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortingOrdersActivationJobs200Response.md b/docs/ListPortingOrdersActivationJobs200Response.md
new file mode 100644
index 00000000..e1687fba
--- /dev/null
+++ b/docs/ListPortingOrdersActivationJobs200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortingOrdersActivationJobs200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrdersActivationJob>**](PortingOrdersActivationJob.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortingOrdersComments200Response.md b/docs/ListPortingOrdersComments200Response.md
new file mode 100644
index 00000000..e0d9f99e
--- /dev/null
+++ b/docs/ListPortingOrdersComments200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortingOrdersComments200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrdersComment>**](PortingOrdersComment.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortingOrdersExceptionTypes200Response.md b/docs/ListPortingOrdersExceptionTypes200Response.md
new file mode 100644
index 00000000..0838a11d
--- /dev/null
+++ b/docs/ListPortingOrdersExceptionTypes200Response.md
@@ -0,0 +1,13 @@
+
+
+# ListPortingOrdersExceptionTypes200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrdersExceptionType>**](PortingOrdersExceptionType.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortingPhoneNumbers200Response.md b/docs/ListPortingPhoneNumbers200Response.md
new file mode 100644
index 00000000..e70b008a
--- /dev/null
+++ b/docs/ListPortingPhoneNumbers200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortingPhoneNumbers200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingPhoneNumber>**](PortingPhoneNumber.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListPortoutRequest200Response.md b/docs/ListPortoutRequest200Response.md
new file mode 100644
index 00000000..ce499d33
--- /dev/null
+++ b/docs/ListPortoutRequest200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListPortoutRequest200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortoutDetails>**](PortoutDetails.md) | | [optional] |
+|**meta** | [**Metadata**](Metadata.md) | | [optional] |
+
+
+
diff --git a/docs/ListQueueCallsResponse.md b/docs/ListQueueCallsResponse.md
index 571d84f6..43590546 100644
--- a/docs/ListQueueCallsResponse.md
+++ b/docs/ListQueueCallsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<QueueCall>**](QueueCall.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<QueueCall>**](QueueCall.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListRecordingsResponse.md b/docs/ListRecordingsResponse.md
index a9d08709..3d77565b 100644
--- a/docs/ListRecordingsResponse.md
+++ b/docs/ListRecordingsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Recording>**](Recording.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Recording>**](Recording.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListRegulartoryRequirements200Response.md b/docs/ListRegulartoryRequirements200Response.md
new file mode 100644
index 00000000..3af16dd8
--- /dev/null
+++ b/docs/ListRegulartoryRequirements200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRegulartoryRequirements200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<RegulatoryRequirements>**](RegulatoryRequirements.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListRequirements200Response.md b/docs/ListRequirements200Response.md
new file mode 100644
index 00000000..4da983fc
--- /dev/null
+++ b/docs/ListRequirements200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRequirements200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<DocReqsRequirement>**](DocReqsRequirement.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListRoomCompositions200Response.md b/docs/ListRoomCompositions200Response.md
new file mode 100644
index 00000000..c878d3e4
--- /dev/null
+++ b/docs/ListRoomCompositions200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRoomCompositions200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<RoomComposition>**](RoomComposition.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListRoomParticipants200Response.md b/docs/ListRoomParticipants200Response.md
new file mode 100644
index 00000000..00e34329
--- /dev/null
+++ b/docs/ListRoomParticipants200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRoomParticipants200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<RoomParticipant>**](RoomParticipant.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListRoomRecordings200Response.md b/docs/ListRoomRecordings200Response.md
new file mode 100644
index 00000000..a2f7c342
--- /dev/null
+++ b/docs/ListRoomRecordings200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRoomRecordings200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<RoomRecording>**](RoomRecording.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListRoomSessions200Response.md b/docs/ListRoomSessions200Response.md
new file mode 100644
index 00000000..1b736ba7
--- /dev/null
+++ b/docs/ListRoomSessions200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRoomSessions200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<RoomSession>**](RoomSession.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListRooms200Response.md b/docs/ListRooms200Response.md
new file mode 100644
index 00000000..a17620f9
--- /dev/null
+++ b/docs/ListRooms200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListRooms200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Room>**](Room.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListSIMCardActions200Response.md b/docs/ListSIMCardActions200Response.md
new file mode 100644
index 00000000..3227412a
--- /dev/null
+++ b/docs/ListSIMCardActions200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListSIMCardActions200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<SIMCardAction>**](SIMCardAction.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListShortCodesResponse.md b/docs/ListShortCodesResponse.md
index f50c7376..41de8a95 100644
--- a/docs/ListShortCodesResponse.md
+++ b/docs/ListShortCodesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<ShortCode>**](ShortCode.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<ShortCode>**](ShortCode.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListSimCardDataUsageNotifications200Response.md b/docs/ListSimCardDataUsageNotifications200Response.md
new file mode 100644
index 00000000..44be069d
--- /dev/null
+++ b/docs/ListSimCardDataUsageNotifications200Response.md
@@ -0,0 +1,14 @@
+
+
+# ListSimCardDataUsageNotifications200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<SimCardDataUsageNotification>**](SimCardDataUsageNotification.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ListSubNumberOrdersResponse.md b/docs/ListSubNumberOrdersResponse.md
index 141c1f39..e88277b6 100644
--- a/docs/ListSubNumberOrdersResponse.md
+++ b/docs/ListSubNumberOrdersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<SubNumberOrder>**](SubNumberOrder.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<SubNumberOrder>**](SubNumberOrder.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListTagsResponse.md b/docs/ListTagsResponse.md
index aa28c831..d675eab5 100644
--- a/docs/ListTagsResponse.md
+++ b/docs/ListTagsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<ListTagsResponseData>**](ListTagsResponseData.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<ListTagsResponseDataInner>**](ListTagsResponseDataInner.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListTagsResponseDataInner.md b/docs/ListTagsResponseDataInner.md
new file mode 100644
index 00000000..ecacfe5d
--- /dev/null
+++ b/docs/ListTagsResponseDataInner.md
@@ -0,0 +1,14 @@
+
+
+# ListTagsResponseDataInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**tag** | **String** | | [optional] |
+|**amount** | **Integer** | | [optional] |
+
+
+
diff --git a/docs/ListVerificationsResponse.md b/docs/ListVerificationsResponse.md
index 8c27f827..58f5f0ec 100644
--- a/docs/ListVerificationsResponse.md
+++ b/docs/ListVerificationsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<Verification>**](Verification.md) | |
-**meta** | [**Meta**](Meta.md) | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Verification>**](Verification.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ListVerifiedCallsDisplayProfilesResponse.md b/docs/ListVerifiedCallsDisplayProfilesResponse.md
index e4109f1c..010d8668 100644
--- a/docs/ListVerifiedCallsDisplayProfilesResponse.md
+++ b/docs/ListVerifiedCallsDisplayProfilesResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<VerifiedCallsDisplayProfile>**](VerifiedCallsDisplayProfile.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<VerifiedCallsDisplayProfile>**](VerifiedCallsDisplayProfile.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListVerifyProfilesResponse.md b/docs/ListVerifyProfilesResponse.md
index e42186f9..24e91cb5 100644
--- a/docs/ListVerifyProfilesResponse.md
+++ b/docs/ListVerifyProfilesResponse.md
@@ -6,10 +6,10 @@ A paginated list of Verify profiles
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<VerifyProfileResponse>**](VerifyProfileResponse.md) | |
-**meta** | [**Meta**](Meta.md) | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<VerifyProfileResponse>**](VerifyProfileResponse.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ListWhatsAppBusinessAccountsResponse.md b/docs/ListWhatsAppBusinessAccountsResponse.md
index 13e8104c..5455caf4 100644
--- a/docs/ListWhatsAppBusinessAccountsResponse.md
+++ b/docs/ListWhatsAppBusinessAccountsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<WhatsappBusinessAccount>**](WhatsappBusinessAccount.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<WhatsappBusinessAccount>**](WhatsappBusinessAccount.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/ListWhatsAppPhoneNumbersResponse.md b/docs/ListWhatsAppPhoneNumbersResponse.md
index cc4250e0..e496d187 100644
--- a/docs/ListWhatsAppPhoneNumbersResponse.md
+++ b/docs/ListWhatsAppPhoneNumbersResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<WhatsappPhoneNumber>**](WhatsappPhoneNumber.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<WhatsappPhoneNumber>**](WhatsappPhoneNumber.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/Location.md b/docs/Location.md
index 7d698652..299394ae 100644
--- a/docs/Location.md
+++ b/docs/Location.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**longitude** | **String** | Longitude of the location |
-**latitude** | **String** | Latitude of the location |
-**name** | **String** | Name of the location |
-**address** | **String** | Address of the location. Only displayed if name is present. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**longitude** | **String** | Longitude of the location | |
+|**latitude** | **String** | Latitude of the location | |
+|**name** | **String** | Name of the location | |
+|**address** | **String** | Address of the location. Only displayed if name is present. | |
diff --git a/docs/ManagedAccount.md b/docs/ManagedAccount.md
index 62797d1a..34e5b1d3 100644
--- a/docs/ManagedAccount.md
+++ b/docs/ManagedAccount.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. |
-**id** | **UUID** | Uniquely identifies the managed account. |
-**email** | **String** | The managed account's email. |
-**apiKey** | **String** | The managed account's V2 API access key |
-**apiUser** | **String** | The manager account's email, which serves as the V1 API user identifier |
-**apiToken** | **String** | The managed account's V1 API token |
-**organizationName** | **String** | The organization the managed account is associated with. | [optional]
-**managerAccountId** | **String** | The ID of the manager account associated with the managed account. |
-**balance** | [**ManagedAccountBalance**](ManagedAccountBalance.md) | | [optional]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. |
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. |
-**managedAccountAllowCustomPricing** | **Boolean** | Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect. | [optional]
-**rollupBilling** | **Boolean** | Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | |
+|**id** | **UUID** | Uniquely identifies the managed account. | |
+|**email** | **String** | The managed account's email. | |
+|**apiKey** | **String** | The managed account's V2 API access key | |
+|**apiUser** | **String** | The manager account's email, which serves as the V1 API user identifier | |
+|**apiToken** | **String** | The managed account's V1 API token | |
+|**organizationName** | **String** | The organization the managed account is associated with. | [optional] |
+|**managerAccountId** | **String** | The ID of the manager account associated with the managed account. | |
+|**balance** | [**ManagedAccountBalance**](ManagedAccountBalance.md) | | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | |
+|**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | |
+|**managedAccountAllowCustomPricing** | **Boolean** | Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect. | [optional] |
+|**rollupBilling** | **Boolean** | Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-MANAGED_ACCOUNT | "managed_account"
+| Name | Value |
+|---- | -----|
+| MANAGED_ACCOUNT | "managed_account" |
diff --git a/docs/ManagedAccountBalance.md b/docs/ManagedAccountBalance.md
index ee6d33d5..687acae6 100644
--- a/docs/ManagedAccountBalance.md
+++ b/docs/ManagedAccountBalance.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**balance** | **BigDecimal** | The account's current balance. | [optional]
-**creditLimit** | **BigDecimal** | The account's credit limit. | [optional]
-**availableCredit** | **BigDecimal** | Available amount to spend (balance + credit limit) | [optional]
-**currency** | **String** | The ISO 4217 currency identifier. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**balance** | **BigDecimal** | The account's current balance. | [optional] |
+|**creditLimit** | **BigDecimal** | The account's credit limit. | [optional] |
+|**availableCredit** | **BigDecimal** | Available amount to spend (balance + credit limit) | [optional] |
+|**currency** | **String** | The ISO 4217 currency identifier. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-BALANCE | "balance"
+| Name | Value |
+|---- | -----|
+| BALANCE | "balance" |
diff --git a/docs/ManagedAccountsApi.md b/docs/ManagedAccountsApi.md
index e5d7a022..0961a0e2 100644
--- a/docs/ManagedAccountsApi.md
+++ b/docs/ManagedAccountsApi.md
@@ -15,7 +15,7 @@ Method | HTTP request | Description
## createManagedAccount
-> ManagedAccountResponse createManagedAccount(createManagedAccountRequest)
+> CreateManagedAccount200Response createManagedAccount(createManagedAccountRequest)
Create a new managed account.
@@ -44,7 +44,7 @@ public class Example {
ManagedAccountsApi apiInstance = new ManagedAccountsApi(defaultClient);
CreateManagedAccountRequest createManagedAccountRequest = new CreateManagedAccountRequest(); // CreateManagedAccountRequest | Parameters that define the managed account to be created
try {
- ManagedAccountResponse result = apiInstance.createManagedAccount(createManagedAccountRequest);
+ CreateManagedAccount200Response result = apiInstance.createManagedAccount(createManagedAccountRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagedAccountsApi#createManagedAccount");
@@ -66,7 +66,7 @@ Name | Type | Description | Notes
### Return type
-[**ManagedAccountResponse**](ManagedAccountResponse.md)
+[**CreateManagedAccount200Response**](CreateManagedAccount200Response.md)
### Authorization
@@ -81,13 +81,13 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with information about a single managed account. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
## disableManagedAccount
-> ManagedAccountResponse disableManagedAccount(id)
+> CreateManagedAccount200Response disableManagedAccount(id)
Disables a managed account
@@ -116,7 +116,7 @@ public class Example {
ManagedAccountsApi apiInstance = new ManagedAccountsApi(defaultClient);
String id = "id_example"; // String | Managed Account User ID
try {
- ManagedAccountResponse result = apiInstance.disableManagedAccount(id);
+ CreateManagedAccount200Response result = apiInstance.disableManagedAccount(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagedAccountsApi#disableManagedAccount");
@@ -138,7 +138,7 @@ Name | Type | Description | Notes
### Return type
-[**ManagedAccountResponse**](ManagedAccountResponse.md)
+[**CreateManagedAccount200Response**](CreateManagedAccount200Response.md)
### Authorization
@@ -153,14 +153,14 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with information about a single managed account. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
## enableManagedAccount
-> ManagedAccountResponse enableManagedAccount(id)
+> CreateManagedAccount200Response enableManagedAccount(id)
Enables a managed account
@@ -189,7 +189,7 @@ public class Example {
ManagedAccountsApi apiInstance = new ManagedAccountsApi(defaultClient);
String id = "id_example"; // String | Managed Account User ID
try {
- ManagedAccountResponse result = apiInstance.enableManagedAccount(id);
+ CreateManagedAccount200Response result = apiInstance.enableManagedAccount(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagedAccountsApi#enableManagedAccount");
@@ -211,7 +211,7 @@ Name | Type | Description | Notes
### Return type
-[**ManagedAccountResponse**](ManagedAccountResponse.md)
+[**CreateManagedAccount200Response**](CreateManagedAccount200Response.md)
### Authorization
@@ -226,14 +226,14 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with information about a single managed account. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
## listManagedAccounts
-> ListManagedAccountsResponse listManagedAccounts(pageNumber, pageSize, filterEmailContains, filterEmailEq, sort)
+> ListManagedAccounts200Response listManagedAccounts(pageNumber, pageSize, filterEmailContains, filterEmailEq, sort, includeCancelledAccounts)
Lists accounts managed by the current user.
@@ -265,8 +265,9 @@ public class Example {
String filterEmailContains = "null"; // String | If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
String filterEmailEq = "null"; // String | If present, only returns results with the email matching exactly the value given.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.email: sorts the result by the email field in ascending order. -email: sorts the result by the email field in descending order. created_at in descending order.
+ Boolean includeCancelledAccounts = false; // Boolean | Specifies if cancelled accounts should be included in the results.
try {
- ListManagedAccountsResponse result = apiInstance.listManagedAccounts(pageNumber, pageSize, filterEmailContains, filterEmailEq, sort);
+ ListManagedAccounts200Response result = apiInstance.listManagedAccounts(pageNumber, pageSize, filterEmailContains, filterEmailEq, sort, includeCancelledAccounts);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagedAccountsApi#listManagedAccounts");
@@ -289,10 +290,11 @@ Name | Type | Description | Notes
**filterEmailContains** | **String**| If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
**filterEmailEq** | **String**| If present, only returns results with the <code>email</code> matching exactly the value given. | [optional] [default to null]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>email</code>: sorts the result by the <code>email</code> field in ascending order. </li> <li> <code>-email</code>: sorts the result by the <code>email</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, email]
+ **includeCancelledAccounts** | **Boolean**| Specifies if cancelled accounts should be included in the results. | [optional] [default to false]
### Return type
-[**ListManagedAccountsResponse**](ListManagedAccountsResponse.md)
+[**ListManagedAccounts200Response**](ListManagedAccounts200Response.md)
### Authorization
@@ -307,12 +309,12 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with a list of managed accounts. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
## retrieveManagedAccount
-> ManagedAccountResponse retrieveManagedAccount(id)
+> CreateManagedAccount200Response retrieveManagedAccount(id)
Retrieve a managed account
@@ -341,7 +343,7 @@ public class Example {
ManagedAccountsApi apiInstance = new ManagedAccountsApi(defaultClient);
String id = "id_example"; // String | Managed Account User ID
try {
- ManagedAccountResponse result = apiInstance.retrieveManagedAccount(id);
+ CreateManagedAccount200Response result = apiInstance.retrieveManagedAccount(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagedAccountsApi#retrieveManagedAccount");
@@ -363,7 +365,7 @@ Name | Type | Description | Notes
### Return type
-[**ManagedAccountResponse**](ManagedAccountResponse.md)
+[**CreateManagedAccount200Response**](CreateManagedAccount200Response.md)
### Authorization
@@ -378,13 +380,13 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with information about a single managed account. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
## updateManagedAccount
-> ManagedAccountResponse updateManagedAccount(id, updateManagedAccountRequest)
+> CreateManagedAccount200Response updateManagedAccount(id, updateManagedAccountRequest)
Update a managed account
@@ -414,7 +416,7 @@ public class Example {
String id = "id_example"; // String | Managed Account User ID
UpdateManagedAccountRequest updateManagedAccountRequest = new UpdateManagedAccountRequest(); // UpdateManagedAccountRequest | Parameters that define the updates to the managed account
try {
- ManagedAccountResponse result = apiInstance.updateManagedAccount(id, updateManagedAccountRequest);
+ CreateManagedAccount200Response result = apiInstance.updateManagedAccount(id, updateManagedAccountRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ManagedAccountsApi#updateManagedAccount");
@@ -437,7 +439,7 @@ Name | Type | Description | Notes
### Return type
-[**ManagedAccountResponse**](ManagedAccountResponse.md)
+[**CreateManagedAccount200Response**](CreateManagedAccount200Response.md)
### Authorization
@@ -452,7 +454,7 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response with information about a single managed account. | - |
-| **401** | Unauthorized | - |
+| **401** | Unauthorized response. Happens when the current user is not a manager account. | - |
| **404** | Resource not found | - |
| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
diff --git a/docs/MarkCommentRead200Response.md b/docs/MarkCommentRead200Response.md
new file mode 100644
index 00000000..114bedf0
--- /dev/null
+++ b/docs/MarkCommentRead200Response.md
@@ -0,0 +1,13 @@
+
+
+# MarkCommentRead200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MarkCommentRead200ResponseData**](MarkCommentRead200ResponseData.md) | | [optional] |
+
+
+
diff --git a/docs/MarkCommentRead200ResponseData.md b/docs/MarkCommentRead200ResponseData.md
new file mode 100644
index 00000000..1490c177
--- /dev/null
+++ b/docs/MarkCommentRead200ResponseData.md
@@ -0,0 +1,40 @@
+
+
+# MarkCommentRead200ResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**body** | **String** | | [optional] |
+|**commenter** | **String** | | [optional] [readonly] |
+|**commenterType** | [**CommenterTypeEnum**](#CommenterTypeEnum) | | [optional] [readonly] |
+|**commentRecordType** | [**CommentRecordTypeEnum**](#CommentRecordTypeEnum) | | [optional] |
+|**commentRecordId** | **UUID** | | [optional] |
+|**readAt** | **String** | An ISO 8901 datetime string for when the comment was read. | [optional] [readonly] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the comment was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the comment was updated. | [optional] [readonly] |
+
+
+
+## Enum: CommenterTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ADMIN | "admin" |
+| USER | "user" |
+
+
+
+## Enum: CommentRecordTypeEnum
+
+| Name | Value |
+|---- | -----|
+| NUMBER_ORDER | "number_order" |
+| SUB_NUMBER_ORDER | "sub_number_order" |
+| NUMBER_ORDER_PHONE_NUMBER | "number_order_phone_number" |
+
+
+
diff --git a/docs/MarkMessageAsReadRequestBody.md b/docs/MarkMessageAsReadRequestBody.md
index b300b7af..74e42768 100644
--- a/docs/MarkMessageAsReadRequestBody.md
+++ b/docs/MarkMessageAsReadRequestBody.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**whatsappUserId** | **String** | The user's WhatsApp ID. |
-**status** | **String** | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**whatsappUserId** | **String** | The user's WhatsApp ID. | |
+|**status** | **String** | | |
diff --git a/docs/MdrDeleteDetailReportResponse.md b/docs/MdrDeleteDetailReportResponse.md
index 75df8ab0..9d3712de 100644
--- a/docs/MdrDeleteDetailReportResponse.md
+++ b/docs/MdrDeleteDetailReportResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrDetailReportResponse**](MdrDetailReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrDetailReportResponse**](MdrDetailReportResponse.md) | | [optional] |
diff --git a/docs/MdrDeleteUsageReportsResponse.md b/docs/MdrDeleteUsageReportsResponse.md
index fe85e5f3..cf641ae3 100644
--- a/docs/MdrDeleteUsageReportsResponse.md
+++ b/docs/MdrDeleteUsageReportsResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional] |
diff --git a/docs/MdrDetailReportResponse.md b/docs/MdrDetailReportResponse.md
index 7be9ab26..db9dab56 100644
--- a/docs/MdrDetailReportResponse.md
+++ b/docs/MdrDetailReportResponse.md
@@ -5,52 +5,52 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Identifies the resource | [optional]
-**startDate** | **OffsetDateTime** | | [optional]
-**endDate** | **OffsetDateTime** | | [optional]
-**directions** | [**List<DirectionsEnum>**](#List<DirectionsEnum>) | | [optional]
-**recordTypes** | [**List<RecordTypesEnum>**](#List<RecordTypesEnum>) | | [optional]
-**connections** | **List<Long>** | | [optional]
-**reportName** | **String** | | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | | [optional]
-**reportUrl** | **String** | | [optional]
-**filters** | [**List<Filter>**](Filter.md) | | [optional]
-**createdAt** | **OffsetDateTime** | | [optional]
-**updatedAt** | **OffsetDateTime** | | [optional]
-**profiles** | **String** | | [optional]
-**recordType** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource | [optional] |
+|**startDate** | **OffsetDateTime** | | [optional] |
+|**endDate** | **OffsetDateTime** | | [optional] |
+|**directions** | [**List<DirectionsEnum>**](#List<DirectionsEnum>) | | [optional] |
+|**recordTypes** | [**List<RecordTypesEnum>**](#List<RecordTypesEnum>) | | [optional] |
+|**connections** | **List<Long>** | | [optional] |
+|**reportName** | **String** | | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**reportUrl** | **String** | | [optional] |
+|**filters** | [**List<Filter>**](Filter.md) | | [optional] |
+|**createdAt** | **OffsetDateTime** | | [optional] |
+|**updatedAt** | **OffsetDateTime** | | [optional] |
+|**profiles** | **String** | | [optional] |
+|**recordType** | **String** | | [optional] |
## Enum: List<DirectionsEnum>
-Name | Value
----- | -----
-INBOUND | "INBOUND"
-OUTBOUND | "OUTBOUND"
+| Name | Value |
+|---- | -----|
+| INBOUND | "INBOUND" |
+| OUTBOUND | "OUTBOUND" |
## Enum: List<RecordTypesEnum>
-Name | Value
----- | -----
-INCOMPLETE | "INCOMPLETE"
-COMPLETED | "COMPLETED"
-ERRORS | "ERRORS"
+| Name | Value |
+|---- | -----|
+| INCOMPLETE | "INCOMPLETE" |
+| COMPLETED | "COMPLETED" |
+| ERRORS | "ERRORS" |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "PENDING"
-COMPLETE | "COMPLETE"
-FAILED | "FAILED"
-EXPIRED | "EXPIRED"
+| Name | Value |
+|---- | -----|
+| PENDING | "PENDING" |
+| COMPLETE | "COMPLETE" |
+| FAILED | "FAILED" |
+| EXPIRED | "EXPIRED" |
diff --git a/docs/MdrDetailResponse.md b/docs/MdrDetailResponse.md
index 91c0751f..2f0916c5 100644
--- a/docs/MdrDetailResponse.md
+++ b/docs/MdrDetailResponse.md
@@ -5,56 +5,56 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**createdAt** | **OffsetDateTime** | Message sent time | [optional]
-**profileName** | **String** | Configured profile name. New profiles can be created and configured on Telnyx portal | [optional]
-**direction** | **String** | Direction of message - inbound or outbound. | [optional]
-**parts** | **BigDecimal** | Number of parts this message has. Max number of character is 160. If message contains more characters then that it will be broken down in multiple parts | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Message status | [optional]
-**cld** | **String** | The destination number for a call, or the callee | [optional]
-**cli** | **String** | The number associated with the person initiating the call, or the caller | [optional]
-**rate** | **String** | Rate applied to the message | [optional]
-**cost** | **String** | Final cost. Cost is calculated as rate * parts | [optional]
-**currency** | [**CurrencyEnum**](#CurrencyEnum) | Currency of the rate and cost | [optional]
-**id** | **String** | Id of message detail record | [optional]
-**messageType** | [**MessageTypeEnum**](#MessageTypeEnum) | Type of message | [optional]
-**recordType** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**createdAt** | **OffsetDateTime** | Message sent time | [optional] |
+|**profileName** | **String** | Configured profile name. New profiles can be created and configured on Telnyx portal | [optional] |
+|**direction** | **String** | Direction of message - inbound or outbound. | [optional] |
+|**parts** | **BigDecimal** | Number of parts this message has. Max number of character is 160. If message contains more characters then that it will be broken down in multiple parts | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Message status | [optional] |
+|**cld** | **String** | The destination number for a call, or the callee | [optional] |
+|**cli** | **String** | The number associated with the person initiating the call, or the caller | [optional] |
+|**rate** | **String** | Rate applied to the message | [optional] |
+|**cost** | **String** | Final cost. Cost is calculated as rate * parts | [optional] |
+|**currency** | [**CurrencyEnum**](#CurrencyEnum) | Currency of the rate and cost | [optional] |
+|**id** | **String** | Id of message detail record | [optional] |
+|**messageType** | [**MessageTypeEnum**](#MessageTypeEnum) | Type of message | [optional] |
+|**recordType** | **String** | | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-GW_TIMEOUT | "GW_TIMEOUT"
-DELIVERED | "DELIVERED"
-DLR_UNCONFIRMED | "DLR_UNCONFIRMED"
-DLR_TIMEOUT | "DLR_TIMEOUT"
-RECEIVED | "RECEIVED"
-GW_REJECT | "GW_REJECT"
-FAILED | "FAILED"
+| Name | Value |
+|---- | -----|
+| GW_TIMEOUT | "GW_TIMEOUT" |
+| DELIVERED | "DELIVERED" |
+| DLR_UNCONFIRMED | "DLR_UNCONFIRMED" |
+| DLR_TIMEOUT | "DLR_TIMEOUT" |
+| RECEIVED | "RECEIVED" |
+| GW_REJECT | "GW_REJECT" |
+| FAILED | "FAILED" |
## Enum: CurrencyEnum
-Name | Value
----- | -----
-AUD | "AUD"
-CAD | "CAD"
-EUR | "EUR"
-GBP | "GBP"
-USD | "USD"
+| Name | Value |
+|---- | -----|
+| AUD | "AUD" |
+| CAD | "CAD" |
+| EUR | "EUR" |
+| GBP | "GBP" |
+| USD | "USD" |
## Enum: MessageTypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/MdrGetDetailReportByIdResponse.md b/docs/MdrGetDetailReportByIdResponse.md
index 7eb2f350..610bc80a 100644
--- a/docs/MdrGetDetailReportByIdResponse.md
+++ b/docs/MdrGetDetailReportByIdResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrDetailReportResponse**](MdrDetailReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrDetailReportResponse**](MdrDetailReportResponse.md) | | [optional] |
diff --git a/docs/MdrGetDetailReportResponse.md b/docs/MdrGetDetailReportResponse.md
index b679f22a..b6dc54e4 100644
--- a/docs/MdrGetDetailReportResponse.md
+++ b/docs/MdrGetDetailReportResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MdrDetailReportResponse>**](MdrDetailReportResponse.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MdrDetailReportResponse>**](MdrDetailReportResponse.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/MdrGetDetailResponse.md b/docs/MdrGetDetailResponse.md
index 2dbe9d56..64231473 100644
--- a/docs/MdrGetDetailResponse.md
+++ b/docs/MdrGetDetailResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MdrDetailResponse>**](MdrDetailResponse.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MdrDetailResponse>**](MdrDetailResponse.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/MdrGetSyncUsageReportResponse.md b/docs/MdrGetSyncUsageReportResponse.md
index e97af006..f0a39cbe 100644
--- a/docs/MdrGetSyncUsageReportResponse.md
+++ b/docs/MdrGetSyncUsageReportResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional] |
diff --git a/docs/MdrGetUsageReportsByIdResponse.md b/docs/MdrGetUsageReportsByIdResponse.md
index 120998d5..09cfdea7 100644
--- a/docs/MdrGetUsageReportsByIdResponse.md
+++ b/docs/MdrGetUsageReportsByIdResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional] |
diff --git a/docs/MdrGetUsageReportsResponse.md b/docs/MdrGetUsageReportsResponse.md
index cbc93e12..60ce6ddc 100644
--- a/docs/MdrGetUsageReportsResponse.md
+++ b/docs/MdrGetUsageReportsResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<MdrUsageReportResponse>**](MdrUsageReportResponse.md) | | [optional]
-**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MdrUsageReportResponse>**](MdrUsageReportResponse.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
diff --git a/docs/MdrPostDetailReportRequest.md b/docs/MdrPostDetailReportRequest.md
index 55a190ef..48330c68 100644
--- a/docs/MdrPostDetailReportRequest.md
+++ b/docs/MdrPostDetailReportRequest.md
@@ -5,36 +5,36 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startDate** | **OffsetDateTime** | |
-**endDate** | **OffsetDateTime** | |
-**directions** | [**List<DirectionsEnum>**](#List<DirectionsEnum>) | | [optional]
-**recordTypes** | [**List<RecordTypesEnum>**](#List<RecordTypesEnum>) | | [optional]
-**connections** | **List<Long>** | | [optional]
-**reportName** | **String** | | [optional]
-**includeMessageBody** | **Boolean** | | [optional]
-**filters** | [**List<Filter>**](Filter.md) | | [optional]
-**profiles** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startDate** | **OffsetDateTime** | | |
+|**endDate** | **OffsetDateTime** | | |
+|**directions** | [**List<DirectionsEnum>**](#List<DirectionsEnum>) | | [optional] |
+|**recordTypes** | [**List<RecordTypesEnum>**](#List<RecordTypesEnum>) | | [optional] |
+|**connections** | **List<Long>** | | [optional] |
+|**reportName** | **String** | | [optional] |
+|**includeMessageBody** | **Boolean** | | [optional] |
+|**filters** | [**List<Filter>**](Filter.md) | | [optional] |
+|**profiles** | **String** | | [optional] |
## Enum: List<DirectionsEnum>
-Name | Value
----- | -----
-INBOUND | "INBOUND"
-OUTBOUND | "OUTBOUND"
+| Name | Value |
+|---- | -----|
+| INBOUND | "INBOUND" |
+| OUTBOUND | "OUTBOUND" |
## Enum: List<RecordTypesEnum>
-Name | Value
----- | -----
-INCOMPLETE | "INCOMPLETE"
-COMPLETED | "COMPLETED"
-ERRORS | "ERRORS"
+| Name | Value |
+|---- | -----|
+| INCOMPLETE | "INCOMPLETE" |
+| COMPLETED | "COMPLETED" |
+| ERRORS | "ERRORS" |
diff --git a/docs/MdrPostDetailReportResponse.md b/docs/MdrPostDetailReportResponse.md
index 650bf1c0..9f43d440 100644
--- a/docs/MdrPostDetailReportResponse.md
+++ b/docs/MdrPostDetailReportResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrDetailReportResponse**](MdrDetailReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrDetailReportResponse**](MdrDetailReportResponse.md) | | [optional] |
diff --git a/docs/MdrPostUsageReportRequest.md b/docs/MdrPostUsageReportRequest.md
index c552120f..a9cfe065 100644
--- a/docs/MdrPostUsageReportRequest.md
+++ b/docs/MdrPostUsageReportRequest.md
@@ -5,22 +5,22 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startDate** | **OffsetDateTime** | |
-**endDate** | **OffsetDateTime** | |
-**aggregationType** | [**AggregationTypeEnum**](#AggregationTypeEnum) | |
-**profiles** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startDate** | **OffsetDateTime** | | |
+|**endDate** | **OffsetDateTime** | | |
+|**aggregationType** | [**AggregationTypeEnum**](#AggregationTypeEnum) | | |
+|**profiles** | **String** | | [optional] |
## Enum: AggregationTypeEnum
-Name | Value
----- | -----
-NO_AGGREGATION | "NO_AGGREGATION"
-PROFILE | "PROFILE"
-TAGS | "TAGS"
+| Name | Value |
+|---- | -----|
+| NO_AGGREGATION | "NO_AGGREGATION" |
+| PROFILE | "PROFILE" |
+| TAGS | "TAGS" |
diff --git a/docs/MdrPostUsageReportsResponse.md b/docs/MdrPostUsageReportsResponse.md
index ffe135cc..6a643112 100644
--- a/docs/MdrPostUsageReportsResponse.md
+++ b/docs/MdrPostUsageReportsResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MdrUsageReportResponse**](MdrUsageReportResponse.md) | | [optional] |
diff --git a/docs/MdrUsageRecord.md b/docs/MdrUsageRecord.md
index 30b31d53..7e9ab223 100644
--- a/docs/MdrUsageRecord.md
+++ b/docs/MdrUsageRecord.md
@@ -5,22 +5,22 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cost** | **String** | | [optional]
-**direction** | **String** | | [optional]
-**product** | **String** | | [optional]
-**connection** | **String** | | [optional]
-**received** | **String** | | [optional]
-**delivered** | **String** | | [optional]
-**currency** | **String** | | [optional]
-**parts** | **String** | | [optional]
-**sent** | **String** | | [optional]
-**profileId** | **String** | | [optional]
-**tags** | **String** | | [optional]
-**messageType** | **String** | | [optional]
-**tnType** | **String** | | [optional]
-**carrierPassthroughFee** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**cost** | **String** | | [optional] |
+|**direction** | **String** | | [optional] |
+|**product** | **String** | | [optional] |
+|**connection** | **String** | | [optional] |
+|**received** | **String** | | [optional] |
+|**delivered** | **String** | | [optional] |
+|**currency** | **String** | | [optional] |
+|**parts** | **String** | | [optional] |
+|**sent** | **String** | | [optional] |
+|**profileId** | **String** | | [optional] |
+|**tags** | **String** | | [optional] |
+|**messageType** | **String** | | [optional] |
+|**tnType** | **String** | | [optional] |
+|**carrierPassthroughFee** | **String** | | [optional] |
diff --git a/docs/MdrUsageReportResponse.md b/docs/MdrUsageReportResponse.md
index da4efbad..eac12fa0 100644
--- a/docs/MdrUsageReportResponse.md
+++ b/docs/MdrUsageReportResponse.md
@@ -5,41 +5,41 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Identifies the resource | [optional]
-**startDate** | **OffsetDateTime** | | [optional]
-**endDate** | **OffsetDateTime** | | [optional]
-**connections** | **List<Long>** | | [optional]
-**aggregationType** | [**AggregationTypeEnum**](#AggregationTypeEnum) | | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | | [optional]
-**reportUrl** | **String** | | [optional]
-**result** | [**List<MdrUsageRecord>**](MdrUsageRecord.md) | | [optional]
-**createdAt** | **OffsetDateTime** | | [optional]
-**updatedAt** | **OffsetDateTime** | | [optional]
-**profiles** | **String** | | [optional]
-**recordType** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource | [optional] |
+|**startDate** | **OffsetDateTime** | | [optional] |
+|**endDate** | **OffsetDateTime** | | [optional] |
+|**connections** | **List<Long>** | | [optional] |
+|**aggregationType** | [**AggregationTypeEnum**](#AggregationTypeEnum) | | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**reportUrl** | **String** | | [optional] |
+|**result** | [**List<MdrUsageRecord>**](MdrUsageRecord.md) | | [optional] |
+|**createdAt** | **OffsetDateTime** | | [optional] |
+|**updatedAt** | **OffsetDateTime** | | [optional] |
+|**profiles** | **String** | | [optional] |
+|**recordType** | **String** | | [optional] |
## Enum: AggregationTypeEnum
-Name | Value
----- | -----
-NO_AGGREGATION | "NO_AGGREGATION"
-PROFILE | "PROFILE"
-TAGS | "TAGS"
+| Name | Value |
+|---- | -----|
+| NO_AGGREGATION | "NO_AGGREGATION" |
+| PROFILE | "PROFILE" |
+| TAGS | "TAGS" |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "PENDING"
-COMPLETE | "COMPLETE"
-FAILED | "FAILED"
-EXPIRED | "EXPIRED"
+| Name | Value |
+|---- | -----|
+| PENDING | "PENDING" |
+| COMPLETE | "COMPLETE" |
+| FAILED | "FAILED" |
+| EXPIRED | "EXPIRED" |
diff --git a/docs/MediaFeatures.md b/docs/MediaFeatures.md
index a8391fc2..a743ac50 100644
--- a/docs/MediaFeatures.md
+++ b/docs/MediaFeatures.md
@@ -6,21 +6,21 @@ The media features settings for a phone number.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rtpAutoAdjustEnabled** | **Boolean** | When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets. | [optional]
-**mediaHandlingMode** | [**MediaHandlingModeEnum**](#MediaHandlingModeEnum) | Controls how media is handled for the phone number. default: media routed through Telnyx with transcode support. proxy: media routed through Telnyx with no transcode support. | [optional]
-**acceptAnyRtpPacketsEnabled** | **Boolean** | When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP. | [optional]
-**t38FaxGatewayEnabled** | **Boolean** | Controls whether Telnyx will accept a T.38 re-INVITE for this phone number. Note that Telnyx will not send a T.38 re-INVITE; this option only controls whether one will be accepted. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**rtpAutoAdjustEnabled** | **Boolean** | When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets. | [optional] |
+|**mediaHandlingMode** | [**MediaHandlingModeEnum**](#MediaHandlingModeEnum) | Controls how media is handled for the phone number. default: media routed through Telnyx with transcode support. proxy: media routed through Telnyx with no transcode support. | [optional] |
+|**acceptAnyRtpPacketsEnabled** | **Boolean** | When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP. | [optional] |
+|**t38FaxGatewayEnabled** | **Boolean** | Controls whether Telnyx will accept a T.38 re-INVITE for this phone number. Note that Telnyx will not send a T.38 re-INVITE; this option only controls whether one will be accepted. | [optional] |
## Enum: MediaHandlingModeEnum
-Name | Value
----- | -----
-DEFAULT | "default"
-PROXY | "proxy"
+| Name | Value |
+|---- | -----|
+| DEFAULT | "default" |
+| PROXY | "proxy" |
diff --git a/docs/MediaResource.md b/docs/MediaResource.md
index 61d96916..3751f726 100644
--- a/docs/MediaResource.md
+++ b/docs/MediaResource.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mediaName** | **String** | Uniquely identifies a media resource. | [optional]
-**expiresAt** | **String** | ISO 8601 formatted date of when the media resource will expire and be deleted. | [optional]
-**createdAt** | **String** | ISO 8601 formatted date of when the media resource was created | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date of when the media resource was last updated | [optional]
-**contentType** | **String** | Content type of the file | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mediaName** | **String** | Uniquely identifies a media resource. | [optional] |
+|**expiresAt** | **String** | ISO 8601 formatted date of when the media resource will expire and be deleted. | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date of when the media resource was created | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date of when the media resource was last updated | [optional] |
+|**contentType** | **String** | Content type of the file | [optional] |
diff --git a/docs/MediaResourceResponse.md b/docs/MediaResourceResponse.md
index 391dee3a..218834ea 100644
--- a/docs/MediaResourceResponse.md
+++ b/docs/MediaResourceResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MediaResource**](MediaResource.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MediaResource**](MediaResource.md) | | [optional] |
diff --git a/docs/MediaStorageDetailRecord.md b/docs/MediaStorageDetailRecord.md
index 5a042611..5570660d 100644
--- a/docs/MediaStorageDetailRecord.md
+++ b/docs/MediaStorageDetailRecord.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique identifier for the Media Storage Event | [optional]
-**createdAt** | **OffsetDateTime** | Event creation time | [optional]
-**assetId** | **String** | Asset id | [optional]
-**userId** | **String** | User id | [optional]
-**orgId** | **String** | Organization owner id | [optional]
-**actionType** | **String** | Type of action performed against the Media Storage API | [optional]
-**linkChannelType** | **String** | Link channel type | [optional]
-**linkChannelId** | **String** | Link channel id | [optional]
-**status** | **String** | Request status | [optional]
-**webhookId** | **String** | Webhook id | [optional]
-**rate** | **String** | Currency amount per billing unit used to calculate the Telnyx billing cost | [optional]
-**rateMeasuredIn** | **String** | Billing unit used to calculate the Telnyx billing cost | [optional]
-**cost** | **String** | Currency amount for Telnyx billing cost | [optional]
-**currency** | **String** | Telnyx account currency used to describe monetary values, including billing cost | [optional]
-**recordType** | **String** | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique identifier for the Media Storage Event | [optional] |
+|**createdAt** | **OffsetDateTime** | Event creation time | [optional] |
+|**assetId** | **String** | Asset id | [optional] |
+|**userId** | **String** | User id | [optional] |
+|**orgId** | **String** | Organization owner id | [optional] |
+|**actionType** | **String** | Type of action performed against the Media Storage API | [optional] |
+|**linkChannelType** | **String** | Link channel type | [optional] |
+|**linkChannelId** | **String** | Link channel id | [optional] |
+|**status** | **String** | Request status | [optional] |
+|**webhookId** | **String** | Webhook id | [optional] |
+|**rate** | **String** | Currency amount per billing unit used to calculate the Telnyx billing cost | [optional] |
+|**rateMeasuredIn** | **String** | Billing unit used to calculate the Telnyx billing cost | [optional] |
+|**cost** | **String** | Currency amount for Telnyx billing cost | [optional] |
+|**currency** | **String** | Telnyx account currency used to describe monetary values, including billing cost | [optional] |
+|**recordType** | **String** | | |
diff --git a/docs/Message.md b/docs/Message.md
index 3e3ffaef..b4f942ab 100644
--- a/docs/Message.md
+++ b/docs/Message.md
@@ -3,20 +3,21 @@
# Message
+
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly]
-**id** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly] |
+|**id** | **String** | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-WHATSAPP_MESSAGE_ID | "whatsapp_message_id"
+| Name | Value |
+|---- | -----|
+| WHATSAPP_MESSAGE_ID | "whatsapp_message_id" |
diff --git a/docs/MessageDetailRecord.md b/docs/MessageDetailRecord.md
index f3d06629..24ca43b5 100644
--- a/docs/MessageDetailRecord.md
+++ b/docs/MessageDetailRecord.md
@@ -5,72 +5,72 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uuid** | **String** | Unique identifier of the message | [optional]
-**userId** | **String** | Identifier of the Telnyx account who owns the message | [optional]
-**completedAt** | **OffsetDateTime** | Message completion time | [optional]
-**createdAt** | **OffsetDateTime** | Message creation time | [optional]
-**updatedAt** | **OffsetDateTime** | Message updated time | [optional]
-**sentAt** | **OffsetDateTime** | Time when the message was sent | [optional]
-**carrier** | **String** | Country-specific carrier used to send or receive the message | [optional]
-**carrierFee** | **String** | Fee charged by certain carriers in order to deliver certain message types. Telnyx passes this fee on to the customer according to our pricing table | [optional]
-**cld** | **String** | The recipient of the message (to parameter in the Messaging API) | [optional]
-**cli** | **String** | The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value | [optional]
-**countryCode** | **String** | Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format | [optional]
-**deliveryStatus** | **String** | Final webhook delivery status | [optional]
-**deliveryStatusFailoverUrl** | **String** | Failover customer-provided URL which Telnyx posts delivery status webhooks to | [optional]
-**deliveryStatusWebhookUrl** | **String** | Primary customer-provided URL which Telnyx posts delivery status webhooks to | [optional]
-**direction** | [**DirectionEnum**](#DirectionEnum) | Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise | [optional]
-**fteu** | **Boolean** | Indicates whether this is a Free-To-End-User (FTEU) short code message | [optional]
-**mcc** | **String** | Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID | [optional]
-**mnc** | **String** | Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID | [optional]
-**messageType** | [**MessageTypeEnum**](#MessageTypeEnum) | Describes the Messaging service used to send the message. Available services are: Short Message Service (SMS), Multimedia Messaging Service (MMS), and Rich Communication Services (RCS) | [optional]
-**onNet** | **Boolean** | Indicates whether both sender and recipient numbers are Telnyx-managed | [optional]
-**profileId** | **String** | Unique identifier of the Messaging Profile used to send or receive the message | [optional]
-**profileName** | **String** | Name of the Messaging Profile used to send or receive the message | [optional]
-**sourceCountryCode** | **String** | Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Final status of the message after the delivery attempt | [optional]
-**tags** | **String** | Comma-separated tags assigned to the Telnyx number associated with the message | [optional]
-**rate** | **String** | Currency amount per billing unit used to calculate the Telnyx billing cost | [optional]
-**currency** | **String** | Telnyx account currency used to describe monetary values, including billing cost | [optional]
-**cost** | **String** | Amount, in the user currency, for the Telnyx billing cost | [optional]
-**errors** | **List<String>** | Telnyx API error codes returned by the Telnyx gateway | [optional]
-**parts** | **Integer** | Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters | [optional]
-**recordType** | **String** | Identifies the record schema |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**uuid** | **String** | Unique identifier of the message | [optional] |
+|**userId** | **String** | Identifier of the Telnyx account who owns the message | [optional] |
+|**completedAt** | **OffsetDateTime** | Message completion time | [optional] |
+|**createdAt** | **OffsetDateTime** | Message creation time | [optional] |
+|**updatedAt** | **OffsetDateTime** | Message updated time | [optional] |
+|**sentAt** | **OffsetDateTime** | Time when the message was sent | [optional] |
+|**carrier** | **String** | Country-specific carrier used to send or receive the message | [optional] |
+|**carrierFee** | **String** | Fee charged by certain carriers in order to deliver certain message types. Telnyx passes this fee on to the customer according to our pricing table | [optional] |
+|**cld** | **String** | The recipient of the message (to parameter in the Messaging API) | [optional] |
+|**cli** | **String** | The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value | [optional] |
+|**countryCode** | **String** | Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format | [optional] |
+|**deliveryStatus** | **String** | Final webhook delivery status | [optional] |
+|**deliveryStatusFailoverUrl** | **String** | Failover customer-provided URL which Telnyx posts delivery status webhooks to | [optional] |
+|**deliveryStatusWebhookUrl** | **String** | Primary customer-provided URL which Telnyx posts delivery status webhooks to | [optional] |
+|**direction** | [**DirectionEnum**](#DirectionEnum) | Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise | [optional] |
+|**fteu** | **Boolean** | Indicates whether this is a Free-To-End-User (FTEU) short code message | [optional] |
+|**mcc** | **String** | Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID | [optional] |
+|**mnc** | **String** | Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID | [optional] |
+|**messageType** | [**MessageTypeEnum**](#MessageTypeEnum) | Describes the Messaging service used to send the message. Available services are: Short Message Service (SMS), Multimedia Messaging Service (MMS), and Rich Communication Services (RCS) | [optional] |
+|**onNet** | **Boolean** | Indicates whether both sender and recipient numbers are Telnyx-managed | [optional] |
+|**profileId** | **String** | Unique identifier of the Messaging Profile used to send or receive the message | [optional] |
+|**profileName** | **String** | Name of the Messaging Profile used to send or receive the message | [optional] |
+|**sourceCountryCode** | **String** | Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Final status of the message after the delivery attempt | [optional] |
+|**tags** | **String** | Comma-separated tags assigned to the Telnyx number associated with the message | [optional] |
+|**rate** | **String** | Currency amount per billing unit used to calculate the Telnyx billing cost | [optional] |
+|**currency** | **String** | Telnyx account currency used to describe monetary values, including billing cost | [optional] |
+|**cost** | **String** | Amount, in the user currency, for the Telnyx billing cost | [optional] |
+|**errors** | **List<String>** | Telnyx API error codes returned by the Telnyx gateway | [optional] |
+|**parts** | **Integer** | Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters | [optional] |
+|**recordType** | **String** | Identifies the record schema | |
## Enum: DirectionEnum
-Name | Value
----- | -----
-INBOUND | "inbound"
-OUTBOUND | "outbound"
+| Name | Value |
+|---- | -----|
+| INBOUND | "inbound" |
+| OUTBOUND | "outbound" |
## Enum: MessageTypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
-RCS | "RCS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
+| RCS | "RCS" |
## Enum: StatusEnum
-Name | Value
----- | -----
-GW_TIMEOUT | "gw_timeout"
-DELIVERED | "delivered"
-DLR_UNCONFIRMED | "dlr_unconfirmed"
-DLR_TIMEOUT | "dlr_timeout"
-RECEIVED | "received"
-GW_REJECT | "gw_reject"
-FAILED | "failed"
+| Name | Value |
+|---- | -----|
+| GW_TIMEOUT | "gw_timeout" |
+| DELIVERED | "delivered" |
+| DLR_UNCONFIRMED | "dlr_unconfirmed" |
+| DLR_TIMEOUT | "dlr_timeout" |
+| RECEIVED | "received" |
+| GW_REJECT | "gw_reject" |
+| FAILED | "failed" |
diff --git a/docs/MessageResponse.md b/docs/MessageResponse.md
index 9545620a..99c251c4 100644
--- a/docs/MessageResponse.md
+++ b/docs/MessageResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**OutboundMessagePayload**](OutboundMessagePayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**OutboundMessagePayload**](OutboundMessagePayload.md) | | [optional] |
diff --git a/docs/MessageType.md b/docs/MessageType.md
index 3017739f..fba2904a 100644
--- a/docs/MessageType.md
+++ b/docs/MessageType.md
@@ -11,8 +11,6 @@
* `DOCUMENT` (value: `"document"`)
-* `HSM` (value: `"hsm"`)
-
* `IMAGE` (value: `"image"`)
* `LOCATION` (value: `"location"`)
diff --git a/docs/MessagingFeatureSet.md b/docs/MessagingFeatureSet.md
index 0afab5b0..59bd51e8 100644
--- a/docs/MessagingFeatureSet.md
+++ b/docs/MessagingFeatureSet.md
@@ -6,11 +6,11 @@ The set of features available for a specific messaging use case (SMS or MMS). Fe
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**domesticTwoWay** | **Boolean** | Send messages to and receive messages from numbers in the same country. |
-**internationalInbound** | **Boolean** | Receive messages from numbers in other countries. |
-**internationalOutbound** | **Boolean** | Send messages to numbers in other countries. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**domesticTwoWay** | **Boolean** | Send messages to and receive messages from numbers in the same country. | |
+|**internationalInbound** | **Boolean** | Receive messages from numbers in other countries. | |
+|**internationalOutbound** | **Boolean** | Send messages to numbers in other countries. | |
diff --git a/docs/MessagingHostedNumberOrder.md b/docs/MessagingHostedNumberOrder.md
index 63c725c8..3ab5ec04 100644
--- a/docs/MessagingHostedNumberOrder.md
+++ b/docs/MessagingHostedNumberOrder.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**id** | **UUID** | Resource unique identifier. | [optional] [readonly]
-**messagingProfileId** | **String** | Automatically associate the number with this messaging profile ID when the order is complete. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | | [optional]
-**phoneNumbers** | [**List<HostedNumber>**](HostedNumber.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**id** | **UUID** | Resource unique identifier. | [optional] [readonly] |
+|**messagingProfileId** | **String** | Automatically associate the number with this messaging profile ID when the order is complete. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**phoneNumbers** | [**List<HostedNumber>**](HostedNumber.md) | | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-FAILED | "failed"
-PENDING | "pending"
-SUCCESSFUL | "successful"
+| Name | Value |
+|---- | -----|
+| FAILED | "failed" |
+| PENDING | "pending" |
+| SUCCESSFUL | "successful" |
diff --git a/docs/MessagingProfile.md b/docs/MessagingProfile.md
index 336945eb..bb0fdf2b 100644
--- a/docs/MessagingProfile.md
+++ b/docs/MessagingProfile.md
@@ -5,39 +5,39 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly]
-**id** | **UUID** | Identifies the type of resource. | [optional] [readonly]
-**name** | **String** | A user friendly name for the messaging profile. | [optional]
-**enabled** | **Boolean** | Specifies whether the messaging profile is enabled or not. | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this messaging profile will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. | [optional]
-**whitelistedDestinations** | **List<String>** | Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
-**v1Secret** | **String** | Secret used to authenticate with v1 endpoints. | [optional]
-**numberPoolSettings** | [**NumberPoolSettings**](NumberPoolSettings.md) | | [optional]
-**urlShortenerSettings** | [**UrlShortenerSettings**](UrlShortenerSettings.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] [readonly] |
+|**name** | **String** | A user friendly name for the messaging profile. | [optional] |
+|**enabled** | **Boolean** | Specifies whether the messaging profile is enabled or not. | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this messaging profile will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. | [optional] |
+|**whitelistedDestinations** | **List<String>** | Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
+|**v1Secret** | **String** | Secret used to authenticate with v1 endpoints. | [optional] |
+|**numberPoolSettings** | [**NumberPoolSettings**](NumberPoolSettings.md) | | [optional] |
+|**urlShortenerSettings** | [**UrlShortenerSettings**](UrlShortenerSettings.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-MESSAGING_PROFILE | "messaging_profile"
+| Name | Value |
+|---- | -----|
+| MESSAGING_PROFILE | "messaging_profile" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
-_2010_04_01 | "2010-04-01"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
+| _2010_04_01 | "2010-04-01" |
diff --git a/docs/MessagingProfileDetailedMetric.md b/docs/MessagingProfileDetailedMetric.md
index 29bd3f04..3ea075d0 100644
--- a/docs/MessagingProfileDetailedMetric.md
+++ b/docs/MessagingProfileDetailedMetric.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timestamp** | **String** | The timestamp of the aggregated data. | [optional] [readonly]
-**metrics** | [**List<MessagingProfileMessageTypeMetrics>**](MessagingProfileMessageTypeMetrics.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**timestamp** | **String** | The timestamp of the aggregated data. | [optional] [readonly] |
+|**metrics** | [**List<MessagingProfileMessageTypeMetrics>**](MessagingProfileMessageTypeMetrics.md) | | [optional] |
diff --git a/docs/MessagingProfileDetailedMetrics.md b/docs/MessagingProfileDetailedMetrics.md
index 68970e0e..b4956659 100644
--- a/docs/MessagingProfileDetailedMetrics.md
+++ b/docs/MessagingProfileDetailedMetrics.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**overview** | [**MessagingProfileHighLevelMetrics**](MessagingProfileHighLevelMetrics.md) | | [optional]
-**detailed** | [**List<MessagingProfileDetailedMetric>**](MessagingProfileDetailedMetric.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**overview** | [**MessagingProfileHighLevelMetrics**](MessagingProfileHighLevelMetrics.md) | | [optional] |
+|**detailed** | [**List<MessagingProfileDetailedMetric>**](MessagingProfileDetailedMetric.md) | | [optional] |
diff --git a/docs/MessagingProfileHighLevelMetrics.md b/docs/MessagingProfileHighLevelMetrics.md
index 478d64f7..41c299ec 100644
--- a/docs/MessagingProfileHighLevelMetrics.md
+++ b/docs/MessagingProfileHighLevelMetrics.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly]
-**messagingProfileId** | **UUID** | Identifies the type of resource. | [optional] [readonly]
-**phoneNumbers** | **BigDecimal** | The number of phone numbers associated with the messaging profile. | [optional] [readonly]
-**outbound** | [**MessagingProfileHighLevelMetricsOutbound**](MessagingProfileHighLevelMetricsOutbound.md) | | [optional]
-**inbound** | [**MessagingProfileHighLevelMetricsInbound**](MessagingProfileHighLevelMetricsInbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly] |
+|**messagingProfileId** | **UUID** | Identifies the type of resource. | [optional] [readonly] |
+|**phoneNumbers** | **BigDecimal** | The number of phone numbers associated with the messaging profile. | [optional] [readonly] |
+|**outbound** | [**MessagingProfileHighLevelMetricsOutbound**](MessagingProfileHighLevelMetricsOutbound.md) | | [optional] |
+|**inbound** | [**MessagingProfileHighLevelMetricsInbound**](MessagingProfileHighLevelMetricsInbound.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-MESSAGING_PROFILE_METRICS | "messaging_profile_metrics"
+| Name | Value |
+|---- | -----|
+| MESSAGING_PROFILE_METRICS | "messaging_profile_metrics" |
diff --git a/docs/MessagingProfileHighLevelMetricsInbound.md b/docs/MessagingProfileHighLevelMetricsInbound.md
index 8b2ad4d5..3eb18f82 100644
--- a/docs/MessagingProfileHighLevelMetricsInbound.md
+++ b/docs/MessagingProfileHighLevelMetricsInbound.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**received** | **BigDecimal** | The number of inbound messages received. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**received** | **BigDecimal** | The number of inbound messages received. | [optional] [readonly] |
diff --git a/docs/MessagingProfileHighLevelMetricsOutbound.md b/docs/MessagingProfileHighLevelMetricsOutbound.md
index f742d274..bf8587e9 100644
--- a/docs/MessagingProfileHighLevelMetricsOutbound.md
+++ b/docs/MessagingProfileHighLevelMetricsOutbound.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sent** | **BigDecimal** | The number of outbound messages sent. | [optional] [readonly]
-**delivered** | **BigDecimal** | The number of outbound messages successfully delivered. | [optional] [readonly]
-**errorRatio** | **BigDecimal** | The ratio of messages sent that resulted in errors. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**sent** | **BigDecimal** | The number of outbound messages sent. | [optional] [readonly] |
+|**delivered** | **BigDecimal** | The number of outbound messages successfully delivered. | [optional] [readonly] |
+|**errorRatio** | **BigDecimal** | The ratio of messages sent that resulted in errors. | [optional] [readonly] |
diff --git a/docs/MessagingProfileMessageTypeMetrics.md b/docs/MessagingProfileMessageTypeMetrics.md
index f97fb683..5d109f19 100644
--- a/docs/MessagingProfileMessageTypeMetrics.md
+++ b/docs/MessagingProfileMessageTypeMetrics.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**label** | **String** | The metric type. | [optional] [readonly]
-**sent** | **BigDecimal** | The number of outbound messages sent. | [optional] [readonly]
-**delivered** | **BigDecimal** | The number of outbound messages successfully delivered. | [optional] [readonly]
-**outboundErrorRatio** | **BigDecimal** | The ratio of outbound messages sent that resulted in errors. | [optional] [readonly]
-**received** | **BigDecimal** | The number of inbound messages received. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**label** | **String** | The metric type. | [optional] [readonly] |
+|**sent** | **BigDecimal** | The number of outbound messages sent. | [optional] [readonly] |
+|**delivered** | **BigDecimal** | The number of outbound messages successfully delivered. | [optional] [readonly] |
+|**outboundErrorRatio** | **BigDecimal** | The ratio of outbound messages sent that resulted in errors. | [optional] [readonly] |
+|**received** | **BigDecimal** | The number of inbound messages received. | [optional] [readonly] |
diff --git a/docs/MessagingProfileResponse.md b/docs/MessagingProfileResponse.md
index 5a4c6bfd..1fccd6a8 100644
--- a/docs/MessagingProfileResponse.md
+++ b/docs/MessagingProfileResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MessagingProfile**](MessagingProfile.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**MessagingProfile**](MessagingProfile.md) | | [optional] |
diff --git a/docs/MessagingUrlDomain.md b/docs/MessagingUrlDomain.md
index 57d89018..50be829c 100644
--- a/docs/MessagingUrlDomain.md
+++ b/docs/MessagingUrlDomain.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional]
-**id** | **String** | | [optional]
-**urlDomain** | **String** | | [optional]
-**useCase** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] |
+|**id** | **String** | | [optional] |
+|**urlDomain** | **String** | | [optional] |
+|**useCase** | **String** | | [optional] |
diff --git a/docs/Meta.md b/docs/Meta.md
index e416d59f..63b40fbd 100644
--- a/docs/Meta.md
+++ b/docs/Meta.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalPages** | **Integer** | | [optional]
-**totalResults** | **Integer** | | [optional]
-**pageNumber** | **Integer** | | [optional]
-**pageSize** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalPages** | **Integer** | | [optional] |
+|**totalResults** | **Integer** | | [optional] |
+|**pageNumber** | **Integer** | | [optional] |
+|**pageSize** | **Integer** | | [optional] |
diff --git a/docs/Metadata.md b/docs/Metadata.md
index 7fb632e2..85305f08 100644
--- a/docs/Metadata.md
+++ b/docs/Metadata.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalPages** | **Double** | Total number of pages based on pagination settings | [optional]
-**totalResults** | **Double** | Total number of results | [optional]
-**pageNumber** | **Double** | Current Page based on pagination settings (included when defaults are used.) | [optional]
-**pageSize** | **Double** | Number of results to return per page based on pagination settings (included when defaults are used.) | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalPages** | **Double** | Total number of pages based on pagination settings | [optional] |
+|**totalResults** | **Double** | Total number of results | [optional] |
+|**pageNumber** | **Double** | Current Page based on pagination settings (included when defaults are used.) | [optional] |
+|**pageSize** | **Double** | Number of results to return per page based on pagination settings (included when defaults are used.) | [optional] |
diff --git a/docs/MobileOperatorNetwork.md b/docs/MobileOperatorNetwork.md
index 4b999409..67f79f91 100644
--- a/docs/MobileOperatorNetwork.md
+++ b/docs/MobileOperatorNetwork.md
@@ -5,15 +5,15 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Identifies the resource. | [optional] [readonly]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**name** | **String** | The operator network name. | [optional]
-**tadig** | **String** | TADIG stands for Transferred Account Data Interchange Group. The TADIG code is a unique identifier for network operators in GSM mobile networks. | [optional]
-**countryCode** | **String** | The mobile operator two-character (ISO 3166-1 alpha-2) origin country code. | [optional]
-**mcc** | **String** | MCC stands for Mobile Country Code. It's a three decimal digit that identifies a country.<br/><br/> This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code. | [optional]
-**mnc** | **String** | MNC stands for Mobile Network Code. It's a two to three decimal digits that identify a network.<br/><br/> This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**name** | **String** | The operator network name. | [optional] |
+|**tadig** | **String** | TADIG stands for Transferred Account Data Interchange Group. The TADIG code is a unique identifier for network operators in GSM mobile networks. | [optional] |
+|**countryCode** | **String** | The mobile operator two-character (ISO 3166-1 alpha-2) origin country code. | [optional] |
+|**mcc** | **String** | MCC stands for Mobile Country Code. It's a three decimal digit that identifies a country.<br/><br/> This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code. | [optional] |
+|**mnc** | **String** | MNC stands for Mobile Network Code. It's a two to three decimal digits that identify a network.<br/><br/> This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code. | [optional] |
diff --git a/docs/MobileOperatorNetworkPreferencesRequest.md b/docs/MobileOperatorNetworkPreferencesRequest.md
index 75ccc15e..93132261 100644
--- a/docs/MobileOperatorNetworkPreferencesRequest.md
+++ b/docs/MobileOperatorNetworkPreferencesRequest.md
@@ -3,12 +3,13 @@
# MobileOperatorNetworkPreferencesRequest
+
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mobileOperatorNetworkId** | **UUID** | The mobile operator network resource identification UUID. | [optional]
-**priority** | **Integer** | It determines what is the priority of a specific operator network that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mobileOperatorNetworkId** | **UUID** | The mobile operator network resource identification UUID. | [optional] |
+|**priority** | **Integer** | It determines what is the priority of a specific operator network that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on. | [optional] |
diff --git a/docs/MobileOperatorNetworkPreferencesResponse.md b/docs/MobileOperatorNetworkPreferencesResponse.md
index 946a7db3..1c0cc147 100644
--- a/docs/MobileOperatorNetworkPreferencesResponse.md
+++ b/docs/MobileOperatorNetworkPreferencesResponse.md
@@ -3,13 +3,14 @@
# MobileOperatorNetworkPreferencesResponse
+
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mobileOperatorNetworkId** | **UUID** | The mobile operator network resource identification UUID. | [optional]
-**mobileOperatorNetworkName** | **String** | The mobile operator network resource name. | [optional]
-**priority** | **Integer** | It determines what is the priority of a specific operator network that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mobileOperatorNetworkId** | **UUID** | The mobile operator network resource identification UUID. | [optional] |
+|**mobileOperatorNetworkName** | **String** | The mobile operator network resource name. | [optional] |
+|**priority** | **Integer** | It determines what is the priority of a specific operator network that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on. | [optional] |
diff --git a/docs/MobileOperatorNetworksApi.md b/docs/MobileOperatorNetworksApi.md
index 1edb1773..7969410b 100644
--- a/docs/MobileOperatorNetworksApi.md
+++ b/docs/MobileOperatorNetworksApi.md
@@ -10,7 +10,7 @@ Method | HTTP request | Description
## mobileOperatorNetworksGet
-> SearchMobileOperatorNetworksResponse mobileOperatorNetworksGet(pageNumber, pageSize, filterNameStartsWith, filterNameContains, filterNameEndsWith, filterCountryCode, filterMcc, filterMnc, filterTadig)
+> MobileOperatorNetworksGet200Response mobileOperatorNetworksGet(pageNumber, pageSize, filterNameStartsWith, filterNameContains, filterNameEndsWith, filterCountryCode, filterMcc, filterMnc, filterTadig)
List mobile operator networks
@@ -47,7 +47,7 @@ public class Example {
String filterMnc = "410"; // String | Filter by exact MNC.
String filterTadig = "USACG"; // String | Filter by exact TADIG.
try {
- SearchMobileOperatorNetworksResponse result = apiInstance.mobileOperatorNetworksGet(pageNumber, pageSize, filterNameStartsWith, filterNameContains, filterNameEndsWith, filterCountryCode, filterMcc, filterMnc, filterTadig);
+ MobileOperatorNetworksGet200Response result = apiInstance.mobileOperatorNetworksGet(pageNumber, pageSize, filterNameStartsWith, filterNameContains, filterNameEndsWith, filterCountryCode, filterMcc, filterMnc, filterTadig);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MobileOperatorNetworksApi#mobileOperatorNetworksGet");
@@ -77,7 +77,7 @@ Name | Type | Description | Notes
### Return type
-[**SearchMobileOperatorNetworksResponse**](SearchMobileOperatorNetworksResponse.md)
+[**MobileOperatorNetworksGet200Response**](MobileOperatorNetworksGet200Response.md)
### Authorization
diff --git a/docs/MobileOperatorNetworksGet200Response.md b/docs/MobileOperatorNetworksGet200Response.md
new file mode 100644
index 00000000..8988ad36
--- /dev/null
+++ b/docs/MobileOperatorNetworksGet200Response.md
@@ -0,0 +1,14 @@
+
+
+# MobileOperatorNetworksGet200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MobileOperatorNetwork>**](MobileOperatorNetwork.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/ModelInterface.md b/docs/ModelInterface.md
new file mode 100644
index 00000000..2e20c583
--- /dev/null
+++ b/docs/ModelInterface.md
@@ -0,0 +1,15 @@
+
+
+# ModelInterface
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**networkId** | **UUID** | The id of the network associated with the interface. | [optional] |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+
+
+
diff --git a/docs/Money.md b/docs/Money.md
index 6c61d4b0..06074f48 100644
--- a/docs/Money.md
+++ b/docs/Money.md
@@ -5,22 +5,22 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **String** | | [optional]
-**currency** | [**CurrencyEnum**](#CurrencyEnum) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**amount** | **String** | | [optional] |
+|**currency** | [**CurrencyEnum**](#CurrencyEnum) | | [optional] |
## Enum: CurrencyEnum
-Name | Value
----- | -----
-AUD | "AUD"
-CAD | "CAD"
-EUR | "EUR"
-GBP | "GBP"
-USD | "USD"
+| Name | Value |
+|---- | -----|
+| AUD | "AUD" |
+| CAD | "CAD" |
+| EUR | "EUR" |
+| GBP | "GBP" |
+| USD | "USD" |
diff --git a/docs/Network.md b/docs/Network.md
new file mode 100644
index 00000000..8008611a
--- /dev/null
+++ b/docs/Network.md
@@ -0,0 +1,17 @@
+
+
+# Network
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**name** | **String** | A user specified name for the network. | [optional] |
+
+
+
diff --git a/docs/Network1.md b/docs/Network1.md
new file mode 100644
index 00000000..f0d0b5ec
--- /dev/null
+++ b/docs/Network1.md
@@ -0,0 +1,14 @@
+
+
+# Network1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**name** | **String** | A user specified name for the network. | [optional] |
+
+
+
diff --git a/docs/NetworkCreate.md b/docs/NetworkCreate.md
new file mode 100644
index 00000000..178550a1
--- /dev/null
+++ b/docs/NetworkCreate.md
@@ -0,0 +1,17 @@
+
+
+# NetworkCreate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**name** | **String** | A user specified name for the network. | |
+
+
+
diff --git a/docs/NetworkCreate200Response.md b/docs/NetworkCreate200Response.md
new file mode 100644
index 00000000..904f57a3
--- /dev/null
+++ b/docs/NetworkCreate200Response.md
@@ -0,0 +1,13 @@
+
+
+# NetworkCreate200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Network**](Network.md) | | [optional] |
+
+
+
diff --git a/docs/NetworkInterface.md b/docs/NetworkInterface.md
new file mode 100644
index 00000000..64e0dde3
--- /dev/null
+++ b/docs/NetworkInterface.md
@@ -0,0 +1,22 @@
+
+
+# NetworkInterface
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | [optional] |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**regionCode** | **String** | The region interface is deployed to. | [optional] |
+|**region** | [**RegionOutRegion**](RegionOutRegion.md) | | [optional] |
+|**type** | **String** | Identifies the type of the interface. | [optional] [readonly] |
+
+
+
diff --git a/docs/NetworkInterface1.md b/docs/NetworkInterface1.md
new file mode 100644
index 00000000..6ca0162d
--- /dev/null
+++ b/docs/NetworkInterface1.md
@@ -0,0 +1,14 @@
+
+
+# NetworkInterface1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**type** | **String** | Identifies the type of the interface. | [optional] [readonly] |
+
+
+
diff --git a/docs/NetworkInterfaceList200Response.md b/docs/NetworkInterfaceList200Response.md
new file mode 100644
index 00000000..5180cda8
--- /dev/null
+++ b/docs/NetworkInterfaceList200Response.md
@@ -0,0 +1,14 @@
+
+
+# NetworkInterfaceList200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<NetworkInterface>**](NetworkInterface.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/NetworkList200Response.md b/docs/NetworkList200Response.md
new file mode 100644
index 00000000..a657cfb0
--- /dev/null
+++ b/docs/NetworkList200Response.md
@@ -0,0 +1,14 @@
+
+
+# NetworkList200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<Network>**](Network.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/NetworksApi.md b/docs/NetworksApi.md
new file mode 100644
index 00000000..0cce79aa
--- /dev/null
+++ b/docs/NetworksApi.md
@@ -0,0 +1,461 @@
+# NetworksApi
+
+All URIs are relative to *https://api.telnyx.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**networkCreate**](NetworksApi.md#networkCreate) | **POST** /networks | Create a Network
+[**networkDelete**](NetworksApi.md#networkDelete) | **DELETE** /networks/{id} | Delete a Network
+[**networkGet**](NetworksApi.md#networkGet) | **GET** /networks/{id} | Retrieve a Network
+[**networkInterfaceList**](NetworksApi.md#networkInterfaceList) | **GET** /networks/{id}/network_interfaces | List all Interfaces for a Network.
+[**networkList**](NetworksApi.md#networkList) | **GET** /networks | List all Networks
+[**networkUpdate**](NetworksApi.md#networkUpdate) | **PATCH** /networks/{id} | Update a Network
+
+
+
+## networkCreate
+
+> NetworkCreate200Response networkCreate(networkCreate)
+
+Create a Network
+
+Create a new Network.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.NetworksApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ NetworksApi apiInstance = new NetworksApi(defaultClient);
+ NetworkCreate networkCreate = new NetworkCreate(); // NetworkCreate |
+ try {
+ NetworkCreate200Response result = apiInstance.networkCreate(networkCreate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling NetworksApi#networkCreate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **networkCreate** | [**NetworkCreate**](NetworkCreate.md)| |
+
+### Return type
+
+[**NetworkCreate200Response**](NetworkCreate200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
+| **0** | Unexpected error | - |
+
+
+## networkDelete
+
+> NetworkCreate200Response networkDelete(id)
+
+Delete a Network
+
+Delete a Network.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.NetworksApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ NetworksApi apiInstance = new NetworksApi(defaultClient);
+ UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ try {
+ NetworkCreate200Response result = apiInstance.networkDelete(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling NetworksApi#networkDelete");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Identifies the resource. |
+
+### Return type
+
+[**NetworkCreate200Response**](NetworkCreate200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## networkGet
+
+> NetworkCreate200Response networkGet(id)
+
+Retrieve a Network
+
+Retrieve a Network.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.NetworksApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ NetworksApi apiInstance = new NetworksApi(defaultClient);
+ UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ try {
+ NetworkCreate200Response result = apiInstance.networkGet(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling NetworksApi#networkGet");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Identifies the resource. |
+
+### Return type
+
+[**NetworkCreate200Response**](NetworkCreate200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## networkInterfaceList
+
+> NetworkInterfaceList200Response networkInterfaceList(id, pageNumber, pageSize, filterName, filterType, filterStatus)
+
+List all Interfaces for a Network.
+
+List all Interfaces for a Network.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.NetworksApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ NetworksApi apiInstance = new NetworksApi(defaultClient);
+ UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ Integer pageNumber = 1; // Integer | The page number to load
+ Integer pageSize = 20; // Integer | The size of the page
+ String filterName = "test interface"; // String | The interface name to filter on.
+ String filterType = "wireguard_interface"; // String | The interface type to filter on.
+ InterfaceStatus filterStatus = InterfaceStatus.fromValue("created"); // InterfaceStatus | The interface status to filter on.
+ try {
+ NetworkInterfaceList200Response result = apiInstance.networkInterfaceList(id, pageNumber, pageSize, filterName, filterType, filterStatus);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling NetworksApi#networkInterfaceList");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Identifies the resource. |
+ **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **filterName** | **String**| The interface name to filter on. | [optional]
+ **filterType** | **String**| The interface type to filter on. | [optional]
+ **filterStatus** | **InterfaceStatus**| The interface status to filter on. | [optional] [enum: created, provisioning, provisioned, deleting]
+
+### Return type
+
+[**NetworkInterfaceList200Response**](NetworkInterfaceList200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## networkList
+
+> NetworkList200Response networkList(pageNumber, pageSize, filterName)
+
+List all Networks
+
+List all Networks.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.NetworksApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ NetworksApi apiInstance = new NetworksApi(defaultClient);
+ Integer pageNumber = 1; // Integer | The page number to load
+ Integer pageSize = 20; // Integer | The size of the page
+ String filterName = "test network"; // String | The network name to filter on.
+ try {
+ NetworkList200Response result = apiInstance.networkList(pageNumber, pageSize, filterName);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling NetworksApi#networkList");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **filterName** | **String**| The network name to filter on. | [optional]
+
+### Return type
+
+[**NetworkList200Response**](NetworkList200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## networkUpdate
+
+> NetworkCreate200Response networkUpdate(id, networkCreate)
+
+Update a Network
+
+Update a Network.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.NetworksApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ NetworksApi apiInstance = new NetworksApi(defaultClient);
+ UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ NetworkCreate networkCreate = new NetworkCreate(); // NetworkCreate |
+ try {
+ NetworkCreate200Response result = apiInstance.networkUpdate(id, networkCreate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling NetworksApi#networkUpdate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Identifies the resource. |
+ **networkCreate** | [**NetworkCreate**](NetworkCreate.md)| |
+
+### Return type
+
+[**NetworkCreate200Response**](NetworkCreate200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
diff --git a/docs/NewBillingGroup.md b/docs/NewBillingGroup.md
index cf5a5316..8521227f 100644
--- a/docs/NewBillingGroup.md
+++ b/docs/NewBillingGroup.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A name for the billing group | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | A name for the billing group | [optional] |
diff --git a/docs/NewLedgerBillingGroupReport.md b/docs/NewLedgerBillingGroupReport.md
index 957c61ab..8f0ea218 100644
--- a/docs/NewLedgerBillingGroupReport.md
+++ b/docs/NewLedgerBillingGroupReport.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**year** | **Integer** | Year of the ledger billing group report | [optional]
-**month** | **Integer** | Month of the ledger billing group report | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**year** | **Integer** | Year of the ledger billing group report | [optional] |
+|**month** | **Integer** | Month of the ledger billing group report | [optional] |
diff --git a/docs/NotificationChannel.md b/docs/NotificationChannel.md
index 3baadca7..4f19e445 100644
--- a/docs/NotificationChannel.md
+++ b/docs/NotificationChannel.md
@@ -6,25 +6,25 @@ A Notification Channel
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | A UUID. | [optional] [readonly]
-**notificationProfileId** | **String** | A UUID reference to the associated Notification Profile. | [optional]
-**channelTypeId** | [**ChannelTypeIdEnum**](#ChannelTypeIdEnum) | A Channel Type ID | [optional]
-**channelDestination** | **String** | The destination associated with the channel type. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | A UUID. | [optional] [readonly] |
+|**notificationProfileId** | **String** | A UUID reference to the associated Notification Profile. | [optional] |
+|**channelTypeId** | [**ChannelTypeIdEnum**](#ChannelTypeIdEnum) | A Channel Type ID | [optional] |
+|**channelDestination** | **String** | The destination associated with the channel type. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
## Enum: ChannelTypeIdEnum
-Name | Value
----- | -----
-SMS | "sms"
-VOICE | "voice"
-EMAIL | "email"
-WEBHOOK | "webhook"
+| Name | Value |
+|---- | -----|
+| SMS | "sms" |
+| VOICE | "voice" |
+| EMAIL | "email" |
+| WEBHOOK | "webhook" |
diff --git a/docs/NotificationEvent.md b/docs/NotificationEvent.md
index 5d93a27f..f6c9f867 100644
--- a/docs/NotificationEvent.md
+++ b/docs/NotificationEvent.md
@@ -6,14 +6,14 @@ An object representing the available notifications.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | A UUID. | [optional] [readonly]
-**name** | **String** | A human readable name. | [optional]
-**notificationCategory** | **String** | | [optional]
-**enabled** | **Boolean** | | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | A UUID. | [optional] [readonly] |
+|**name** | **String** | A human readable name. | [optional] |
+|**notificationCategory** | **String** | | [optional] |
+|**enabled** | **Boolean** | | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] |
diff --git a/docs/NotificationEventCondition.md b/docs/NotificationEventCondition.md
index c75195f0..d07e5e2d 100644
--- a/docs/NotificationEventCondition.md
+++ b/docs/NotificationEventCondition.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | A UUID. | [optional] [readonly]
-**name** | **String** | | [optional]
-**description** | **String** | | [optional]
-**notificationEventId** | **String** | | [optional]
-**associatedRecordType** | [**AssociatedRecordTypeEnum**](#AssociatedRecordTypeEnum) | | [optional]
-**parameters** | [**List<NotificationEventConditionParameters>**](NotificationEventConditionParameters.md) | | [optional]
-**enabled** | **Boolean** | | [optional]
-**allowMultipleChannels** | **Boolean** | Dictates whether a notification channel id needs to be provided when creating a notficiation setting. | [optional]
-**asynchronous** | **Boolean** | Dictates whether a notification setting will take effect immediately. | [optional]
-**supportedChannels** | **List<String>** | Dictates the supported notification channel types that can be emitted. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | A UUID. | [optional] [readonly] |
+|**name** | **String** | | [optional] |
+|**description** | **String** | | [optional] |
+|**notificationEventId** | **String** | | [optional] |
+|**associatedRecordType** | [**AssociatedRecordTypeEnum**](#AssociatedRecordTypeEnum) | | [optional] |
+|**parameters** | [**List<NotificationEventConditionParametersInner>**](NotificationEventConditionParametersInner.md) | | [optional] |
+|**enabled** | **Boolean** | | [optional] |
+|**allowMultipleChannels** | **Boolean** | Dictates whether a notification channel id needs to be provided when creating a notficiation setting. | [optional] |
+|**asynchronous** | **Boolean** | Dictates whether a notification setting will take effect immediately. | [optional] |
+|**supportedChannels** | **List<String>** | Dictates the supported notification channel types that can be emitted. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] |
## Enum: AssociatedRecordTypeEnum
-Name | Value
----- | -----
-ACCOUNT | "account"
-PHONE_NUMBER | "phone_number"
+| Name | Value |
+|---- | -----|
+| ACCOUNT | "account" |
+| PHONE_NUMBER | "phone_number" |
diff --git a/docs/NotificationEventConditionParametersInner.md b/docs/NotificationEventConditionParametersInner.md
new file mode 100644
index 00000000..ab3f49a6
--- /dev/null
+++ b/docs/NotificationEventConditionParametersInner.md
@@ -0,0 +1,15 @@
+
+
+# NotificationEventConditionParametersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**optional** | **Boolean** | | [optional] |
+|**dataType** | **String** | | [optional] |
+
+
+
diff --git a/docs/NotificationProfile.md b/docs/NotificationProfile.md
index 02dd13a1..68b02539 100644
--- a/docs/NotificationProfile.md
+++ b/docs/NotificationProfile.md
@@ -6,12 +6,12 @@ A Collection of Notification Channels
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | A UUID. | [optional] [readonly]
-**name** | **String** | A human readable name. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | A UUID. | [optional] [readonly] |
+|**name** | **String** | A human readable name. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
diff --git a/docs/NotificationSetting.md b/docs/NotificationSetting.md
index f4e030ae..03416cb4 100644
--- a/docs/NotificationSetting.md
+++ b/docs/NotificationSetting.md
@@ -5,33 +5,33 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | A UUID. | [optional] [readonly]
-**notificationEventConditionId** | **String** | A UUID reference to the associated Notification Event Condition. | [optional]
-**notificationProfileId** | **String** | A UUID reference to the associated Notification Profile. | [optional]
-**associatedRecordType** | **String** | | [optional] [readonly]
-**associatedRecordTypeValue** | **String** | | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | Most preferences apply immediately; however, other may needs to propagate. | [optional] [readonly]
-**notificationChannelId** | **String** | A UUID reference to the associated Notification Channel. | [optional]
-**parameters** | [**List<NotificationSettingParameters>**](NotificationSettingParameters.md) | | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | A UUID. | [optional] [readonly] |
+|**notificationEventConditionId** | **String** | A UUID reference to the associated Notification Event Condition. | [optional] |
+|**notificationProfileId** | **String** | A UUID reference to the associated Notification Profile. | [optional] |
+|**associatedRecordType** | **String** | | [optional] [readonly] |
+|**associatedRecordTypeValue** | **String** | | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | Most preferences apply immediately; however, other may needs to propagate. | [optional] [readonly] |
+|**notificationChannelId** | **String** | A UUID reference to the associated Notification Channel. | [optional] |
+|**parameters** | [**List<NotificationSettingParametersInner>**](NotificationSettingParametersInner.md) | | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-ENABLED | "enabled"
-ENABLE_RECEIVED | "enable-received"
-ENABLE_PENDING | "enable-pending"
-ENABLE_SUBMTITED | "enable-submtited"
-DELETE_RECEIVED | "delete-received"
-DELETE_PENDING | "delete-pending"
-DELETE_SUBMITTED | "delete-submitted"
-DELETED | "deleted"
+| Name | Value |
+|---- | -----|
+| ENABLED | "enabled" |
+| ENABLE_RECEIVED | "enable-received" |
+| ENABLE_PENDING | "enable-pending" |
+| ENABLE_SUBMTITED | "enable-submtited" |
+| DELETE_RECEIVED | "delete-received" |
+| DELETE_PENDING | "delete-pending" |
+| DELETE_SUBMITTED | "delete-submitted" |
+| DELETED | "deleted" |
diff --git a/docs/NotificationSettingParametersInner.md b/docs/NotificationSettingParametersInner.md
new file mode 100644
index 00000000..9d4bf878
--- /dev/null
+++ b/docs/NotificationSettingParametersInner.md
@@ -0,0 +1,14 @@
+
+
+# NotificationSettingParametersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**value** | **String** | | [optional] |
+
+
+
diff --git a/docs/NotificationsApi.md b/docs/NotificationsApi.md
index 9de8d358..b9ac552d 100644
--- a/docs/NotificationsApi.md
+++ b/docs/NotificationsApi.md
@@ -25,7 +25,7 @@ Method | HTTP request | Description
## createNotificationChannels
-> CreateNotificationChannel createNotificationChannels(notificationChannel)
+> CreateNotificationChannels200Response createNotificationChannels(notificationChannel)
Create a notification channel
@@ -54,7 +54,7 @@ public class Example {
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
NotificationChannel notificationChannel = new NotificationChannel(); // NotificationChannel | Add a Notification Channel
try {
- CreateNotificationChannel result = apiInstance.createNotificationChannels(notificationChannel);
+ CreateNotificationChannels200Response result = apiInstance.createNotificationChannels(notificationChannel);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#createNotificationChannels");
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
### Return type
-[**CreateNotificationChannel**](CreateNotificationChannel.md)
+[**CreateNotificationChannels200Response**](CreateNotificationChannels200Response.md)
### Authorization
@@ -96,7 +96,7 @@ Name | Type | Description | Notes
## createNotificationProfile
-> CreateNotificationProfile createNotificationProfile(notificationProfile)
+> CreateNotificationProfile200Response createNotificationProfile(notificationProfile)
Create a notification profile
@@ -125,7 +125,7 @@ public class Example {
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
NotificationProfile notificationProfile = new NotificationProfile(); // NotificationProfile | Add a Notification Profile
try {
- CreateNotificationProfile result = apiInstance.createNotificationProfile(notificationProfile);
+ CreateNotificationProfile200Response result = apiInstance.createNotificationProfile(notificationProfile);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#createNotificationProfile");
@@ -147,7 +147,7 @@ Name | Type | Description | Notes
### Return type
-[**CreateNotificationProfile**](CreateNotificationProfile.md)
+[**CreateNotificationProfile200Response**](CreateNotificationProfile200Response.md)
### Authorization
@@ -167,7 +167,7 @@ Name | Type | Description | Notes
## createNotificationSetting
-> CreateNotificationSetting createNotificationSetting(notificationSetting)
+> CreateNotificationSetting200Response createNotificationSetting(notificationSetting)
Add a Notification Setting
@@ -196,7 +196,7 @@ public class Example {
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
NotificationSetting notificationSetting = new NotificationSetting(); // NotificationSetting |
try {
- CreateNotificationSetting result = apiInstance.createNotificationSetting(notificationSetting);
+ CreateNotificationSetting200Response result = apiInstance.createNotificationSetting(notificationSetting);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#createNotificationSetting");
@@ -218,7 +218,7 @@ Name | Type | Description | Notes
### Return type
-[**CreateNotificationSetting**](CreateNotificationSetting.md)
+[**CreateNotificationSetting200Response**](CreateNotificationSetting200Response.md)
### Authorization
@@ -239,7 +239,7 @@ Name | Type | Description | Notes
## deleteNotificationChannel
-> DeleteNotificationChannel deleteNotificationChannel(id)
+> CreateNotificationChannels200Response deleteNotificationChannel(id)
Delete a notification channel
@@ -267,9 +267,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
try {
- DeleteNotificationChannel result = apiInstance.deleteNotificationChannel(id);
+ CreateNotificationChannels200Response result = apiInstance.deleteNotificationChannel(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#deleteNotificationChannel");
@@ -287,11 +287,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
### Return type
-[**DeleteNotificationChannel**](DeleteNotificationChannel.md)
+[**CreateNotificationChannels200Response**](CreateNotificationChannels200Response.md)
### Authorization
@@ -311,7 +311,7 @@ Name | Type | Description | Notes
## deleteNotificationProfile
-> DeleteNotificationProfiles deleteNotificationProfile(id)
+> CreateNotificationProfile200Response deleteNotificationProfile(id)
Delete a notification profile
@@ -339,9 +339,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
try {
- DeleteNotificationProfiles result = apiInstance.deleteNotificationProfile(id);
+ CreateNotificationProfile200Response result = apiInstance.deleteNotificationProfile(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#deleteNotificationProfile");
@@ -359,11 +359,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
### Return type
-[**DeleteNotificationProfiles**](DeleteNotificationProfiles.md)
+[**CreateNotificationProfile200Response**](CreateNotificationProfile200Response.md)
### Authorization
@@ -383,7 +383,7 @@ Name | Type | Description | Notes
## deleteNotificationSetting
-> DeleteNotificationSetting deleteNotificationSetting(id)
+> CreateNotificationSetting200Response deleteNotificationSetting(id)
Delete a notification setting
@@ -411,9 +411,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
try {
- DeleteNotificationSetting result = apiInstance.deleteNotificationSetting(id);
+ CreateNotificationSetting200Response result = apiInstance.deleteNotificationSetting(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#deleteNotificationSetting");
@@ -431,11 +431,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
### Return type
-[**DeleteNotificationSetting**](DeleteNotificationSetting.md)
+[**CreateNotificationSetting200Response**](CreateNotificationSetting200Response.md)
### Authorization
@@ -456,7 +456,7 @@ Name | Type | Description | Notes
## findNotificationsEvents
-> ListNotificationEvents findNotificationsEvents(pageNumber, pageSize)
+> FindNotificationsEvents200Response findNotificationsEvents(pageNumber, pageSize)
List all Notifications Events
@@ -486,7 +486,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListNotificationEvents result = apiInstance.findNotificationsEvents(pageNumber, pageSize);
+ FindNotificationsEvents200Response result = apiInstance.findNotificationsEvents(pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#findNotificationsEvents");
@@ -509,7 +509,7 @@ Name | Type | Description | Notes
### Return type
-[**ListNotificationEvents**](ListNotificationEvents.md)
+[**FindNotificationsEvents200Response**](FindNotificationsEvents200Response.md)
### Authorization
@@ -529,7 +529,7 @@ Name | Type | Description | Notes
## findNotificationsEventsConditions
-> ListNotificationEvenConditions findNotificationsEventsConditions(pageNumber, pageSize, filterAssociatedRecordTypeEq)
+> FindNotificationsEventsConditions200Response findNotificationsEventsConditions(pageNumber, pageSize, filterAssociatedRecordTypeEq)
List all Notifications Events Conditions
@@ -560,7 +560,7 @@ public class Example {
Integer pageSize = 20; // Integer | The size of the page
String filterAssociatedRecordTypeEq = "account"; // String | Filter by the associated record type
try {
- ListNotificationEvenConditions result = apiInstance.findNotificationsEventsConditions(pageNumber, pageSize, filterAssociatedRecordTypeEq);
+ FindNotificationsEventsConditions200Response result = apiInstance.findNotificationsEventsConditions(pageNumber, pageSize, filterAssociatedRecordTypeEq);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#findNotificationsEventsConditions");
@@ -584,7 +584,7 @@ Name | Type | Description | Notes
### Return type
-[**ListNotificationEvenConditions**](ListNotificationEvenConditions.md)
+[**FindNotificationsEventsConditions200Response**](FindNotificationsEventsConditions200Response.md)
### Authorization
@@ -604,7 +604,7 @@ Name | Type | Description | Notes
## findNotificationsProfiles
-> ListNotificationProfiles findNotificationsProfiles(pageNumber, pageSize)
+> FindNotificationsProfiles200Response findNotificationsProfiles(pageNumber, pageSize)
List all Notifications Profiles
@@ -634,7 +634,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListNotificationProfiles result = apiInstance.findNotificationsProfiles(pageNumber, pageSize);
+ FindNotificationsProfiles200Response result = apiInstance.findNotificationsProfiles(pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#findNotificationsProfiles");
@@ -657,7 +657,7 @@ Name | Type | Description | Notes
### Return type
-[**ListNotificationProfiles**](ListNotificationProfiles.md)
+[**FindNotificationsProfiles200Response**](FindNotificationsProfiles200Response.md)
### Authorization
@@ -677,7 +677,7 @@ Name | Type | Description | Notes
## listNotificationChannels
-> ListNotificationChannels listNotificationChannels(pageNumber, pageSize, filterChannelTypeIdEq)
+> ListNotificationChannels200Response listNotificationChannels(pageNumber, pageSize, filterChannelTypeIdEq)
List notification channels
@@ -708,7 +708,7 @@ public class Example {
Integer pageSize = 20; // Integer | The size of the page
String filterChannelTypeIdEq = "webhook"; // String | Filter by the id of a channel type
try {
- ListNotificationChannels result = apiInstance.listNotificationChannels(pageNumber, pageSize, filterChannelTypeIdEq);
+ ListNotificationChannels200Response result = apiInstance.listNotificationChannels(pageNumber, pageSize, filterChannelTypeIdEq);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#listNotificationChannels");
@@ -732,7 +732,7 @@ Name | Type | Description | Notes
### Return type
-[**ListNotificationChannels**](ListNotificationChannels.md)
+[**ListNotificationChannels200Response**](ListNotificationChannels200Response.md)
### Authorization
@@ -752,7 +752,7 @@ Name | Type | Description | Notes
## listNotificationSettings
-> ListNotificationSettings listNotificationSettings(pageNumber, pageSize, filterNotificationProfileIdEq, filterNotificationChannelEq, filterNotificationEventConditionIdEq, filterAssociatedRecordTypeEq, filterStatusEq)
+> ListNotificationSettings200Response listNotificationSettings(pageNumber, pageSize, filterNotificationProfileIdEq, filterNotificationChannelEq, filterNotificationEventConditionIdEq, filterAssociatedRecordTypeEq, filterStatusEq)
List notification settings
@@ -787,7 +787,7 @@ public class Example {
String filterAssociatedRecordTypeEq = "account"; // String | Filter by the associated record type
String filterStatusEq = "enabled"; // String | The status of a notification setting
try {
- ListNotificationSettings result = apiInstance.listNotificationSettings(pageNumber, pageSize, filterNotificationProfileIdEq, filterNotificationChannelEq, filterNotificationEventConditionIdEq, filterAssociatedRecordTypeEq, filterStatusEq);
+ ListNotificationSettings200Response result = apiInstance.listNotificationSettings(pageNumber, pageSize, filterNotificationProfileIdEq, filterNotificationChannelEq, filterNotificationEventConditionIdEq, filterAssociatedRecordTypeEq, filterStatusEq);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#listNotificationSettings");
@@ -815,7 +815,7 @@ Name | Type | Description | Notes
### Return type
-[**ListNotificationSettings**](ListNotificationSettings.md)
+[**ListNotificationSettings200Response**](ListNotificationSettings200Response.md)
### Authorization
@@ -835,7 +835,7 @@ Name | Type | Description | Notes
## retrieveNotificationChannel
-> RetrieveNotificationChannel retrieveNotificationChannel(id)
+> CreateNotificationChannels200Response retrieveNotificationChannel(id)
Retrieve a notification channel
@@ -863,9 +863,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
try {
- RetrieveNotificationChannel result = apiInstance.retrieveNotificationChannel(id);
+ CreateNotificationChannels200Response result = apiInstance.retrieveNotificationChannel(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#retrieveNotificationChannel");
@@ -883,11 +883,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
### Return type
-[**RetrieveNotificationChannel**](RetrieveNotificationChannel.md)
+[**CreateNotificationChannels200Response**](CreateNotificationChannels200Response.md)
### Authorization
@@ -907,7 +907,7 @@ Name | Type | Description | Notes
## retrieveNotificationProfile
-> RetrieveNotificationProfile retrieveNotificationProfile(id)
+> CreateNotificationProfile200Response retrieveNotificationProfile(id)
Retrieve a notification profile
@@ -935,9 +935,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
try {
- RetrieveNotificationProfile result = apiInstance.retrieveNotificationProfile(id);
+ CreateNotificationProfile200Response result = apiInstance.retrieveNotificationProfile(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#retrieveNotificationProfile");
@@ -955,11 +955,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
### Return type
-[**RetrieveNotificationProfile**](RetrieveNotificationProfile.md)
+[**CreateNotificationProfile200Response**](CreateNotificationProfile200Response.md)
### Authorization
@@ -979,7 +979,7 @@ Name | Type | Description | Notes
## retrieveNotificationSetting
-> RetrieveNotificationSetting retrieveNotificationSetting(id)
+> CreateNotificationSetting200Response retrieveNotificationSetting(id)
Retrieve a notification setting
@@ -1007,9 +1007,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
try {
- RetrieveNotificationSetting result = apiInstance.retrieveNotificationSetting(id);
+ CreateNotificationSetting200Response result = apiInstance.retrieveNotificationSetting(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#retrieveNotificationSetting");
@@ -1027,11 +1027,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
### Return type
-[**RetrieveNotificationSetting**](RetrieveNotificationSetting.md)
+[**CreateNotificationSetting200Response**](CreateNotificationSetting200Response.md)
### Authorization
@@ -1051,7 +1051,7 @@ Name | Type | Description | Notes
## updateNotificationChannel
-> UpdateNotificationChannel updateNotificationChannel(id, notificationChannel)
+> CreateNotificationChannels200Response updateNotificationChannel(id, notificationChannel)
Update a notification channel
@@ -1079,10 +1079,10 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
NotificationChannel notificationChannel = new NotificationChannel(); // NotificationChannel | Update notification channel object
try {
- UpdateNotificationChannel result = apiInstance.updateNotificationChannel(id, notificationChannel);
+ CreateNotificationChannels200Response result = apiInstance.updateNotificationChannel(id, notificationChannel);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#updateNotificationChannel");
@@ -1100,12 +1100,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
**notificationChannel** | [**NotificationChannel**](NotificationChannel.md)| Update notification channel object |
### Return type
-[**UpdateNotificationChannel**](UpdateNotificationChannel.md)
+[**CreateNotificationChannels200Response**](CreateNotificationChannels200Response.md)
### Authorization
@@ -1125,7 +1125,7 @@ Name | Type | Description | Notes
## updateNotificationProfile
-> UpdateNotificationProfile updateNotificationProfile(id, notificationProfile)
+> CreateNotificationProfile200Response updateNotificationProfile(id, notificationProfile)
Update a notification profile
@@ -1153,10 +1153,10 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
NotificationsApi apiInstance = new NotificationsApi(defaultClient);
- UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ UUID id = UUID.randomUUID(); // UUID | The id of the resource.
NotificationProfile notificationProfile = new NotificationProfile(); // NotificationProfile | Update notification profile object
try {
- UpdateNotificationProfile result = apiInstance.updateNotificationProfile(id, notificationProfile);
+ CreateNotificationProfile200Response result = apiInstance.updateNotificationProfile(id, notificationProfile);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NotificationsApi#updateNotificationProfile");
@@ -1174,12 +1174,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **UUID**| Identifies the resource. |
+ **id** | **UUID**| The id of the resource. |
**notificationProfile** | [**NotificationProfile**](NotificationProfile.md)| Update notification profile object |
### Return type
-[**UpdateNotificationProfile**](UpdateNotificationProfile.md)
+[**CreateNotificationProfile200Response**](CreateNotificationProfile200Response.md)
### Authorization
diff --git a/docs/NumberBackgroundJobsApi.md b/docs/NumberBackgroundJobsApi.md
index 6c06309e..ee6ca8f1 100644
--- a/docs/NumberBackgroundJobsApi.md
+++ b/docs/NumberBackgroundJobsApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
## createPhoneNumbersJobDeletePhoneNumbers
-> CreatePhoneNumbersJobDeletePhoneNumbers createPhoneNumbersJobDeletePhoneNumbers().phoneNumbersJobDeletePhoneNumbersRequest(phoneNumbersJobDeletePhoneNumbersRequest).execute();
+> PhoneNumbersJobDeletePhoneNumbers createPhoneNumbersJobDeletePhoneNumbers().phoneNumbersJobDeletePhoneNumbersRequest(phoneNumbersJobDeletePhoneNumbersRequest).execute();
Delete a batch of numbers
@@ -43,7 +43,7 @@ public class Example {
NumberBackgroundJobsApi apiInstance = new NumberBackgroundJobsApi(defaultClient);
PhoneNumbersJobDeletePhoneNumbersRequest phoneNumbersJobDeletePhoneNumbersRequest = new PhoneNumbersJobDeletePhoneNumbersRequest(); // PhoneNumbersJobDeletePhoneNumbersRequest |
try {
- CreatePhoneNumbersJobDeletePhoneNumbers result = api.createPhoneNumbersJobDeletePhoneNumbers()
+ PhoneNumbersJobDeletePhoneNumbers result = api.createPhoneNumbersJobDeletePhoneNumbers()
.phoneNumbersJobDeletePhoneNumbersRequest(phoneNumbersJobDeletePhoneNumbersRequest)
.execute();
System.out.println(result);
@@ -67,7 +67,7 @@ Name | Type | Description | Notes
### Return type
-[**CreatePhoneNumbersJobDeletePhoneNumbers**](CreatePhoneNumbersJobDeletePhoneNumbers.md)
+[**PhoneNumbersJobDeletePhoneNumbers**](PhoneNumbersJobDeletePhoneNumbers.md)
### Authorization
@@ -87,7 +87,7 @@ Name | Type | Description | Notes
## createPhoneNumbersJobUpdateEmergencySettings
-> CreatePhoneNumbersEnableEmergency createPhoneNumbersJobUpdateEmergencySettings(phoneNumbersJobUpdateEmergencySettingsRequest)
+> PhoneNumbersEnableEmergency createPhoneNumbersJobUpdateEmergencySettings(phoneNumbersJobUpdateEmergencySettingsRequest)
Update the emergency settings from a batch of numbers
@@ -116,7 +116,7 @@ public class Example {
NumberBackgroundJobsApi apiInstance = new NumberBackgroundJobsApi(defaultClient);
PhoneNumbersJobUpdateEmergencySettingsRequest phoneNumbersJobUpdateEmergencySettingsRequest = new PhoneNumbersJobUpdateEmergencySettingsRequest(); // PhoneNumbersJobUpdateEmergencySettingsRequest |
try {
- CreatePhoneNumbersEnableEmergency result = apiInstance.createPhoneNumbersJobUpdateEmergencySettings(phoneNumbersJobUpdateEmergencySettingsRequest);
+ PhoneNumbersEnableEmergency result = apiInstance.createPhoneNumbersJobUpdateEmergencySettings(phoneNumbersJobUpdateEmergencySettingsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberBackgroundJobsApi#createPhoneNumbersJobUpdateEmergencySettings");
@@ -138,7 +138,7 @@ Name | Type | Description | Notes
### Return type
-[**CreatePhoneNumbersEnableEmergency**](CreatePhoneNumbersEnableEmergency.md)
+[**PhoneNumbersEnableEmergency**](PhoneNumbersEnableEmergency.md)
### Authorization
@@ -311,7 +311,7 @@ Name | Type | Description | Notes
## retrievePhoneNumbersJob
-> RetrievePhoneNumbersJob retrievePhoneNumbersJob(id).execute();
+> PhoneNumbersJob retrievePhoneNumbersJob(id).execute();
Retrieve a phone numbers job
@@ -338,7 +338,7 @@ public class Example {
NumberBackgroundJobsApi apiInstance = new NumberBackgroundJobsApi(defaultClient);
String id = "id_example"; // String | Identifies the Phone Numbers Job.
try {
- RetrievePhoneNumbersJob result = api.retrievePhoneNumbersJob(id)
+ PhoneNumbersJob result = api.retrievePhoneNumbersJob(id)
.execute();
System.out.println(result);
} catch (ApiException e) {
@@ -361,7 +361,7 @@ Name | Type | Description | Notes
### Return type
-[**RetrievePhoneNumbersJob**](RetrievePhoneNumbersJob.md)
+[**PhoneNumbersJob**](PhoneNumbersJob.md)
### Authorization
diff --git a/docs/NumberBlockOrder.md b/docs/NumberBlockOrder.md
index 1568f21e..868b2d94 100644
--- a/docs/NumberBlockOrder.md
+++ b/docs/NumberBlockOrder.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**startingNumber** | **String** | Starting phone number block | [optional]
-**range** | **Integer** | The phone number range included in the block. | [optional]
-**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly]
-**connectionId** | **String** | Identifies the connection associated to all numbers in the phone number block. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated to all numbers in the phone number block. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly]
-**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**startingNumber** | **String** | Starting phone number block | [optional] |
+|**range** | **Integer** | The phone number range included in the block. | [optional] |
+|**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly] |
+|**connectionId** | **String** | Identifies the connection associated to all numbers in the phone number block. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated to all numbers in the phone number block. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/NumberBlockOrderResponse.md b/docs/NumberBlockOrderResponse.md
index 0e4f0df8..10849edc 100644
--- a/docs/NumberBlockOrderResponse.md
+++ b/docs/NumberBlockOrderResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberBlockOrder**](NumberBlockOrder.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberBlockOrder**](NumberBlockOrder.md) | | [optional] |
diff --git a/docs/NumberBlocksBackgroundJobsApi.md b/docs/NumberBlocksBackgroundJobsApi.md
index c958fe61..5447b264 100644
--- a/docs/NumberBlocksBackgroundJobsApi.md
+++ b/docs/NumberBlocksBackgroundJobsApi.md
@@ -168,7 +168,7 @@ Name | Type | Description | Notes
## retrievePhoneNumberBlocksJob
-> RetrievePhoneNumberBlocksJob retrievePhoneNumberBlocksJob(id).execute();
+> PhoneNumberBlocksJob retrievePhoneNumberBlocksJob(id).execute();
Retrieves a phone number blocks job
@@ -195,7 +195,7 @@ public class Example {
NumberBlocksBackgroundJobsApi apiInstance = new NumberBlocksBackgroundJobsApi(defaultClient);
String id = "id_example"; // String | Identifies the Phone Number Blocks Job.
try {
- RetrievePhoneNumberBlocksJob result = api.retrievePhoneNumberBlocksJob(id)
+ PhoneNumberBlocksJob result = api.retrievePhoneNumberBlocksJob(id)
.execute();
System.out.println(result);
} catch (ApiException e) {
@@ -218,7 +218,7 @@ Name | Type | Description | Notes
### Return type
-[**RetrievePhoneNumberBlocksJob**](RetrievePhoneNumberBlocksJob.md)
+[**PhoneNumberBlocksJob**](PhoneNumberBlocksJob.md)
### Authorization
diff --git a/docs/NumberConfigurationsApi.md b/docs/NumberConfigurationsApi.md
index 067f7368..c0b24090 100644
--- a/docs/NumberConfigurationsApi.md
+++ b/docs/NumberConfigurationsApi.md
@@ -89,7 +89,7 @@ Name | Type | Description | Notes
## enableEmergencyPhoneNumber
-> CreatePhoneNumberEmergencyEnable enableEmergencyPhoneNumber(id, phoneNumberEnableEmergencyRequest)
+> PhoneNumberEnableEmergency enableEmergencyPhoneNumber(id, phoneNumberEnableEmergencyRequest)
Enable emergency for a phone number
@@ -117,7 +117,7 @@ public class Example {
String id = "1293384261075731499"; // String | Identifies the resource.
PhoneNumberEnableEmergencyRequest phoneNumberEnableEmergencyRequest = new PhoneNumberEnableEmergencyRequest(); // PhoneNumberEnableEmergencyRequest |
try {
- CreatePhoneNumberEmergencyEnable result = apiInstance.enableEmergencyPhoneNumber(id, phoneNumberEnableEmergencyRequest);
+ PhoneNumberEnableEmergency result = apiInstance.enableEmergencyPhoneNumber(id, phoneNumberEnableEmergencyRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberConfigurationsApi#enableEmergencyPhoneNumber");
@@ -140,7 +140,7 @@ Name | Type | Description | Notes
### Return type
-[**CreatePhoneNumberEmergencyEnable**](CreatePhoneNumberEmergencyEnable.md)
+[**PhoneNumberEnableEmergency**](PhoneNumberEnableEmergency.md)
### Authorization
diff --git a/docs/NumberHealthMetrics.md b/docs/NumberHealthMetrics.md
index 91dbacb8..013f4b54 100644
--- a/docs/NumberHealthMetrics.md
+++ b/docs/NumberHealthMetrics.md
@@ -6,12 +6,12 @@ High level health metrics about the number and it's messaging sending patterns.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messageCount** | **Integer** | The number of messages analyzed for the health metrics. |
-**inboundOutboundRatio** | **Float** | The ratio of messages received to the number of messages sent. |
-**successRatio** | **Float** | The ratio of messages sucessfully delivered to the number of messages attempted. |
-**spamRatio** | **Float** | The ratio of messages blocked for spam to the number of messages attempted. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messageCount** | **Integer** | The number of messages analyzed for the health metrics. | |
+|**inboundOutboundRatio** | **Float** | The ratio of messages received to the number of messages sent. | |
+|**successRatio** | **Float** | The ratio of messages sucessfully delivered to the number of messages attempted. | |
+|**spamRatio** | **Float** | The ratio of messages blocked for spam to the number of messages attempted. | |
diff --git a/docs/NumberLookupRecord.md b/docs/NumberLookupRecord.md
index f307018d..7fbb6dc6 100644
--- a/docs/NumberLookupRecord.md
+++ b/docs/NumberLookupRecord.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | Identifies the type of record | [optional]
-**countryCode** | **String** | Region code that matches the specific country calling code | [optional]
-**nationalFormat** | **String** | Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found | [optional]
-**phoneNumber** | **String** | E164-formatted phone number | [optional]
-**fraud** | **String** | Unused | [optional]
-**carrier** | [**Carrier**](Carrier.md) | | [optional]
-**callerName** | [**CallerName**](CallerName.md) | | [optional]
-**portability** | [**Portability**](Portability.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of record | [optional] |
+|**countryCode** | **String** | Region code that matches the specific country calling code | [optional] |
+|**nationalFormat** | **String** | Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found | [optional] |
+|**phoneNumber** | **String** | E164-formatted phone number | [optional] |
+|**fraud** | **String** | Unused | [optional] |
+|**carrier** | [**Carrier**](Carrier.md) | | [optional] |
+|**callerName** | [**CallerName**](CallerName.md) | | [optional] |
+|**portability** | [**Portability**](Portability.md) | | [optional] |
diff --git a/docs/NumberLookupResponse.md b/docs/NumberLookupResponse.md
index b4eba126..e2af2d58 100644
--- a/docs/NumberLookupResponse.md
+++ b/docs/NumberLookupResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberLookupRecord**](NumberLookupRecord.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberLookupRecord**](NumberLookupRecord.md) | | [optional] |
diff --git a/docs/NumberOrder.md b/docs/NumberOrder.md
index 32127269..7c8f5e02 100644
--- a/docs/NumberOrder.md
+++ b/docs/NumberOrder.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly]
-**subNumberOrderIds** | **List<String>** | | [optional]
-**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly]
-**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly] |
+|**subNumberOrderIds** | **List<String>** | | [optional] |
+|**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/NumberOrderBlockEvent.md b/docs/NumberOrderBlockEvent.md
index c2852efc..d37aeaf4 100644
--- a/docs/NumberOrderBlockEvent.md
+++ b/docs/NumberOrderBlockEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberBlockOrder**](NumberBlockOrder.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberBlockOrder**](NumberBlockOrder.md) | | [optional] |
diff --git a/docs/NumberOrderDocument.md b/docs/NumberOrderDocument.md
index ba1daf34..60e82527 100644
--- a/docs/NumberOrderDocument.md
+++ b/docs/NumberOrderDocument.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**fileId** | **String** | The id of the file to associate as a number order document. | [optional]
-**requirementsId** | **String** | Unique id for a requirement. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**requirementType** | [**RequirementTypeEnum**](#RequirementTypeEnum) | | [optional] [readonly]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order document was uploaded. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**fileId** | **String** | The id of the file to associate as a number order document. | [optional] |
+|**requirementsId** | **String** | Unique id for a requirement. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**requirementType** | [**RequirementTypeEnum**](#RequirementTypeEnum) | | [optional] [readonly] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order document was uploaded. | [optional] [readonly] |
## Enum: RequirementTypeEnum
-Name | Value
----- | -----
-ADDRESS_PROOF | "address_proof"
-IDENTIFICATION | "identification"
-REG_FORM | "reg_form"
+| Name | Value |
+|---- | -----|
+| ADDRESS_PROOF | "address_proof" |
+| IDENTIFICATION | "identification" |
+| REG_FORM | "reg_form" |
diff --git a/docs/NumberOrderDocumentResponse.md b/docs/NumberOrderDocumentResponse.md
index 8db575d4..f7fc4840 100644
--- a/docs/NumberOrderDocumentResponse.md
+++ b/docs/NumberOrderDocumentResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberOrderDocument**](NumberOrderDocument.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberOrderDocument**](NumberOrderDocument.md) | | [optional] |
diff --git a/docs/NumberOrderPhoneNumber.md b/docs/NumberOrderPhoneNumber.md
index 1949ca99..38180ca3 100644
--- a/docs/NumberOrderPhoneNumber.md
+++ b/docs/NumberOrderPhoneNumber.md
@@ -5,41 +5,41 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumber** | **String** | | [optional]
-**orderRequestId** | **UUID** | | [optional]
-**subNumberOrderId** | **UUID** | | [optional]
-**countryCode** | **String** | | [optional]
-**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | | [optional]
-**regulatoryRequirements** | [**List<PhoneNumberRegulatoryRequirement>**](PhoneNumberRegulatoryRequirement.md) | | [optional]
-**requirementsMet** | **Boolean** | True if all requirements are met for a phone number, false otherwise. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the phone number in the order. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumber** | **String** | | [optional] |
+|**orderRequestId** | **UUID** | | [optional] |
+|**subNumberOrderId** | **UUID** | | [optional] |
+|**countryCode** | **String** | | [optional] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | | [optional] |
+|**regulatoryRequirements** | [**List<PhoneNumberRegulatoryRequirement>**](PhoneNumberRegulatoryRequirement.md) | | [optional] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for a phone number, false otherwise. | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the phone number in the order. | [optional] [readonly] |
## Enum: PhoneNumberTypeEnum
-Name | Value
----- | -----
-LOCAL | "local"
-TOLL_FREE | "toll_free"
-MOBILE | "mobile"
-NATIONAL | "national"
-SHARED_COST | "shared_cost"
-LANDLINE | "landline"
+| Name | Value |
+|---- | -----|
+| LOCAL | "local" |
+| TOLL_FREE | "toll_free" |
+| MOBILE | "mobile" |
+| NATIONAL | "national" |
+| SHARED_COST | "shared_cost" |
+| LANDLINE | "landline" |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/NumberOrderPhoneNumberResponse.md b/docs/NumberOrderPhoneNumberResponse.md
index 8fb67de7..23adf289 100644
--- a/docs/NumberOrderPhoneNumberResponse.md
+++ b/docs/NumberOrderPhoneNumberResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberOrderPhoneNumber**](NumberOrderPhoneNumber.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberOrderPhoneNumber**](NumberOrderPhoneNumber.md) | | [optional] |
diff --git a/docs/NumberOrderResponse.md b/docs/NumberOrderResponse.md
index 0ec184af..ad6fd406 100644
--- a/docs/NumberOrderResponse.md
+++ b/docs/NumberOrderResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberOrderWithPhoneNumbers**](NumberOrderWithPhoneNumbers.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberOrderWithPhoneNumbers**](NumberOrderWithPhoneNumbers.md) | | [optional] |
diff --git a/docs/NumberOrderWithPhoneNumbers.md b/docs/NumberOrderWithPhoneNumbers.md
index e7769c67..652f6ec0 100644
--- a/docs/NumberOrderWithPhoneNumbers.md
+++ b/docs/NumberOrderWithPhoneNumbers.md
@@ -5,31 +5,31 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly]
-**subNumberOrderIds** | **List<String>** | | [optional]
-**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly]
-**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly]
-**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly] |
+|**subNumberOrderIds** | **List<String>** | | [optional] |
+|**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly] |
+|**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/NumberOrderWithPhoneNumbersAllOf.md b/docs/NumberOrderWithPhoneNumbersAllOf.md
index 976d0661..a60524d5 100644
--- a/docs/NumberOrderWithPhoneNumbersAllOf.md
+++ b/docs/NumberOrderWithPhoneNumbersAllOf.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional] |
diff --git a/docs/NumberOrdered.md b/docs/NumberOrdered.md
index 2ae0270c..249a2b05 100644
--- a/docs/NumberOrdered.md
+++ b/docs/NumberOrdered.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**eventType** | **String** | The type of event being delivered. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**payload** | [**NumberOrder**](NumberOrder.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**eventType** | **String** | The type of event being delivered. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**payload** | [**NumberOrder**](NumberOrder.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
diff --git a/docs/NumberOrderedEvent.md b/docs/NumberOrderedEvent.md
index b625c5c3..959e2fe2 100644
--- a/docs/NumberOrderedEvent.md
+++ b/docs/NumberOrderedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberOrdered**](NumberOrdered.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberOrdered**](NumberOrdered.md) | | [optional] |
diff --git a/docs/NumberOrdersApi.md b/docs/NumberOrdersApi.md
index fea33f0a..6a641ba1 100644
--- a/docs/NumberOrdersApi.md
+++ b/docs/NumberOrdersApi.md
@@ -24,7 +24,7 @@ Method | HTTP request | Description
## createComment
-> CommentResponse createComment(comment)
+> CreateComment200Response createComment(comment)
Create a comment
@@ -51,7 +51,7 @@ public class Example {
NumberOrdersApi apiInstance = new NumberOrdersApi(defaultClient);
Comment comment = new Comment(); // Comment |
try {
- CommentResponse result = apiInstance.createComment(comment);
+ CreateComment200Response result = apiInstance.createComment(comment);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberOrdersApi#createComment");
@@ -73,7 +73,7 @@ Name | Type | Description | Notes
### Return type
-[**CommentResponse**](CommentResponse.md)
+[**CreateComment200Response**](CreateComment200Response.md)
### Authorization
@@ -164,7 +164,7 @@ Name | Type | Description | Notes
## listComments
-> ListCommentsResponse listComments(filterCommentRecordType, filterCommentRecordId)
+> ListComments200Response listComments(filterCommentRecordType, filterCommentRecordId)
Retrieve all comments
@@ -192,7 +192,7 @@ public class Example {
String filterCommentRecordType = "sub_number_order"; // String | Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number
String filterCommentRecordId = "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"; // String | ID of the record the comments relate to
try {
- ListCommentsResponse result = apiInstance.listComments(filterCommentRecordType, filterCommentRecordId);
+ ListComments200Response result = apiInstance.listComments(filterCommentRecordType, filterCommentRecordId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberOrdersApi#listComments");
@@ -215,7 +215,7 @@ Name | Type | Description | Notes
### Return type
-[**ListCommentsResponse**](ListCommentsResponse.md)
+[**ListComments200Response**](ListComments200Response.md)
### Authorization
@@ -329,7 +329,7 @@ Name | Type | Description | Notes
## listRegulartoryRequirements
-> ListRegulatoryRequirements listRegulartoryRequirements(filterPhoneNumber)
+> ListRegulartoryRequirements200Response listRegulartoryRequirements(filterPhoneNumber)
Retrieve regulartory requirements
@@ -356,7 +356,7 @@ public class Example {
NumberOrdersApi apiInstance = new NumberOrdersApi(defaultClient);
String filterPhoneNumber = "+41215470622,+41215470633"; // String | Record type phone number/ phone numbers
try {
- ListRegulatoryRequirements result = apiInstance.listRegulartoryRequirements(filterPhoneNumber);
+ ListRegulartoryRequirements200Response result = apiInstance.listRegulartoryRequirements(filterPhoneNumber);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberOrdersApi#listRegulartoryRequirements");
@@ -378,7 +378,7 @@ Name | Type | Description | Notes
### Return type
-[**ListRegulatoryRequirements**](ListRegulatoryRequirements.md)
+[**ListRegulartoryRequirements200Response**](ListRegulartoryRequirements200Response.md)
### Authorization
@@ -484,7 +484,7 @@ Name | Type | Description | Notes
## markCommentRead
-> ReadCommentResponse markCommentRead(id)
+> MarkCommentRead200Response markCommentRead(id)
Mark a comment as read
@@ -511,7 +511,7 @@ public class Example {
NumberOrdersApi apiInstance = new NumberOrdersApi(defaultClient);
String id = "id_example"; // String | The comment ID.
try {
- ReadCommentResponse result = apiInstance.markCommentRead(id);
+ MarkCommentRead200Response result = apiInstance.markCommentRead(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberOrdersApi#markCommentRead");
@@ -533,7 +533,7 @@ Name | Type | Description | Notes
### Return type
-[**ReadCommentResponse**](ReadCommentResponse.md)
+[**MarkCommentRead200Response**](MarkCommentRead200Response.md)
### Authorization
@@ -553,7 +553,7 @@ Name | Type | Description | Notes
## retrieveComment
-> CommentResponse retrieveComment(id)
+> CreateComment200Response retrieveComment(id)
Retrieve a comment
@@ -580,7 +580,7 @@ public class Example {
NumberOrdersApi apiInstance = new NumberOrdersApi(defaultClient);
String id = "id_example"; // String | The comment ID.
try {
- CommentResponse result = apiInstance.retrieveComment(id);
+ CreateComment200Response result = apiInstance.retrieveComment(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberOrdersApi#retrieveComment");
@@ -602,7 +602,7 @@ Name | Type | Description | Notes
### Return type
-[**CommentResponse**](CommentResponse.md)
+[**CreateComment200Response**](CreateComment200Response.md)
### Authorization
diff --git a/docs/NumberPoolSettings.md b/docs/NumberPoolSettings.md
index d91c803b..ef17b65c 100644
--- a/docs/NumberPoolSettings.md
+++ b/docs/NumberPoolSettings.md
@@ -6,13 +6,13 @@ Number Pool allows you to send messages from a pool of numbers of different type
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tollFreeWeight** | **BigDecimal** | Defines the probability weight for a Toll Free number to be selected when sending a message. The higher the weight the higher the probability. The sum of the weights for all number types does not necessarily need to add to 100. Weight must be a non-negative number, and when equal to zero it will remove the number type from the pool. |
-**longCodeWeight** | **BigDecimal** | Defines the probability weight for a Long Code number to be selected when sending a message. The higher the weight the higher the probability. The sum of the weights for all number types does not necessarily need to add to 100. Weight must be a non-negative number, and when equal to zero it will remove the number type from the pool. |
-**skipUnhealthy** | **Boolean** | If set to true all unhealthy numbers will be automatically excluded from the pool. Health metrics per number are calculated on a regular basis, taking into account the deliverability rate and the amount of messages marked as spam by upstream carriers. Numbers with a deliverability rate below 25% or spam ratio over 75% will be considered unhealthy. |
-**stickySender** | **Boolean** | If set to true, Number Pool will try to choose the same sending number for all messages to a particular recipient. If the sending number becomes unhealthy and `skip_unhealthy` is set to true, a new number will be chosen. | [optional]
-**geomatch** | **Boolean** | If set to true, Number Pool will try to choose a sending number with the same area code as the destination number. If there are no such numbers available, a nunber with a different area code will be chosen. Currently only NANP numbers are supported. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**tollFreeWeight** | **BigDecimal** | Defines the probability weight for a Toll Free number to be selected when sending a message. The higher the weight the higher the probability. The sum of the weights for all number types does not necessarily need to add to 100. Weight must be a non-negative number, and when equal to zero it will remove the number type from the pool. | |
+|**longCodeWeight** | **BigDecimal** | Defines the probability weight for a Long Code number to be selected when sending a message. The higher the weight the higher the probability. The sum of the weights for all number types does not necessarily need to add to 100. Weight must be a non-negative number, and when equal to zero it will remove the number type from the pool. | |
+|**skipUnhealthy** | **Boolean** | If set to true all unhealthy numbers will be automatically excluded from the pool. Health metrics per number are calculated on a regular basis, taking into account the deliverability rate and the amount of messages marked as spam by upstream carriers. Numbers with a deliverability rate below 25% or spam ratio over 75% will be considered unhealthy. | |
+|**stickySender** | **Boolean** | If set to true, Number Pool will try to choose the same sending number for all messages to a particular recipient. If the sending number becomes unhealthy and `skip_unhealthy` is set to true, a new number will be chosen. | [optional] |
+|**geomatch** | **Boolean** | If set to true, Number Pool will try to choose a sending number with the same area code as the destination number. If there are no such numbers available, a nunber with a different area code will be chosen. Currently only NANP numbers are supported. | [optional] |
diff --git a/docs/NumberPortoutApi.md b/docs/NumberPortoutApi.md
index dacc32f9..16f22b28 100644
--- a/docs/NumberPortoutApi.md
+++ b/docs/NumberPortoutApi.md
@@ -16,7 +16,7 @@ Method | HTTP request | Description
## findPortoutComments
-> ListPortoutComments findPortoutComments(id)
+> FindPortoutComments200Response findPortoutComments(id)
List all comments for a portout request
@@ -46,7 +46,7 @@ public class Example {
NumberPortoutApi apiInstance = new NumberPortoutApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Portout id
try {
- ListPortoutComments result = apiInstance.findPortoutComments(id);
+ FindPortoutComments200Response result = apiInstance.findPortoutComments(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#findPortoutComments");
@@ -68,7 +68,7 @@ Name | Type | Description | Notes
### Return type
-[**ListPortoutComments**](ListPortoutComments.md)
+[**FindPortoutComments200Response**](FindPortoutComments200Response.md)
### Authorization
@@ -90,7 +90,7 @@ Name | Type | Description | Notes
## findPortoutRequest
-> PortoutResponse findPortoutRequest(id)
+> FindPortoutRequest200Response findPortoutRequest(id)
Get a portout request
@@ -120,7 +120,7 @@ public class Example {
NumberPortoutApi apiInstance = new NumberPortoutApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Portout id
try {
- PortoutResponse result = apiInstance.findPortoutRequest(id);
+ FindPortoutRequest200Response result = apiInstance.findPortoutRequest(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#findPortoutRequest");
@@ -142,7 +142,7 @@ Name | Type | Description | Notes
### Return type
-[**PortoutResponse**](PortoutResponse.md)
+[**FindPortoutRequest200Response**](FindPortoutRequest200Response.md)
### Authorization
@@ -164,7 +164,7 @@ Name | Type | Description | Notes
## getPortRequestSupportingDocuments
-> PortOutListSupportingDocumentsResponse getPortRequestSupportingDocuments(id)
+> GetPortRequestSupportingDocuments201Response getPortRequestSupportingDocuments(id)
List supporting documents on a portout request
@@ -194,7 +194,7 @@ public class Example {
NumberPortoutApi apiInstance = new NumberPortoutApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Portout id
try {
- PortOutListSupportingDocumentsResponse result = apiInstance.getPortRequestSupportingDocuments(id);
+ GetPortRequestSupportingDocuments201Response result = apiInstance.getPortRequestSupportingDocuments(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#getPortRequestSupportingDocuments");
@@ -216,7 +216,7 @@ Name | Type | Description | Notes
### Return type
-[**PortOutListSupportingDocumentsResponse**](PortOutListSupportingDocumentsResponse.md)
+[**GetPortRequestSupportingDocuments201Response**](GetPortRequestSupportingDocuments201Response.md)
### Authorization
@@ -237,7 +237,7 @@ Name | Type | Description | Notes
## listPortoutRequest
-> ListPortoutResponse listPortoutRequest(filterCarrierName, filterSpid, filterStatus, pageNumber, pageSize)
+> ListPortoutRequest200Response listPortoutRequest(filterCarrierName, filterSpid, filterStatus, pageNumber, pageSize)
List portout requests
@@ -270,7 +270,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListPortoutResponse result = apiInstance.listPortoutRequest(filterCarrierName, filterSpid, filterStatus, pageNumber, pageSize);
+ ListPortoutRequest200Response result = apiInstance.listPortoutRequest(filterCarrierName, filterSpid, filterStatus, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#listPortoutRequest");
@@ -296,7 +296,7 @@ Name | Type | Description | Notes
### Return type
-[**ListPortoutResponse**](ListPortoutResponse.md)
+[**ListPortoutRequest200Response**](ListPortoutRequest200Response.md)
### Authorization
@@ -318,7 +318,7 @@ Name | Type | Description | Notes
## postPortRequestComment
-> PortoutCommentResposne postPortRequestComment(id, createCommentPortoutRequest)
+> PostPortRequestComment201Response postPortRequestComment(id, postPortRequestCommentRequest)
Create a comment on a portout request
@@ -347,9 +347,9 @@ public class Example {
NumberPortoutApi apiInstance = new NumberPortoutApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Portout id
- CreateCommentPortoutRequest createCommentPortoutRequest = new CreateCommentPortoutRequest(); // CreateCommentPortoutRequest |
+ PostPortRequestCommentRequest postPortRequestCommentRequest = new PostPortRequestCommentRequest(); // PostPortRequestCommentRequest |
try {
- PortoutCommentResposne result = apiInstance.postPortRequestComment(id, createCommentPortoutRequest);
+ PostPortRequestComment201Response result = apiInstance.postPortRequestComment(id, postPortRequestCommentRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#postPortRequestComment");
@@ -368,11 +368,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| Portout id |
- **createCommentPortoutRequest** | [**CreateCommentPortoutRequest**](CreateCommentPortoutRequest.md)| |
+ **postPortRequestCommentRequest** | [**PostPortRequestCommentRequest**](PostPortRequestCommentRequest.md)| |
### Return type
-[**PortoutCommentResposne**](PortoutCommentResposne.md)
+[**PostPortRequestComment201Response**](PostPortRequestComment201Response.md)
### Authorization
@@ -394,7 +394,7 @@ Name | Type | Description | Notes
## postPortRequestSupportingDocuments
-> CreatePortOutSupportingDocumentsResponse postPortRequestSupportingDocuments(id, createPortingSupportingDocsRequest)
+> GetPortRequestSupportingDocuments201Response postPortRequestSupportingDocuments(id, postPortRequestSupportingDocumentsRequest)
Create a list of supporting documents on a portout request
@@ -423,9 +423,9 @@ public class Example {
NumberPortoutApi apiInstance = new NumberPortoutApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Portout id
- CreatePortingSupportingDocsRequest createPortingSupportingDocsRequest = new CreatePortingSupportingDocsRequest(); // CreatePortingSupportingDocsRequest |
+ PostPortRequestSupportingDocumentsRequest postPortRequestSupportingDocumentsRequest = new PostPortRequestSupportingDocumentsRequest(); // PostPortRequestSupportingDocumentsRequest |
try {
- CreatePortOutSupportingDocumentsResponse result = apiInstance.postPortRequestSupportingDocuments(id, createPortingSupportingDocsRequest);
+ GetPortRequestSupportingDocuments201Response result = apiInstance.postPortRequestSupportingDocuments(id, postPortRequestSupportingDocumentsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#postPortRequestSupportingDocuments");
@@ -444,11 +444,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| Portout id |
- **createPortingSupportingDocsRequest** | [**CreatePortingSupportingDocsRequest**](CreatePortingSupportingDocsRequest.md)| |
+ **postPortRequestSupportingDocumentsRequest** | [**PostPortRequestSupportingDocumentsRequest**](PostPortRequestSupportingDocumentsRequest.md)| |
### Return type
-[**CreatePortOutSupportingDocumentsResponse**](CreatePortOutSupportingDocumentsResponse.md)
+[**GetPortRequestSupportingDocuments201Response**](GetPortRequestSupportingDocuments201Response.md)
### Authorization
@@ -470,7 +470,7 @@ Name | Type | Description | Notes
## updatePortoutRequest
-> PortoutResponse updatePortoutRequest(id, status, updatePortoutStatusRequest)
+> FindPortoutRequest200Response updatePortoutRequest(id, status, updatePortoutRequestRequest)
Update Status
@@ -500,9 +500,9 @@ public class Example {
NumberPortoutApi apiInstance = new NumberPortoutApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Portout id
String status = "authorized"; // String | Updated portout status
- UpdatePortoutStatusRequest updatePortoutStatusRequest = new UpdatePortoutStatusRequest(); // UpdatePortoutStatusRequest |
+ UpdatePortoutRequestRequest updatePortoutRequestRequest = new UpdatePortoutRequestRequest(); // UpdatePortoutRequestRequest |
try {
- PortoutResponse result = apiInstance.updatePortoutRequest(id, status, updatePortoutStatusRequest);
+ FindPortoutRequest200Response result = apiInstance.updatePortoutRequest(id, status, updatePortoutRequestRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NumberPortoutApi#updatePortoutRequest");
@@ -522,11 +522,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| Portout id |
**status** | **String**| Updated portout status | [enum: authorized, rejected-pending]
- **updatePortoutStatusRequest** | [**UpdatePortoutStatusRequest**](UpdatePortoutStatusRequest.md)| |
+ **updatePortoutRequestRequest** | [**UpdatePortoutRequestRequest**](UpdatePortoutRequestRequest.md)| |
### Return type
-[**PortoutResponse**](PortoutResponse.md)
+[**FindPortoutRequest200Response**](FindPortoutRequest200Response.md)
### Authorization
diff --git a/docs/NumberReservation.md b/docs/NumberReservation.md
index 08a8bfd2..1282304d 100644
--- a/docs/NumberReservation.md
+++ b/docs/NumberReservation.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumbers** | [**List<ReservedPhoneNumber>**](ReservedPhoneNumber.md) | | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the entire reservation. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the numbers reservation was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number reservation was updated. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumbers** | [**List<ReservedPhoneNumber>**](ReservedPhoneNumber.md) | | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the entire reservation. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the numbers reservation was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number reservation was updated. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/NumberReservationResponse.md b/docs/NumberReservationResponse.md
index a7d06f2d..3c73ab4e 100644
--- a/docs/NumberReservationResponse.md
+++ b/docs/NumberReservationResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**NumberReservation**](NumberReservation.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NumberReservation**](NumberReservation.md) | | [optional] |
diff --git a/docs/OTAUpdateGET200Response.md b/docs/OTAUpdateGET200Response.md
new file mode 100644
index 00000000..f97d4d01
--- /dev/null
+++ b/docs/OTAUpdateGET200Response.md
@@ -0,0 +1,13 @@
+
+
+# OTAUpdateGET200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CompleteOTAUpdate**](CompleteOTAUpdate.md) | | [optional] |
+
+
+
diff --git a/docs/OTAUpdatesList200Response.md b/docs/OTAUpdatesList200Response.md
new file mode 100644
index 00000000..a5a295eb
--- /dev/null
+++ b/docs/OTAUpdatesList200Response.md
@@ -0,0 +1,14 @@
+
+
+# OTAUpdatesList200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<SimplifiedOTAUpdate>**](SimplifiedOTAUpdate.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/Organization.md b/docs/Organization.md
index 4c461008..34467f45 100644
--- a/docs/Organization.md
+++ b/docs/Organization.md
@@ -6,11 +6,11 @@ Contact organization information
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**company** | **String** | Name of the contact's company |
-**department** | **String** | Name of the contact's department | [optional]
-**title** | **String** | Contact's business title | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**company** | **String** | Name of the contact's company | |
+|**department** | **String** | Name of the contact's department | [optional] |
+|**title** | **String** | Contact's business title | [optional] |
diff --git a/docs/OtaUpdatesApi.md b/docs/OtaUpdatesApi.md
index f1308f3a..361fbd23 100644
--- a/docs/OtaUpdatesApi.md
+++ b/docs/OtaUpdatesApi.md
@@ -11,7 +11,7 @@ Method | HTTP request | Description
## oTAUpdateGET
-> OTAUpdateResponse oTAUpdateGET(id)
+> OTAUpdateGET200Response oTAUpdateGET(id)
Get OTA update
@@ -41,7 +41,7 @@ public class Example {
OtaUpdatesApi apiInstance = new OtaUpdatesApi(defaultClient);
UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
try {
- OTAUpdateResponse result = apiInstance.oTAUpdateGET(id);
+ OTAUpdateGET200Response result = apiInstance.oTAUpdateGET(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OtaUpdatesApi#oTAUpdateGET");
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
### Return type
-[**OTAUpdateResponse**](OTAUpdateResponse.md)
+[**OTAUpdateGET200Response**](OTAUpdateGET200Response.md)
### Authorization
@@ -83,7 +83,7 @@ Name | Type | Description | Notes
## oTAUpdatesList
-> SearchOTAUpdateResponse oTAUpdatesList(pageNumber, pageSize, filterStatus, filterSimCardId, filterType)
+> OTAUpdatesList200Response oTAUpdatesList(pageNumber, pageSize, filterStatus, filterSimCardId, filterType)
List OTA updates
@@ -114,7 +114,7 @@ public class Example {
String filterSimCardId = "filterSimCardId_example"; // String | The SIM card identification UUID.
String filterType = "sim_card_network_preferences"; // String | Filter by type.
try {
- SearchOTAUpdateResponse result = apiInstance.oTAUpdatesList(pageNumber, pageSize, filterStatus, filterSimCardId, filterType);
+ OTAUpdatesList200Response result = apiInstance.oTAUpdatesList(pageNumber, pageSize, filterStatus, filterSimCardId, filterType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OtaUpdatesApi#oTAUpdatesList");
@@ -140,7 +140,7 @@ Name | Type | Description | Notes
### Return type
-[**SearchOTAUpdateResponse**](SearchOTAUpdateResponse.md)
+[**OTAUpdatesList200Response**](OTAUpdatesList200Response.md)
### Authorization
diff --git a/docs/OutboundCallRecording.md b/docs/OutboundCallRecording.md
index 0aa341ac..30d40853 100644
--- a/docs/OutboundCallRecording.md
+++ b/docs/OutboundCallRecording.md
@@ -5,40 +5,40 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callRecordingType** | [**CallRecordingTypeEnum**](#CallRecordingTypeEnum) | Specifies which calls are recorded. | [optional]
-**callRecordingCallerPhoneNumbers** | **List<String>** | When call_recording_type is 'by_caller_phone_number', only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format. | [optional]
-**callRecordingChannels** | [**CallRecordingChannelsEnum**](#CallRecordingChannelsEnum) | When using 'dual' channels, the final audio file will be a stereo recording with the first leg on channel A, and the rest on channel B. | [optional]
-**callRecordingFormat** | [**CallRecordingFormatEnum**](#CallRecordingFormatEnum) | The audio file format for calls being recorded. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callRecordingType** | [**CallRecordingTypeEnum**](#CallRecordingTypeEnum) | Specifies which calls are recorded. | [optional] |
+|**callRecordingCallerPhoneNumbers** | **List<String>** | When call_recording_type is 'by_caller_phone_number', only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format. | [optional] |
+|**callRecordingChannels** | [**CallRecordingChannelsEnum**](#CallRecordingChannelsEnum) | When using 'dual' channels, the final audio file will be a stereo recording with the first leg on channel A, and the rest on channel B. | [optional] |
+|**callRecordingFormat** | [**CallRecordingFormatEnum**](#CallRecordingFormatEnum) | The audio file format for calls being recorded. | [optional] |
## Enum: CallRecordingTypeEnum
-Name | Value
----- | -----
-ALL | "all"
-NONE | "none"
-BY_CALLER_PHONE_NUMBER | "by_caller_phone_number"
+| Name | Value |
+|---- | -----|
+| ALL | "all" |
+| NONE | "none" |
+| BY_CALLER_PHONE_NUMBER | "by_caller_phone_number" |
## Enum: CallRecordingChannelsEnum
-Name | Value
----- | -----
-SINGLE | "single"
-DUAL | "dual"
+| Name | Value |
+|---- | -----|
+| SINGLE | "single" |
+| DUAL | "dual" |
## Enum: CallRecordingFormatEnum
-Name | Value
----- | -----
-WAV | "wav"
-MP3 | "mp3"
+| Name | Value |
+|---- | -----|
+| WAV | "wav" |
+| MP3 | "mp3" |
diff --git a/docs/OutboundIp.md b/docs/OutboundIp.md
index e6b47718..8b75b605 100644
--- a/docs/OutboundIp.md
+++ b/docs/OutboundIp.md
@@ -5,52 +5,52 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callParkingEnabled** | **Boolean** | Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next. | [optional]
-**aniOverride** | **String** | Set a phone number as the ani_override value to override caller id number on outbound calls. | [optional]
-**aniOverrideType** | [**AniOverrideTypeEnum**](#AniOverrideTypeEnum) | Specifies when we apply your ani_override setting. Only applies when ani_override is not blank. | [optional]
-**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional]
-**instantRingbackEnabled** | **Boolean** | When set, ringback will not wait for indication before sending ringback tone to calling party. | [optional]
-**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional]
-**localization** | **String** | A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default. | [optional]
-**t38ReinviteSource** | [**T38ReinviteSourceEnum**](#T38ReinviteSourceEnum) | This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite. | [optional]
-**techPrefix** | **String** | Numerical chars only, exactly 4 characters. | [optional]
-**ipAuthenticationMethod** | [**IpAuthenticationMethodEnum**](#IpAuthenticationMethodEnum) | | [optional]
-**ipAuthenticationToken** | **String** | | [optional]
-**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callParkingEnabled** | **Boolean** | Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next. | [optional] |
+|**aniOverride** | **String** | Set a phone number as the ani_override value to override caller id number on outbound calls. | [optional] |
+|**aniOverrideType** | [**AniOverrideTypeEnum**](#AniOverrideTypeEnum) | Specifies when we apply your ani_override setting. Only applies when ani_override is not blank. | [optional] |
+|**channelLimit** | **Integer** | When set, this will limit the total number of outbound calls to phone numbers associated with this connection. | [optional] |
+|**instantRingbackEnabled** | **Boolean** | When set, ringback will not wait for indication before sending ringback tone to calling party. | [optional] |
+|**generateRingbackTone** | **Boolean** | Generate ringback tone through 183 session progress message with early media. | [optional] |
+|**localization** | **String** | A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default. | [optional] |
+|**t38ReinviteSource** | [**T38ReinviteSourceEnum**](#T38ReinviteSourceEnum) | This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite. | [optional] |
+|**techPrefix** | **String** | Numerical chars only, exactly 4 characters. | [optional] |
+|**ipAuthenticationMethod** | [**IpAuthenticationMethodEnum**](#IpAuthenticationMethodEnum) | | [optional] |
+|**ipAuthenticationToken** | **String** | | [optional] |
+|**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. | [optional] |
## Enum: AniOverrideTypeEnum
-Name | Value
----- | -----
-ALWAYS | "always"
-NORMAL | "normal"
-EMERGENCY | "emergency"
+| Name | Value |
+|---- | -----|
+| ALWAYS | "always" |
+| NORMAL | "normal" |
+| EMERGENCY | "emergency" |
## Enum: T38ReinviteSourceEnum
-Name | Value
----- | -----
-TELNYX | "telnyx"
-CUSTOMER | "customer"
-DISABLED | "disabled"
-PASSTHRU | "passthru"
-CALLER_PASSTHRU | "caller-passthru"
-CALLEE_PASSTHRU | "callee-passthru"
+| Name | Value |
+|---- | -----|
+| TELNYX | "telnyx" |
+| CUSTOMER | "customer" |
+| DISABLED | "disabled" |
+| PASSTHRU | "passthru" |
+| CALLER_PASSTHRU | "caller-passthru" |
+| CALLEE_PASSTHRU | "callee-passthru" |
## Enum: IpAuthenticationMethodEnum
-Name | Value
----- | -----
-TECH_PREFIXP_CHARGE_INFO | "tech-prefixp-charge-info"
-TOKEN | "token"
+| Name | Value |
+|---- | -----|
+| TECH_PREFIXP_CHARGE_INFO | "tech-prefixp-charge-info" |
+| TOKEN | "token" |
diff --git a/docs/OutboundMessage.md b/docs/OutboundMessage.md
index 455578cf..6537cccc 100644
--- a/docs/OutboundMessage.md
+++ b/docs/OutboundMessage.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**payload** | [**OutboundMessagePayload**](OutboundMessagePayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
+|**payload** | [**OutboundMessagePayload**](OutboundMessagePayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-SENT | "message.sent"
-FINALIZED | "message.finalized"
+| Name | Value |
+|---- | -----|
+| SENT | "message.sent" |
+| FINALIZED | "message.finalized" |
diff --git a/docs/OutboundMessageEvent.md b/docs/OutboundMessageEvent.md
index 66aabca1..d1da31ef 100644
--- a/docs/OutboundMessageEvent.md
+++ b/docs/OutboundMessageEvent.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**OutboundMessage**](OutboundMessage.md) | | [optional]
-**meta** | [**OutboundMessageEventMeta**](OutboundMessageEventMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**OutboundMessage**](OutboundMessage.md) | | [optional] |
+|**meta** | [**OutboundMessageEventMeta**](OutboundMessageEventMeta.md) | | [optional] |
diff --git a/docs/OutboundMessageEventMeta.md b/docs/OutboundMessageEventMeta.md
index 8786e4a1..cb0d4d18 100644
--- a/docs/OutboundMessageEventMeta.md
+++ b/docs/OutboundMessageEventMeta.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**attempt** | **Integer** | Number of attempts to deliver the webhook event. | [optional]
-**deliveredTo** | **String** | The webhook URL the event was delivered to. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**attempt** | **Integer** | Number of attempts to deliver the webhook event. | [optional] |
+|**deliveredTo** | **String** | The webhook URL the event was delivered to. | [optional] |
diff --git a/docs/OutboundMessagePayload.md b/docs/OutboundMessagePayload.md
index 951550ea..de34e74c 100644
--- a/docs/OutboundMessagePayload.md
+++ b/docs/OutboundMessagePayload.md
@@ -5,55 +5,55 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**direction** | [**DirectionEnum**](#DirectionEnum) | The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**type** | [**TypeEnum**](#TypeEnum) | The type of message. | [optional]
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional]
-**organizationId** | **UUID** | The id of the organization the messaging profile belongs to. | [optional]
-**from** | [**OutboundMessagePayloadFrom**](OutboundMessagePayloadFrom.md) | | [optional]
-**to** | [**List<OutboundMessagePayloadTo>**](OutboundMessagePayloadTo.md) | | [optional]
-**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional]
-**subject** | **String** | Subject of multimedia message | [optional]
-**media** | [**List<OutboundMessagePayloadMedia>**](OutboundMessagePayloadMedia.md) | | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional]
-**encoding** | **String** | Encoding scheme used for the message body. | [optional]
-**parts** | **Integer** | Number of parts into which the message's body must be split. | [optional]
-**tags** | **List<String>** | Tags associated with the resource. | [optional]
-**cost** | [**InboundMessagePayloadCost**](InboundMessagePayloadCost.md) | | [optional]
-**receivedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message request was received. | [optional]
-**sentAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message was sent. | [optional]
-**completedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message was finalized. | [optional]
-**validUntil** | **OffsetDateTime** | Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled | [optional]
-**errors** | [**List<Error>**](Error.md) | These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**direction** | [**DirectionEnum**](#DirectionEnum) | The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | The type of message. | [optional] |
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional] |
+|**organizationId** | **UUID** | The id of the organization the messaging profile belongs to. | [optional] |
+|**from** | [**OutboundMessagePayloadFrom**](OutboundMessagePayloadFrom.md) | | [optional] |
+|**to** | [**List<OutboundMessagePayloadToInner>**](OutboundMessagePayloadToInner.md) | | [optional] |
+|**text** | **String** | Message body (i.e., content) as a non-empty string. **Required for SMS** | [optional] |
+|**subject** | **String** | Subject of multimedia message | [optional] |
+|**media** | [**List<OutboundMessagePayloadMediaInner>**](OutboundMessagePayloadMediaInner.md) | | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this message will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. | [optional] |
+|**encoding** | **String** | Encoding scheme used for the message body. | [optional] |
+|**parts** | **Integer** | Number of parts into which the message's body must be split. | [optional] |
+|**tags** | **List<String>** | Tags associated with the resource. | [optional] |
+|**cost** | [**InboundMessagePayloadCost**](InboundMessagePayloadCost.md) | | [optional] |
+|**receivedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message request was received. | [optional] |
+|**sentAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message was sent. | [optional] |
+|**completedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the message was finalized. | [optional] |
+|**validUntil** | **OffsetDateTime** | Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled | [optional] |
+|**errors** | [**List<Error>**](Error.md) | These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-MESSAGE | "message"
+| Name | Value |
+|---- | -----|
+| MESSAGE | "message" |
## Enum: DirectionEnum
-Name | Value
----- | -----
-OUTBOUND | "outbound"
+| Name | Value |
+|---- | -----|
+| OUTBOUND | "outbound" |
## Enum: TypeEnum
-Name | Value
----- | -----
-SMS | "SMS"
-MMS | "MMS"
+| Name | Value |
+|---- | -----|
+| SMS | "SMS" |
+| MMS | "MMS" |
diff --git a/docs/OutboundMessagePayloadFrom.md b/docs/OutboundMessagePayloadFrom.md
index a361f2de..46536f0b 100644
--- a/docs/OutboundMessagePayloadFrom.md
+++ b/docs/OutboundMessagePayloadFrom.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). | [optional]
-**carrier** | **String** | The carrier of the receiver. | [optional]
-**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the receiver. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). | [optional] |
+|**carrier** | **String** | The carrier of the receiver. | [optional] |
+|**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the receiver. | [optional] |
## Enum: LineTypeEnum
-Name | Value
----- | -----
-WIRELINE | "Wireline"
-WIRELESS | "Wireless"
-VOWIFI | "VoWiFi"
-VOIP | "VoIP"
-PRE_PAID_WIRELESS | "Pre-Paid Wireless"
-EMPTY | ""
+| Name | Value |
+|---- | -----|
+| WIRELINE | "Wireline" |
+| WIRELESS | "Wireless" |
+| VOWIFI | "VoWiFi" |
+| VOIP | "VoIP" |
+| PRE_PAID_WIRELESS | "Pre-Paid Wireless" |
+| EMPTY | "" |
diff --git a/docs/OutboundMessagePayloadMediaInner.md b/docs/OutboundMessagePayloadMediaInner.md
new file mode 100644
index 00000000..b7cf8f4c
--- /dev/null
+++ b/docs/OutboundMessagePayloadMediaInner.md
@@ -0,0 +1,16 @@
+
+
+# OutboundMessagePayloadMediaInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | The url of the media requested to be sent. | [optional] |
+|**contentType** | **String** | The MIME type of the requested media. | [optional] |
+|**sha256** | **String** | The SHA256 hash of the requested media. | [optional] |
+|**size** | **Integer** | The size of the requested media. | [optional] |
+
+
+
diff --git a/docs/OutboundMessagePayloadToInner.md b/docs/OutboundMessagePayloadToInner.md
new file mode 100644
index 00000000..97331438
--- /dev/null
+++ b/docs/OutboundMessagePayloadToInner.md
@@ -0,0 +1,44 @@
+
+
+# OutboundMessagePayloadToInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | Receiving address (+E.164 formatted phone number or short code). | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The delivery status of the message. | [optional] |
+|**carrier** | **String** | The carrier of the receiver. | [optional] |
+|**lineType** | [**LineTypeEnum**](#LineTypeEnum) | The line-type of the receiver. | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| QUEUED | "queued" |
+| SENDING | "sending" |
+| SENT | "sent" |
+| EXPIRED | "expired" |
+| SENDING_FAILED | "sending_failed" |
+| DELIVERY_UNCONFIRMED | "delivery_unconfirmed" |
+| DELIVERED | "delivered" |
+| DELIVERY_FAILED | "delivery_failed" |
+
+
+
+## Enum: LineTypeEnum
+
+| Name | Value |
+|---- | -----|
+| WIRELINE | "Wireline" |
+| WIRELESS | "Wireless" |
+| VOWIFI | "VoWiFi" |
+| VOIP | "VoIP" |
+| PRE_PAID_WIRELESS | "Pre-Paid Wireless" |
+| EMPTY | "" |
+
+
+
diff --git a/docs/OutboundVoiceProfile.md b/docs/OutboundVoiceProfile.md
index 9367bbb3..582ac89e 100644
--- a/docs/OutboundVoiceProfile.md
+++ b/docs/OutboundVoiceProfile.md
@@ -5,26 +5,26 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**name** | **String** | A user-supplied name to help with organization. |
-**connectionsCount** | **Integer** | Amount of connections associated with this outbound voice profile. | [optional]
-**trafficType** | **TrafficType** | | [optional]
-**servicePlan** | **ServicePlan** | | [optional]
-**concurrentCallLimit** | **Integer** | Must be no more than your global concurrent call limit. Null means no limit. | [optional]
-**enabled** | **Boolean** | Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections. | [optional]
-**tags** | **List<String>** | | [optional]
-**usagePaymentMethod** | **UsagePaymentMethod** | | [optional]
-**whitelistedDestinations** | **List<String>** | The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2. | [optional]
-**maxDestinationRate** | **BigDecimal** | Maximum rate (price per minute) for a Destination to be allowed when making outbound calls. | [optional]
-**dailySpendLimit** | **String** | The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls. | [optional]
-**dailySpendLimitEnabled** | **Boolean** | Specifies whether to enforce the daily_spend_limit on this outbound voice profile. | [optional]
-**callRecording** | [**OutboundCallRecording**](OutboundCallRecording.md) | | [optional]
-**billingGroupId** | **UUID** | The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned). | [optional]
-**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**name** | **String** | A user-supplied name to help with organization. | |
+|**connectionsCount** | **Integer** | Amount of connections associated with this outbound voice profile. | [optional] |
+|**trafficType** | **TrafficType** | | [optional] |
+|**servicePlan** | **ServicePlan** | | [optional] |
+|**concurrentCallLimit** | **Integer** | Must be no more than your global concurrent call limit. Null means no limit. | [optional] |
+|**enabled** | **Boolean** | Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections. | [optional] |
+|**tags** | **List<String>** | | [optional] |
+|**usagePaymentMethod** | **UsagePaymentMethod** | | [optional] |
+|**whitelistedDestinations** | **List<String>** | The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2. | [optional] |
+|**maxDestinationRate** | **BigDecimal** | Maximum rate (price per minute) for a Destination to be allowed when making outbound calls. | [optional] |
+|**dailySpendLimit** | **String** | The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls. | [optional] |
+|**dailySpendLimitEnabled** | **Boolean** | Specifies whether to enforce the daily_spend_limit on this outbound voice profile. | [optional] |
+|**callRecording** | [**OutboundCallRecording**](OutboundCallRecording.md) | | [optional] |
+|**billingGroupId** | **UUID** | The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned). | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] |
diff --git a/docs/OutboundVoiceProfileResponse.md b/docs/OutboundVoiceProfileResponse.md
index 3b1746bb..de90bb85 100644
--- a/docs/OutboundVoiceProfileResponse.md
+++ b/docs/OutboundVoiceProfileResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**OutboundVoiceProfile**](OutboundVoiceProfile.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**OutboundVoiceProfile**](OutboundVoiceProfile.md) | | [optional] |
diff --git a/docs/PWGAssignedResourcesSummary.md b/docs/PWGAssignedResourcesSummary.md
new file mode 100644
index 00000000..98a42cff
--- /dev/null
+++ b/docs/PWGAssignedResourcesSummary.md
@@ -0,0 +1,15 @@
+
+
+# PWGAssignedResourcesSummary
+
+The summary of the resource that have been assigned to the Private Wireless Gateway
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | The type of the resource assigned to the Private Wireless Gateway | [optional] [readonly] |
+|**count** | **Integer** | The current count of a resource type assigned to the Private Wireless Gateway | [optional] [readonly] |
+
+
+
diff --git a/docs/PaginationMeta.md b/docs/PaginationMeta.md
index 11f3cbac..1d338f84 100644
--- a/docs/PaginationMeta.md
+++ b/docs/PaginationMeta.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalPages** | **Integer** | | [optional]
-**totalResults** | **Integer** | | [optional]
-**pageNumber** | **Integer** | | [optional]
-**pageSize** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**totalPages** | **Integer** | | [optional] |
+|**totalResults** | **Integer** | | [optional] |
+|**pageNumber** | **Integer** | | [optional] |
+|**pageSize** | **Integer** | | [optional] |
diff --git a/docs/PaginationMetaSimple.md b/docs/PaginationMetaSimple.md
index b4d66402..7870c32e 100644
--- a/docs/PaginationMetaSimple.md
+++ b/docs/PaginationMetaSimple.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pageNumber** | **Integer** | | [optional]
-**pageSize** | **Integer** | | [optional]
-**totalPages** | **Integer** | | [optional]
-**totalResults** | **Integer** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**pageNumber** | **Integer** | | [optional] |
+|**pageSize** | **Integer** | | [optional] |
+|**totalPages** | **Integer** | | [optional] |
+|**totalResults** | **Integer** | | [optional] |
diff --git a/docs/Participant.md b/docs/Participant.md
index 21a6ed67..4b2e044e 100644
--- a/docs/Participant.md
+++ b/docs/Participant.md
@@ -5,39 +5,39 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | |
-**id** | **String** | Uniquely identifies the participant |
-**callLegId** | **String** | Uniquely identifies the call leg associated with the participant |
-**callControlId** | **String** | Call Control ID associated with the partiipant of the conference |
-**conference** | [**ParticipantConference**](ParticipantConference.md) | |
-**whisperCallControlIds** | **List<String>** | Array of unique call_control_ids the participant can whisper to.. |
-**createdAt** | **String** | ISO 8601 formatted date of when the participant was created |
-**updatedAt** | **String** | ISO 8601 formatted date of when the participant was last updated |
-**endConferenceOnExit** | **Boolean** | Whether the conference will end and all remaining participants be hung up after the participant leaves the conference. |
-**softEndConferenceOnExit** | **Boolean** | Whether the conference will end after the participant leaves the conference. |
-**status** | [**StatusEnum**](#StatusEnum) | The status of the participant with respect to the lifecycle within the conference |
-**muted** | **Boolean** | Whether the participant is muted. |
-**onHold** | **Boolean** | Whether the participant is put on_hold. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | | |
+|**id** | **String** | Uniquely identifies the participant | |
+|**callLegId** | **String** | Uniquely identifies the call leg associated with the participant | |
+|**callControlId** | **String** | Call Control ID associated with the partiipant of the conference | |
+|**conference** | [**ParticipantConference**](ParticipantConference.md) | | |
+|**whisperCallControlIds** | **List<String>** | Array of unique call_control_ids the participant can whisper to.. | |
+|**createdAt** | **String** | ISO 8601 formatted date of when the participant was created | |
+|**updatedAt** | **String** | ISO 8601 formatted date of when the participant was last updated | |
+|**endConferenceOnExit** | **Boolean** | Whether the conference will end and all remaining participants be hung up after the participant leaves the conference. | |
+|**softEndConferenceOnExit** | **Boolean** | Whether the conference will end after the participant leaves the conference. | |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the participant with respect to the lifecycle within the conference | |
+|**muted** | **Boolean** | Whether the participant is muted. | |
+|**onHold** | **Boolean** | Whether the participant is put on_hold. | |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-PARTICIPANT | "participant"
+| Name | Value |
+|---- | -----|
+| PARTICIPANT | "participant" |
## Enum: StatusEnum
-Name | Value
----- | -----
-JOINING | "joining"
-JOINED | "joined"
-LEFT | "left"
+| Name | Value |
+|---- | -----|
+| JOINING | "joining" |
+| JOINED | "joined" |
+| LEFT | "left" |
diff --git a/docs/ParticipantConference.md b/docs/ParticipantConference.md
index 3ac817e0..845769c8 100644
--- a/docs/ParticipantConference.md
+++ b/docs/ParticipantConference.md
@@ -6,10 +6,10 @@ Info about the conference that the participant is in
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Uniquely identifies the conference | [optional]
-**name** | **String** | Name of the conference | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Uniquely identifies the conference | [optional] |
+|**name** | **String** | Name of the conference | [optional] |
diff --git a/docs/ParticipantJoined.md b/docs/ParticipantJoined.md
index 67877f91..ca237204 100644
--- a/docs/ParticipantJoined.md
+++ b/docs/ParticipantJoined.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | An identifier for the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Uniquely identify the event. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**ParticipantJoinedPayload**](ParticipantJoinedPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | An identifier for the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Uniquely identify the event. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**ParticipantJoinedPayload**](ParticipantJoinedPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-VIDEO_ROOM_PARTICIPANT_JOINED | "video.room.participant.joined"
+| Name | Value |
+|---- | -----|
+| VIDEO_ROOM_PARTICIPANT_JOINED | "video.room.participant.joined" |
diff --git a/docs/ParticipantJoinedEvent.md b/docs/ParticipantJoinedEvent.md
index 6f0bf491..07d439c0 100644
--- a/docs/ParticipantJoinedEvent.md
+++ b/docs/ParticipantJoinedEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**ParticipantJoined**](ParticipantJoined.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ParticipantJoined**](ParticipantJoined.md) | | [optional] |
diff --git a/docs/ParticipantJoinedPayload.md b/docs/ParticipantJoinedPayload.md
index 96afa3e1..79ef1f10 100644
--- a/docs/ParticipantJoinedPayload.md
+++ b/docs/ParticipantJoinedPayload.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sessionId** | **UUID** | Session ID that identifies the session where the participant joined. | [optional]
-**roomId** | **UUID** | Room ID that identifies the room where the participant joined. | [optional]
-**context** | **String** | Context provided to the given participant through the client SDK | [optional]
-**participantId** | **UUID** | Participant ID that identifies the participant that joined. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**sessionId** | **UUID** | Session ID that identifies the session where the participant joined. | [optional] |
+|**roomId** | **UUID** | Room ID that identifies the room where the participant joined. | [optional] |
+|**context** | **String** | Context provided to the given participant through the client SDK | [optional] |
+|**participantId** | **UUID** | Participant ID that identifies the participant that joined. | [optional] |
diff --git a/docs/ParticipantLeft.md b/docs/ParticipantLeft.md
index d4dd0551..41cdb86c 100644
--- a/docs/ParticipantLeft.md
+++ b/docs/ParticipantLeft.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | An identifier for the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Uniquely identify the event. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**ParticipantLeftPayload**](ParticipantLeftPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | An identifier for the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Uniquely identify the event. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**ParticipantLeftPayload**](ParticipantLeftPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-VIDEO_ROOM_PARTICIPANT_LEFT | "video.room.participant.left"
+| Name | Value |
+|---- | -----|
+| VIDEO_ROOM_PARTICIPANT_LEFT | "video.room.participant.left" |
diff --git a/docs/ParticipantLeftEvent.md b/docs/ParticipantLeftEvent.md
index e9086e0a..fd938cd4 100644
--- a/docs/ParticipantLeftEvent.md
+++ b/docs/ParticipantLeftEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**ParticipantLeft**](ParticipantLeft.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ParticipantLeft**](ParticipantLeft.md) | | [optional] |
diff --git a/docs/ParticipantLeftPayload.md b/docs/ParticipantLeftPayload.md
index b82d6f08..b7a2b2d8 100644
--- a/docs/ParticipantLeftPayload.md
+++ b/docs/ParticipantLeftPayload.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sessionId** | **UUID** | Session ID that identifies the session where the participant left. | [optional]
-**roomId** | **UUID** | Room ID that identifies the room where the participant left. | [optional]
-**context** | **String** | Context provided to the given participant through the client SDK | [optional]
-**participantId** | **UUID** | Participant ID that identifies the participant that left. | [optional]
-**durationSecs** | **Integer** | The duration in seconds of the participant in the session | [optional]
-**leftReason** | **String** | The reason why the participant left | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**sessionId** | **UUID** | Session ID that identifies the session where the participant left. | [optional] |
+|**roomId** | **UUID** | Room ID that identifies the room where the participant left. | [optional] |
+|**context** | **String** | Context provided to the given participant through the client SDK | [optional] |
+|**participantId** | **UUID** | Participant ID that identifies the participant that left. | [optional] |
+|**durationSecs** | **Integer** | The duration in seconds of the participant in the session | [optional] |
+|**leftReason** | **String** | The reason why the participant left | [optional] |
diff --git a/docs/PatchGroupRequest.md b/docs/PatchGroupRequest.md
new file mode 100644
index 00000000..82e00ed0
--- /dev/null
+++ b/docs/PatchGroupRequest.md
@@ -0,0 +1,13 @@
+
+
+# PatchGroupRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channels** | **Long** | | [optional] |
+
+
+
diff --git a/docs/PatchRoomRequest.md b/docs/PatchRoomRequest.md
index 6fe6294d..d77e877c 100644
--- a/docs/PatchRoomRequest.md
+++ b/docs/PatchRoomRequest.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uniqueName** | **String** | The unique (within the Telnyx account scope) name of the room. | [optional]
-**maxParticipants** | **Integer** | The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected. | [optional]
-**enableRecording** | **Boolean** | Enable or disable recording for that room. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**uniqueName** | **String** | The unique (within the Telnyx account scope) name of the room. | [optional] |
+|**maxParticipants** | **Integer** | The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected. | [optional] |
+|**enableRecording** | **Boolean** | Enable or disable recording for that room. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
diff --git a/docs/PauseRecordingRequest.md b/docs/PauseRecordingRequest.md
index 1871016a..c15e0fe7 100644
--- a/docs/PauseRecordingRequest.md
+++ b/docs/PauseRecordingRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/Phone.md b/docs/Phone.md
index 41fce896..f6ff2b75 100644
--- a/docs/Phone.md
+++ b/docs/Phone.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone** | **String** | | [optional]
-**type** | **String** | Standard Values: CELL, MAIN, IPHONE, HOME, WORK | [optional]
-**id** | **String** | WhatsApp ID | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phone** | **String** | | [optional] |
+|**type** | **String** | Standard Values: CELL, MAIN, IPHONE, HOME, WORK | [optional] |
+|**id** | **String** | WhatsApp ID | [optional] |
diff --git a/docs/PhoneNumber.md b/docs/PhoneNumber.md
index bf372edc..b23fe9ca 100644
--- a/docs/PhoneNumber.md
+++ b/docs/PhoneNumber.md
@@ -5,25 +5,53 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumber** | **String** | | [optional]
-**regulatoryGroupId** | **String** | | [optional] [readonly]
-**regulatoryRequirements** | [**List<PhoneNumberRegulatoryRequirement>**](PhoneNumberRegulatoryRequirement.md) | | [optional]
-**requirementsMet** | **Boolean** | True if all requirements are met for a phone number, false otherwise. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the phone number in the order. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumber** | **String** | | [optional] |
+|**regulatoryGroupId** | **String** | | [optional] [readonly] |
+|**regulatoryRequirements** | [**List<PhoneNumberRegulatoryRequirement>**](PhoneNumberRegulatoryRequirement.md) | | [optional] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for a phone number, false otherwise. | [optional] [readonly] |
+|**requirementsStatus** | [**RequirementsStatusEnum**](#RequirementsStatusEnum) | Status of document requirements (if applicable) | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the phone number in the order. | [optional] [readonly] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | Phone number type | [optional] [readonly] |
+
+
+
+## Enum: RequirementsStatusEnum
+
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| APPROVED | "approved" |
+| CANCELLED | "cancelled" |
+| DELETED | "deleted" |
+| REQUIREMENT_INFO_EXCEPTION | "requirement-info-exception" |
+| REQUIREMENT_INFO_PENDING | "requirement-info-pending" |
+| REQUIREMENT_INFO_UNDER_REVIEW | "requirement-info-under-review" |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
+
+
+
+## Enum: PhoneNumberTypeEnum
+
+| Name | Value |
+|---- | -----|
+| LOCAL | "local" |
+| MOBILE | "mobile" |
+| NATIONAL | "national" |
+| SHARED_COST | "shared_cost" |
+| TOLL_FREE | "toll_free" |
diff --git a/docs/PhoneNumberBlocksJob.md b/docs/PhoneNumberBlocksJob.md
index d56c0d7c..d2b9a865 100644
--- a/docs/PhoneNumberBlocksJob.md
+++ b/docs/PhoneNumberBlocksJob.md
@@ -5,36 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Identifies the resource. | [optional] [readonly]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | Indicates the completion status of the background operation. | [optional] [readonly]
-**type** | [**TypeEnum**](#TypeEnum) | Identifies the type of the background job. | [optional] [readonly]
-**etc** | **OffsetDateTime** | ISO 8601 formatted date indicating when the estimated time of completion of the background job. | [optional] [readonly]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
-**successfulOperations** | [**List<PhoneNumberBlocksJobSuccessfulOperation>**](PhoneNumberBlocksJobSuccessfulOperation.md) | | [optional] [readonly]
-**failedOperations** | [**List<PhoneNumberBlocksJobFailedOperation>**](PhoneNumberBlocksJobFailedOperation.md) | | [optional] [readonly]
-
-
-
-## Enum: StatusEnum
-
-Name | Value
----- | -----
-PENDING | "pending"
-IN_PROGRESS | "in_progress"
-COMPLETED | "completed"
-FAILED | "failed"
-
-
-
-## Enum: TypeEnum
-
-Name | Value
----- | -----
-DELETE_PHONE_NUMBER_BLOCK | "delete_phone_number_block"
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumberBlocksJob**](PhoneNumberBlocksJob.md) | | [optional] |
diff --git a/docs/PhoneNumberBlocksJobDeletePhoneNumberBlock.md b/docs/PhoneNumberBlocksJobDeletePhoneNumberBlock.md
index 3673a0b4..c0002947 100644
--- a/docs/PhoneNumberBlocksJobDeletePhoneNumberBlock.md
+++ b/docs/PhoneNumberBlocksJobDeletePhoneNumberBlock.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumberBlocksJob**](PhoneNumberBlocksJob.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumberBlocksJob**](PhoneNumberBlocksJob.md) | | [optional] |
diff --git a/docs/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest.md b/docs/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest.md
index 0a4ca786..fe0c4e11 100644
--- a/docs/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest.md
+++ b/docs/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumberBlockId** | **String** | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumberBlockId** | **String** | | |
diff --git a/docs/PhoneNumberBlocksJobFailedOperation.md b/docs/PhoneNumberBlocksJobFailedOperation.md
index 72240d77..59edb772 100644
--- a/docs/PhoneNumberBlocksJobFailedOperation.md
+++ b/docs/PhoneNumberBlocksJobFailedOperation.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**id** | **String** | The phone number's ID | [optional]
-**errors** | [**List<Error>**](Error.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**id** | **String** | The phone number's ID | [optional] |
+|**errors** | [**List<Error>**](Error.md) | | [optional] |
diff --git a/docs/PhoneNumberBlocksJobSuccessfulOperation.md b/docs/PhoneNumberBlocksJobSuccessfulOperation.md
index cd7460ba..8a727ed8 100644
--- a/docs/PhoneNumberBlocksJobSuccessfulOperation.md
+++ b/docs/PhoneNumberBlocksJobSuccessfulOperation.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**id** | **String** | The phone number's ID | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**id** | **String** | The phone number's ID | [optional] |
diff --git a/docs/PhoneNumberDeletedDetailed.md b/docs/PhoneNumberDeletedDetailed.md
index a1f9e286..c62f304b 100644
--- a/docs/PhoneNumberDeletedDetailed.md
+++ b/docs/PhoneNumberDeletedDetailed.md
@@ -5,70 +5,70 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Uniquely identifies the resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**phoneNumber** | **String** | The +E.164-formatted phone number associated with this record. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | The phone number's current status. | [optional] [readonly]
-**tags** | **List<String>** | A list of user-assigned tags to help manage the phone number. | [optional]
-**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional]
-**connectionName** | **String** | The user-assigned name of the connection to be associated with this phone number. | [optional] [readonly]
-**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**messagingProfileName** | **String** | The name of the messaging profile associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional]
-**emergencyEnabled** | **Boolean** | Indicates whether emergency services are enabled for this number. | [optional] [readonly]
-**emergencyAddressId** | **String** | Identifies the emergency address associated with the phone number. | [optional] [readonly]
-**callForwardingEnabled** | **Boolean** | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional] [readonly]
-**cnamListingEnabled** | **Boolean** | Indicates whether a CNAM listing is enabled for this number. | [optional] [readonly]
-**callerIdNameEnabled** | **Boolean** | Indicates whether caller ID is enabled for this number. | [optional] [readonly]
-**callRecordingEnabled** | **Boolean** | Indicates whether call recording is enabled for this number. | [optional] [readonly]
-**t38FaxGatewayEnabled** | **Boolean** | Indicates whether T38 Fax Gateway for inbound calls to this number. | [optional] [readonly]
-**purchasedAt** | **String** | ISO 8601 formatted date indicating the time the request was made to purchase the number. | [optional] [readonly]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the time it took to activate after the purchase. | [optional] [readonly]
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
-**numberLevelRouting** | [**NumberLevelRoutingEnum**](#NumberLevelRoutingEnum) | Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level. | [optional]
-**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The phone number's type. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Uniquely identifies the resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**phoneNumber** | **String** | The +E.164-formatted phone number associated with this record. | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | The phone number's current status. | [optional] [readonly] |
+|**tags** | **List<String>** | A list of user-assigned tags to help manage the phone number. | [optional] |
+|**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional] |
+|**connectionName** | **String** | The user-assigned name of the connection to be associated with this phone number. | [optional] [readonly] |
+|**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**messagingProfileName** | **String** | The name of the messaging profile associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional] |
+|**emergencyEnabled** | **Boolean** | Indicates whether emergency services are enabled for this number. | [optional] [readonly] |
+|**emergencyAddressId** | **String** | Identifies the emergency address associated with the phone number. | [optional] [readonly] |
+|**callForwardingEnabled** | **Boolean** | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional] [readonly] |
+|**cnamListingEnabled** | **Boolean** | Indicates whether a CNAM listing is enabled for this number. | [optional] [readonly] |
+|**callerIdNameEnabled** | **Boolean** | Indicates whether caller ID is enabled for this number. | [optional] [readonly] |
+|**callRecordingEnabled** | **Boolean** | Indicates whether call recording is enabled for this number. | [optional] [readonly] |
+|**t38FaxGatewayEnabled** | **Boolean** | Indicates whether T38 Fax Gateway for inbound calls to this number. | [optional] [readonly] |
+|**purchasedAt** | **String** | ISO 8601 formatted date indicating the time the request was made to purchase the number. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date indicating when the time it took to activate after the purchase. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
+|**numberLevelRouting** | [**NumberLevelRoutingEnum**](#NumberLevelRoutingEnum) | Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to disabled or the value set on your user profile in default_number_routing_setting. There are performance advantages to using disabled and setting all routing information at the connection level. | [optional] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The phone number's type. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PURCHASE_PENDING | "purchase-pending"
-PURCHASE_FAILED | "purchase-failed"
-PORT_PENDING | "port-pending"
-PORT_FAILED | "port-failed"
-ACTIVE | "active"
-DELETED | "deleted"
-EMERGENCY_ONLY | "emergency-only"
-PORTED_OUT | "ported-out"
-PORT_OUT_PENDING | "port-out-pending"
+| Name | Value |
+|---- | -----|
+| PURCHASE_PENDING | "purchase-pending" |
+| PURCHASE_FAILED | "purchase-failed" |
+| PORT_PENDING | "port-pending" |
+| PORT_FAILED | "port-failed" |
+| ACTIVE | "active" |
+| DELETED | "deleted" |
+| EMERGENCY_ONLY | "emergency-only" |
+| PORTED_OUT | "ported-out" |
+| PORT_OUT_PENDING | "port-out-pending" |
## Enum: NumberLevelRoutingEnum
-Name | Value
----- | -----
-ENABLED | "enabled"
-DISABLED | "disabled"
+| Name | Value |
+|---- | -----|
+| ENABLED | "enabled" |
+| DISABLED | "disabled" |
## Enum: PhoneNumberTypeEnum
-Name | Value
----- | -----
-LOCAL | "local"
-TOLL_FREE | "toll_free"
-MOBILE | "mobile"
-NATIONAL | "national"
-SHARED_COST | "shared_cost"
-LANDLINE | "landline"
+| Name | Value |
+|---- | -----|
+| LOCAL | "local" |
+| TOLL_FREE | "toll_free" |
+| MOBILE | "mobile" |
+| NATIONAL | "national" |
+| SHARED_COST | "shared_cost" |
+| LANDLINE | "landline" |
diff --git a/docs/PhoneNumberDetailed.md b/docs/PhoneNumberDetailed.md
index 973adf37..92bd99c8 100644
--- a/docs/PhoneNumberDetailed.md
+++ b/docs/PhoneNumberDetailed.md
@@ -5,69 +5,69 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Uniquely identifies the resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**phoneNumber** | **String** | The +E.164-formatted phone number associated with this record. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | The phone number's current status. | [optional] [readonly]
-**tags** | **List<String>** | A list of user-assigned tags to help manage the phone number. | [optional]
-**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional]
-**connectionName** | **String** | The user-assigned name of the connection to be associated with this phone number. | [optional] [readonly]
-**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional]
-**messagingProfileName** | **String** | The name of the messaging profile associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional]
-**emergencyEnabled** | **Boolean** | Indicates whether emergency services are enabled for this number. | [optional] [readonly]
-**emergencyAddressId** | **String** | Identifies the emergency address associated with the phone number. | [optional] [readonly]
-**callForwardingEnabled** | **Boolean** | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional] [readonly]
-**cnamListingEnabled** | **Boolean** | Indicates whether a CNAM listing is enabled for this number. | [optional] [readonly]
-**callerIdNameEnabled** | **Boolean** | Indicates whether caller ID is enabled for this number. | [optional] [readonly]
-**callRecordingEnabled** | **Boolean** | Indicates whether call recording is enabled for this number. | [optional] [readonly]
-**t38FaxGatewayEnabled** | **Boolean** | Indicates whether T38 Fax Gateway for inbound calls to this number. | [optional] [readonly]
-**purchasedAt** | **String** | ISO 8601 formatted date indicating when the resource was purchased. | [optional] [readonly]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**numberLevelRouting** | [**NumberLevelRoutingEnum**](#NumberLevelRoutingEnum) | Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level. | [optional]
-**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The phone number's type. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Uniquely identifies the resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**phoneNumber** | **String** | The +E.164-formatted phone number associated with this record. | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | The phone number's current status. | [optional] [readonly] |
+|**tags** | **List<String>** | A list of user-assigned tags to help manage the phone number. | [optional] |
+|**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional] |
+|**connectionName** | **String** | The user-assigned name of the connection to be associated with this phone number. | [optional] [readonly] |
+|**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**messagingProfileId** | **String** | Identifies the messaging profile associated with the phone number. | [optional] |
+|**messagingProfileName** | **String** | The name of the messaging profile associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional] |
+|**emergencyEnabled** | **Boolean** | Indicates whether emergency services are enabled for this number. | [optional] [readonly] |
+|**emergencyAddressId** | **String** | Identifies the emergency address associated with the phone number. | [optional] [readonly] |
+|**callForwardingEnabled** | **Boolean** | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional] [readonly] |
+|**cnamListingEnabled** | **Boolean** | Indicates whether a CNAM listing is enabled for this number. | [optional] [readonly] |
+|**callerIdNameEnabled** | **Boolean** | Indicates whether caller ID is enabled for this number. | [optional] [readonly] |
+|**callRecordingEnabled** | **Boolean** | Indicates whether call recording is enabled for this number. | [optional] [readonly] |
+|**t38FaxGatewayEnabled** | **Boolean** | Indicates whether T38 Fax Gateway for inbound calls to this number. | [optional] [readonly] |
+|**purchasedAt** | **String** | ISO 8601 formatted date indicating when the resource was purchased. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**numberLevelRouting** | [**NumberLevelRoutingEnum**](#NumberLevelRoutingEnum) | Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to disabled or the value set on your user profile in default_number_routing_setting. There are performance advantages to using disabled and setting all routing information at the connection level. | [optional] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The phone number's type. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PURCHASE_PENDING | "purchase-pending"
-PURCHASE_FAILED | "purchase-failed"
-PORT_PENDING | "port-pending"
-PORT_FAILED | "port-failed"
-ACTIVE | "active"
-DELETED | "deleted"
-EMERGENCY_ONLY | "emergency-only"
-PORTED_OUT | "ported-out"
-PORT_OUT_PENDING | "port-out-pending"
+| Name | Value |
+|---- | -----|
+| PURCHASE_PENDING | "purchase-pending" |
+| PURCHASE_FAILED | "purchase-failed" |
+| PORT_PENDING | "port-pending" |
+| PORT_FAILED | "port-failed" |
+| ACTIVE | "active" |
+| DELETED | "deleted" |
+| EMERGENCY_ONLY | "emergency-only" |
+| PORTED_OUT | "ported-out" |
+| PORT_OUT_PENDING | "port-out-pending" |
## Enum: NumberLevelRoutingEnum
-Name | Value
----- | -----
-ENABLED | "enabled"
-DISABLED | "disabled"
+| Name | Value |
+|---- | -----|
+| ENABLED | "enabled" |
+| DISABLED | "disabled" |
## Enum: PhoneNumberTypeEnum
-Name | Value
----- | -----
-LOCAL | "local"
-TOLL_FREE | "toll_free"
-MOBILE | "mobile"
-NATIONAL | "national"
-SHARED_COST | "shared_cost"
-LANDLINE | "landline"
+| Name | Value |
+|---- | -----|
+| LOCAL | "local" |
+| TOLL_FREE | "toll_free" |
+| MOBILE | "mobile" |
+| NATIONAL | "national" |
+| SHARED_COST | "shared_cost" |
+| LANDLINE | "landline" |
diff --git a/docs/PhoneNumberEnableEmergency.md b/docs/PhoneNumberEnableEmergency.md
index a846c11d..e4a50cce 100644
--- a/docs/PhoneNumberEnableEmergency.md
+++ b/docs/PhoneNumberEnableEmergency.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumberWithVoiceSettings**](PhoneNumberWithVoiceSettings.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumberWithVoiceSettings**](PhoneNumberWithVoiceSettings.md) | | [optional] |
diff --git a/docs/PhoneNumberEnableEmergencyRequest.md b/docs/PhoneNumberEnableEmergencyRequest.md
index 3970ae62..5ce0c7a9 100644
--- a/docs/PhoneNumberEnableEmergencyRequest.md
+++ b/docs/PhoneNumberEnableEmergencyRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**emergencyEnabled** | **Boolean** | Indicates whether to enable emergency services on this number. |
-**emergencyAddressId** | **String** | Identifies the address to be used with emergency services. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**emergencyEnabled** | **Boolean** | Indicates whether to enable emergency services on this number. | |
+|**emergencyAddressId** | **String** | Identifies the address to be used with emergency services. | |
diff --git a/docs/PhoneNumberPortingApi.md b/docs/PhoneNumberPortingApi.md
index 3a3816ba..1721ba05 100644
--- a/docs/PhoneNumberPortingApi.md
+++ b/docs/PhoneNumberPortingApi.md
@@ -10,7 +10,7 @@ Method | HTTP request | Description
## postPortabilityCheck
-> PortabilityCheckResponse postPortabilityCheck(createPortabilityCheckRequest)
+> PostPortabilityCheck201Response postPortabilityCheck(postPortabilityCheckRequest)
Run a portability check
@@ -37,9 +37,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
PhoneNumberPortingApi apiInstance = new PhoneNumberPortingApi(defaultClient);
- CreatePortabilityCheckRequest createPortabilityCheckRequest = new CreatePortabilityCheckRequest(); // CreatePortabilityCheckRequest |
+ PostPortabilityCheckRequest postPortabilityCheckRequest = new PostPortabilityCheckRequest(); // PostPortabilityCheckRequest |
try {
- PortabilityCheckResponse result = apiInstance.postPortabilityCheck(createPortabilityCheckRequest);
+ PostPortabilityCheck201Response result = apiInstance.postPortabilityCheck(postPortabilityCheckRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PhoneNumberPortingApi#postPortabilityCheck");
@@ -57,11 +57,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **createPortabilityCheckRequest** | [**CreatePortabilityCheckRequest**](CreatePortabilityCheckRequest.md)| |
+ **postPortabilityCheckRequest** | [**PostPortabilityCheckRequest**](PostPortabilityCheckRequest.md)| |
### Return type
-[**PortabilityCheckResponse**](PortabilityCheckResponse.md)
+[**PostPortabilityCheck201Response**](PostPortabilityCheck201Response.md)
### Authorization
diff --git a/docs/PhoneNumberRegulatoryRequirement.md b/docs/PhoneNumberRegulatoryRequirement.md
index 43d27096..99950b25 100644
--- a/docs/PhoneNumberRegulatoryRequirement.md
+++ b/docs/PhoneNumberRegulatoryRequirement.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional] [readonly]
-**requirementId** | **UUID** | Unique id for a requirement. | [optional]
-**fieldType** | [**FieldTypeEnum**](#FieldTypeEnum) | | [optional] [readonly]
-**fieldValue** | **String** | The value of the requirement, this could be an id to a resource or a string value. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**requirementId** | **UUID** | Unique id for a requirement. | [optional] |
+|**fieldType** | [**FieldTypeEnum**](#FieldTypeEnum) | | [optional] [readonly] |
+|**fieldValue** | **String** | The value of the requirement, this could be an id to a resource or a string value. | [optional] |
## Enum: FieldTypeEnum
-Name | Value
----- | -----
-TEXTUAL | "textual"
-DATETIME | "datetime"
-ADDRESS | "address"
-DOCUMENT | "document"
+| Name | Value |
+|---- | -----|
+| TEXTUAL | "textual" |
+| DATETIME | "datetime" |
+| ADDRESS | "address" |
+| DOCUMENT | "document" |
diff --git a/docs/PhoneNumberRegulatoryRequirementAllOf.md b/docs/PhoneNumberRegulatoryRequirementAllOf.md
index 36cbb00b..bd44042b 100644
--- a/docs/PhoneNumberRegulatoryRequirementAllOf.md
+++ b/docs/PhoneNumberRegulatoryRequirementAllOf.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fieldValue** | **String** | The value of the requirement, this could be an id to a resource or a string value. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldValue** | **String** | The value of the requirement, this could be an id to a resource or a string value. | [optional] |
diff --git a/docs/PhoneNumberResponse.md b/docs/PhoneNumberResponse.md
index c84b4724..67a2154b 100644
--- a/docs/PhoneNumberResponse.md
+++ b/docs/PhoneNumberResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumberDetailed**](PhoneNumberDetailed.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumberDetailed**](PhoneNumberDetailed.md) | | [optional] |
diff --git a/docs/PhoneNumberResponse1.md b/docs/PhoneNumberResponse1.md
index 3b5eb269..7ad773be 100644
--- a/docs/PhoneNumberResponse1.md
+++ b/docs/PhoneNumberResponse1.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumberDeletedDetailed**](PhoneNumberDeletedDetailed.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumberDeletedDetailed**](PhoneNumberDeletedDetailed.md) | | [optional] |
diff --git a/docs/PhoneNumberWithMessagingSettings.md b/docs/PhoneNumberWithMessagingSettings.md
index 24a15d37..cfd27353 100644
--- a/docs/PhoneNumberWithMessagingSettings.md
+++ b/docs/PhoneNumberWithMessagingSettings.md
@@ -5,43 +5,43 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly]
-**id** | **String** | Identifies the type of resource. | [optional] [readonly]
-**phoneNumber** | **String** | +E.164 formatted phone number. | [optional] [readonly]
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
-**countryCode** | **String** | ISO 3166-1 alpha-2 country code. | [optional] [readonly]
-**type** | [**TypeEnum**](#TypeEnum) | The type of the phone number | [optional] [readonly]
-**health** | [**NumberHealthMetrics**](NumberHealthMetrics.md) | | [optional]
-**eligibleMessagingProducts** | **List<String>** | The messaging products that this number can be registered to use | [optional] [readonly]
-**trafficType** | **String** | The messaging traffic or use case for which the number is currently configured. | [optional] [readonly]
-**messagingProduct** | **String** | The messaging product that the number is registered to use | [optional]
-**features** | [**PhoneNumberWithMessagingSettingsFeatures**](PhoneNumberWithMessagingSettingsFeatures.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly] |
+|**id** | **String** | Identifies the type of resource. | [optional] [readonly] |
+|**phoneNumber** | **String** | +E.164 formatted phone number. | [optional] [readonly] |
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
+|**countryCode** | **String** | ISO 3166-1 alpha-2 country code. | [optional] [readonly] |
+|**type** | [**TypeEnum**](#TypeEnum) | The type of the phone number | [optional] [readonly] |
+|**health** | [**NumberHealthMetrics**](NumberHealthMetrics.md) | | [optional] |
+|**eligibleMessagingProducts** | **List<String>** | The messaging products that this number can be registered to use | [optional] [readonly] |
+|**trafficType** | **String** | The messaging traffic or use case for which the number is currently configured. | [optional] [readonly] |
+|**messagingProduct** | **String** | The messaging product that the number is registered to use | [optional] |
+|**features** | [**PhoneNumberWithMessagingSettingsFeatures**](PhoneNumberWithMessagingSettingsFeatures.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-PHONE_NUMBER | "messaging_phone_number"
-SETTINGS | "messaging_settings"
+| Name | Value |
+|---- | -----|
+| PHONE_NUMBER | "messaging_phone_number" |
+| SETTINGS | "messaging_settings" |
## Enum: TypeEnum
-Name | Value
----- | -----
-LONG_CODE | "long-code"
-TOLL_FREE | "toll-free"
-SHORT_CODE | "short-code"
-LONGCODE | "longcode"
-TOLLFREE | "tollfree"
-SHORTCODE | "shortcode"
+| Name | Value |
+|---- | -----|
+| LONG_CODE | "long-code" |
+| TOLL_FREE | "toll-free" |
+| SHORT_CODE | "short-code" |
+| LONGCODE | "longcode" |
+| TOLLFREE | "tollfree" |
+| SHORTCODE | "shortcode" |
diff --git a/docs/PhoneNumberWithMessagingSettingsFeatures.md b/docs/PhoneNumberWithMessagingSettingsFeatures.md
index 1a0ad4ab..8eb3eb13 100644
--- a/docs/PhoneNumberWithMessagingSettingsFeatures.md
+++ b/docs/PhoneNumberWithMessagingSettingsFeatures.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sms** | [**MessagingFeatureSet**](MessagingFeatureSet.md) | | [optional]
-**mms** | [**MessagingFeatureSet**](MessagingFeatureSet.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**sms** | [**MessagingFeatureSet**](MessagingFeatureSet.md) | | [optional] |
+|**mms** | [**MessagingFeatureSet**](MessagingFeatureSet.md) | | [optional] |
diff --git a/docs/PhoneNumberWithVoiceSettings.md b/docs/PhoneNumberWithVoiceSettings.md
index 56bf2abe..db762e88 100644
--- a/docs/PhoneNumberWithVoiceSettings.md
+++ b/docs/PhoneNumberWithVoiceSettings.md
@@ -5,30 +5,30 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the type of resource. | [optional] [readonly]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**phoneNumber** | **String** | The phone number in +E164 format. | [optional] [readonly]
-**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**techPrefixEnabled** | **Boolean** | Controls whether a tech prefix is enabled for this phone number. | [optional]
-**translatedNumber** | **String** | This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed. | [optional]
-**callForwarding** | [**CallForwarding**](CallForwarding.md) | | [optional]
-**cnamListing** | [**CnamListing**](CnamListing.md) | | [optional]
-**emergency** | [**EmergencySettings**](EmergencySettings.md) | | [optional]
-**usagePaymentMethod** | [**UsagePaymentMethodEnum**](#UsagePaymentMethodEnum) | Controls whether a number is billed per minute or uses your concurrent channels. | [optional]
-**mediaFeatures** | [**MediaFeatures**](MediaFeatures.md) | | [optional]
-**callRecording** | [**CallRecording**](CallRecording.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the type of resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**phoneNumber** | **String** | The phone number in +E164 format. | [optional] [readonly] |
+|**connectionId** | **String** | Identifies the connection associated with this phone number. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**techPrefixEnabled** | **Boolean** | Controls whether a tech prefix is enabled for this phone number. | [optional] |
+|**translatedNumber** | **String** | This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed. | [optional] |
+|**callForwarding** | [**CallForwarding**](CallForwarding.md) | | [optional] |
+|**cnamListing** | [**CnamListing**](CnamListing.md) | | [optional] |
+|**emergency** | [**EmergencySettings**](EmergencySettings.md) | | [optional] |
+|**usagePaymentMethod** | [**UsagePaymentMethodEnum**](#UsagePaymentMethodEnum) | Controls whether a number is billed per minute or uses your concurrent channels. | [optional] |
+|**mediaFeatures** | [**MediaFeatures**](MediaFeatures.md) | | [optional] |
+|**callRecording** | [**CallRecording**](CallRecording.md) | | [optional] |
## Enum: UsagePaymentMethodEnum
-Name | Value
----- | -----
-PAY_PER_MINUTE | "pay-per-minute"
-CHANNEL | "channel"
+| Name | Value |
+|---- | -----|
+| PAY_PER_MINUTE | "pay-per-minute" |
+| CHANNEL | "channel" |
diff --git a/docs/PhoneNumbersBulkUpdateError.md b/docs/PhoneNumbersBulkUpdateError.md
index 52daee1c..ff36a386 100644
--- a/docs/PhoneNumbersBulkUpdateError.md
+++ b/docs/PhoneNumbersBulkUpdateError.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**errors** | [**List<Error>**](Error.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**errors** | [**List<Error>**](Error.md) | | [optional] |
diff --git a/docs/PhoneNumbersEnableEmergency.md b/docs/PhoneNumbersEnableEmergency.md
index af5e2aa9..40569a6e 100644
--- a/docs/PhoneNumbersEnableEmergency.md
+++ b/docs/PhoneNumbersEnableEmergency.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional] |
diff --git a/docs/PhoneNumbersJob.md b/docs/PhoneNumbersJob.md
index e4c275b9..f34c302d 100644
--- a/docs/PhoneNumbersJob.md
+++ b/docs/PhoneNumbersJob.md
@@ -5,41 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Identifies the resource. | [optional] [readonly]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | Indicates the completion status of the background update. | [optional] [readonly]
-**type** | [**TypeEnum**](#TypeEnum) | Identifies the type of the background job. | [optional] [readonly]
-**etc** | **OffsetDateTime** | ISO 8601 formatted date indicating when the estimated time of completion of the background job. | [optional] [readonly]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
-**phoneNumbers** | [**List<PhoneNumbersJobPhoneNumber>**](PhoneNumbersJobPhoneNumber.md) | | [optional]
-**successfulOperations** | [**List<PhoneNumbersJobSuccessfulOperation>**](PhoneNumbersJobSuccessfulOperation.md) | | [optional] [readonly]
-**pendingOperations** | [**List<PhoneNumbersJobPendingOperation>**](PhoneNumbersJobPendingOperation.md) | | [optional] [readonly]
-**failedOperations** | [**List<PhoneNumbersJobFailedOperation>**](PhoneNumbersJobFailedOperation.md) | | [optional] [readonly]
-
-
-
-## Enum: StatusEnum
-
-Name | Value
----- | -----
-PENDING | "pending"
-IN_PROGRESS | "in_progress"
-COMPLETED | "completed"
-FAILED | "failed"
-EXPIRED | "expired"
-
-
-
-## Enum: TypeEnum
-
-Name | Value
----- | -----
-UPDATE_EMERGENCY_SETTINGS | "update_emergency_settings"
-DELETE_PHONE_NUMBERS | "delete_phone_numbers"
-UPDATE_PHONE_NUMBERS | "update_phone_numbers"
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional] |
diff --git a/docs/PhoneNumbersJobDeletePhoneNumbers.md b/docs/PhoneNumbersJobDeletePhoneNumbers.md
index 51bc7760..fd02dc28 100644
--- a/docs/PhoneNumbersJobDeletePhoneNumbers.md
+++ b/docs/PhoneNumbersJobDeletePhoneNumbers.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional] |
diff --git a/docs/PhoneNumbersJobDeletePhoneNumbersRequest.md b/docs/PhoneNumbersJobDeletePhoneNumbersRequest.md
index 122029df..f326b267 100644
--- a/docs/PhoneNumbersJobDeletePhoneNumbersRequest.md
+++ b/docs/PhoneNumbersJobDeletePhoneNumbersRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumbers** | **List<String>** | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | | |
diff --git a/docs/PhoneNumbersJobFailedOperation.md b/docs/PhoneNumbersJobFailedOperation.md
index 78627e73..6ad752d7 100644
--- a/docs/PhoneNumbersJobFailedOperation.md
+++ b/docs/PhoneNumbersJobFailedOperation.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**id** | **String** | The phone number's ID | [optional]
-**errors** | [**List<Error>**](Error.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**id** | **String** | The phone number's ID | [optional] |
+|**errors** | [**List<Error>**](Error.md) | | [optional] |
diff --git a/docs/PhoneNumbersJobPendingOperation.md b/docs/PhoneNumbersJobPendingOperation.md
index d55707e9..e96c8c87 100644
--- a/docs/PhoneNumbersJobPendingOperation.md
+++ b/docs/PhoneNumbersJobPendingOperation.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**id** | **String** | The phone number's ID | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**id** | **String** | The phone number's ID | [optional] |
diff --git a/docs/PhoneNumbersJobPhoneNumber.md b/docs/PhoneNumbersJobPhoneNumber.md
index 08417213..ed4824ae 100644
--- a/docs/PhoneNumbersJobPhoneNumber.md
+++ b/docs/PhoneNumbersJobPhoneNumber.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**id** | **String** | The phone number's ID | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**id** | **String** | The phone number's ID | [optional] |
diff --git a/docs/PhoneNumbersJobSuccessfulOperation.md b/docs/PhoneNumbersJobSuccessfulOperation.md
index 52f191c0..496e534a 100644
--- a/docs/PhoneNumbersJobSuccessfulOperation.md
+++ b/docs/PhoneNumbersJobSuccessfulOperation.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | The phone number in e164 format. | [optional]
-**id** | **String** | The phone number's ID | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | The phone number in e164 format. | [optional] |
+|**id** | **String** | The phone number's ID | [optional] |
diff --git a/docs/PhoneNumbersJobUpdateEmergencySettingsRequest.md b/docs/PhoneNumbersJobUpdateEmergencySettingsRequest.md
index 79abc18c..dd6ba6d5 100644
--- a/docs/PhoneNumbersJobUpdateEmergencySettingsRequest.md
+++ b/docs/PhoneNumbersJobUpdateEmergencySettingsRequest.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumbers** | **List<String>** | |
-**emergencyEnabled** | **Boolean** | Indicates whether to enable emergency services on this number. |
-**emergencyAddressId** | **String** | Identifies the address to be used with emergency services. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | | |
+|**emergencyEnabled** | **Boolean** | Indicates whether to enable emergency services on this number. | |
+|**emergencyAddressId** | **String** | Identifies the address to be used with emergency services. | |
diff --git a/docs/PhoneNumbersJobUpdatePhoneNumbers.md b/docs/PhoneNumbersJobUpdatePhoneNumbers.md
index c76ac663..28a58237 100644
--- a/docs/PhoneNumbersJobUpdatePhoneNumbers.md
+++ b/docs/PhoneNumbersJobUpdatePhoneNumbers.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PhoneNumbersJob**](PhoneNumbersJob.md) | | [optional] |
diff --git a/docs/PhoneNumbersJobUpdatePhoneNumbersRequest.md b/docs/PhoneNumbersJobUpdatePhoneNumbersRequest.md
index 6868f539..3837d4f0 100644
--- a/docs/PhoneNumbersJobUpdatePhoneNumbersRequest.md
+++ b/docs/PhoneNumbersJobUpdatePhoneNumbersRequest.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumbers** | **List<String>** | Array of phone number ids and/or phone numbers in E164 format to update |
-**tags** | **List<String>** | A list of user-assigned tags to help organize phone numbers. | [optional]
-**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | Array of phone number ids and/or phone numbers in E164 format to update | |
+|**tags** | **List<String>** | A list of user-assigned tags to help organize phone numbers. | [optional] |
+|**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional] |
diff --git a/docs/PlayAudioUrlRequest.md b/docs/PlayAudioUrlRequest.md
index 5f791f0b..ef9d8d37 100644
--- a/docs/PlayAudioUrlRequest.md
+++ b/docs/PlayAudioUrlRequest.md
@@ -5,17 +5,18 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**audioUrl** | **String** | The URL of a file to be played back on the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional]
-**mediaName** | **String** | The media_name of a file to be played back on the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional]
-**loop** | [**Loopcount**](Loopcount.md) | | [optional]
-**overlay** | **Boolean** | When enabled, audio will be mixed on top of any other audio that is actively being played back. Note that `overlay: true` will only work if there is another audio file already being played on the call. | [optional]
-**stop** | **String** | When specified, it stops the current audio being played. Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue. | [optional]
-**targetLegs** | **String** | Specifies the leg or legs on which audio will be played. If supplied, the value must be either `self`, `opposite` or `both`. | [optional]
-**cacheAudio** | **Boolean** | Fetches the audio file for caching prior to playing on the call. Useful when an audio file is queued. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**audioUrl** | **String** | The URL of a file to be played back on the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional] |
+|**mediaName** | **String** | The media_name of a file to be played back on the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional] |
+|**loop** | [**Loopcount**](Loopcount.md) | | [optional] |
+|**overlay** | **Boolean** | When enabled, audio will be mixed on top of any other audio that is actively being played back. Note that `overlay: true` will only work if there is another audio file already being played on the call. | [optional] |
+|**stop** | **String** | When specified, it stops the current audio being played. Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue. | [optional] |
+|**targetLegs** | **String** | Specifies the leg or legs on which audio will be played. If supplied, the value must be either `self`, `opposite` or `both`. | [optional] |
+|**cacheAudio** | **Boolean** | Fetches the audio file for caching prior to playing on the call. Useful when an audio file is queued. | [optional] |
+|**playbackContent** | **String** | Allows a user to provide base64 encoded mp3. Note: when using this parameter, `media_url` and `media_name` in the `playback_started` and `playback_ended` webhooks will be empty | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/PlaybackStopRequest.md b/docs/PlaybackStopRequest.md
index 7fc780d6..acd446df 100644
--- a/docs/PlaybackStopRequest.md
+++ b/docs/PlaybackStopRequest.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**overlay** | **Boolean** | When enabled, it stops the audio being played in the overlay queue. | [optional]
-**stop** | **String** | Use `current` to stop the current audio being played. Use `all` to stop the current audio file being played and clear all audio files from the queue. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**overlay** | **Boolean** | When enabled, it stops the audio being played in the overlay queue. | [optional] |
+|**stop** | **String** | Use `current` to stop the current audio being played. Use `all` to stop the current audio file being played and clear all audio files from the queue. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/PortOutSupportingDocument.md b/docs/PortOutSupportingDocument.md
index c9d634fc..6d10441e 100644
--- a/docs/PortOutSupportingDocument.md
+++ b/docs/PortOutSupportingDocument.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | |
-**recordType** | **String** | Identifies the type of the resource. | [readonly]
-**type** | [**TypeEnum**](#TypeEnum) | Identifies the type of the document | [readonly]
-**portoutId** | **UUID** | Identifies the associated port request | [readonly]
-**documentId** | **UUID** | Identifies the associated document |
-**createdAt** | **String** | Supporting document creation timestamp in ISO 8601 format |
-**updatedAt** | **String** | Supporting document last changed timestamp in ISO 8601 format |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | |
+|**recordType** | **String** | Identifies the type of the resource. | [readonly] |
+|**type** | [**TypeEnum**](#TypeEnum) | Identifies the type of the document | [readonly] |
+|**portoutId** | **UUID** | Identifies the associated port request | [readonly] |
+|**documentId** | **UUID** | Identifies the associated document | |
+|**createdAt** | **String** | Supporting document creation timestamp in ISO 8601 format | |
+|**updatedAt** | **String** | Supporting document last changed timestamp in ISO 8601 format | |
## Enum: TypeEnum
-Name | Value
----- | -----
-LOA | "loa"
-INVOICE | "invoice"
+| Name | Value |
+|---- | -----|
+| LOA | "loa" |
+| INVOICE | "invoice" |
diff --git a/docs/Portability.md b/docs/Portability.md
index e2c18a0c..c6d765ce 100644
--- a/docs/Portability.md
+++ b/docs/Portability.md
@@ -5,31 +5,31 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**lrn** | **String** | Local Routing Number, if assigned to the requested phone number | [optional]
-**portedStatus** | [**PortedStatusEnum**](#PortedStatusEnum) | Indicates whether or not the requested phone number has been ported | [optional]
-**portedDate** | **String** | ISO-formatted date when the requested phone number has been ported | [optional]
-**ocn** | **String** | Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database | [optional]
-**lineType** | **String** | Type of number | [optional]
-**spid** | **String** | SPID (Service Provider ID) | [optional]
-**spidCarrierName** | **String** | Service provider name | [optional]
-**spidCarrierType** | **String** | Service provider type | [optional]
-**altspid** | **String** | Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier | [optional]
-**altspidCarrierName** | **String** | Alternative service provider name | [optional]
-**altspidCarrierType** | **String** | Alternative service provider type | [optional]
-**city** | **String** | City name extracted from the locality in the Local Exchange Routing Guide (LERG) database | [optional]
-**state** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**lrn** | **String** | Local Routing Number, if assigned to the requested phone number | [optional] |
+|**portedStatus** | [**PortedStatusEnum**](#PortedStatusEnum) | Indicates whether or not the requested phone number has been ported | [optional] |
+|**portedDate** | **String** | ISO-formatted date when the requested phone number has been ported | [optional] |
+|**ocn** | **String** | Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database | [optional] |
+|**lineType** | **String** | Type of number | [optional] |
+|**spid** | **String** | SPID (Service Provider ID) | [optional] |
+|**spidCarrierName** | **String** | Service provider name | [optional] |
+|**spidCarrierType** | **String** | Service provider type | [optional] |
+|**altspid** | **String** | Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier | [optional] |
+|**altspidCarrierName** | **String** | Alternative service provider name | [optional] |
+|**altspidCarrierType** | **String** | Alternative service provider type | [optional] |
+|**city** | **String** | City name extracted from the locality in the Local Exchange Routing Guide (LERG) database | [optional] |
+|**state** | **String** | | [optional] |
## Enum: PortedStatusEnum
-Name | Value
----- | -----
-Y | "Y"
-N | "N"
-EMPTY | ""
+| Name | Value |
+|---- | -----|
+| Y | "Y" |
+| N | "N" |
+| EMPTY | "" |
diff --git a/docs/PortabilityCheckDetails.md b/docs/PortabilityCheckDetails.md
index 1536658c..068b50d7 100644
--- a/docs/PortabilityCheckDetails.md
+++ b/docs/PortabilityCheckDetails.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**fastPortable** | **Boolean** | Indicates whether this phone number is FastPort eligible | [optional] [readonly]
-**notPortableReason** | **String** | If this phone number is not portable, explains why. Empty string if the number is portable. | [optional] [readonly]
-**phoneNumber** | **String** | The +E.164 formatted phone number this result is about | [optional] [readonly]
-**portable** | **Boolean** | Indicates whether this phone number is portable | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**fastPortable** | **Boolean** | Indicates whether this phone number is FastPort eligible | [optional] [readonly] |
+|**notPortableReason** | **String** | If this phone number is not portable, explains why. Empty string if the number is portable. | [optional] [readonly] |
+|**phoneNumber** | **String** | The +E.164 formatted phone number this result is about | [optional] [readonly] |
+|**portable** | **Boolean** | Indicates whether this phone number is portable | [optional] [readonly] |
diff --git a/docs/PortingOrder.md b/docs/PortingOrder.md
index ac8000ec..54c1fb25 100644
--- a/docs/PortingOrder.md
+++ b/docs/PortingOrder.md
@@ -5,27 +5,43 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Uniquely identifies this porting order | [optional] [readonly]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**status** | [**PortingOrderStatus**](PortingOrderStatus.md) | | [optional]
-**supportKey** | **String** | A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders. | [optional] [readonly]
-**parentSupportKey** | **String** | A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in `draft` state | [optional] [readonly]
-**portingPhoneNumbersCount** | **Integer** | Count of phone numbers associated with this porting order | [optional] [readonly]
-**oldServiceProviderOcn** | **String** | Identifies the old service provider | [optional] [readonly]
-**documents** | [**PortingOrderDocuments**](PortingOrderDocuments.md) | | [optional]
-**misc** | [**PortingOrderMisc**](PortingOrderMisc.md) | | [optional]
-**endUser** | [**PortingOrderEndUser**](PortingOrderEndUser.md) | | [optional]
-**activationSettings** | [**PortingOrderActivationSettings**](PortingOrderActivationSettings.md) | | [optional]
-**phoneNumberConfiguration** | [**PortingOrderPhoneNumberConfiguration**](PortingOrderPhoneNumberConfiguration.md) | | [optional]
-**description** | **String** | A description of the porting order | [optional] [readonly]
-**requirements** | [**List<PortingOrderRequirement>**](PortingOrderRequirement.md) | List of documentation requirements for porting numbers. | [optional]
-**userFeedback** | [**PortingOrderUserFeedback**](PortingOrderUserFeedback.md) | | [optional]
-**webhookUrl** | **URI** | | [optional]
-**userReference** | **String** | A customer-specified reference number for customer bookkeeping purposes | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Uniquely identifies this porting order | [optional] [readonly] |
+|**customerReference** | **String** | A customer-specified reference number for customer bookkeeping purposes | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**status** | [**PortingOrderStatus**](PortingOrderStatus.md) | | [optional] |
+|**supportKey** | **String** | A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders. | [optional] [readonly] |
+|**parentSupportKey** | **String** | A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in `draft` state | [optional] [readonly] |
+|**portingPhoneNumbersCount** | **Integer** | Count of phone numbers associated with this porting order | [optional] [readonly] |
+|**oldServiceProviderOcn** | **String** | Identifies the old service provider | [optional] [readonly] |
+|**documents** | [**PortingOrderDocuments**](PortingOrderDocuments.md) | | [optional] |
+|**misc** | [**PortingOrderMisc**](PortingOrderMisc.md) | | [optional] |
+|**endUser** | [**PortingOrderEndUser**](PortingOrderEndUser.md) | | [optional] |
+|**activationSettings** | [**PortingOrderActivationSettings**](PortingOrderActivationSettings.md) | | [optional] |
+|**phoneNumberConfiguration** | [**PortingOrderPhoneNumberConfiguration**](PortingOrderPhoneNumberConfiguration.md) | | [optional] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The type of the phone number | [optional] |
+|**description** | **String** | A description of the porting order | [optional] [readonly] |
+|**requirements** | [**List<PortingOrderRequirement>**](PortingOrderRequirement.md) | List of documentation requirements for porting numbers. | [optional] |
+|**requirementsMet** | **Boolean** | Is true when the required documentation is met | [optional] |
+|**userFeedback** | [**PortingOrderUserFeedback**](PortingOrderUserFeedback.md) | | [optional] |
+|**userId** | **UUID** | Identifies the user (or organization) who requested the porting order | [optional] |
+|**webhookUrl** | **URI** | | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+
+
+
+## Enum: PhoneNumberTypeEnum
+
+| Name | Value |
+|---- | -----|
+| LANDLINE | "landline" |
+| LOCAL | "local" |
+| MOBILE | "mobile" |
+| NATIONAL | "national" |
+| SHARED_COST | "shared_cost" |
+| TOLL_FREE | "toll_free" |
diff --git a/docs/PortingOrderActivationSettings.md b/docs/PortingOrderActivationSettings.md
index 27c60371..33040074 100644
--- a/docs/PortingOrderActivationSettings.md
+++ b/docs/PortingOrderActivationSettings.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**focDatetimeRequested** | **OffsetDateTime** | ISO 8601 formatted Date/Time requested for the FOC date | [optional]
-**focDatetimeActual** | **OffsetDateTime** | ISO 8601 formatted Date/Time of the FOC date | [optional]
-**fastPortEligible** | **Boolean** | Indicates whether this porting order is eligible for FastPort | [optional] [readonly]
-**activationStatus** | **PortingOrderActivationStatus** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**focDatetimeRequested** | **OffsetDateTime** | ISO 8601 formatted Date/Time requested for the FOC date | [optional] |
+|**focDatetimeActual** | **OffsetDateTime** | ISO 8601 formatted Date/Time of the FOC date | [optional] |
+|**fastPortEligible** | **Boolean** | Indicates whether this porting order is eligible for FastPort | [optional] [readonly] |
+|**activationStatus** | **PortingOrderActivationStatus** | | [optional] |
diff --git a/docs/PortingOrderApi.md b/docs/PortingOrderApi.md
index 68101bbe..528ca69b 100644
--- a/docs/PortingOrderApi.md
+++ b/docs/PortingOrderApi.md
@@ -16,6 +16,7 @@ Method | HTTP request | Description
[**getPortingOrdersActivationJob**](PortingOrderApi.md#getPortingOrdersActivationJob) | **GET** /porting_orders/{id}/activation_jobs/{activationJobId} | Retrieve a porting activation job
[**listAllowedFocWindows**](PortingOrderApi.md#listAllowedFocWindows) | **GET** /porting_orders/{id}/allowed_foc_windows | List allowed FOC dates
[**listPortingOrderDocuments**](PortingOrderApi.md#listPortingOrderDocuments) | **GET** /porting_orders/{id}/documents | List all documents associated with a porting order
+[**listPortingOrderRequirements**](PortingOrderApi.md#listPortingOrderRequirements) | **GET** /porting_orders/{id}/requirements | List all required documents for this porting order
[**listPortingOrders**](PortingOrderApi.md#listPortingOrders) | **GET** /porting_orders | List all porting orders
[**listPortingOrdersActivationJobs**](PortingOrderApi.md#listPortingOrdersActivationJobs) | **GET** /porting_orders/{id}/activation_jobs | List all porting activation jobs
[**listPortingOrdersComments**](PortingOrderApi.md#listPortingOrdersComments) | **GET** /porting_orders/{id}/comments | List all comments of a porting order
@@ -28,7 +29,7 @@ Method | HTTP request | Description
## activatePortingOrder
-> ShowPortingOrdersActivationJob activatePortingOrder(id)
+> ActivatePortingOrder202Response activatePortingOrder(id)
Activates every number on a porting order.
@@ -58,7 +59,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
- ShowPortingOrdersActivationJob result = apiInstance.activatePortingOrder(id);
+ ActivatePortingOrder202Response result = apiInstance.activatePortingOrder(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#activatePortingOrder");
@@ -80,7 +81,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrdersActivationJob**](ShowPortingOrdersActivationJob.md)
+[**ActivatePortingOrder202Response**](ActivatePortingOrder202Response.md)
### Authorization
@@ -101,7 +102,7 @@ Name | Type | Description | Notes
## cancelPortingOrder
-> ShowPortingOrder cancelPortingOrder(id)
+> CancelPortingOrder200Response cancelPortingOrder(id)
Cancel a porting order
@@ -131,7 +132,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
- ShowPortingOrder result = apiInstance.cancelPortingOrder(id);
+ CancelPortingOrder200Response result = apiInstance.cancelPortingOrder(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#cancelPortingOrder");
@@ -153,7 +154,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrder**](ShowPortingOrder.md)
+[**CancelPortingOrder200Response**](CancelPortingOrder200Response.md)
### Authorization
@@ -174,7 +175,7 @@ Name | Type | Description | Notes
## confirmPortingOrder
-> ShowPortingOrder confirmPortingOrder(id)
+> ConfirmPortingOrder200Response confirmPortingOrder(id)
Submit a porting order.
@@ -204,7 +205,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
- ShowPortingOrder result = apiInstance.confirmPortingOrder(id);
+ ConfirmPortingOrder200Response result = apiInstance.confirmPortingOrder(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#confirmPortingOrder");
@@ -226,7 +227,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrder**](ShowPortingOrder.md)
+[**ConfirmPortingOrder200Response**](ConfirmPortingOrder200Response.md)
### Authorization
@@ -247,7 +248,7 @@ Name | Type | Description | Notes
## createPortingOrder
-> ListDraftPortingOrderWithoutPagination createPortingOrder(createPortingOrder)
+> CreatePortingOrder201Response createPortingOrder(createPortingOrder)
Create a porting order
@@ -276,7 +277,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
CreatePortingOrder createPortingOrder = new CreatePortingOrder(); // CreatePortingOrder |
try {
- ListDraftPortingOrderWithoutPagination result = apiInstance.createPortingOrder(createPortingOrder);
+ CreatePortingOrder201Response result = apiInstance.createPortingOrder(createPortingOrder);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createPortingOrder");
@@ -298,7 +299,7 @@ Name | Type | Description | Notes
### Return type
-[**ListDraftPortingOrderWithoutPagination**](ListDraftPortingOrderWithoutPagination.md)
+[**CreatePortingOrder201Response**](CreatePortingOrder201Response.md)
### Authorization
@@ -319,7 +320,7 @@ Name | Type | Description | Notes
## createPortingOrderComment
-> ShowPortingOrderComment createPortingOrderComment(id, createPortingOrderComment)
+> CreatePortingOrderComment201Response createPortingOrderComment(id, createPortingOrderComment)
Create a comment for a porting order
@@ -350,7 +351,7 @@ public class Example {
UUID id = UUID.randomUUID(); // UUID | Porting Order id
CreatePortingOrderComment createPortingOrderComment = new CreatePortingOrderComment(); // CreatePortingOrderComment |
try {
- ShowPortingOrderComment result = apiInstance.createPortingOrderComment(id, createPortingOrderComment);
+ CreatePortingOrderComment201Response result = apiInstance.createPortingOrderComment(id, createPortingOrderComment);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createPortingOrderComment");
@@ -373,7 +374,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrderComment**](ShowPortingOrderComment.md)
+[**CreatePortingOrderComment201Response**](CreatePortingOrderComment201Response.md)
### Authorization
@@ -466,7 +467,7 @@ null (empty response body)
## getPortingOrder
-> ShowPortingOrder getPortingOrder(id, includePhoneNumbers)
+> GetPortingOrder200Response getPortingOrder(id, includePhoneNumbers)
Retrieve a porting order
@@ -497,7 +498,7 @@ public class Example {
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Boolean includePhoneNumbers = true; // Boolean | Include the first 50 phone number objects in the results
try {
- ShowPortingOrder result = apiInstance.getPortingOrder(id, includePhoneNumbers);
+ GetPortingOrder200Response result = apiInstance.getPortingOrder(id, includePhoneNumbers);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrder");
@@ -520,7 +521,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrder**](ShowPortingOrder.md)
+[**GetPortingOrder200Response**](GetPortingOrder200Response.md)
### Authorization
@@ -612,7 +613,7 @@ Name | Type | Description | Notes
## getPortingOrderSubRequest
-> SubRequestByPortingOrder getPortingOrderSubRequest(id)
+> GetPortingOrderSubRequest200Response getPortingOrderSubRequest(id)
Retrieve the associated V1 sub_request_id and port_request_id
@@ -642,7 +643,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
- SubRequestByPortingOrder result = apiInstance.getPortingOrderSubRequest(id);
+ GetPortingOrderSubRequest200Response result = apiInstance.getPortingOrderSubRequest(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrderSubRequest");
@@ -664,7 +665,7 @@ Name | Type | Description | Notes
### Return type
-[**SubRequestByPortingOrder**](SubRequestByPortingOrder.md)
+[**GetPortingOrderSubRequest200Response**](GetPortingOrderSubRequest200Response.md)
### Authorization
@@ -685,7 +686,7 @@ Name | Type | Description | Notes
## getPortingOrdersActivationJob
-> ShowPortingOrdersActivationJob getPortingOrdersActivationJob(id, activationJobId)
+> ActivatePortingOrder202Response getPortingOrdersActivationJob(id, activationJobId)
Retrieve a porting activation job
@@ -716,7 +717,7 @@ public class Example {
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UUID activationJobId = UUID.randomUUID(); // UUID | Activation Job Identifier
try {
- ShowPortingOrdersActivationJob result = apiInstance.getPortingOrdersActivationJob(id, activationJobId);
+ ActivatePortingOrder202Response result = apiInstance.getPortingOrdersActivationJob(id, activationJobId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrdersActivationJob");
@@ -739,7 +740,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrdersActivationJob**](ShowPortingOrdersActivationJob.md)
+[**ActivatePortingOrder202Response**](ActivatePortingOrder202Response.md)
### Authorization
@@ -760,7 +761,7 @@ Name | Type | Description | Notes
## listAllowedFocWindows
-> ListAllowedFocWindow listAllowedFocWindows(id)
+> ListAllowedFocWindows200Response listAllowedFocWindows(id)
List allowed FOC dates
@@ -790,7 +791,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
- ListAllowedFocWindow result = apiInstance.listAllowedFocWindows(id);
+ ListAllowedFocWindows200Response result = apiInstance.listAllowedFocWindows(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listAllowedFocWindows");
@@ -812,7 +813,7 @@ Name | Type | Description | Notes
### Return type
-[**ListAllowedFocWindow**](ListAllowedFocWindow.md)
+[**ListAllowedFocWindows200Response**](ListAllowedFocWindows200Response.md)
### Authorization
@@ -832,7 +833,7 @@ Name | Type | Description | Notes
## listPortingOrderDocuments
-> ListPortingOrderDocuments listPortingOrderDocuments(id, pageNumber, pageSize)
+> ListPortingOrderDocuments200Response listPortingOrderDocuments(id, pageNumber, pageSize)
List all documents associated with a porting order
@@ -864,7 +865,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListPortingOrderDocuments result = apiInstance.listPortingOrderDocuments(id, pageNumber, pageSize);
+ ListPortingOrderDocuments200Response result = apiInstance.listPortingOrderDocuments(id, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrderDocuments");
@@ -888,7 +889,84 @@ Name | Type | Description | Notes
### Return type
-[**ListPortingOrderDocuments**](ListPortingOrderDocuments.md)
+[**ListPortingOrderDocuments200Response**](ListPortingOrderDocuments200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **401** | Unauthorized | - |
+| **422** | Unprocessable entity. Check message field in response for details. | - |
+
+
+## listPortingOrderRequirements
+
+> ListPortingOrderRequirements200Response listPortingOrderRequirements(id, pageNumber, pageSize)
+
+List all required documents for this porting order
+
+Returns a list of all requirements for this porting order.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.PortingOrderApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
+ UUID id = UUID.randomUUID(); // UUID | Porting Order id
+ Integer pageNumber = 1; // Integer | The page number to load
+ Integer pageSize = 20; // Integer | The size of the page
+ try {
+ ListPortingOrderRequirements200Response result = apiInstance.listPortingOrderRequirements(id, pageNumber, pageSize);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PortingOrderApi#listPortingOrderRequirements");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Porting Order id |
+ **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+
+### Return type
+
+[**ListPortingOrderRequirements200Response**](ListPortingOrderRequirements200Response.md)
### Authorization
@@ -909,7 +987,7 @@ Name | Type | Description | Notes
## listPortingOrders
-> ListPortingOrder listPortingOrders(pageNumber, pageSize, includePhoneNumbers, filterStatus, filterCustomerReference, filterPhoneNumbersCountryCode, filterPhoneNumbersCarrierName, filterMiscType, filterEndUserAdminEntityName, filterEndUserAdminAuthPersonName, filterActivationSettingsFastPortEligible, filterActivationSettingsFocDatetimeRequestedGt, filterActivationSettingsFocDatetimeRequestedLt, sort)
+> ListPortingOrders200Response listPortingOrders(pageNumber, pageSize, includePhoneNumbers, filterStatus, filterCustomerReference, filterPhoneNumbersCountryCode, filterPhoneNumbersCarrierName, filterMiscType, filterEndUserAdminEntityName, filterEndUserAdminAuthPersonName, filterActivationSettingsFastPortEligible, filterActivationSettingsFocDatetimeRequestedGt, filterActivationSettingsFocDatetimeRequestedLt, sort)
List all porting orders
@@ -951,7 +1029,7 @@ public class Example {
String filterActivationSettingsFocDatetimeRequestedLt = "2021-03-25T10:00:00.000Z"; // String | Filter results by foc date earlier than this value
String sort = "created_at"; // String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
try {
- ListPortingOrder result = apiInstance.listPortingOrders(pageNumber, pageSize, includePhoneNumbers, filterStatus, filterCustomerReference, filterPhoneNumbersCountryCode, filterPhoneNumbersCarrierName, filterMiscType, filterEndUserAdminEntityName, filterEndUserAdminAuthPersonName, filterActivationSettingsFastPortEligible, filterActivationSettingsFocDatetimeRequestedGt, filterActivationSettingsFocDatetimeRequestedLt, sort);
+ ListPortingOrders200Response result = apiInstance.listPortingOrders(pageNumber, pageSize, includePhoneNumbers, filterStatus, filterCustomerReference, filterPhoneNumbersCountryCode, filterPhoneNumbersCarrierName, filterMiscType, filterEndUserAdminEntityName, filterEndUserAdminAuthPersonName, filterActivationSettingsFastPortEligible, filterActivationSettingsFocDatetimeRequestedGt, filterActivationSettingsFocDatetimeRequestedLt, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrders");
@@ -986,7 +1064,7 @@ Name | Type | Description | Notes
### Return type
-[**ListPortingOrder**](ListPortingOrder.md)
+[**ListPortingOrders200Response**](ListPortingOrders200Response.md)
### Authorization
@@ -1007,7 +1085,7 @@ Name | Type | Description | Notes
## listPortingOrdersActivationJobs
-> ListPortingOrdersActivationJobs listPortingOrdersActivationJobs(id, pageNumber, pageSize)
+> ListPortingOrdersActivationJobs200Response listPortingOrdersActivationJobs(id, pageNumber, pageSize)
List all porting activation jobs
@@ -1039,7 +1117,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListPortingOrdersActivationJobs result = apiInstance.listPortingOrdersActivationJobs(id, pageNumber, pageSize);
+ ListPortingOrdersActivationJobs200Response result = apiInstance.listPortingOrdersActivationJobs(id, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrdersActivationJobs");
@@ -1063,7 +1141,7 @@ Name | Type | Description | Notes
### Return type
-[**ListPortingOrdersActivationJobs**](ListPortingOrdersActivationJobs.md)
+[**ListPortingOrdersActivationJobs200Response**](ListPortingOrdersActivationJobs200Response.md)
### Authorization
@@ -1084,7 +1162,7 @@ Name | Type | Description | Notes
## listPortingOrdersComments
-> ListPortingOrdersComments listPortingOrdersComments(id, pageNumber, pageSize)
+> ListPortingOrdersComments200Response listPortingOrdersComments(id, pageNumber, pageSize)
List all comments of a porting order
@@ -1116,7 +1194,7 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
- ListPortingOrdersComments result = apiInstance.listPortingOrdersComments(id, pageNumber, pageSize);
+ ListPortingOrdersComments200Response result = apiInstance.listPortingOrdersComments(id, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrdersComments");
@@ -1140,7 +1218,7 @@ Name | Type | Description | Notes
### Return type
-[**ListPortingOrdersComments**](ListPortingOrdersComments.md)
+[**ListPortingOrdersComments200Response**](ListPortingOrdersComments200Response.md)
### Authorization
@@ -1161,7 +1239,7 @@ Name | Type | Description | Notes
## listPortingOrdersExceptionTypes
-> ListPortingOrdersExceptionTypes listPortingOrdersExceptionTypes()
+> ListPortingOrdersExceptionTypes200Response listPortingOrdersExceptionTypes()
List all exception types
@@ -1189,7 +1267,7 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
try {
- ListPortingOrdersExceptionTypes result = apiInstance.listPortingOrdersExceptionTypes();
+ ListPortingOrdersExceptionTypes200Response result = apiInstance.listPortingOrdersExceptionTypes();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrdersExceptionTypes");
@@ -1208,7 +1286,7 @@ This endpoint does not need any parameter.
### Return type
-[**ListPortingOrdersExceptionTypes**](ListPortingOrdersExceptionTypes.md)
+[**ListPortingOrdersExceptionTypes200Response**](ListPortingOrdersExceptionTypes200Response.md)
### Authorization
@@ -1229,7 +1307,7 @@ This endpoint does not need any parameter.
## listPortingPhoneNumbers
-> ListPortingPhoneNumbers listPortingPhoneNumbers(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterSupportKeyEq, filterSupportKeyIn, filterPhoneNumber, filterPhoneNumberIn, filterPortingOrderStatus, filterActivationStatus, filterPortabilityStatus)
+> ListPortingPhoneNumbers200Response listPortingPhoneNumbers(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterSupportKeyEq, filterSupportKeyIn, filterPhoneNumber, filterPhoneNumberIn, filterPortingOrderStatus, filterActivationStatus, filterPortabilityStatus)
List all porting phone numbers
@@ -1269,7 +1347,7 @@ public class Example {
PortingOrderActivationStatus filterActivationStatus = PortingOrderActivationStatus.fromValue("New"); // PortingOrderActivationStatus | Filter results by activation status
PortabilityStatus filterPortabilityStatus = PortabilityStatus.fromValue("pending"); // PortabilityStatus | Filter results by portability status
try {
- ListPortingPhoneNumbers result = apiInstance.listPortingPhoneNumbers(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterSupportKeyEq, filterSupportKeyIn, filterPhoneNumber, filterPhoneNumberIn, filterPortingOrderStatus, filterActivationStatus, filterPortabilityStatus);
+ ListPortingPhoneNumbers200Response result = apiInstance.listPortingPhoneNumbers(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterSupportKeyEq, filterSupportKeyIn, filterPhoneNumber, filterPhoneNumberIn, filterPortingOrderStatus, filterActivationStatus, filterPortabilityStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingPhoneNumbers");
@@ -1301,7 +1379,7 @@ Name | Type | Description | Notes
### Return type
-[**ListPortingPhoneNumbers**](ListPortingPhoneNumbers.md)
+[**ListPortingPhoneNumbers200Response**](ListPortingPhoneNumbers200Response.md)
### Authorization
@@ -1322,7 +1400,7 @@ Name | Type | Description | Notes
## updatePortingOrder
-> ShowPortingOrder updatePortingOrder(id, updatePortingOrder)
+> UpdatePortingOrder200Response updatePortingOrder(id, updatePortingOrder)
Edit a porting order
@@ -1357,7 +1435,7 @@ public class Example {
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UpdatePortingOrder updatePortingOrder = new UpdatePortingOrder(); // UpdatePortingOrder |
try {
- ShowPortingOrder result = apiInstance.updatePortingOrder(id, updatePortingOrder);
+ UpdatePortingOrder200Response result = apiInstance.updatePortingOrder(id, updatePortingOrder);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#updatePortingOrder");
@@ -1380,7 +1458,7 @@ Name | Type | Description | Notes
### Return type
-[**ShowPortingOrder**](ShowPortingOrder.md)
+[**UpdatePortingOrder200Response**](UpdatePortingOrder200Response.md)
### Authorization
@@ -1401,7 +1479,7 @@ Name | Type | Description | Notes
## uploadPortingOrderDocuments
-> PortingOrderDocumentsCreated uploadPortingOrderDocuments(id, UNKNOWN_BASE_TYPE)
+> UploadPortingOrderDocuments201Response uploadPortingOrderDocuments(id, uploadPortingOrderDocumentsRequest)
Associate a list of documents with a porting order
@@ -1430,9 +1508,9 @@ public class Example {
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
- UNKNOWN_BASE_TYPE UNKNOWN_BASE_TYPE = new HashMap(); // UNKNOWN_BASE_TYPE |
+ UploadPortingOrderDocumentsRequest uploadPortingOrderDocumentsRequest = new UploadPortingOrderDocumentsRequest(); // UploadPortingOrderDocumentsRequest |
try {
- PortingOrderDocumentsCreated result = apiInstance.uploadPortingOrderDocuments(id, UNKNOWN_BASE_TYPE);
+ UploadPortingOrderDocuments201Response result = apiInstance.uploadPortingOrderDocuments(id, uploadPortingOrderDocumentsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#uploadPortingOrderDocuments");
@@ -1451,11 +1529,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| Porting Order id |
- **UNKNOWN_BASE_TYPE** | **UNKNOWN_BASE_TYPE**| |
+ **uploadPortingOrderDocumentsRequest** | [**UploadPortingOrderDocumentsRequest**](UploadPortingOrderDocumentsRequest.md)| |
### Return type
-[**PortingOrderDocumentsCreated**](PortingOrderDocumentsCreated.md)
+[**UploadPortingOrderDocuments201Response**](UploadPortingOrderDocuments201Response.md)
### Authorization
diff --git a/docs/PortingOrderDocument.md b/docs/PortingOrderDocument.md
index ab497bf2..1b16016a 100644
--- a/docs/PortingOrderDocument.md
+++ b/docs/PortingOrderDocument.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Uniquely identifies the document in the porting order | [optional]
-**documentType** | [**DocumentTypeEnum**](#DocumentTypeEnum) | The type of document | [optional]
-**documentId** | **UUID** | Uniquely identifies a document uploaded via the <code><a href=\"https://developers.telnyx.com/docs/api/v2/documents/Documents#createDocument\">/v2/documents</a></code> endpoint. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date/time when document was associated for the porting order. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Uniquely identifies the document in the porting order | [optional] |
+|**documentType** | [**DocumentTypeEnum**](#DocumentTypeEnum) | The type of document | [optional] |
+|**documentId** | **UUID** | Uniquely identifies a document uploaded via the <code><a href=\"https://developers.telnyx.com/docs/api/v2/documents/Documents#createDocument\">/v2/documents</a></code> endpoint. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date/time when document was associated for the porting order. | [optional] |
## Enum: DocumentTypeEnum
-Name | Value
----- | -----
-LOA | "loa"
-INVOICE | "invoice"
-OTHER | "other"
+| Name | Value |
+|---- | -----|
+| LOA | "loa" |
+| INVOICE | "invoice" |
+| OTHER | "other" |
diff --git a/docs/PortingOrderDocuments.md b/docs/PortingOrderDocuments.md
index 65413b01..1afd4703 100644
--- a/docs/PortingOrderDocuments.md
+++ b/docs/PortingOrderDocuments.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**loa** | **UUID** | Returned ID of the submitted LOA via the Documents endpoint | [optional]
-**invoice** | **UUID** | Returned ID of the submitted Invoice via the Documents endpoint | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**loa** | **UUID** | Returned ID of the submitted LOA via the Documents endpoint | [optional] |
+|**invoice** | **UUID** | Returned ID of the submitted Invoice via the Documents endpoint | [optional] |
diff --git a/docs/PortingOrderEndUser.md b/docs/PortingOrderEndUser.md
index 8f183146..003fb6ab 100644
--- a/docs/PortingOrderEndUser.md
+++ b/docs/PortingOrderEndUser.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**admin** | [**PortingOrderEndUserAdmin**](PortingOrderEndUserAdmin.md) | | [optional]
-**location** | [**PortingOrderEndUserLocation**](PortingOrderEndUserLocation.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**admin** | [**PortingOrderEndUserAdmin**](PortingOrderEndUserAdmin.md) | | [optional] |
+|**location** | [**PortingOrderEndUserLocation**](PortingOrderEndUserLocation.md) | | [optional] |
diff --git a/docs/PortingOrderEndUserAdmin.md b/docs/PortingOrderEndUserAdmin.md
index 20117b12..91f35c66 100644
--- a/docs/PortingOrderEndUserAdmin.md
+++ b/docs/PortingOrderEndUserAdmin.md
@@ -5,15 +5,15 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**entityName** | **String** | Person Name or Company name requesting the port | [optional]
-**authPersonName** | **String** | Name of person authorizing the porting order | [optional]
-**billingPhoneNumber** | **String** | Billing phone number associated with these phone numbers | [optional]
-**accountNumber** | **String** | The authorized person's account number with the current service provider | [optional]
-**taxIdentifier** | **String** | European tax identification number. Applicable only in the European Union | [optional]
-**pinPasscode** | **String** | PIN/passcode possibly required by the old service provider for extra verification | [optional]
-**businessIdentifier** | **String** | European business identification number. Applicable only in the European Union | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**entityName** | **String** | Person Name or Company name requesting the port | [optional] |
+|**authPersonName** | **String** | Name of person authorizing the porting order | [optional] |
+|**billingPhoneNumber** | **String** | Billing phone number associated with these phone numbers | [optional] |
+|**accountNumber** | **String** | The authorized person's account number with the current service provider | [optional] |
+|**taxIdentifier** | **String** | European tax identification number. Applicable only in the European Union | [optional] |
+|**pinPasscode** | **String** | PIN/passcode possibly required by the old service provider for extra verification | [optional] |
+|**businessIdentifier** | **String** | European business identification number. Applicable only in the European Union | [optional] |
diff --git a/docs/PortingOrderEndUserLocation.md b/docs/PortingOrderEndUserLocation.md
index ee90b893..38761687 100644
--- a/docs/PortingOrderEndUserLocation.md
+++ b/docs/PortingOrderEndUserLocation.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**streetAddress** | **String** | First line of billing address | [optional]
-**extendedAddress** | **String** | Second line of billing address | [optional]
-**locality** | **String** | City or municipality of billing address | [optional]
-**administrativeArea** | **String** | State, province, or similar of billing address | [optional]
-**postalCode** | **String** | Postal Code of billing address | [optional]
-**countryCode** | **String** | ISO3166-1 alpha-2 country code of billing address | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**streetAddress** | **String** | First line of billing address | [optional] |
+|**extendedAddress** | **String** | Second line of billing address | [optional] |
+|**locality** | **String** | City or municipality of billing address | [optional] |
+|**administrativeArea** | **String** | State, province, or similar of billing address | [optional] |
+|**postalCode** | **String** | Postal Code of billing address | [optional] |
+|**countryCode** | **String** | ISO3166-1 alpha-2 country code of billing address | [optional] |
diff --git a/docs/PortingOrderMisc.md b/docs/PortingOrderMisc.md
index 146559bf..1184e1d1 100644
--- a/docs/PortingOrderMisc.md
+++ b/docs/PortingOrderMisc.md
@@ -5,20 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **PortingOrderType** | | [optional]
-**remainingNumbersAction** | [**RemainingNumbersActionEnum**](#RemainingNumbersActionEnum) | Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'. | [optional]
-**newBillingPhoneNumber** | **String** | New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **PortingOrderType** | | [optional] |
+|**remainingNumbersAction** | [**RemainingNumbersActionEnum**](#RemainingNumbersActionEnum) | Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'. | [optional] |
+|**newBillingPhoneNumber** | **String** | New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account. | [optional] |
## Enum: RemainingNumbersActionEnum
-Name | Value
----- | -----
-KEEP | "keep"
-DISCONNECT | "disconnect"
+| Name | Value |
+|---- | -----|
+| KEEP | "keep" |
+| DISCONNECT | "disconnect" |
diff --git a/docs/PortingOrderPhoneNumberConfiguration.md b/docs/PortingOrderPhoneNumberConfiguration.md
index 60a047c8..b7870b91 100644
--- a/docs/PortingOrderPhoneNumberConfiguration.md
+++ b/docs/PortingOrderPhoneNumberConfiguration.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connectionId** | **String** | identifies the connection to set on the numbers when ported | [optional]
-**messagingProfileId** | **String** | identifies the messaging profile to set on the numbers when ported | [optional]
-**emergencyAddressId** | **String** | identifies the emergency address to set on the numbers when ported | [optional]
-**tags** | **List<String>** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**connectionId** | **String** | identifies the connection to set on the numbers when ported | [optional] |
+|**messagingProfileId** | **String** | identifies the messaging profile to set on the numbers when ported | [optional] |
+|**emergencyAddressId** | **String** | identifies the emergency address to set on the numbers when ported | [optional] |
+|**tags** | **List<String>** | | [optional] |
diff --git a/docs/PortingOrderRequirement.md b/docs/PortingOrderRequirement.md
index 499996df..cdb1375c 100644
--- a/docs/PortingOrderRequirement.md
+++ b/docs/PortingOrderRequirement.md
@@ -5,20 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fieldType** | [**FieldTypeEnum**](#FieldTypeEnum) | Type of value expected on field_value field | [optional]
-**fieldValue** | **String** | identifies the document that satisfies this requirement | [optional]
-**requirementTypeId** | **String** | Identifies the requirement type that meets this requirement | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldType** | [**FieldTypeEnum**](#FieldTypeEnum) | Type of value expected on field_value field | [optional] |
+|**fieldValue** | **String** | identifies the document that satisfies this requirement | [optional] |
+|**requirementTypeId** | **String** | Identifies the requirement type that meets this requirement | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
## Enum: FieldTypeEnum
-Name | Value
----- | -----
-DOCUMENT | "document"
+| Name | Value |
+|---- | -----|
+| DOCUMENT | "document" |
diff --git a/docs/PortingOrderRequirementDetail.md b/docs/PortingOrderRequirementDetail.md
new file mode 100644
index 00000000..a0ecbd09
--- /dev/null
+++ b/docs/PortingOrderRequirementDetail.md
@@ -0,0 +1,26 @@
+
+
+# PortingOrderRequirementDetail
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldType** | [**FieldTypeEnum**](#FieldTypeEnum) | Type of value expected on field_value field | [optional] |
+|**fieldValue** | **String** | Identifies the document that satisfies this requirement | [optional] |
+|**requirementType** | [**PortingOrderRequirementDetailRequirementType**](PortingOrderRequirementDetailRequirementType.md) | | [optional] |
+|**requirementStatus** | **String** | Status of the requirement | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+
+
+
+## Enum: FieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| DOCUMENT | "document" |
+| TEXTUAL | "textual" |
+
+
+
diff --git a/docs/PortingOrderRequirementDetailRequirementType.md b/docs/PortingOrderRequirementDetailRequirementType.md
new file mode 100644
index 00000000..c0cf541f
--- /dev/null
+++ b/docs/PortingOrderRequirementDetailRequirementType.md
@@ -0,0 +1,19 @@
+
+
+# PortingOrderRequirementDetailRequirementType
+
+Identifies the requirement type that meets this requirement
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**acceptanceCriteria** | **Object** | The acceptance criteria for the requirement type | [optional] |
+|**description** | **String** | A description of the requirement type | [optional] |
+|**example** | **String** | An example of the requirement type | [optional] |
+|**id** | **String** | Identifies the requirement type | [optional] |
+|**name** | **String** | The name of the requirement type | [optional] |
+|**type** | **String** | The type of the requirement type | [optional] |
+
+
+
diff --git a/docs/PortingOrderStatus.md b/docs/PortingOrderStatus.md
index 7264ca48..ffd7c8d1 100644
--- a/docs/PortingOrderStatus.md
+++ b/docs/PortingOrderStatus.md
@@ -6,25 +6,25 @@ Porting order status
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**details** | [**List<PortingOrdersExceptionType>**](PortingOrdersExceptionType.md) | A list of 0 or more details about this porting order's status | [optional]
-**value** | [**ValueEnum**](#ValueEnum) | The current status of the porting order | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**details** | [**List<PortingOrdersExceptionType>**](PortingOrdersExceptionType.md) | A list of 0 or more details about this porting order's status | [optional] |
+|**value** | [**ValueEnum**](#ValueEnum) | The current status of the porting order | [optional] |
## Enum: ValueEnum
-Name | Value
----- | -----
-DRAFT | "draft"
-IN_PROCESS | "in-process"
-SUBMITTED | "submitted"
-EXCEPTION | "exception"
-FOC_DATE_CONFIRMED | "foc-date-confirmed"
-PORTED | "ported"
-CANCELED | "canceled"
-CANCEL_PENDING | "cancel-pending"
+| Name | Value |
+|---- | -----|
+| DRAFT | "draft" |
+| IN_PROCESS | "in-process" |
+| SUBMITTED | "submitted" |
+| EXCEPTION | "exception" |
+| FOC_DATE_CONFIRMED | "foc-date-confirmed" |
+| PORTED | "ported" |
+| CANCELED | "canceled" |
+| CANCEL_PENDING | "cancel-pending" |
diff --git a/docs/PortingOrderUserFeedback.md b/docs/PortingOrderUserFeedback.md
index c3ef5f51..882c8b60 100644
--- a/docs/PortingOrderUserFeedback.md
+++ b/docs/PortingOrderUserFeedback.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userRating** | **Integer** | Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience | [optional]
-**userComment** | **String** | A comment related to the customer rating. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**userRating** | **Integer** | Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience | [optional] |
+|**userComment** | **String** | A comment related to the customer rating. | [optional] |
diff --git a/docs/PortingOrdersActivationJob.md b/docs/PortingOrdersActivationJob.md
index b0b2cbee..87f23663 100644
--- a/docs/PortingOrdersActivationJob.md
+++ b/docs/PortingOrdersActivationJob.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Uniquely identifies this activation job | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | Specifies the status of this activation job | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Uniquely identifies this activation job | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | Specifies the status of this activation job | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-CREATED | "created"
-IN_PROCESS | "in-process"
-COMPLETED | "completed"
-FAILED | "failed"
+| Name | Value |
+|---- | -----|
+| CREATED | "created" |
+| IN_PROCESS | "in-process" |
+| COMPLETED | "completed" |
+| FAILED | "failed" |
diff --git a/docs/PortingOrdersAllowedFocWindow.md b/docs/PortingOrdersAllowedFocWindow.md
index 0943ba1d..538bbb39 100644
--- a/docs/PortingOrdersAllowedFocWindow.md
+++ b/docs/PortingOrdersAllowedFocWindow.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating the start of the range of foc window. | [optional] [readonly]
-**endedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating the end of the range of foc window | [optional] [readonly]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating the start of the range of foc window. | [optional] [readonly] |
+|**endedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating the end of the range of foc window | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
diff --git a/docs/PortingOrdersComment.md b/docs/PortingOrdersComment.md
index 15170f74..eb867c26 100644
--- a/docs/PortingOrdersComment.md
+++ b/docs/PortingOrdersComment.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional]
-**body** | **String** | Body of comment | [optional]
-**portingOrderId** | **UUID** | | [optional]
-**userType** | [**UserTypeEnum**](#UserTypeEnum) | Indicates whether this comment was created by a Telnyx Admin, user, or system | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] |
+|**body** | **String** | Body of comment | [optional] |
+|**portingOrderId** | **UUID** | | [optional] |
+|**userType** | [**UserTypeEnum**](#UserTypeEnum) | Indicates whether this comment was created by a Telnyx Admin, user, or system | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] |
## Enum: UserTypeEnum
-Name | Value
----- | -----
-ADMIN | "admin"
-USER | "user"
-SYSTEM | "system"
+| Name | Value |
+|---- | -----|
+| ADMIN | "admin" |
+| USER | "user" |
+| SYSTEM | "system" |
diff --git a/docs/PortingOrdersExceptionType.md b/docs/PortingOrdersExceptionType.md
index 3b1d95f3..f9256744 100644
--- a/docs/PortingOrdersExceptionType.md
+++ b/docs/PortingOrdersExceptionType.md
@@ -5,39 +5,39 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | [**CodeEnum**](#CodeEnum) | Identifier of an exception type | [optional]
-**description** | **String** | Description of an exception type | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | [**CodeEnum**](#CodeEnum) | Identifier of an exception type | [optional] |
+|**description** | **String** | Description of an exception type | [optional] |
## Enum: CodeEnum
-Name | Value
----- | -----
-ACCOUNT_NUMBER_MISMATCH | "ACCOUNT_NUMBER_MISMATCH"
-AUTH_PERSON_MISMATCH | "AUTH_PERSON_MISMATCH"
-BTN_ATN_MISMATCH | "BTN_ATN_MISMATCH"
-ENTITY_NAME_MISMATCH | "ENTITY_NAME_MISMATCH"
-FOC_EXPIRED | "FOC_EXPIRED"
-FOC_REJECTED | "FOC_REJECTED"
-LOCATION_MISMATCH | "LOCATION_MISMATCH"
-LSR_PENDING | "LSR_PENDING"
-MAIN_BTN_PORTING | "MAIN_BTN_PORTING"
-OSP_IRRESPONSIVE | "OSP_IRRESPONSIVE"
-OTHER | "OTHER"
-PASSCODE_PIN_INVALID | "PASSCODE_PIN_INVALID"
-PHONE_NUMBER_HAS_SPECIAL_FEATURE | "PHONE_NUMBER_HAS_SPECIAL_FEATURE"
-PHONE_NUMBER_MISMATCH | "PHONE_NUMBER_MISMATCH"
-PHONE_NUMBER_NOT_PORTABLE | "PHONE_NUMBER_NOT_PORTABLE"
-PORT_TYPE_INCORRECT | "PORT_TYPE_INCORRECT"
-PORTING_ORDER_SPLIT_REQUIRED | "PORTING_ORDER_SPLIT_REQUIRED"
-PORTING_ORDER_SPLIT_REQUIRED | "PORTING_ORDER_SPLIT_REQUIRED"
-POSTAL_CODE_MISMATCH | "POSTAL_CODE_MISMATCH"
-RATE_CENTER_NOT_PORTABLE | "RATE_CENTER_NOT_PORTABLE"
-SV_CONFLICT | "SV_CONFLICT"
-SV_UNKNOWN_FAILURE | "SV_UNKNOWN_FAILURE"
+| Name | Value |
+|---- | -----|
+| ACCOUNT_NUMBER_MISMATCH | "ACCOUNT_NUMBER_MISMATCH" |
+| AUTH_PERSON_MISMATCH | "AUTH_PERSON_MISMATCH" |
+| BTN_ATN_MISMATCH | "BTN_ATN_MISMATCH" |
+| ENTITY_NAME_MISMATCH | "ENTITY_NAME_MISMATCH" |
+| FOC_EXPIRED | "FOC_EXPIRED" |
+| FOC_REJECTED | "FOC_REJECTED" |
+| LOCATION_MISMATCH | "LOCATION_MISMATCH" |
+| LSR_PENDING | "LSR_PENDING" |
+| MAIN_BTN_PORTING | "MAIN_BTN_PORTING" |
+| OSP_IRRESPONSIVE | "OSP_IRRESPONSIVE" |
+| OTHER | "OTHER" |
+| PASSCODE_PIN_INVALID | "PASSCODE_PIN_INVALID" |
+| PHONE_NUMBER_HAS_SPECIAL_FEATURE | "PHONE_NUMBER_HAS_SPECIAL_FEATURE" |
+| PHONE_NUMBER_MISMATCH | "PHONE_NUMBER_MISMATCH" |
+| PHONE_NUMBER_NOT_PORTABLE | "PHONE_NUMBER_NOT_PORTABLE" |
+| PORT_TYPE_INCORRECT | "PORT_TYPE_INCORRECT" |
+| PORTING_ORDER_SPLIT_REQUIRED | "PORTING_ORDER_SPLIT_REQUIRED" |
+| PORTING_ORDER_SPLIT_REQUIRED | "PORTING_ORDER_SPLIT_REQUIRED" |
+| POSTAL_CODE_MISMATCH | "POSTAL_CODE_MISMATCH" |
+| RATE_CENTER_NOT_PORTABLE | "RATE_CENTER_NOT_PORTABLE" |
+| SV_CONFLICT | "SV_CONFLICT" |
+| SV_UNKNOWN_FAILURE | "SV_UNKNOWN_FAILURE" |
diff --git a/docs/PortingPhoneNumber.md b/docs/PortingPhoneNumber.md
index c61d61be..0231a59a 100644
--- a/docs/PortingPhoneNumber.md
+++ b/docs/PortingPhoneNumber.md
@@ -5,56 +5,56 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**portingOrderStatus** | [**PortingOrderStatusEnum**](#PortingOrderStatusEnum) | The current status of the porting order | [optional]
-**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The type of the phone number | [optional]
-**phoneNumber** | **String** | E164 formatted phone number | [optional]
-**portingOrderId** | **UUID** | Identifies the associated port request | [optional]
-**supportKey** | **String** | A key to reference this porting order when contacting Telnyx customer support | [optional]
-**activationStatus** | **PortingOrderActivationStatus** | | [optional]
-**portabilityStatus** | **PortabilityStatus** | | [optional]
-**requirementsStatus** | [**RequirementsStatusEnum**](#RequirementsStatusEnum) | The current status of the requirements in a INTL porting order | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**portingOrderStatus** | [**PortingOrderStatusEnum**](#PortingOrderStatusEnum) | The current status of the porting order | [optional] |
+|**phoneNumberType** | [**PhoneNumberTypeEnum**](#PhoneNumberTypeEnum) | The type of the phone number | [optional] |
+|**phoneNumber** | **String** | E164 formatted phone number | [optional] |
+|**portingOrderId** | **UUID** | Identifies the associated port request | [optional] |
+|**supportKey** | **String** | A key to reference this porting order when contacting Telnyx customer support | [optional] |
+|**activationStatus** | **PortingOrderActivationStatus** | | [optional] |
+|**portabilityStatus** | **PortabilityStatus** | | [optional] |
+|**requirementsStatus** | [**RequirementsStatusEnum**](#RequirementsStatusEnum) | The current status of the requirements in a INTL porting order | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
## Enum: PortingOrderStatusEnum
-Name | Value
----- | -----
-DRAFT | "draft"
-IN_PROCESS | "in-process"
-SUBMITTED | "submitted"
-EXCEPTION | "exception"
-FOC_DATE_CONFIRMED | "foc-date-confirmed"
-CANCEL_PENDING | "cancel-pending"
-PORTED | "ported"
-CANCELLED | "cancelled"
+| Name | Value |
+|---- | -----|
+| DRAFT | "draft" |
+| IN_PROCESS | "in-process" |
+| SUBMITTED | "submitted" |
+| EXCEPTION | "exception" |
+| FOC_DATE_CONFIRMED | "foc-date-confirmed" |
+| CANCEL_PENDING | "cancel-pending" |
+| PORTED | "ported" |
+| CANCELLED | "cancelled" |
## Enum: PhoneNumberTypeEnum
-Name | Value
----- | -----
-LANDLINE | "landline"
-LOCAL | "local"
-MOBILE | "mobile"
-NATIONAL | "national"
-SHARED_COST | "shared_cost"
-TOLL_FREE | "toll_free"
+| Name | Value |
+|---- | -----|
+| LANDLINE | "landline" |
+| LOCAL | "local" |
+| MOBILE | "mobile" |
+| NATIONAL | "national" |
+| SHARED_COST | "shared_cost" |
+| TOLL_FREE | "toll_free" |
## Enum: RequirementsStatusEnum
-Name | Value
----- | -----
-REQUIREMENT_INFO_PENDING | "requirement-info-pending"
-REQUIREMENT_INFO_UNDER_REVIEW | "requirement-info-under-review"
-REQUIREMENT_INFO_EXCEPTION | "requirement-info-exception"
-APPROVED | "approved"
+| Name | Value |
+|---- | -----|
+| REQUIREMENT_INFO_PENDING | "requirement-info-pending" |
+| REQUIREMENT_INFO_UNDER_REVIEW | "requirement-info-under-review" |
+| REQUIREMENT_INFO_EXCEPTION | "requirement-info-exception" |
+| APPROVED | "approved" |
diff --git a/docs/PortoutComment.md b/docs/PortoutComment.md
index 0701e770..f4f1fcb4 100644
--- a/docs/PortoutComment.md
+++ b/docs/PortoutComment.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | |
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**body** | **String** | Comment body |
-**portoutId** | **String** | Identifies the associated port request | [optional]
-**userId** | **String** | Identifies the user who created the comment. Will be null if created by Telnyx Admin |
-**createdAt** | **String** | Comment creation timestamp in ISO 8601 format |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**body** | **String** | Comment body | |
+|**portoutId** | **String** | Identifies the associated port request | [optional] |
+|**userId** | **String** | Identifies the user who created the comment. Will be null if created by Telnyx Admin | |
+|**createdAt** | **String** | Comment creation timestamp in ISO 8601 format | |
diff --git a/docs/PortoutDetails.md b/docs/PortoutDetails.md
index 2006d86c..7510f6ac 100644
--- a/docs/PortoutDetails.md
+++ b/docs/PortoutDetails.md
@@ -5,31 +5,46 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly]
-**phoneNumbers** | **List<String>** | Phone numbers associated with this portout | [optional]
-**carrierName** | **String** | Carrier the number will be ported out to | [optional]
-**focDate** | **String** | ISO 8601 formatted Date/Time of the FOC date | [optional]
-**requestedFocDate** | **String** | ISO 8601 formatted Date/Time of the user requested FOC date | [optional]
-**spid** | **String** | New service provider spid | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | Status of portout request | [optional]
-**createdAt** | **String** | ISO 8601 formatted date of when the portout was created | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date of when the portout was last updated | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**phoneNumbers** | **List<String>** | Phone numbers associated with this portout | [optional] |
+|**authorizedName** | **String** | Name of person authorizing the porting order | [optional] |
+|**carrierName** | **String** | Carrier the number will be ported out to | [optional] |
+|**currentCarrier** | **String** | The current carrier | [optional] |
+|**endUserName** | **String** | Person name or company name requesting the port | [optional] |
+|**city** | **String** | City or municipality of billing address | [optional] |
+|**state** | **String** | State, province, or similar of billing address | [optional] |
+|**zip** | **String** | Postal Code of billing address | [optional] |
+|**lsr** | **List<URI>** | The Local Service Request | [optional] |
+|**pon** | **String** | Port order number assigned by the carrier the number will be ported out to | [optional] |
+|**reason** | **String** | The reason why the order is being rejected by the user. If the order is authorized, this field can be left null | [optional] |
+|**serviceAddress** | **String** | First line of billing address (street address) | [optional] |
+|**focDate** | **String** | ISO 8601 formatted Date/Time of the FOC date | [optional] |
+|**requestedFocDate** | **String** | ISO 8601 formatted Date/Time of the user requested FOC date | [optional] |
+|**spid** | **String** | New service provider spid | [optional] |
+|**supportKey** | **String** | A key to reference this port out request when contacting Telnyx customer support | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Status of portout request | [optional] |
+|**alreadyPorted** | **Boolean** | Is true when the number is already ported | [optional] |
+|**userId** | **UUID** | Identifies the user (or organization) who requested the port out | [optional] |
+|**vendor** | **UUID** | Telnyx partner providing network coverage | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date of when the portout was created | [optional] |
+|**insertedAt** | **String** | ISO 8601 formatted date of when the portout was created | [optional] |
+|**updatedAt** | **String** | ISO 8601 formatted date of when the portout was last updated | [optional] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-AUTHORIZED | "authorized"
-PORTED | "ported"
-REJECTED | "rejected"
-REJECTED_PENDING | "rejected-pending"
-CANCELED | "canceled"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| AUTHORIZED | "authorized" |
+| PORTED | "ported" |
+| REJECTED | "rejected" |
+| REJECTED_PENDING | "rejected-pending" |
+| CANCELED | "canceled" |
diff --git a/docs/PostPortRequestComment201Response.md b/docs/PostPortRequestComment201Response.md
new file mode 100644
index 00000000..3798a07f
--- /dev/null
+++ b/docs/PostPortRequestComment201Response.md
@@ -0,0 +1,13 @@
+
+
+# PostPortRequestComment201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PortoutComment**](PortoutComment.md) | | [optional] |
+
+
+
diff --git a/docs/PostPortRequestCommentRequest.md b/docs/PostPortRequestCommentRequest.md
new file mode 100644
index 00000000..37f3d0c4
--- /dev/null
+++ b/docs/PostPortRequestCommentRequest.md
@@ -0,0 +1,13 @@
+
+
+# PostPortRequestCommentRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**body** | **String** | Comment to post on this portout request | [optional] |
+
+
+
diff --git a/docs/PostPortRequestSupportingDocumentsRequest.md b/docs/PostPortRequestSupportingDocumentsRequest.md
new file mode 100644
index 00000000..1746b8b8
--- /dev/null
+++ b/docs/PostPortRequestSupportingDocumentsRequest.md
@@ -0,0 +1,13 @@
+
+
+# PostPortRequestSupportingDocumentsRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**documents** | [**List<PostPortRequestSupportingDocumentsRequestDocumentsInner>**](PostPortRequestSupportingDocumentsRequestDocumentsInner.md) | List of supporting documents parameters | [optional] |
+
+
+
diff --git a/docs/PostPortRequestSupportingDocumentsRequestDocumentsInner.md b/docs/PostPortRequestSupportingDocumentsRequestDocumentsInner.md
new file mode 100644
index 00000000..0cd1041b
--- /dev/null
+++ b/docs/PostPortRequestSupportingDocumentsRequestDocumentsInner.md
@@ -0,0 +1,23 @@
+
+
+# PostPortRequestSupportingDocumentsRequestDocumentsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | Identifies the type of the document | |
+|**documentId** | **UUID** | Identifies the associated document | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| LOA | "loa" |
+| INVOICE | "invoice" |
+
+
+
diff --git a/docs/PostPortabilityCheck201Response.md b/docs/PostPortabilityCheck201Response.md
new file mode 100644
index 00000000..310c4e94
--- /dev/null
+++ b/docs/PostPortabilityCheck201Response.md
@@ -0,0 +1,13 @@
+
+
+# PostPortabilityCheck201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortabilityCheckDetails>**](PortabilityCheckDetails.md) | | [optional] |
+
+
+
diff --git a/docs/PostPortabilityCheckRequest.md b/docs/PostPortabilityCheckRequest.md
new file mode 100644
index 00000000..9148d9be
--- /dev/null
+++ b/docs/PostPortabilityCheckRequest.md
@@ -0,0 +1,13 @@
+
+
+# PostPortabilityCheckRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | The list of +E.164 formatted phone numbers to check for portability | [optional] |
+
+
+
diff --git a/docs/PostValidateRegistrationCodesRequest.md b/docs/PostValidateRegistrationCodesRequest.md
new file mode 100644
index 00000000..db9da5dd
--- /dev/null
+++ b/docs/PostValidateRegistrationCodesRequest.md
@@ -0,0 +1,14 @@
+
+
+# PostValidateRegistrationCodesRequest
+
+The object containing the Array of SIM card registration codes.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**registrationCodes** | **List<String>** | | [optional] |
+
+
+
diff --git a/docs/PrivateWirelessGateway.md b/docs/PrivateWirelessGateway.md
index 6b67f791..26ff857c 100644
--- a/docs/PrivateWirelessGateway.md
+++ b/docs/PrivateWirelessGateway.md
@@ -5,17 +5,18 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Identifies the resource. | [optional] [readonly]
-**networkId** | **UUID** | The identification of the related network resource. | [optional]
-**recordType** | **String** | | [optional] [readonly]
-**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly]
-**name** | **String** | The private wireless gateway name. | [optional]
-**regionCode** | **String** | The geographical region where the Private Wireless Gateway is deployed to. | [optional]
-**status** | [**PrivateWirelessGatewayStatus**](PrivateWirelessGatewayStatus.md) | | [optional]
-**ipRange** | **String** | IP block used to assign IPs to the SIM cards in the Private Wireless Gateway. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**networkId** | **UUID** | The identification of the related network resource. | [optional] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**name** | **String** | The private wireless gateway name. | [optional] |
+|**regionCode** | **String** | The geographical region where the Private Wireless Gateway is deployed to. | [optional] |
+|**status** | [**PrivateWirelessGatewayStatus**](PrivateWirelessGatewayStatus.md) | | [optional] |
+|**ipRange** | **String** | IP block used to assign IPs to the SIM cards in the Private Wireless Gateway. | [optional] [readonly] |
+|**assignedResources** | [**List<PWGAssignedResourcesSummary>**](PWGAssignedResourcesSummary.md) | A list of the resources that have been assigned to the Private Wireless Gateway | [optional] |
diff --git a/docs/PrivateWirelessGatewayRequest.md b/docs/PrivateWirelessGatewayRequest.md
index 63dd641f..ec3f7290 100644
--- a/docs/PrivateWirelessGatewayRequest.md
+++ b/docs/PrivateWirelessGatewayRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**networkId** | **UUID** | The identification of the related network resource. | [optional]
-**name** | **String** | The private wireless gateway name. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**networkId** | **UUID** | The identification of the related network resource. | [optional] |
+|**name** | **String** | The private wireless gateway name. | [optional] |
diff --git a/docs/PrivateWirelessGatewayStatus.md b/docs/PrivateWirelessGatewayStatus.md
index d8eea2ce..12b71462 100644
--- a/docs/PrivateWirelessGatewayStatus.md
+++ b/docs/PrivateWirelessGatewayStatus.md
@@ -6,22 +6,22 @@ The current status or failure details of the Private Wireless Gateway.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**ValueEnum**](#ValueEnum) | The current status or failure details of the Private Wireless Gateway. <ul> <li><code>provisioning</code> - the Private Wireless Gateway is being provisioned.</li> <li><code>provisioned</code> - the Private Wireless Gateway was provisioned and able to receive connections.</li> <li><code>failed</code> - the provisioning had failed for a reason and it requires an intervention.</li> <li><code>decommissioning</code> - the Private Wireless Gateway is being removed from the network.</li> </ul> Transitioning between the provisioning and provisioned states may take some time. | [optional] [readonly]
-**errorDescription** | **String** | This attribute provides a human-readable explanation of why a failure happened. | [optional] [readonly]
-**errorCode** | **String** | This attribute is an <a href=\"https://developers.telnyx.com/docs/api/v2/overview#errors\">error code</a> related to the failure reason. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**value** | [**ValueEnum**](#ValueEnum) | The current status or failure details of the Private Wireless Gateway. <ul> <li><code>provisioning</code> - the Private Wireless Gateway is being provisioned.</li> <li><code>provisioned</code> - the Private Wireless Gateway was provisioned and able to receive connections.</li> <li><code>failed</code> - the provisioning had failed for a reason and it requires an intervention.</li> <li><code>decommissioning</code> - the Private Wireless Gateway is being removed from the network.</li> </ul> Transitioning between the provisioning and provisioned states may take some time. | [optional] [readonly] |
+|**errorDescription** | **String** | This attribute provides a human-readable explanation of why a failure happened. | [optional] [readonly] |
+|**errorCode** | **String** | This attribute is an <a href=\"https://developers.telnyx.com/docs/api/v2/overview#errors\">error code</a> related to the failure reason. | [optional] [readonly] |
## Enum: ValueEnum
-Name | Value
----- | -----
-PROVISIONING | "provisioning"
-PROVISIONED | "provisioned"
-FAILED | "failed"
-DECOMMISSIONING | "decommissioning"
+| Name | Value |
+|---- | -----|
+| PROVISIONING | "provisioning" |
+| PROVISIONED | "provisioned" |
+| FAILED | "failed" |
+| DECOMMISSIONING | "decommissioning" |
diff --git a/docs/PrivateWirelessGatewaysApi.md b/docs/PrivateWirelessGatewaysApi.md
index f2e9a648..fcb2a470 100644
--- a/docs/PrivateWirelessGatewaysApi.md
+++ b/docs/PrivateWirelessGatewaysApi.md
@@ -13,7 +13,7 @@ Method | HTTP request | Description
## createPrivateWirelessGateway
-> CreatePrivateWirelessGatewayResponse createPrivateWirelessGateway(createPrivateWirelessGatwewayRequest)
+> CreatePrivateWirelessGateway202Response createPrivateWirelessGateway(createPrivateWirelessGatewayRequest)
Create a Private Wireless Gateway
@@ -40,9 +40,9 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
PrivateWirelessGatewaysApi apiInstance = new PrivateWirelessGatewaysApi(defaultClient);
- CreatePrivateWirelessGatwewayRequest createPrivateWirelessGatwewayRequest = new CreatePrivateWirelessGatwewayRequest(); // CreatePrivateWirelessGatwewayRequest |
+ CreatePrivateWirelessGatewayRequest createPrivateWirelessGatewayRequest = new CreatePrivateWirelessGatewayRequest(); // CreatePrivateWirelessGatewayRequest |
try {
- CreatePrivateWirelessGatewayResponse result = apiInstance.createPrivateWirelessGateway(createPrivateWirelessGatwewayRequest);
+ CreatePrivateWirelessGateway202Response result = apiInstance.createPrivateWirelessGateway(createPrivateWirelessGatewayRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrivateWirelessGatewaysApi#createPrivateWirelessGateway");
@@ -60,11 +60,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **createPrivateWirelessGatwewayRequest** | [**CreatePrivateWirelessGatwewayRequest**](CreatePrivateWirelessGatwewayRequest.md)| |
+ **createPrivateWirelessGatewayRequest** | [**CreatePrivateWirelessGatewayRequest**](CreatePrivateWirelessGatewayRequest.md)| |
### Return type
-[**CreatePrivateWirelessGatewayResponse**](CreatePrivateWirelessGatewayResponse.md)
+[**CreatePrivateWirelessGateway202Response**](CreatePrivateWirelessGateway202Response.md)
### Authorization
@@ -85,7 +85,7 @@ Name | Type | Description | Notes
## deletePrivateWirelessGateway
-> DeletePrivateWirelessGatewayResponse deletePrivateWirelessGateway(id)
+> CreatePrivateWirelessGateway202Response deletePrivateWirelessGateway(id)
Delete a Private Wireless Gateway
@@ -115,7 +115,7 @@ public class Example {
PrivateWirelessGatewaysApi apiInstance = new PrivateWirelessGatewaysApi(defaultClient);
UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
try {
- DeletePrivateWirelessGatewayResponse result = apiInstance.deletePrivateWirelessGateway(id);
+ CreatePrivateWirelessGateway202Response result = apiInstance.deletePrivateWirelessGateway(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrivateWirelessGatewaysApi#deletePrivateWirelessGateway");
@@ -137,7 +137,7 @@ Name | Type | Description | Notes
### Return type
-[**DeletePrivateWirelessGatewayResponse**](DeletePrivateWirelessGatewayResponse.md)
+[**CreatePrivateWirelessGateway202Response**](CreatePrivateWirelessGateway202Response.md)
### Authorization
@@ -158,7 +158,7 @@ Name | Type | Description | Notes
## getPrivateWirelessGateway
-> GetPrivateWirelessGatewayResponse getPrivateWirelessGateway(id)
+> CreatePrivateWirelessGateway202Response getPrivateWirelessGateway(id)
Get a Private Wireless Gateway
@@ -188,7 +188,7 @@ public class Example {
PrivateWirelessGatewaysApi apiInstance = new PrivateWirelessGatewaysApi(defaultClient);
UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
try {
- GetPrivateWirelessGatewayResponse result = apiInstance.getPrivateWirelessGateway(id);
+ CreatePrivateWirelessGateway202Response result = apiInstance.getPrivateWirelessGateway(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrivateWirelessGatewaysApi#getPrivateWirelessGateway");
@@ -210,7 +210,7 @@ Name | Type | Description | Notes
### Return type
-[**GetPrivateWirelessGatewayResponse**](GetPrivateWirelessGatewayResponse.md)
+[**CreatePrivateWirelessGateway202Response**](CreatePrivateWirelessGateway202Response.md)
### Authorization
@@ -231,7 +231,7 @@ Name | Type | Description | Notes
## getPrivateWirelessGateways
-> GetAllPrivateWirelessGatewaysResponse getPrivateWirelessGateways(pageNumber, pageSize, filterName, filterIpRange, filterRegionCode, filterCreatedAt, filterUpdatedAt)
+> GetPrivateWirelessGateways200Response getPrivateWirelessGateways(pageNumber, pageSize, filterName, filterIpRange, filterRegionCode, filterCreatedAt, filterUpdatedAt)
Get all Private Wireless Gateways
@@ -266,7 +266,7 @@ public class Example {
String filterCreatedAt = "2018-02-02T22:25:27.521Z"; // String | Private Wireless Gateway resource creation date.
String filterUpdatedAt = "2018-02-02T22:25:27.521Z"; // String | When the Private Wireless Gateway was last updated.
try {
- GetAllPrivateWirelessGatewaysResponse result = apiInstance.getPrivateWirelessGateways(pageNumber, pageSize, filterName, filterIpRange, filterRegionCode, filterCreatedAt, filterUpdatedAt);
+ GetPrivateWirelessGateways200Response result = apiInstance.getPrivateWirelessGateways(pageNumber, pageSize, filterName, filterIpRange, filterRegionCode, filterCreatedAt, filterUpdatedAt);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrivateWirelessGatewaysApi#getPrivateWirelessGateways");
@@ -294,7 +294,7 @@ Name | Type | Description | Notes
### Return type
-[**GetAllPrivateWirelessGatewaysResponse**](GetAllPrivateWirelessGatewaysResponse.md)
+[**GetPrivateWirelessGateways200Response**](GetPrivateWirelessGateways200Response.md)
### Authorization
diff --git a/docs/ProgrammableFaxApplicationsApi.md b/docs/ProgrammableFaxApplicationsApi.md
index e3b4698a..032a4ceb 100644
--- a/docs/ProgrammableFaxApplicationsApi.md
+++ b/docs/ProgrammableFaxApplicationsApi.md
@@ -231,7 +231,7 @@ Name | Type | Description | Notes
## listFaxApplications
-> GetAllFaxApplicationsResponse listFaxApplications(pageNumber, pageSize, filterApplicationNameContains, filterOutboundOutboundVoiceProfileId, sort)
+> GetAllFaxApplicationsResponse listFaxApplications(pageNumber, pageSize, filterApplicationNameContains, filterOutboundVoiceProfileId, sort)
List all Fax Applications
@@ -261,10 +261,10 @@ public class Example {
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
String filterApplicationNameContains = "null"; // String | If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
- String filterOutboundOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
+ String filterOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
- GetAllFaxApplicationsResponse result = apiInstance.listFaxApplications(pageNumber, pageSize, filterApplicationNameContains, filterOutboundOutboundVoiceProfileId, sort);
+ GetAllFaxApplicationsResponse result = apiInstance.listFaxApplications(pageNumber, pageSize, filterApplicationNameContains, filterOutboundVoiceProfileId, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProgrammableFaxApplicationsApi#listFaxApplications");
@@ -285,7 +285,7 @@ Name | Type | Description | Notes
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
**filterApplicationNameContains** | **String**| If present, applications with <code>application_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
- **filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
+ **filterOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
### Return type
diff --git a/docs/ProgrammableFaxCommandsApi.md b/docs/ProgrammableFaxCommandsApi.md
index 8a98a6d0..9c70369b 100644
--- a/docs/ProgrammableFaxCommandsApi.md
+++ b/docs/ProgrammableFaxCommandsApi.md
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.telnyx.com/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
+[**cancelFax**](ProgrammableFaxCommandsApi.md#cancelFax) | **POST** /faxes/{id}/actions/cancel | Cancel a fax
[**deleteFax**](ProgrammableFaxCommandsApi.md#deleteFax) | **DELETE** /faxes/{id} | Delete a fax
[**listFaxes**](ProgrammableFaxCommandsApi.md#listFaxes) | **GET** /faxes | View a list of faxes
[**refreshFax**](ProgrammableFaxCommandsApi.md#refreshFax) | **POST** /faxes/{id}/actions/refresh | Refresh a fax
@@ -12,6 +13,80 @@ Method | HTTP request | Description
+## cancelFax
+
+> SuccessfulResponseUponAcceptingCancelFaxCommand cancelFax(id)
+
+Cancel a fax
+
+Cancel the outbound fax that is in one of the following states: `queued`, `media.processed`, `originated` or `sending`
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.ProgrammableFaxCommandsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ ProgrammableFaxCommandsApi apiInstance = new ProgrammableFaxCommandsApi(defaultClient);
+ UUID id = UUID.randomUUID(); // UUID | The unique identifier of a fax.
+ try {
+ SuccessfulResponseUponAcceptingCancelFaxCommand result = apiInstance.cancelFax(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ProgrammableFaxCommandsApi#cancelFax");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| The unique identifier of a fax. |
+
+### Return type
+
+[**SuccessfulResponseUponAcceptingCancelFaxCommand**](SuccessfulResponseUponAcceptingCancelFaxCommand.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Successful response upon accepting cancel fax command | - |
+| **404** | Fax does not exist | - |
+| **422** | Unprocessable entity | - |
+| **0** | Unexpected error | - |
+
+
## deleteFax
> deleteFax(id)
@@ -87,6 +162,8 @@ null (empty response body)
View a list of faxes
+
+
### Example
```java
@@ -234,7 +311,7 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Refresh fax response | - |
-| **404** | Conference does not exist | - |
+| **404** | Fax does not exist | - |
| **0** | Unexpected error | - |
@@ -244,6 +321,17 @@ Name | Type | Description | Notes
Send a fax
+Send a fax. Files have size limits and page count limit validations. If a file is bigger than 50MB or has more than 350 pages it will fail with `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively.
+
+**Expected Webhooks:**
+
+- `fax.queued`
+- `fax.media.processed`
+- `fax.sending.started`
+- `fax.delivered`
+- `fax.failed`
+
+
### Example
```java
diff --git a/docs/PublicInternetGateway.md b/docs/PublicInternetGateway.md
new file mode 100644
index 00000000..229a69d7
--- /dev/null
+++ b/docs/PublicInternetGateway.md
@@ -0,0 +1,20 @@
+
+
+# PublicInternetGateway
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | [optional] |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**publicIp** | **String** | The publically accessible ip for this interface. | [optional] [readonly] |
+
+
+
diff --git a/docs/PublicInternetGateway1.md b/docs/PublicInternetGateway1.md
new file mode 100644
index 00000000..29c5bbb9
--- /dev/null
+++ b/docs/PublicInternetGateway1.md
@@ -0,0 +1,14 @@
+
+
+# PublicInternetGateway1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**publicIp** | **String** | The publically accessible ip for this interface. | [optional] [readonly] |
+
+
+
diff --git a/docs/PublicInternetGatewayCreate.md b/docs/PublicInternetGatewayCreate.md
new file mode 100644
index 00000000..65f6e58c
--- /dev/null
+++ b/docs/PublicInternetGatewayCreate.md
@@ -0,0 +1,21 @@
+
+
+# PublicInternetGatewayCreate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**publicIp** | **String** | The publically accessible ip for this interface. | [optional] [readonly] |
+|**regionCode** | **String** | The region the interface should be deployed to. | [optional] |
+
+
+
diff --git a/docs/PublicInternetGatewayCreate202Response.md b/docs/PublicInternetGatewayCreate202Response.md
new file mode 100644
index 00000000..218a5dca
--- /dev/null
+++ b/docs/PublicInternetGatewayCreate202Response.md
@@ -0,0 +1,13 @@
+
+
+# PublicInternetGatewayCreate202Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PublicInternetGatewayRead**](PublicInternetGatewayRead.md) | | [optional] |
+
+
+
diff --git a/docs/PublicInternetGatewayList200Response.md b/docs/PublicInternetGatewayList200Response.md
new file mode 100644
index 00000000..3351c7cb
--- /dev/null
+++ b/docs/PublicInternetGatewayList200Response.md
@@ -0,0 +1,14 @@
+
+
+# PublicInternetGatewayList200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PublicInternetGatewayRead>**](PublicInternetGatewayRead.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/PublicInternetGatewayRead.md b/docs/PublicInternetGatewayRead.md
new file mode 100644
index 00000000..5b95f3e5
--- /dev/null
+++ b/docs/PublicInternetGatewayRead.md
@@ -0,0 +1,22 @@
+
+
+# PublicInternetGatewayRead
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | [optional] |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**publicIp** | **String** | The publically accessible ip for this interface. | [optional] [readonly] |
+|**regionCode** | **String** | The region interface is deployed to. | [optional] |
+|**region** | [**RegionOutRegion**](RegionOutRegion.md) | | [optional] |
+
+
+
diff --git a/docs/PublicInternetGatewaysApi.md b/docs/PublicInternetGatewaysApi.md
new file mode 100644
index 00000000..f39a3a83
--- /dev/null
+++ b/docs/PublicInternetGatewaysApi.md
@@ -0,0 +1,303 @@
+# PublicInternetGatewaysApi
+
+All URIs are relative to *https://api.telnyx.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**publicInternetGatewayCreate**](PublicInternetGatewaysApi.md#publicInternetGatewayCreate) | **POST** /public_internet_gateways | Create a Public Internet Gateway
+[**publicInternetGatewayDelete**](PublicInternetGatewaysApi.md#publicInternetGatewayDelete) | **DELETE** /public_internet_gateways/{id} | Delete a Public Internet Gateway
+[**publicInternetGatewayGet**](PublicInternetGatewaysApi.md#publicInternetGatewayGet) | **GET** /public_internet_gateways/{id} | Retrieve a Public Internet Gateway
+[**publicInternetGatewayList**](PublicInternetGatewaysApi.md#publicInternetGatewayList) | **GET** /public_internet_gateways | List all Public Internet Gateways
+
+
+
+## publicInternetGatewayCreate
+
+> PublicInternetGatewayCreate202Response publicInternetGatewayCreate(publicInternetGatewayCreate)
+
+Create a Public Internet Gateway
+
+Create a new Public Internet Gateway.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.PublicInternetGatewaysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ PublicInternetGatewaysApi apiInstance = new PublicInternetGatewaysApi(defaultClient);
+ PublicInternetGatewayCreate publicInternetGatewayCreate = new PublicInternetGatewayCreate(); // PublicInternetGatewayCreate |
+ try {
+ PublicInternetGatewayCreate202Response result = apiInstance.publicInternetGatewayCreate(publicInternetGatewayCreate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PublicInternetGatewaysApi#publicInternetGatewayCreate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **publicInternetGatewayCreate** | [**PublicInternetGatewayCreate**](PublicInternetGatewayCreate.md)| |
+
+### Return type
+
+[**PublicInternetGatewayCreate202Response**](PublicInternetGatewayCreate202Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Successful response | - |
+| **422** | Unprocessable entity. Check the 'detail' field in response for details. | - |
+| **0** | Unexpected error | - |
+
+
+## publicInternetGatewayDelete
+
+> PublicInternetGatewayCreate202Response publicInternetGatewayDelete(id)
+
+Delete a Public Internet Gateway
+
+Delete a Public Internet Gateway.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.PublicInternetGatewaysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ PublicInternetGatewaysApi apiInstance = new PublicInternetGatewaysApi(defaultClient);
+ UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ try {
+ PublicInternetGatewayCreate202Response result = apiInstance.publicInternetGatewayDelete(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PublicInternetGatewaysApi#publicInternetGatewayDelete");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Identifies the resource. |
+
+### Return type
+
+[**PublicInternetGatewayCreate202Response**](PublicInternetGatewayCreate202Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## publicInternetGatewayGet
+
+> PublicInternetGatewayCreate202Response publicInternetGatewayGet(id)
+
+Retrieve a Public Internet Gateway
+
+Retrieve a Public Internet Gateway.
+
+### Example
+
+```java
+import java.util.UUID;
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.PublicInternetGatewaysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ PublicInternetGatewaysApi apiInstance = new PublicInternetGatewaysApi(defaultClient);
+ UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
+ try {
+ PublicInternetGatewayCreate202Response result = apiInstance.publicInternetGatewayGet(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PublicInternetGatewaysApi#publicInternetGatewayGet");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **UUID**| Identifies the resource. |
+
+### Return type
+
+[**PublicInternetGatewayCreate202Response**](PublicInternetGatewayCreate202Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## publicInternetGatewayList
+
+> PublicInternetGatewayList200Response publicInternetGatewayList(pageNumber, pageSize, filterNetworkId)
+
+List all Public Internet Gateways
+
+List all Public Internet Gateways.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.PublicInternetGatewaysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ PublicInternetGatewaysApi apiInstance = new PublicInternetGatewaysApi(defaultClient);
+ Integer pageNumber = 1; // Integer | The page number to load
+ Integer pageSize = 20; // Integer | The size of the page
+ String filterNetworkId = "6a09cdc3-8948-47f0-aa62-74ac943d6c58"; // String | The associated network id to filter on.
+ try {
+ PublicInternetGatewayList200Response result = apiInstance.publicInternetGatewayList(pageNumber, pageSize, filterNetworkId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PublicInternetGatewaysApi#publicInternetGatewayList");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **filterNetworkId** | **String**| The associated network id to filter on. | [optional]
+
+### Return type
+
+[**PublicInternetGatewayList200Response**](PublicInternetGatewayList200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
diff --git a/docs/PushCredential.md b/docs/PushCredential.md
index e895ba22..45f96032 100644
--- a/docs/PushCredential.md
+++ b/docs/PushCredential.md
@@ -5,16 +5,17 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique identifier of a push credential |
-**certificate** | **String** | Apple certificate for sending push notifications |
-**privateKey** | **String** | Apple private key for a given certificate for sending push notifications |
-**serverKey** | **String** | Google server key for sending push notifications |
-**alias** | **String** | Alias to uniquely identify a credential |
-**recordType** | **String** | | [readonly]
-**createdAt** | **String** | ISO 8601 timestamp when the room was created |
-**updatedAt** | **String** | ISO 8601 timestamp when the room was updated. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique identifier of a push credential | |
+|**certificate** | **String** | Apple certificate for sending push notifications. For iOS only | |
+|**privateKey** | **String** | Apple private key for a given certificate for sending push notifications. For iOS only | |
+|**serverKey** | **String** | Google server key for sending push notifications. For Android only | |
+|**alias** | **String** | Alias to uniquely identify a credential | |
+|**type** | **String** | Type of mobile push credential. Either <code>ios</code> or <code>android</code> | |
+|**recordType** | **String** | | [readonly] |
+|**createdAt** | **String** | ISO 8601 timestamp when the room was created | |
+|**updatedAt** | **String** | ISO 8601 timestamp when the room was updated. | |
diff --git a/docs/PushCredentialsApi.md b/docs/PushCredentialsApi.md
index b4c6f352..0293bdab 100644
--- a/docs/PushCredentialsApi.md
+++ b/docs/PushCredentialsApi.md
@@ -4,25 +4,24 @@ All URIs are relative to *https://api.telnyx.com/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**deletePushCredentialnById**](PushCredentialsApi.md#deletePushCredentialnById) | **DELETE** /push_credentials/{push_credential_id} | Deletes a push credential
-[**getPushCredentialById**](PushCredentialsApi.md#getPushCredentialById) | **GET** /push_credentials/{push_credential_id} | Retrieves a push credential
-[**getPushCredentials**](PushCredentialsApi.md#getPushCredentials) | **GET** /mobile_applications/{mobile_application_id}/push_credentials | Retrieves push credentials associated to a mobile application
-[**updatePushCredentialById**](PushCredentialsApi.md#updatePushCredentialById) | **PATCH** /push_credentials/{push_credential_id} | Updates a push credential
+[**createPushCredential**](PushCredentialsApi.md#createPushCredential) | **POST** /mobile_push_credentials | Creates a new mobile push credential
+[**deletePushCredentialById**](PushCredentialsApi.md#deletePushCredentialById) | **DELETE** /mobile_push_credentials/{push_credential_id} | Deletes a mobile push credential
+[**getPushCredentialById**](PushCredentialsApi.md#getPushCredentialById) | **GET** /mobile_push_credentials/{push_credential_id} | Retrieves a mobile push credential
+[**listPushCredentials**](PushCredentialsApi.md#listPushCredentials) | **GET** /mobile_push_credentials | List mobile push credentials
-## deletePushCredentialnById
+## createPushCredential
-> deletePushCredentialnById(pushCredentialId)
+> PushCredentialResponse createPushCredential(createPushCredentialRequest)
-Deletes a push credential
+Creates a new mobile push credential
-Deletes a push credential based on the given `id`
+Creates a new mobile push credential
### Example
```java
-import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
@@ -41,11 +40,12 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
PushCredentialsApi apiInstance = new PushCredentialsApi(defaultClient);
- UUID pushCredentialId = UUID.fromString("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0"); // UUID | The unique identifier of a push credential
+ CreatePushCredentialRequest createPushCredentialRequest = new CreatePushCredentialRequest(); // CreatePushCredentialRequest | Mobile push credential parameters that need to be sent in the request
try {
- apiInstance.deletePushCredentialnById(pushCredentialId);
+ PushCredentialResponse result = apiInstance.createPushCredential(createPushCredentialRequest);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PushCredentialsApi#deletePushCredentialnById");
+ System.err.println("Exception when calling PushCredentialsApi#createPushCredential");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -60,11 +60,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pushCredentialId** | **UUID**| The unique identifier of a push credential |
+ **createPushCredentialRequest** | [**CreatePushCredentialRequest**](CreatePushCredentialRequest.md)| Mobile push credential parameters that need to be sent in the request |
### Return type
-null (empty response body)
+[**PushCredentialResponse**](PushCredentialResponse.md)
### Authorization
@@ -72,25 +72,24 @@ null (empty response body)
### HTTP request headers
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **204** | The push credential was deleted successfully | - |
+| **200** | Mobile push credential created | - |
| **401** | Unauthorized request | - |
-| **404** | Resource not found | - |
| **422** | Unable to process request | - |
-## getPushCredentialById
+## deletePushCredentialById
-> PushCredentialResponse getPushCredentialById(pushCredentialId)
+> deletePushCredentialById(pushCredentialId)
-Retrieves a push credential
+Deletes a mobile push credential
-Retrieves push credential based on the given `id`
+Deletes a mobile push credential based on the given `push_credential_id`
### Example
@@ -114,12 +113,11 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
PushCredentialsApi apiInstance = new PushCredentialsApi(defaultClient);
- UUID pushCredentialId = UUID.fromString("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0"); // UUID | The unique identifier of a push credential
+ UUID pushCredentialId = UUID.fromString("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0"); // UUID | The unique identifier of a mobile push credential
try {
- PushCredentialResponse result = apiInstance.getPushCredentialById(pushCredentialId);
- System.out.println(result);
+ apiInstance.deletePushCredentialById(pushCredentialId);
} catch (ApiException e) {
- System.err.println("Exception when calling PushCredentialsApi#getPushCredentialById");
+ System.err.println("Exception when calling PushCredentialsApi#deletePushCredentialById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -134,11 +132,11 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **pushCredentialId** | **UUID**| The unique identifier of a push credential |
+ **pushCredentialId** | **UUID**| The unique identifier of a mobile push credential |
### Return type
-[**PushCredentialResponse**](PushCredentialResponse.md)
+null (empty response body)
### Authorization
@@ -152,24 +150,23 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | Successful get push credential response | - |
+| **204** | The mobile push credential was deleted successfully | - |
| **401** | Unauthorized request | - |
| **404** | Resource not found | - |
| **422** | Unable to process request | - |
-## getPushCredentials
+## getPushCredentialById
-> List<PushCredentialResponse> getPushCredentials(mobileApplicationId, filterCreatedAtEq, filterCreatedAtGte, filterCreatedAtLte, filterAlias)
+> PushCredentialResponse getPushCredentialById(pushCredentialId)
-Retrieves push credentials associated to a mobile application
+Retrieves a mobile push credential
-Retrieves push credentials for a given mobile application based on filters for a user
+Retrieves mobile push credential based on the given `push_credential_id`
### Example
```java
-import java.time.LocalDate;
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
@@ -189,16 +186,12 @@ public class Example {
bearerAuth.setBearerToken("BEARER TOKEN");
PushCredentialsApi apiInstance = new PushCredentialsApi(defaultClient);
- UUID mobileApplicationId = UUID.fromString("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"); // UUID | The unique identifier of a mobile application
- LocalDate filterCreatedAtEq = LocalDate.parse("Sat Apr 24 19:00:00 CDT 2021"); // LocalDate | ISO 8601 date for filtering credentials created on that date
- LocalDate filterCreatedAtGte = LocalDate.parse("Sat Apr 24 19:00:00 CDT 2021"); // LocalDate | ISO 8601 date for filtering credentials created after that date
- LocalDate filterCreatedAtLte = LocalDate.parse("Sat Apr 24 19:00:00 CDT 2021"); // LocalDate | ISO 8601 date for filtering credentials created before that date
- String filterAlias = "LucyCredential"; // String | Unique push credential alias
+ UUID pushCredentialId = UUID.fromString("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0"); // UUID | The unique identifier of a mobile push credential
try {
- Listtags they will be found.['customers', 'staff', 'test'] ['test']['customers']['customers', 'test'] returns only the first because it's the only one with both tags.test returns the first two SIMs, because both of them have such tag.customers returns the first and last SIMs.friendly_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
- String filterOutboundOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
+ String filterOutboundVoiceProfileId = "1293384261075731499"; // String | Identifies the associated outbound voice profile.
String sort = "created_at"; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the connection_name field in ascending order. -connection_name: sorts the result by the connection_name field in descending order. created_at in descending order.
try {
- GetAllTexmlApplicationsResponse result = apiInstance.findTexmlApplications(pageNumber, pageSize, filterFriendlyNameContains, filterOutboundOutboundVoiceProfileId, sort);
+ GetAllTexmlApplicationsResponse result = apiInstance.findTexmlApplications(pageNumber, pageSize, filterFriendlyNameContains, filterOutboundVoiceProfileId, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TeXmlApplicationsApi#findTexmlApplications");
@@ -212,7 +212,7 @@ Name | Type | Description | Notes
**pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
**pageSize** | **Integer**| The size of the page | [optional] [default to 20]
**filterFriendlyNameContains** | **String**| If present, applications with <code>friendly_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to null]
- **filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
+ **filterOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
**sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul> <li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
### Return type
diff --git a/docs/TeXmlRESTCommandResponse.md b/docs/TeXmlRESTCommandResponse.md
new file mode 100644
index 00000000..94399a98
--- /dev/null
+++ b/docs/TeXmlRESTCommandResponse.md
@@ -0,0 +1,13 @@
+
+
+# TeXmlRESTCommandResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCommandResult**](UpdateCommandResult.md) | | [optional] |
+
+
+
diff --git a/docs/TeXmlRestCommandsApi.md b/docs/TeXmlRestCommandsApi.md
new file mode 100644
index 00000000..9348b6a6
--- /dev/null
+++ b/docs/TeXmlRestCommandsApi.md
@@ -0,0 +1,83 @@
+# TeXmlRestCommandsApi
+
+All URIs are relative to *https://api.telnyx.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**updateTeXMLCall**](TeXmlRestCommandsApi.md#updateTeXMLCall) | **POST** /texml/{call_sid}/update | Update call
+
+
+
+## updateTeXMLCall
+
+> TeXmlRESTCommandResponse updateTeXMLCall(callSid).updateCallRequest(updateCallRequest).execute();
+
+Update call
+
+Update TeXml call
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.TeXmlRestCommandsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ TeXmlRestCommandsApi apiInstance = new TeXmlRestCommandsApi(defaultClient);
+ String callSid = "callSid_example"; // String | The CallSid that identifies the call to update.
+ UpdateCallRequest updateCallRequest = new UpdateCallRequest(); // UpdateCallRequest | Update Call request object
+ try {
+ TeXmlRESTCommandResponse result = api.updateTeXMLCall(callSid)
+ .updateCallRequest(updateCallRequest)
+ .execute();
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling TeXmlRestCommandsApi#updateTeXMLCall");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **callSid** | **String**| The CallSid that identifies the call to update. |
+ **updateCallRequest** | [**UpdateCallRequest**](UpdateCallRequest.md)| Update Call request object |
+
+### Return type
+
+[**TeXmlRESTCommandResponse**](TeXmlRESTCommandResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response upon updating a TeXml call. | - |
+
diff --git a/docs/TelephonyCredential.md b/docs/TelephonyCredential.md
index 40ff7e3f..65b9094f 100644
--- a/docs/TelephonyCredential.md
+++ b/docs/TelephonyCredential.md
@@ -5,18 +5,18 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**name** | **String** | | [optional]
-**resourceId** | **String** | Identifies the resource this credential is associated with. | [optional]
-**expired** | **Boolean** | Defaults to false | [optional]
-**sipUsername** | **String** | The randomly generated SIP username for the credential. | [optional]
-**sipPassword** | **String** | The randomly generated SIP password for the credential. | [optional]
-**createdAt** | **String** | ISO-8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **String** | ISO-8601 formatted date indicating when the resource was updated. | [optional]
-**expiresAt** | **String** | ISO-8601 formatted date indicating when the resource will expire. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**name** | **String** | | [optional] |
+|**resourceId** | **String** | Identifies the resource this credential is associated with. | [optional] |
+|**expired** | **Boolean** | Defaults to false | [optional] |
+|**sipUsername** | **String** | The randomly generated SIP username for the credential. | [optional] |
+|**sipPassword** | **String** | The randomly generated SIP password for the credential. | [optional] |
+|**createdAt** | **String** | ISO-8601 formatted date indicating when the resource was created. | [optional] |
+|**updatedAt** | **String** | ISO-8601 formatted date indicating when the resource was updated. | [optional] |
+|**expiresAt** | **String** | ISO-8601 formatted date indicating when the resource will expire. | [optional] |
diff --git a/docs/TelephonyCredentialCreateRequest.md b/docs/TelephonyCredentialCreateRequest.md
index 8830dd61..30461c93 100644
--- a/docs/TelephonyCredentialCreateRequest.md
+++ b/docs/TelephonyCredentialCreateRequest.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | | [optional]
-**tag** | **String** | Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials. | [optional]
-**connectionId** | **String** | Identifies the Credential Connection this credential is associated with. |
-**expiresAt** | **String** | ISO-8601 formatted date indicating when the credential will expire. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**tag** | **String** | Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials. | [optional] |
+|**connectionId** | **String** | Identifies the Credential Connection this credential is associated with. | |
+|**expiresAt** | **String** | ISO-8601 formatted date indicating when the credential will expire. | [optional] |
diff --git a/docs/TelephonyCredentialResponse.md b/docs/TelephonyCredentialResponse.md
index 70f67b5b..b734ac14 100644
--- a/docs/TelephonyCredentialResponse.md
+++ b/docs/TelephonyCredentialResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**TelephonyCredential**](TelephonyCredential.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**TelephonyCredential**](TelephonyCredential.md) | | [optional] |
diff --git a/docs/TelephonyCredentialUpdateRequest.md b/docs/TelephonyCredentialUpdateRequest.md
index 5b55e068..bc4a4c33 100644
--- a/docs/TelephonyCredentialUpdateRequest.md
+++ b/docs/TelephonyCredentialUpdateRequest.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | | [optional]
-**tag** | **String** | Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials. | [optional]
-**connectionId** | **String** | Identifies the Credential Connection this credential is associated with. | [optional]
-**expiresAt** | **String** | ISO-8601 formatted date indicating when the credential will expire. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**tag** | **String** | Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials. | [optional] |
+|**connectionId** | **String** | Identifies the Credential Connection this credential is associated with. | [optional] |
+|**expiresAt** | **String** | ISO-8601 formatted date indicating when the credential will expire. | [optional] |
diff --git a/docs/Template.md b/docs/Template.md
index 8b403675..d614a526 100644
--- a/docs/Template.md
+++ b/docs/Template.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**namespace** | **String** | Namespace of the template. This must be the namespace associated with the WhatsApp business account that owns the phone number associated with the current WhatsApp Business API client or the message fails to send. |
-**name** | **String** | Name of the template. |
-**language** | [**Language**](Language.md) | |
-**components** | [**List<Object>**](Object.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**namespace** | **String** | Namespace of the template. This must be the namespace associated with the WhatsApp business account that owns the phone number associated with the current WhatsApp Business API client or the message fails to send. | |
+|**name** | **String** | Name of the template. | |
+|**language** | [**Language**](Language.md) | | |
+|**components** | [**List<TemplateComponents>**](TemplateComponents.md) | | [optional] |
diff --git a/docs/TemplateButtonComponent.md b/docs/TemplateButtonComponent.md
new file mode 100644
index 00000000..73942537
--- /dev/null
+++ b/docs/TemplateButtonComponent.md
@@ -0,0 +1,16 @@
+
+
+# TemplateButtonComponent
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**ButtonComponentType**](ButtonComponentType.md) | Describes the component type. | |
+|**subType** | [**ButtonSubtype**](ButtonSubtype.md) | Used when type is set to button. | |
+|**index** | **Integer** | Position index of the button. You can have up to 3 buttons using index values of 0-2. | |
+|**parameters** | [**List**](List.md) | The parameters for the button, which are set at creation time in your Business Manager. | |
+
+
+
diff --git a/docs/TemplateButtonParameter.md b/docs/TemplateButtonParameter.md
new file mode 100644
index 00000000..b282799e
--- /dev/null
+++ b/docs/TemplateButtonParameter.md
@@ -0,0 +1,15 @@
+
+
+# TemplateButtonParameter
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**ButtonParameterType**](ButtonParameterType.md) | Indicates the type of parameter for the button. | |
+|**payload** | **String** | Required for quick_reply buttons. Developer-defined payload that will be returned when the button is clicked in addition to the display text on the button. | [optional] |
+|**text** | **String** | Required for url buttons. Developer provided suffix that will be appended to a previously created dynamic URL button. | [optional] |
+
+
+
diff --git a/docs/TemplateComponent.md b/docs/TemplateComponent.md
new file mode 100644
index 00000000..1b823542
--- /dev/null
+++ b/docs/TemplateComponent.md
@@ -0,0 +1,14 @@
+
+
+# TemplateComponent
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TemplateComponentType**](TemplateComponentType.md) | Describes the component type. | |
+|**parameters** | [**List<TemplateParameters>**](TemplateParameters.md) | | [optional] |
+
+
+
diff --git a/docs/TemplateComponentType.md b/docs/TemplateComponentType.md
new file mode 100644
index 00000000..81df6c56
--- /dev/null
+++ b/docs/TemplateComponentType.md
@@ -0,0 +1,13 @@
+
+
+# TemplateComponentType
+
+## Enum
+
+
+* `HEADER` (value: `"header"`)
+
+* `BODY` (value: `"body"`)
+
+
+
diff --git a/docs/TemplateComponents.md b/docs/TemplateComponents.md
new file mode 100644
index 00000000..b0faf0da
--- /dev/null
+++ b/docs/TemplateComponents.md
@@ -0,0 +1,39 @@
+
+
+# TemplateComponents
+
+
+
+## anyOf schemas
+* [TemplateButtonComponent](TemplateButtonComponent.md)
+* [TemplateComponent](TemplateComponent.md)
+
+## Example
+```java
+// Import classes:
+import com.telnyx.sdk.model.TemplateComponents;
+import com.telnyx.sdk.model.TemplateButtonComponent;
+import com.telnyx.sdk.model.TemplateComponent;
+
+public class Example {
+ public static void main(String[] args) {
+ TemplateComponents exampleTemplateComponents = new TemplateComponents();
+
+ // create a new TemplateButtonComponent
+ TemplateButtonComponent exampleTemplateButtonComponent = new TemplateButtonComponent();
+ // set TemplateComponents to TemplateButtonComponent
+ exampleTemplateComponents.setActualInstance(exampleTemplateButtonComponent);
+ // to get back the TemplateButtonComponent set earlier
+ TemplateButtonComponent testTemplateButtonComponent = (TemplateButtonComponent) exampleTemplateComponents.getActualInstance();
+
+ // create a new TemplateComponent
+ TemplateComponent exampleTemplateComponent = new TemplateComponent();
+ // set TemplateComponents to TemplateComponent
+ exampleTemplateComponents.setActualInstance(exampleTemplateComponent);
+ // to get back the TemplateComponent set earlier
+ TemplateComponent testTemplateComponent = (TemplateComponent) exampleTemplateComponents.getActualInstance();
+ }
+}
+```
+
+
diff --git a/docs/TemplateParameters.md b/docs/TemplateParameters.md
new file mode 100644
index 00000000..3bd23f08
--- /dev/null
+++ b/docs/TemplateParameters.md
@@ -0,0 +1,33 @@
+
+
+# TemplateParameters
+
+Array containing the content of the message.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | Describes the parameter type. | |
+|**text** | **String** | | [optional] |
+|**currency** | [**Currency**](Currency.md) | | [optional] |
+|**dateTime** | [**DateTimeObject**](DateTimeObject.md) | | [optional] |
+|**image** | [**Image**](Image.md) | | [optional] |
+|**document** | [**Document**](Document.md) | | [optional] |
+|**video** | [**Video**](Video.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| TEXT | "text" |
+| CURRENCY | "currency" |
+| DATE_TIME | "date_time" |
+| IMAGE | "image" |
+| DOCUMENT | "document" |
+| VIDEO | "video" |
+
+
+
diff --git a/docs/TexmlApplication.md b/docs/TexmlApplication.md
index 3292d5c6..fec18dc7 100644
--- a/docs/TexmlApplication.md
+++ b/docs/TexmlApplication.md
@@ -5,43 +5,43 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Uniquely identifies the resource. | [optional]
-**recordType** | **String** | Identifies the type of the resource. | [optional]
-**friendlyName** | **String** | A user-assigned name to help manage the application. | [optional]
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional]
-**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional]
-**voiceUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks. | [optional]
-**voiceFallbackUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url. | [optional]
-**voiceMethod** | [**VoiceMethodEnum**](#VoiceMethodEnum) | HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'. | [optional]
-**statusCallback** | **String** | URL for Telnyx to send requests to containing information about call progress events. | [optional]
-**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request method Telnyx should use when requesting the status_callback URL. | [optional]
-**inbound** | [**CreateTexmlApplicationRequestInbound**](CreateTexmlApplicationRequestInbound.md) | | [optional]
-**outbound** | [**CreateTexmlApplicationRequestOutbound**](CreateTexmlApplicationRequestOutbound.md) | | [optional]
-**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. | [optional]
-**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Uniquely identifies the resource. | [optional] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] |
+|**friendlyName** | **String** | A user-assigned name to help manage the application. | [optional] |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional] |
+|**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional] |
+|**voiceUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks. | [optional] |
+|**voiceFallbackUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url. | [optional] |
+|**voiceMethod** | [**VoiceMethodEnum**](#VoiceMethodEnum) | HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'. | [optional] |
+|**statusCallback** | **String** | URL for Telnyx to send requests to containing information about call progress events. | [optional] |
+|**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request method Telnyx should use when requesting the status_callback URL. | [optional] |
+|**inbound** | [**CreateTexmlApplicationRequestInbound**](CreateTexmlApplicationRequestInbound.md) | | [optional] |
+|**outbound** | [**CreateTexmlApplicationRequestOutbound**](CreateTexmlApplicationRequestOutbound.md) | | [optional] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
## Enum: VoiceMethodEnum
-Name | Value
----- | -----
-GET | "get"
-POST | "post"
+| Name | Value |
+|---- | -----|
+| GET | "get" |
+| POST | "post" |
## Enum: StatusCallbackMethodEnum
-Name | Value
----- | -----
-GET | "get"
-POST | "post"
+| Name | Value |
+|---- | -----|
+| GET | "get" |
+| POST | "post" |
diff --git a/docs/TexmlApplicationResponse.md b/docs/TexmlApplicationResponse.md
index 3b5a48f5..94a99090 100644
--- a/docs/TexmlApplicationResponse.md
+++ b/docs/TexmlApplicationResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**TexmlApplication**](TexmlApplication.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**TexmlApplication**](TexmlApplication.md) | | [optional] |
diff --git a/docs/Text.md b/docs/Text.md
index 234d7fc4..dccb6e08 100644
--- a/docs/Text.md
+++ b/docs/Text.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**body** | **String** | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**body** | **String** | | |
diff --git a/docs/Transcription.md b/docs/Transcription.md
index 5909e42e..fd2a387b 100644
--- a/docs/Transcription.md
+++ b/docs/Transcription.md
@@ -5,29 +5,29 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional]
-**id** | **UUID** | Identifies the type of resource. | [optional]
-**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional]
-**payload** | [**TranscriptionPayload**](TranscriptionPayload.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**eventType** | [**EventTypeEnum**](#EventTypeEnum) | The type of event being delivered. | [optional] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] |
+|**occurredAt** | **OffsetDateTime** | ISO 8601 datetime of when the event occurred. | [optional] |
+|**payload** | [**TranscriptionPayload**](TranscriptionPayload.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-EVENT | "event"
+| Name | Value |
+|---- | -----|
+| EVENT | "event" |
## Enum: EventTypeEnum
-Name | Value
----- | -----
-CALL_TRANSCRIPTION | "call.transcription"
+| Name | Value |
+|---- | -----|
+| CALL_TRANSCRIPTION | "call.transcription" |
diff --git a/docs/TranscriptionEvent.md b/docs/TranscriptionEvent.md
index 87aabd7c..60b84e8d 100644
--- a/docs/TranscriptionEvent.md
+++ b/docs/TranscriptionEvent.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Transcription**](Transcription.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**Transcription**](Transcription.md) | | [optional] |
diff --git a/docs/TranscriptionPayload.md b/docs/TranscriptionPayload.md
index 7fcd26b6..7061e217 100644
--- a/docs/TranscriptionPayload.md
+++ b/docs/TranscriptionPayload.md
@@ -5,14 +5,14 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique identifier and token for controlling the call. | [optional]
-**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional]
-**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**connectionId** | **String** | Telnyx connection ID used in the call. | [optional]
-**transcriptionData** | [**TranscriptionPayloadTranscriptionData**](TranscriptionPayloadTranscriptionData.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique identifier and token for controlling the call. | [optional] |
+|**callLegId** | **String** | ID that is unique to the call and can be used to correlate webhook events. | [optional] |
+|**callSessionId** | **String** | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**connectionId** | **String** | Telnyx connection ID used in the call. | [optional] |
+|**transcriptionData** | [**TranscriptionPayloadTranscriptionData**](TranscriptionPayloadTranscriptionData.md) | | [optional] |
diff --git a/docs/TranscriptionPayloadTranscriptionData.md b/docs/TranscriptionPayloadTranscriptionData.md
index 701adb5d..82b89546 100644
--- a/docs/TranscriptionPayloadTranscriptionData.md
+++ b/docs/TranscriptionPayloadTranscriptionData.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**confidence** | **Double** | Speech recognition confidence level. | [optional]
-**isFinal** | **Boolean** | When false, it means that this is an interim result. | [optional]
-**transcript** | **String** | Recognized text. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**confidence** | **Double** | Speech recognition confidence level. | [optional] |
+|**isFinal** | **Boolean** | When false, it means that this is an interim result. | [optional] |
+|**transcript** | **String** | Recognized text. | [optional] |
diff --git a/docs/TranscriptionStartRequest.md b/docs/TranscriptionStartRequest.md
index 9ea0849d..b2b04d05 100644
--- a/docs/TranscriptionStartRequest.md
+++ b/docs/TranscriptionStartRequest.md
@@ -5,25 +5,26 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**language** | [**LanguageEnum**](#LanguageEnum) | Language to use for speech recognition | [optional]
-**interimResults** | **Boolean** | Whether to send also interim results. If set to false, only final results will be sent. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**language** | [**LanguageEnum**](#LanguageEnum) | Language to use for speech recognition | [optional] |
+|**interimResults** | **Boolean** | Whether to send also interim results. If set to false, only final results will be sent. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**transcriptionTracks** | **String** | Indicates which leg of the call will be transcribed. Use `inbound` for the leg that requested the transcription, `outbound` for the other leg, and `both` for both legs of the call. Will default to `inbound`. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
## Enum: LanguageEnum
-Name | Value
----- | -----
-DE | "de"
-EN | "en"
-ES | "es"
-FR | "fr"
-IT | "it"
-PL | "pl"
+| Name | Value |
+|---- | -----|
+| DE | "de" |
+| EN | "en" |
+| ES | "es" |
+| FR | "fr" |
+| IT | "it" |
+| PL | "pl" |
diff --git a/docs/TranscriptionStopRequest.md b/docs/TranscriptionStopRequest.md
index 0fbbc03d..fc4bdf41 100644
--- a/docs/TranscriptionStopRequest.md
+++ b/docs/TranscriptionStopRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
diff --git a/docs/TransferCallRequest.md b/docs/TransferCallRequest.md
index fd5c4e42..1836b525 100644
--- a/docs/TransferCallRequest.md
+++ b/docs/TransferCallRequest.md
@@ -5,47 +5,48 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**to** | **String** | The DID or SIP URI to dial out and bridge to the given call. |
-**from** | **String** | The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `from` number of the original call if omitted. | [optional]
-**fromDisplayName** | **String** | The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field. | [optional]
-**audioUrl** | **String** | The URL of a file to be played back when the transfer destination answers before bridging the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional]
-**mediaName** | **String** | The media_name of a file to be played back when the transfer destination answers before bridging the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional]
-**timeoutSecs** | **Integer** | The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being transferred. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds. | [optional]
-**timeLimitSecs** | **Integer** | Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length. | [optional]
-**answeringMachineDetection** | [**AnsweringMachineDetectionEnum**](#AnsweringMachineDetectionEnum) | Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected. | [optional]
-**answeringMachineDetectionConfig** | [**CallRequestAnsweringMachineDetectionConfig**](CallRequestAnsweringMachineDetectionConfig.md) | | [optional]
-**customHeaders** | [**List<CustomSipHeader>**](CustomSipHeader.md) | Custom headers to be added to the SIP INVITE. | [optional]
-**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional]
-**targetLegClientState** | **String** | Use this field to add state to every subsequent webhook for the new leg. It must be a valid Base-64 encoded string. | [optional]
-**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional]
-**sipAuthUsername** | **String** | SIP Authentication username used for SIP challenges. | [optional]
-**sipAuthPassword** | **String** | SIP Authentication password used for SIP challenges. | [optional]
-**sipHeaders** | [**List<SipHeader>**](SipHeader.md) | SIP headers to be added to the SIP INVITE. Currently only User-to-User header is supported. | [optional]
-**webhookUrl** | **String** | Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call. | [optional]
-**webhookUrlMethod** | [**WebhookUrlMethodEnum**](#WebhookUrlMethodEnum) | HTTP request type used for `webhook_url`. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**to** | **String** | The DID or SIP URI to dial out and bridge to the given call. | |
+|**from** | **String** | The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `from` number of the original call if omitted. | [optional] |
+|**fromDisplayName** | **String** | The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field. | [optional] |
+|**audioUrl** | **String** | The URL of a file to be played back when the transfer destination answers before bridging the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. | [optional] |
+|**mediaName** | **String** | The media_name of a file to be played back when the transfer destination answers before bridging the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. | [optional] |
+|**timeoutSecs** | **Integer** | The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being transferred. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds. | [optional] |
+|**timeLimitSecs** | **Integer** | Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length. | [optional] |
+|**answeringMachineDetection** | [**AnsweringMachineDetectionEnum**](#AnsweringMachineDetectionEnum) | Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected. | [optional] |
+|**answeringMachineDetectionConfig** | [**CallRequestAnsweringMachineDetectionConfig**](CallRequestAnsweringMachineDetectionConfig.md) | | [optional] |
+|**customHeaders** | [**List<CustomSipHeader>**](CustomSipHeader.md) | Custom headers to be added to the SIP INVITE. | [optional] |
+|**clientState** | **String** | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
+|**targetLegClientState** | **String** | Use this field to add state to every subsequent webhook for the new leg. It must be a valid Base-64 encoded string. | [optional] |
+|**commandId** | **String** | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
+|**sipAuthUsername** | **String** | SIP Authentication username used for SIP challenges. | [optional] |
+|**sipAuthPassword** | **String** | SIP Authentication password used for SIP challenges. | [optional] |
+|**sipHeaders** | [**List<SipHeader>**](SipHeader.md) | SIP headers to be added to the SIP INVITE. Currently only User-to-User header is supported. | [optional] |
+|**soundModifications** | [**SoundModifications**](SoundModifications.md) | | [optional] |
+|**webhookUrl** | **String** | Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call. | [optional] |
+|**webhookUrlMethod** | [**WebhookUrlMethodEnum**](#WebhookUrlMethodEnum) | HTTP request type used for `webhook_url`. | [optional] |
## Enum: AnsweringMachineDetectionEnum
-Name | Value
----- | -----
-DETECT | "detect"
-DETECT_BEEP | "detect_beep"
-DETECT_WORDS | "detect_words"
-GREETING_END | "greeting_end"
-DISABLED | "disabled"
+| Name | Value |
+|---- | -----|
+| DETECT | "detect" |
+| DETECT_BEEP | "detect_beep" |
+| DETECT_WORDS | "detect_words" |
+| GREETING_END | "greeting_end" |
+| DISABLED | "disabled" |
## Enum: WebhookUrlMethodEnum
-Name | Value
----- | -----
-POST | "POST"
-GET | "GET"
+| Name | Value |
+|---- | -----|
+| POST | "POST" |
+| GET | "GET" |
diff --git a/docs/UnauthorizedError.md b/docs/UnauthorizedError.md
index 3ef7a113..153697ad 100644
--- a/docs/UnauthorizedError.md
+++ b/docs/UnauthorizedError.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Object** | | [optional]
-**title** | **Object** | | [optional]
-**detail** | **Object** | | [optional]
-**source** | [**ErrorSource**](ErrorSource.md) | | [optional]
-**meta** | [**UnauthorizedErrorAllOfMeta**](UnauthorizedErrorAllOfMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Object** | | [optional] |
+|**title** | **Object** | | [optional] |
+|**detail** | **Object** | | [optional] |
+|**source** | [**UpdateOutboundChannelsDefaultResponseErrorsInnerSource**](UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md) | | [optional] |
+|**meta** | [**UnauthorizedErrorAllOfMeta**](UnauthorizedErrorAllOfMeta.md) | | [optional] |
diff --git a/docs/UnauthorizedErrorAllOf.md b/docs/UnauthorizedErrorAllOf.md
index 77936ffb..542756f5 100644
--- a/docs/UnauthorizedErrorAllOf.md
+++ b/docs/UnauthorizedErrorAllOf.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Object** | | [optional]
-**title** | **Object** | | [optional]
-**detail** | **Object** | | [optional]
-**meta** | [**UnauthorizedErrorAllOfMeta**](UnauthorizedErrorAllOfMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Object** | | [optional] |
+|**title** | **Object** | | [optional] |
+|**detail** | **Object** | | [optional] |
+|**meta** | [**UnauthorizedErrorAllOfMeta**](UnauthorizedErrorAllOfMeta.md) | | [optional] |
diff --git a/docs/UnauthorizedErrorAllOfMeta.md b/docs/UnauthorizedErrorAllOfMeta.md
index 0d8fb847..3a390559 100644
--- a/docs/UnauthorizedErrorAllOfMeta.md
+++ b/docs/UnauthorizedErrorAllOfMeta.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | | [optional] |
diff --git a/docs/UnexpectedError.md b/docs/UnexpectedError.md
index 7bdc2706..5a706ac5 100644
--- a/docs/UnexpectedError.md
+++ b/docs/UnexpectedError.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Object** | | [optional]
-**title** | **Object** | | [optional]
-**detail** | **Object** | | [optional]
-**source** | [**ErrorSource**](ErrorSource.md) | | [optional]
-**meta** | [**UnexpectedErrorAllOfMeta**](UnexpectedErrorAllOfMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Object** | | [optional] |
+|**title** | **Object** | | [optional] |
+|**detail** | **Object** | | [optional] |
+|**source** | [**UpdateOutboundChannelsDefaultResponseErrorsInnerSource**](UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md) | | [optional] |
+|**meta** | [**UnexpectedErrorAllOfMeta**](UnexpectedErrorAllOfMeta.md) | | [optional] |
diff --git a/docs/UnexpectedErrorAllOf.md b/docs/UnexpectedErrorAllOf.md
index ea1783f5..4bbeb6b9 100644
--- a/docs/UnexpectedErrorAllOf.md
+++ b/docs/UnexpectedErrorAllOf.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Object** | | [optional]
-**title** | **Object** | | [optional]
-**detail** | **Object** | | [optional]
-**meta** | [**UnexpectedErrorAllOfMeta**](UnexpectedErrorAllOfMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Object** | | [optional] |
+|**title** | **Object** | | [optional] |
+|**detail** | **Object** | | [optional] |
+|**meta** | [**UnexpectedErrorAllOfMeta**](UnexpectedErrorAllOfMeta.md) | | [optional] |
diff --git a/docs/UnexpectedErrorAllOfMeta.md b/docs/UnexpectedErrorAllOfMeta.md
index 3695f03c..623f8e61 100644
--- a/docs/UnexpectedErrorAllOfMeta.md
+++ b/docs/UnexpectedErrorAllOfMeta.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | | [optional] |
diff --git a/docs/UnprocessableEntityError.md b/docs/UnprocessableEntityError.md
index 3d9ea619..18eba0c0 100644
--- a/docs/UnprocessableEntityError.md
+++ b/docs/UnprocessableEntityError.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Object** | | [optional]
-**title** | **Object** | | [optional]
-**detail** | **Object** | | [optional]
-**source** | [**UnprocessableEntityErrorAllOfSource**](UnprocessableEntityErrorAllOfSource.md) | | [optional]
-**meta** | [**UnprocessableEntityErrorAllOfMeta**](UnprocessableEntityErrorAllOfMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Object** | | [optional] |
+|**title** | **Object** | | [optional] |
+|**detail** | **Object** | | [optional] |
+|**source** | [**UnprocessableEntityErrorAllOfSource**](UnprocessableEntityErrorAllOfSource.md) | | [optional] |
+|**meta** | [**UnprocessableEntityErrorAllOfMeta**](UnprocessableEntityErrorAllOfMeta.md) | | [optional] |
diff --git a/docs/UnprocessableEntityErrorAllOf.md b/docs/UnprocessableEntityErrorAllOf.md
index 17b061a8..8823a80a 100644
--- a/docs/UnprocessableEntityErrorAllOf.md
+++ b/docs/UnprocessableEntityErrorAllOf.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Object** | | [optional]
-**title** | **Object** | | [optional]
-**detail** | **Object** | | [optional]
-**source** | [**UnprocessableEntityErrorAllOfSource**](UnprocessableEntityErrorAllOfSource.md) | | [optional]
-**meta** | [**UnprocessableEntityErrorAllOfMeta**](UnprocessableEntityErrorAllOfMeta.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Object** | | [optional] |
+|**title** | **Object** | | [optional] |
+|**detail** | **Object** | | [optional] |
+|**source** | [**UnprocessableEntityErrorAllOfSource**](UnprocessableEntityErrorAllOfSource.md) | | [optional] |
+|**meta** | [**UnprocessableEntityErrorAllOfMeta**](UnprocessableEntityErrorAllOfMeta.md) | | [optional] |
diff --git a/docs/UnprocessableEntityErrorAllOfMeta.md b/docs/UnprocessableEntityErrorAllOfMeta.md
index 1c8924c5..42779b41 100644
--- a/docs/UnprocessableEntityErrorAllOfMeta.md
+++ b/docs/UnprocessableEntityErrorAllOfMeta.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | | [optional] |
diff --git a/docs/UnprocessableEntityErrorAllOfSource.md b/docs/UnprocessableEntityErrorAllOfSource.md
index d40253aa..3ec66c10 100644
--- a/docs/UnprocessableEntityErrorAllOfSource.md
+++ b/docs/UnprocessableEntityErrorAllOfSource.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pointer** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**pointer** | **String** | | [optional] |
diff --git a/docs/UpdateAuthenticationProviderRequest.md b/docs/UpdateAuthenticationProviderRequest.md
index 0ec6092a..e0a5a209 100644
--- a/docs/UpdateAuthenticationProviderRequest.md
+++ b/docs/UpdateAuthenticationProviderRequest.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name associated with the authentication provider. | [optional]
-**shortName** | **String** | The short name associated with the authentication provider. This must be unique and URL-friendly, as it's going to be part of the login URL. | [optional]
-**active** | **Boolean** | The active status of the authentication provider | [optional]
-**settings** | [**Settings**](Settings.md) | | [optional]
-**settingsUrl** | **String** | The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name associated with the authentication provider. | [optional] |
+|**shortName** | **String** | The short name associated with the authentication provider. This must be unique and URL-friendly, as it's going to be part of the login URL. | [optional] |
+|**active** | **Boolean** | The active status of the authentication provider | [optional] |
+|**settings** | [**Settings**](Settings.md) | | [optional] |
+|**settingsUrl** | **String** | The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead. | [optional] |
diff --git a/docs/UpdateBillingGroup.md b/docs/UpdateBillingGroup.md
index 760402a0..73a59b7a 100644
--- a/docs/UpdateBillingGroup.md
+++ b/docs/UpdateBillingGroup.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A name for the billing group | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | A name for the billing group | [optional] |
diff --git a/docs/UpdateCallControlApplicationRequest.md b/docs/UpdateCallControlApplicationRequest.md
index feef9ce2..d3bd6361 100644
--- a/docs/UpdateCallControlApplicationRequest.md
+++ b/docs/UpdateCallControlApplicationRequest.md
@@ -5,50 +5,50 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**applicationName** | **String** | A user-assigned name to help manage the application. |
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. |
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | [**AnchorsiteOverrideEnum**](#AnchorsiteOverrideEnum) | <code>Latency</code> directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media. | [optional]
-**dtmfType** | [**DtmfTypeEnum**](#DtmfTypeEnum) | Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats. | [optional]
-**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional]
-**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional]
-**inbound** | [**CallControlApplicationInbound**](CallControlApplicationInbound.md) | | [optional]
-**outbound** | [**CallControlApplicationOutbound**](CallControlApplicationOutbound.md) | | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**applicationName** | **String** | A user-assigned name to help manage the application. | |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | [**AnchorsiteOverrideEnum**](#AnchorsiteOverrideEnum) | <code>Latency</code> directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media. | [optional] |
+|**dtmfType** | [**DtmfTypeEnum**](#DtmfTypeEnum) | Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats. | [optional] |
+|**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional] |
+|**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional] |
+|**inbound** | [**CallControlApplicationInbound**](CallControlApplicationInbound.md) | | [optional] |
+|**outbound** | [**CallControlApplicationOutbound**](CallControlApplicationOutbound.md) | | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
## Enum: AnchorsiteOverrideEnum
-Name | Value
----- | -----
-LATENCY_ | "\"Latency\""
-CHICAGO_IL_ | "\"Chicago, IL\""
-ASHBURN_VA_ | "\"Ashburn, VA\""
-SAN_JOSE_CA_ | "\"San Jose, CA\""
+| Name | Value |
+|---- | -----|
+| LATENCY_ | "\"Latency\"" |
+| CHICAGO_IL_ | "\"Chicago, IL\"" |
+| ASHBURN_VA_ | "\"Ashburn, VA\"" |
+| SAN_JOSE_CA_ | "\"San Jose, CA\"" |
## Enum: DtmfTypeEnum
-Name | Value
----- | -----
-RFC_2833 | "RFC 2833"
-INBAND | "Inband"
-SIP_INFO | "SIP INFO"
+| Name | Value |
+|---- | -----|
+| RFC_2833 | "RFC 2833" |
+| INBAND | "Inband" |
+| SIP_INFO | "SIP INFO" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/UpdateCallRequest.md b/docs/UpdateCallRequest.md
new file mode 100644
index 00000000..fe977dda
--- /dev/null
+++ b/docs/UpdateCallRequest.md
@@ -0,0 +1,47 @@
+
+
+# UpdateCallRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**status** | **String** | The value to set the call status to. Setting the status to completed ends the call. | [optional] |
+|**url** | **String** | The URL where TeXML will make a request to retrieve a new set of TeXML instructions to continue the call flow. | [optional] |
+|**method** | [**MethodEnum**](#MethodEnum) | HTTP request type used for `Url`. | [optional] |
+|**fallbackUrl** | **String** | A failover URL for which Telnyx will retrieve the TeXML call instructions if the Url is not responding. | [optional] |
+|**fallbackMethod** | [**FallbackMethodEnum**](#FallbackMethodEnum) | HTTP request type used for `FallbackUrl`. | [optional] |
+|**statusCallback** | **String** | URL destination for Telnyx to send status callback events to for the call. | [optional] |
+|**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request type used for `StatusCallback`. | [optional] |
+|**texml** | **String** | TeXml to replace the current one with. | [optional] |
+
+
+
+## Enum: MethodEnum
+
+| Name | Value |
+|---- | -----|
+| GET | "GET" |
+| POST | "POST" |
+
+
+
+## Enum: FallbackMethodEnum
+
+| Name | Value |
+|---- | -----|
+| GET | "GET" |
+| POST | "POST" |
+
+
+
+## Enum: StatusCallbackMethodEnum
+
+| Name | Value |
+|---- | -----|
+| GET | "GET" |
+| POST | "POST" |
+
+
+
diff --git a/docs/UpdateCommandResult.md b/docs/UpdateCommandResult.md
new file mode 100644
index 00000000..e39de4d7
--- /dev/null
+++ b/docs/UpdateCommandResult.md
@@ -0,0 +1,14 @@
+
+
+# UpdateCommandResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**sid** | **String** | | [optional] |
+|**status** | **String** | | [optional] |
+
+
+
diff --git a/docs/UpdateConferenceRequest.md b/docs/UpdateConferenceRequest.md
index f4f1c4b1..d253d69b 100644
--- a/docs/UpdateConferenceRequest.md
+++ b/docs/UpdateConferenceRequest.md
@@ -5,23 +5,23 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callControlId** | **String** | Unique identifier and token for controlling the call |
-**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional]
-**supervisorRole** | [**SupervisorRoleEnum**](#SupervisorRoleEnum) | Sets the participant as a supervisor for the conference. A conference can have multiple supervisors. \"barge\" means the supervisor enters the conference as a normal participant. This is the same as \"none\". \"monitor\" means the supervisor is muted but can hear all participants. \"whisper\" means that only the specified \"whisper_call_control_ids\" can hear the supervisor. Defaults to \"none\". |
-**whisperCallControlIds** | **List<String>** | Array of unique call_control_ids the supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callControlId** | **String** | Unique identifier and token for controlling the call | |
+|**commandId** | **String** | Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed. | [optional] |
+|**supervisorRole** | [**SupervisorRoleEnum**](#SupervisorRoleEnum) | Sets the participant as a supervisor for the conference. A conference can have multiple supervisors. \"barge\" means the supervisor enters the conference as a normal participant. This is the same as \"none\". \"monitor\" means the supervisor is muted but can hear all participants. \"whisper\" means that only the specified \"whisper_call_control_ids\" can hear the supervisor. Defaults to \"none\". | |
+|**whisperCallControlIds** | **List<String>** | Array of unique call_control_ids the supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only. | [optional] |
## Enum: SupervisorRoleEnum
-Name | Value
----- | -----
-BARGE | "barge"
-MONITOR | "monitor"
-NONE | "none"
-WHISPER | "whisper"
+| Name | Value |
+|---- | -----|
+| BARGE | "barge" |
+| MONITOR | "monitor" |
+| NONE | "none" |
+| WHISPER | "whisper" |
diff --git a/docs/UpdateCredentialConnectionRequest.md b/docs/UpdateCredentialConnectionRequest.md
index 188baf30..80d5f67d 100644
--- a/docs/UpdateCredentialConnectionRequest.md
+++ b/docs/UpdateCredentialConnectionRequest.md
@@ -5,45 +5,45 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Defaults to true | [optional]
-**userName** | **String** | The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). | [optional]
-**password** | **String** | The password to be used as part of the credentials. Must be 8 to 128 characters long. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | | [optional]
-**sipUriCallingPreference** | [**SipUriCallingPreferenceEnum**](#SipUriCallingPreferenceEnum) | This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**CredentialInbound**](CredentialInbound.md) | | [optional]
-**outbound** | [**CredentialOutbound**](CredentialOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**userName** | **String** | The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). | [optional] |
+|**password** | **String** | The password to be used as part of the credentials. Must be 8 to 128 characters long. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | [optional] |
+|**sipUriCallingPreference** | [**SipUriCallingPreferenceEnum**](#SipUriCallingPreferenceEnum) | This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**CredentialInbound**](CredentialInbound.md) | | [optional] |
+|**outbound** | [**CredentialOutbound**](CredentialOutbound.md) | | [optional] |
## Enum: SipUriCallingPreferenceEnum
-Name | Value
----- | -----
-DISABLED | "disabled"
-UNRESTRICTED | "unrestricted"
-INTERNAL | "internal"
+| Name | Value |
+|---- | -----|
+| DISABLED | "disabled" |
+| UNRESTRICTED | "unrestricted" |
+| INTERNAL | "internal" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/UpdateFaxApplicationRequest.md b/docs/UpdateFaxApplicationRequest.md
index e1001dad..32eacead 100644
--- a/docs/UpdateFaxApplicationRequest.md
+++ b/docs/UpdateFaxApplicationRequest.md
@@ -5,17 +5,17 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**applicationName** | **String** | A user-assigned name to help manage the application. |
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. |
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**faxEmailRecipient** | **String** | Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments) | [optional]
-**inbound** | [**CreateFaxApplicationRequestInbound**](CreateFaxApplicationRequestInbound.md) | | [optional]
-**outbound** | [**CreateFaxApplicationRequestOutbound**](CreateFaxApplicationRequestOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**applicationName** | **String** | A user-assigned name to help manage the application. | |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**faxEmailRecipient** | **String** | Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments) | [optional] |
+|**inbound** | [**CreateFaxApplicationRequestInbound**](CreateFaxApplicationRequestInbound.md) | | [optional] |
+|**outbound** | [**CreateFaxApplicationRequestOutbound**](CreateFaxApplicationRequestOutbound.md) | | [optional] |
diff --git a/docs/UpdateFqdnConnectionRequest.md b/docs/UpdateFqdnConnectionRequest.md
index 09e681eb..19889d74 100644
--- a/docs/UpdateFqdnConnectionRequest.md
+++ b/docs/UpdateFqdnConnectionRequest.md
@@ -5,32 +5,32 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Defaults to true | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | | [optional]
-**transportProtocol** | **FqdnConnectionTransportProtocol** | | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**InboundFqdn**](InboundFqdn.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | [optional] |
+|**transportProtocol** | **FqdnConnectionTransportProtocol** | | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**InboundFqdn**](InboundFqdn.md) | | [optional] |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/UpdateFqdnRequest.md b/docs/UpdateFqdnRequest.md
index a5286ad7..e3735670 100644
--- a/docs/UpdateFqdnRequest.md
+++ b/docs/UpdateFqdnRequest.md
@@ -5,12 +5,12 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connectionId** | **String** | ID of the FQDN connection to which this IP should be attached. | [optional]
-**fqdn** | **String** | FQDN represented by this resource. | [optional]
-**port** | **Integer** | Port to use when connecting to this FQDN. | [optional]
-**dnsRecordType** | **String** | The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**connectionId** | **String** | ID of the FQDN connection to which this IP should be attached. | [optional] |
+|**fqdn** | **String** | FQDN represented by this resource. | [optional] |
+|**port** | **Integer** | Port to use when connecting to this FQDN. | [optional] |
+|**dnsRecordType** | **String** | The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used. | [optional] |
diff --git a/docs/UpdateIpConnectionRequest.md b/docs/UpdateIpConnectionRequest.md
index 9a72f0a6..4a039919 100644
--- a/docs/UpdateIpConnectionRequest.md
+++ b/docs/UpdateIpConnectionRequest.md
@@ -5,43 +5,43 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Defaults to true | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**connectionName** | **String** | | [optional]
-**transportProtocol** | [**TransportProtocolEnum**](#TransportProtocolEnum) | One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication. | [optional]
-**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional]
-**encryptedMedia** | **EncryptedMedia** | | [optional]
-**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional]
-**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional]
-**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional]
-**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional]
-**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional]
-**inbound** | [**InboundIp**](InboundIp.md) | | [optional]
-**outbound** | [**OutboundIp**](OutboundIp.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**active** | **Boolean** | Defaults to true | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**connectionName** | **String** | | [optional] |
+|**transportProtocol** | [**TransportProtocolEnum**](#TransportProtocolEnum) | One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication. | [optional] |
+|**defaultOnHoldComfortNoiseEnabled** | **Boolean** | When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**encodeContactHeaderEnabled** | **Boolean** | Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. | [optional] |
+|**encryptedMedia** | **EncryptedMedia** | | [optional] |
+|**onnetT38PassthroughEnabled** | **Boolean** | Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. | [optional] |
+|**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. | [optional] |
+|**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. | [optional] |
+|**webhookTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a webhook. | [optional] |
+|**rtcpSettings** | [**ConnectionRtcpSettings**](ConnectionRtcpSettings.md) | | [optional] |
+|**inbound** | [**InboundIp**](InboundIp.md) | | [optional] |
+|**outbound** | [**OutboundIp**](OutboundIp.md) | | [optional] |
## Enum: TransportProtocolEnum
-Name | Value
----- | -----
-UDP | "UDP"
-TCP | "TCP"
-TLS | "TLS"
+| Name | Value |
+|---- | -----|
+| UDP | "UDP" |
+| TCP | "TCP" |
+| TLS | "TLS" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
diff --git a/docs/UpdateIpRequest.md b/docs/UpdateIpRequest.md
index d9d3e9ee..0fe121ff 100644
--- a/docs/UpdateIpRequest.md
+++ b/docs/UpdateIpRequest.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**connectionId** | **String** | ID of the IP Connection to which this IP should be attached. | [optional]
-**ipAddress** | **String** | IP adddress represented by this resource. |
-**port** | **Integer** | Port to use when connecting to this IP. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**connectionId** | **String** | ID of the IP Connection to which this IP should be attached. | [optional] |
+|**ipAddress** | **String** | IP adddress represented by this resource. | |
+|**port** | **Integer** | Port to use when connecting to this IP. | [optional] |
diff --git a/docs/UpdateManagedAccountRequest.md b/docs/UpdateManagedAccountRequest.md
index 4722a244..8aa216c1 100644
--- a/docs/UpdateManagedAccountRequest.md
+++ b/docs/UpdateManagedAccountRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**managedAccountAllowCustomPricing** | **Boolean** | Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**managedAccountAllowCustomPricing** | **Boolean** | Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect. | [optional] |
diff --git a/docs/UpdateMediaRequest.md b/docs/UpdateMediaRequest.md
index 8dfbadae..b86c00c3 100644
--- a/docs/UpdateMediaRequest.md
+++ b/docs/UpdateMediaRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mediaUrl** | **String** | The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB. | [optional]
-**ttlSecs** | **Integer** | The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mediaUrl** | **String** | The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB. | [optional] |
+|**ttlSecs** | **Integer** | The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years. | [optional] |
diff --git a/docs/UpdateMessagingProfileRequest.md b/docs/UpdateMessagingProfileRequest.md
index 4ea5a0d9..ad90c150 100644
--- a/docs/UpdateMessagingProfileRequest.md
+++ b/docs/UpdateMessagingProfileRequest.md
@@ -5,39 +5,39 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly]
-**id** | **UUID** | Identifies the type of resource. | [optional] [readonly]
-**name** | **String** | A user friendly name for the messaging profile. | [optional]
-**enabled** | **Boolean** | Specifies whether the messaging profile is enabled or not. | [optional]
-**webhookUrl** | **String** | The URL where webhooks related to this messaging profile will be sent. | [optional]
-**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. | [optional]
-**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. | [optional]
-**whitelistedDestinations** | **List<String>** | Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. | [optional]
-**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly]
-**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly]
-**v1Secret** | **String** | Secret used to authenticate with v1 endpoints. | [optional]
-**numberPoolSettings** | [**NumberPoolSettings**](NumberPoolSettings.md) | | [optional]
-**urlShortenerSettings** | [**UrlShortenerSettings**](UrlShortenerSettings.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] [readonly] |
+|**id** | **UUID** | Identifies the type of resource. | [optional] [readonly] |
+|**name** | **String** | A user friendly name for the messaging profile. | [optional] |
+|**enabled** | **Boolean** | Specifies whether the messaging profile is enabled or not. | [optional] |
+|**webhookUrl** | **String** | The URL where webhooks related to this messaging profile will be sent. | [optional] |
+|**webhookFailoverUrl** | **String** | The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails. | [optional] |
+|**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format. | [optional] |
+|**whitelistedDestinations** | **List<String>** | Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. | [optional] |
+|**createdAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **OffsetDateTime** | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
+|**v1Secret** | **String** | Secret used to authenticate with v1 endpoints. | [optional] |
+|**numberPoolSettings** | [**NumberPoolSettings**](NumberPoolSettings.md) | | [optional] |
+|**urlShortenerSettings** | [**UrlShortenerSettings**](UrlShortenerSettings.md) | | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-MESSAGING_PROFILE | "messaging_profile"
+| Name | Value |
+|---- | -----|
+| MESSAGING_PROFILE | "messaging_profile" |
## Enum: WebhookApiVersionEnum
-Name | Value
----- | -----
-_1 | "1"
-_2 | "2"
-_2010_04_01 | "2010-04-01"
+| Name | Value |
+|---- | -----|
+| _1 | "1" |
+| _2 | "2" |
+| _2010_04_01 | "2010-04-01" |
diff --git a/docs/UpdateNumberOrderDocumentRequest.md b/docs/UpdateNumberOrderDocumentRequest.md
index 0f72c7a1..afd20e6d 100644
--- a/docs/UpdateNumberOrderDocumentRequest.md
+++ b/docs/UpdateNumberOrderDocumentRequest.md
@@ -5,25 +5,25 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**fileId** | **String** | The id of the file to associate as a number order document. | [optional]
-**requirementsId** | **String** | Unique id for a requirement. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**requirementType** | [**RequirementTypeEnum**](#RequirementTypeEnum) | | [optional] [readonly]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order document was uploaded. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**fileId** | **String** | The id of the file to associate as a number order document. | [optional] |
+|**requirementsId** | **String** | Unique id for a requirement. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**requirementType** | [**RequirementTypeEnum**](#RequirementTypeEnum) | | [optional] [readonly] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order document was uploaded. | [optional] [readonly] |
## Enum: RequirementTypeEnum
-Name | Value
----- | -----
-ADDRESS_PROOF | "address_proof"
-IDENTIFICATION | "identification"
-REG_FORM | "reg_form"
+| Name | Value |
+|---- | -----|
+| ADDRESS_PROOF | "address_proof" |
+| IDENTIFICATION | "identification" |
+| REG_FORM | "reg_form" |
diff --git a/docs/UpdateNumberOrderPhoneNumberRequest.md b/docs/UpdateNumberOrderPhoneNumberRequest.md
index 30e7ffd3..1aa9880d 100644
--- a/docs/UpdateNumberOrderPhoneNumberRequest.md
+++ b/docs/UpdateNumberOrderPhoneNumberRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**regulatoryRequirements** | [**List<UpdateRegulatoryRequirement>**](UpdateRegulatoryRequirement.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**regulatoryRequirements** | [**List<UpdateRegulatoryRequirement>**](UpdateRegulatoryRequirement.md) | | [optional] |
diff --git a/docs/UpdateNumberOrderRequest.md b/docs/UpdateNumberOrderRequest.md
index 1f5078b6..aebd33a1 100644
--- a/docs/UpdateNumberOrderRequest.md
+++ b/docs/UpdateNumberOrderRequest.md
@@ -5,27 +5,27 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional] [readonly]
-**recordType** | **String** | | [optional] [readonly]
-**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional]
-**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly]
-**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly]
-**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] [readonly] |
+|**recordType** | **String** | | [optional] [readonly] |
+|**phoneNumbers** | [**List<PhoneNumber>**](PhoneNumber.md) | | [optional] |
+|**phoneNumbersCount** | **Integer** | The count of phone numbers in the number order. | [optional] [readonly] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the order. | [optional] [readonly] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**createdAt** | **String** | An ISO 8901 datetime string denoting when the number order was created. | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8901 datetime string for when the number order was updated. | [optional] [readonly] |
+|**requirementsMet** | **Boolean** | True if all requirements are met for every phone number, false otherwise. | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-PENDING | "pending"
-SUCCESS | "success"
-FAILURE | "failure"
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| SUCCESS | "success" |
+| FAILURE | "failure" |
diff --git a/docs/UpdateOutboundChannels200Response.md b/docs/UpdateOutboundChannels200Response.md
new file mode 100644
index 00000000..a6ea1597
--- /dev/null
+++ b/docs/UpdateOutboundChannels200Response.md
@@ -0,0 +1,13 @@
+
+
+# UpdateOutboundChannels200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateOutboundChannels200ResponseData**](UpdateOutboundChannels200ResponseData.md) | | [optional] |
+
+
+
diff --git a/docs/UpdateOutboundChannels200ResponseData.md b/docs/UpdateOutboundChannels200ResponseData.md
new file mode 100644
index 00000000..e3b6bbc8
--- /dev/null
+++ b/docs/UpdateOutboundChannels200ResponseData.md
@@ -0,0 +1,14 @@
+
+
+# UpdateOutboundChannels200ResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channels** | **Integer** | The number of channels set for the account | [optional] |
+|**recordType** | **String** | Identifies the type of the response | [optional] |
+
+
+
diff --git a/docs/UpdateOutboundChannelsDefaultResponse.md b/docs/UpdateOutboundChannelsDefaultResponse.md
new file mode 100644
index 00000000..78d700db
--- /dev/null
+++ b/docs/UpdateOutboundChannelsDefaultResponse.md
@@ -0,0 +1,13 @@
+
+
+# UpdateOutboundChannelsDefaultResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**errors** | [**List<UpdateOutboundChannelsDefaultResponseErrorsInner>**](UpdateOutboundChannelsDefaultResponseErrorsInner.md) | | [optional] |
+
+
+
diff --git a/docs/UpdateOutboundChannelsDefaultResponseErrorsInner.md b/docs/UpdateOutboundChannelsDefaultResponseErrorsInner.md
new file mode 100644
index 00000000..d86a7bdd
--- /dev/null
+++ b/docs/UpdateOutboundChannelsDefaultResponseErrorsInner.md
@@ -0,0 +1,17 @@
+
+
+# UpdateOutboundChannelsDefaultResponseErrorsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **Integer** | | |
+|**title** | **String** | | |
+|**detail** | **String** | | [optional] |
+|**source** | [**UpdateOutboundChannelsDefaultResponseErrorsInnerSource**](UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md) | | [optional] |
+|**meta** | **Object** | | [optional] |
+
+
+
diff --git a/docs/UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md b/docs/UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md
new file mode 100644
index 00000000..b48ce574
--- /dev/null
+++ b/docs/UpdateOutboundChannelsDefaultResponseErrorsInnerSource.md
@@ -0,0 +1,14 @@
+
+
+# UpdateOutboundChannelsDefaultResponseErrorsInnerSource
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**pointer** | **String** | JSON pointer (RFC6901) to the offending entity. | [optional] |
+|**parameter** | **String** | Indicates which query parameter caused the error. | [optional] |
+
+
+
diff --git a/docs/UpdateOutboundChannelsRequest.md b/docs/UpdateOutboundChannelsRequest.md
new file mode 100644
index 00000000..5dfd042f
--- /dev/null
+++ b/docs/UpdateOutboundChannelsRequest.md
@@ -0,0 +1,13 @@
+
+
+# UpdateOutboundChannelsRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**channels** | **Integer** | The new number of concurrent channels for the account | |
+
+
+
diff --git a/docs/UpdateOutboundVoiceProfileRequest.md b/docs/UpdateOutboundVoiceProfileRequest.md
index aac35610..10d5bc09 100644
--- a/docs/UpdateOutboundVoiceProfileRequest.md
+++ b/docs/UpdateOutboundVoiceProfileRequest.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A user-supplied name to help with organization. |
-**trafficType** | **TrafficType** | | [optional]
-**servicePlan** | **ServicePlan** | | [optional]
-**concurrentCallLimit** | **Integer** | Must be no more than your global concurrent call limit. Null means no limit. | [optional]
-**enabled** | **Boolean** | Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections. | [optional]
-**tags** | **List<String>** | | [optional]
-**usagePaymentMethod** | **UsagePaymentMethod** | | [optional]
-**whitelistedDestinations** | **List<String>** | The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2. | [optional]
-**maxDestinationRate** | **BigDecimal** | Maximum rate (price per minute) for a Destination to be allowed when making outbound calls. | [optional]
-**dailySpendLimit** | **String** | The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls. | [optional]
-**dailySpendLimitEnabled** | **Boolean** | Specifies whether to enforce the daily_spend_limit on this outbound voice profile. | [optional]
-**callRecording** | [**OutboundCallRecording**](OutboundCallRecording.md) | | [optional]
-**billingGroupId** | **UUID** | The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned). | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | A user-supplied name to help with organization. | |
+|**trafficType** | **TrafficType** | | [optional] |
+|**servicePlan** | **ServicePlan** | | [optional] |
+|**concurrentCallLimit** | **Integer** | Must be no more than your global concurrent call limit. Null means no limit. | [optional] |
+|**enabled** | **Boolean** | Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections. | [optional] |
+|**tags** | **List<String>** | | [optional] |
+|**usagePaymentMethod** | **UsagePaymentMethod** | | [optional] |
+|**whitelistedDestinations** | **List<String>** | The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2. | [optional] |
+|**maxDestinationRate** | **BigDecimal** | Maximum rate (price per minute) for a Destination to be allowed when making outbound calls. | [optional] |
+|**dailySpendLimit** | **String** | The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls. | [optional] |
+|**dailySpendLimitEnabled** | **Boolean** | Specifies whether to enforce the daily_spend_limit on this outbound voice profile. | [optional] |
+|**callRecording** | [**OutboundCallRecording**](OutboundCallRecording.md) | | [optional] |
+|**billingGroupId** | **UUID** | The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned). | [optional] |
diff --git a/docs/UpdatePhoneNumberMessagingSettingsRequest.md b/docs/UpdatePhoneNumberMessagingSettingsRequest.md
index 147fef2a..a80b3288 100644
--- a/docs/UpdatePhoneNumberMessagingSettingsRequest.md
+++ b/docs/UpdatePhoneNumberMessagingSettingsRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional]
-**messagingProduct** | **String** | The requested messaging product the number should be on | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. | [optional] |
+|**messagingProduct** | **String** | The requested messaging product the number should be on | [optional] |
diff --git a/docs/UpdatePhoneNumberRequest.md b/docs/UpdatePhoneNumberRequest.md
index 030bfe74..410e8fca 100644
--- a/docs/UpdatePhoneNumberRequest.md
+++ b/docs/UpdatePhoneNumberRequest.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Identifies the type of resource. | [optional] [readonly]
-**tags** | **List<String>** | A list of user-assigned tags to help organize phone numbers. | [optional]
-**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional]
-**customerReference** | **String** | A customer reference string for customer look ups. | [optional]
-**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional]
-**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional]
-**numberLevelRouting** | [**NumberLevelRoutingEnum**](#NumberLevelRoutingEnum) | Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Identifies the type of resource. | [optional] [readonly] |
+|**tags** | **List<String>** | A list of user-assigned tags to help organize phone numbers. | [optional] |
+|**externalPin** | **String** | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional] |
+|**customerReference** | **String** | A customer reference string for customer look ups. | [optional] |
+|**connectionId** | **String** | Identifies the connection associated with the phone number. | [optional] |
+|**billingGroupId** | **String** | Identifies the billing group associated with the phone number. | [optional] |
+|**numberLevelRouting** | [**NumberLevelRoutingEnum**](#NumberLevelRoutingEnum) | Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level. | [optional] |
## Enum: NumberLevelRoutingEnum
-Name | Value
----- | -----
-ENABLED | "enabled"
-DISABLED | "disabled"
+| Name | Value |
+|---- | -----|
+| ENABLED | "enabled" |
+| DISABLED | "disabled" |
diff --git a/docs/UpdatePhoneNumberVoiceSettingsRequest.md b/docs/UpdatePhoneNumberVoiceSettingsRequest.md
index 8080b7e9..11021f1f 100644
--- a/docs/UpdatePhoneNumberVoiceSettingsRequest.md
+++ b/docs/UpdatePhoneNumberVoiceSettingsRequest.md
@@ -5,24 +5,24 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**techPrefixEnabled** | **Boolean** | Controls whether a tech prefix is enabled for this phone number. | [optional]
-**translatedNumber** | **String** | This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed. | [optional]
-**callForwarding** | [**CallForwarding**](CallForwarding.md) | | [optional]
-**cnamListing** | [**CnamListing**](CnamListing.md) | | [optional]
-**usagePaymentMethod** | [**UsagePaymentMethodEnum**](#UsagePaymentMethodEnum) | Controls whether a number is billed per minute or uses your concurrent channels. | [optional]
-**mediaFeatures** | [**MediaFeatures**](MediaFeatures.md) | | [optional]
-**callRecording** | [**CallRecording**](CallRecording.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**techPrefixEnabled** | **Boolean** | Controls whether a tech prefix is enabled for this phone number. | [optional] |
+|**translatedNumber** | **String** | This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed. | [optional] |
+|**callForwarding** | [**CallForwarding**](CallForwarding.md) | | [optional] |
+|**cnamListing** | [**CnamListing**](CnamListing.md) | | [optional] |
+|**usagePaymentMethod** | [**UsagePaymentMethodEnum**](#UsagePaymentMethodEnum) | Controls whether a number is billed per minute or uses your concurrent channels. | [optional] |
+|**mediaFeatures** | [**MediaFeatures**](MediaFeatures.md) | | [optional] |
+|**callRecording** | [**CallRecording**](CallRecording.md) | | [optional] |
## Enum: UsagePaymentMethodEnum
-Name | Value
----- | -----
-PAY_PER_MINUTE | "pay-per-minute"
-CHANNEL | "channel"
+| Name | Value |
+|---- | -----|
+| PAY_PER_MINUTE | "pay-per-minute" |
+| CHANNEL | "channel" |
diff --git a/docs/UpdatePortingOrder.md b/docs/UpdatePortingOrder.md
index a8237774..d8b83cc8 100644
--- a/docs/UpdatePortingOrder.md
+++ b/docs/UpdatePortingOrder.md
@@ -5,17 +5,17 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**misc** | [**PortingOrderMisc**](PortingOrderMisc.md) | | [optional]
-**endUser** | [**PortingOrderEndUser**](PortingOrderEndUser.md) | | [optional]
-**documents** | [**PortingOrderDocuments**](PortingOrderDocuments.md) | | [optional]
-**activationSettings** | [**UpdatePortingOrderActivationSettings**](UpdatePortingOrderActivationSettings.md) | | [optional]
-**phoneNumberConfiguration** | [**PortingOrderPhoneNumberConfiguration**](PortingOrderPhoneNumberConfiguration.md) | | [optional]
-**requirements** | [**List<UpdatePortingOrderRequirement>**](UpdatePortingOrderRequirement.md) | List of requirements for porting numbers. | [optional]
-**userFeedback** | [**PortingOrderUserFeedback**](PortingOrderUserFeedback.md) | | [optional]
-**webhookUrl** | **URI** | | [optional]
-**customerReference** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**misc** | [**PortingOrderMisc**](PortingOrderMisc.md) | | [optional] |
+|**endUser** | [**PortingOrderEndUser**](PortingOrderEndUser.md) | | [optional] |
+|**documents** | [**PortingOrderDocuments**](PortingOrderDocuments.md) | | [optional] |
+|**activationSettings** | [**UpdatePortingOrderActivationSettings**](UpdatePortingOrderActivationSettings.md) | | [optional] |
+|**phoneNumberConfiguration** | [**PortingOrderPhoneNumberConfiguration**](PortingOrderPhoneNumberConfiguration.md) | | [optional] |
+|**requirements** | [**List<UpdatePortingOrderRequirement>**](UpdatePortingOrderRequirement.md) | List of requirements for porting numbers. | [optional] |
+|**userFeedback** | [**PortingOrderUserFeedback**](PortingOrderUserFeedback.md) | | [optional] |
+|**webhookUrl** | **URI** | | [optional] |
+|**customerReference** | **String** | | [optional] |
diff --git a/docs/UpdatePortingOrder200Response.md b/docs/UpdatePortingOrder200Response.md
new file mode 100644
index 00000000..39833443
--- /dev/null
+++ b/docs/UpdatePortingOrder200Response.md
@@ -0,0 +1,14 @@
+
+
+# UpdatePortingOrder200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PortingOrder**](PortingOrder.md) | | [optional] |
+|**meta** | [**UpdatePortingOrder200ResponseMeta**](UpdatePortingOrder200ResponseMeta.md) | | [optional] |
+
+
+
diff --git a/docs/UpdatePortingOrder200ResponseMeta.md b/docs/UpdatePortingOrder200ResponseMeta.md
new file mode 100644
index 00000000..b7c576d6
--- /dev/null
+++ b/docs/UpdatePortingOrder200ResponseMeta.md
@@ -0,0 +1,13 @@
+
+
+# UpdatePortingOrder200ResponseMeta
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbersUrl** | **String** | Link to list all phone numbers | [optional] |
+
+
+
diff --git a/docs/UpdatePortingOrderActivationSettings.md b/docs/UpdatePortingOrderActivationSettings.md
index 752669d5..6222e68f 100644
--- a/docs/UpdatePortingOrderActivationSettings.md
+++ b/docs/UpdatePortingOrderActivationSettings.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**focDatetimeRequested** | **OffsetDateTime** | ISO 8601 formatted Date/Time requested for the FOC date | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**focDatetimeRequested** | **OffsetDateTime** | ISO 8601 formatted Date/Time requested for the FOC date | [optional] |
diff --git a/docs/UpdatePortingOrderRequirement.md b/docs/UpdatePortingOrderRequirement.md
index 7fa09767..242b2973 100644
--- a/docs/UpdatePortingOrderRequirement.md
+++ b/docs/UpdatePortingOrderRequirement.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fieldValue** | **String** | identifies the document that satisfies this requirement |
-**requirementTypeId** | **String** | Identifies the requirement type that meets this requirement |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldValue** | **String** | identifies the document that satisfies this requirement | |
+|**requirementTypeId** | **String** | Identifies the requirement type that meets this requirement | |
diff --git a/docs/UpdatePortoutRequestRequest.md b/docs/UpdatePortoutRequestRequest.md
new file mode 100644
index 00000000..f7ff6d93
--- /dev/null
+++ b/docs/UpdatePortoutRequestRequest.md
@@ -0,0 +1,13 @@
+
+
+# UpdatePortoutRequestRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**reason** | **String** | Provide a reason if rejecting the port out request | [optional] |
+
+
+
diff --git a/docs/UpdateRegulatoryRequirement.md b/docs/UpdateRegulatoryRequirement.md
index 5ea0e512..a83caf84 100644
--- a/docs/UpdateRegulatoryRequirement.md
+++ b/docs/UpdateRegulatoryRequirement.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**requirementId** | **UUID** | Unique id for a requirement. | [optional]
-**fieldValue** | **String** | The value of the requirement, this could be an id to a resource or a string value. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**requirementId** | **UUID** | Unique id for a requirement. | [optional] |
+|**fieldValue** | **String** | The value of the requirement, this could be an id to a resource or a string value. | [optional] |
diff --git a/docs/UpdateShortCodeRequest.md b/docs/UpdateShortCodeRequest.md
index 35bdb519..78dfa1b4 100644
--- a/docs/UpdateShortCodeRequest.md
+++ b/docs/UpdateShortCodeRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messagingProfileId** | **String** | Unique identifier for a messaging profile. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messagingProfileId** | **String** | Unique identifier for a messaging profile. | |
diff --git a/docs/UpdateSubNumberOrderRequest.md b/docs/UpdateSubNumberOrderRequest.md
index e86f3b2b..669bcfda 100644
--- a/docs/UpdateSubNumberOrderRequest.md
+++ b/docs/UpdateSubNumberOrderRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**regulatoryRequirements** | [**List<UpdateRegulatoryRequirement>**](UpdateRegulatoryRequirement.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**regulatoryRequirements** | [**List<UpdateRegulatoryRequirement>**](UpdateRegulatoryRequirement.md) | | [optional] |
diff --git a/docs/UpdateTexmlApplicationRequest.md b/docs/UpdateTexmlApplicationRequest.md
index 0f5b740e..065c110d 100644
--- a/docs/UpdateTexmlApplicationRequest.md
+++ b/docs/UpdateTexmlApplicationRequest.md
@@ -5,39 +5,39 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**friendlyName** | **String** | A user-assigned name to help manage the application. |
-**active** | **Boolean** | Specifies whether the connection can be used. | [optional]
-**anchorsiteOverride** | **AnchorsiteOverride** | | [optional]
-**dtmfType** | **DtmfType** | | [optional]
-**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional]
-**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional]
-**voiceUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks. |
-**voiceFallbackUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url. | [optional]
-**voiceMethod** | [**VoiceMethodEnum**](#VoiceMethodEnum) | HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'. | [optional]
-**statusCallback** | **String** | URL for Telnyx to send requests to containing information about call progress events. | [optional]
-**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request method Telnyx should use when requesting the status_callback URL. | [optional]
-**inbound** | [**CreateTexmlApplicationRequestInbound**](CreateTexmlApplicationRequestInbound.md) | | [optional]
-**outbound** | [**CreateTexmlApplicationRequestOutbound**](CreateTexmlApplicationRequestOutbound.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**friendlyName** | **String** | A user-assigned name to help manage the application. | |
+|**active** | **Boolean** | Specifies whether the connection can be used. | [optional] |
+|**anchorsiteOverride** | **AnchorsiteOverride** | | [optional] |
+|**dtmfType** | **DtmfType** | | [optional] |
+|**firstCommandTimeout** | **Boolean** | Specifies whether calls to phone numbers associated with this connection should hangup after timing out. | [optional] |
+|**firstCommandTimeoutSecs** | **Integer** | Specifies how many seconds to wait before timing out a dial command. | [optional] |
+|**voiceUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks. | |
+|**voiceFallbackUrl** | **String** | URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url. | [optional] |
+|**voiceMethod** | [**VoiceMethodEnum**](#VoiceMethodEnum) | HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'. | [optional] |
+|**statusCallback** | **String** | URL for Telnyx to send requests to containing information about call progress events. | [optional] |
+|**statusCallbackMethod** | [**StatusCallbackMethodEnum**](#StatusCallbackMethodEnum) | HTTP request method Telnyx should use when requesting the status_callback URL. | [optional] |
+|**inbound** | [**CreateTexmlApplicationRequestInbound**](CreateTexmlApplicationRequestInbound.md) | | [optional] |
+|**outbound** | [**CreateTexmlApplicationRequestOutbound**](CreateTexmlApplicationRequestOutbound.md) | | [optional] |
## Enum: VoiceMethodEnum
-Name | Value
----- | -----
-GET | "get"
-POST | "post"
+| Name | Value |
+|---- | -----|
+| GET | "get" |
+| POST | "post" |
## Enum: StatusCallbackMethodEnum
-Name | Value
----- | -----
-GET | "get"
-POST | "post"
+| Name | Value |
+|---- | -----|
+| GET | "get" |
+| POST | "post" |
diff --git a/docs/UpdateVerifiedCallsDisplayProfileRequest.md b/docs/UpdateVerifiedCallsDisplayProfileRequest.md
index 97b01955..9ce67cd8 100644
--- a/docs/UpdateVerifiedCallsDisplayProfileRequest.md
+++ b/docs/UpdateVerifiedCallsDisplayProfileRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callReasons** | **CallReasons** | | [optional]
-**phoneNumbers** | **PhoneNumbers** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**callReasons** | **CallReasons** | | [optional] |
+|**phoneNumbers** | **PhoneNumbers** | | [optional] |
diff --git a/docs/UpdateVerifyProfileCallRequest.md b/docs/UpdateVerifyProfileCallRequest.md
index 8b668e2b..941ca7b7 100644
--- a/docs/UpdateVerifyProfileCallRequest.md
+++ b/docs/UpdateVerifyProfileCallRequest.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**speechTemplate** | **String** | Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional]
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**defaultCallTimeoutSecs** | **Integer** | Must be less than default_verification_timeout_secs | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**speechTemplate** | **String** | Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional] |
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**defaultCallTimeoutSecs** | **Integer** | Must be less than default_verification_timeout_secs | [optional] |
diff --git a/docs/UpdateVerifyProfileFlashcallRequest.md b/docs/UpdateVerifyProfileFlashcallRequest.md
index d7062a98..37a4d7ee 100644
--- a/docs/UpdateVerifyProfileFlashcallRequest.md
+++ b/docs/UpdateVerifyProfileFlashcallRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
diff --git a/docs/UpdateVerifyProfilePSD2Request.md b/docs/UpdateVerifyProfilePSD2Request.md
index aaad4685..4604231a 100644
--- a/docs/UpdateVerifyProfilePSD2Request.md
+++ b/docs/UpdateVerifyProfilePSD2Request.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
diff --git a/docs/UpdateVerifyProfileRequest.md b/docs/UpdateVerifyProfileRequest.md
index 62a12384..6a2ad183 100644
--- a/docs/UpdateVerifyProfileRequest.md
+++ b/docs/UpdateVerifyProfileRequest.md
@@ -5,17 +5,17 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | | [optional]
-**webhookUrl** | **String** | | [optional]
-**webhookFailoverUrl** | **String** | | [optional]
-**sms** | **UpdateVerifyProfileSMSRequest** | | [optional]
-**psd2** | **UpdateVerifyProfilePSD2Request** | | [optional]
-**whatsapp** | **UpdateVerifyProfileWhatsappRequest** | | [optional]
-**call** | **UpdateVerifyProfileCallRequest** | | [optional]
-**flashcall** | **UpdateVerifyProfileFlashcallRequest** | | [optional]
-**language** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**webhookUrl** | **String** | | [optional] |
+|**webhookFailoverUrl** | **String** | | [optional] |
+|**sms** | **UpdateVerifyProfileSMSRequest** | | [optional] |
+|**psd2** | **UpdateVerifyProfilePSD2Request** | | [optional] |
+|**whatsapp** | **UpdateVerifyProfileWhatsappRequest** | | [optional] |
+|**call** | **UpdateVerifyProfileCallRequest** | | [optional] |
+|**flashcall** | **UpdateVerifyProfileFlashcallRequest** | | [optional] |
+|**language** | **String** | | [optional] |
diff --git a/docs/UpdateVerifyProfileSMSRequest.md b/docs/UpdateVerifyProfileSMSRequest.md
index 1efa697a..2cb4bef3 100644
--- a/docs/UpdateVerifyProfileSMSRequest.md
+++ b/docs/UpdateVerifyProfileSMSRequest.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messagingEnabled** | **Boolean** | Enables SMS text messaging for the Verify profile. | [optional]
-**rcsEnabled** | **Boolean** | Enables RCS messaging for the Verify profile. | [optional]
-**messagingTemplate** | **String** | Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional]
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**vsmsEnabled** | **Boolean** | Enables VSMS for the Verify profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messagingEnabled** | **Boolean** | Enables SMS text messaging for the Verify profile. | [optional] |
+|**rcsEnabled** | **Boolean** | Enables RCS messaging for the Verify profile. | [optional] |
+|**messagingTemplate** | **String** | Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional] |
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**vsmsEnabled** | **Boolean** | Enables VSMS for the Verify profile. | [optional] |
diff --git a/docs/UpdateVerifyProfileWhatsappRequest.md b/docs/UpdateVerifyProfileWhatsappRequest.md
index 55a8b7f2..67d026bf 100644
--- a/docs/UpdateVerifyProfileWhatsappRequest.md
+++ b/docs/UpdateVerifyProfileWhatsappRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**appName** | **String** | The name that identifies the application requesting 2fa in the verification message. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**appName** | **String** | The name that identifies the application requesting 2fa in the verification message. | [optional] |
diff --git a/docs/UpdateWhatsappPhoneNumberAboutRequest.md b/docs/UpdateWhatsappPhoneNumberAboutRequest.md
index 75a6597b..f1cf626e 100644
--- a/docs/UpdateWhatsappPhoneNumberAboutRequest.md
+++ b/docs/UpdateWhatsappPhoneNumberAboutRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**about** | **String** | The desired text to set for your WhatsApp about section. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**about** | **String** | The desired text to set for your WhatsApp about section. | |
diff --git a/docs/UpdateWhatsappPhoneNumberRequest.md b/docs/UpdateWhatsappPhoneNumberRequest.md
index 64ebb875..792e6af6 100644
--- a/docs/UpdateWhatsappPhoneNumberRequest.md
+++ b/docs/UpdateWhatsappPhoneNumberRequest.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**webhookUrl** | **String** | The desired URL to set for your WhatsApp webhook endpoint. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**webhookUrl** | **String** | The desired URL to set for your WhatsApp webhook endpoint. | |
diff --git a/docs/UplinkData.md b/docs/UplinkData.md
index 163b13d0..4f56a767 100644
--- a/docs/UplinkData.md
+++ b/docs/UplinkData.md
@@ -5,20 +5,20 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **BigDecimal** | Uplink data | [optional]
-**unit** | [**UnitEnum**](#UnitEnum) | Transmission unit | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**amount** | **BigDecimal** | Uplink data | [optional] |
+|**unit** | [**UnitEnum**](#UnitEnum) | Transmission unit | [optional] |
## Enum: UnitEnum
-Name | Value
----- | -----
-B | "B"
-KB | "KB"
-MB | "MB"
+| Name | Value |
+|---- | -----|
+| B | "B" |
+| KB | "KB" |
+| MB | "MB" |
diff --git a/docs/UploadMedia.md b/docs/UploadMedia.md
index 7fe0b9d7..4a32b0ee 100644
--- a/docs/UploadMedia.md
+++ b/docs/UploadMedia.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**List<UploadMedia>**](UploadMedia.md) | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<UploadMedia>**](UploadMedia.md) | | [optional] |
diff --git a/docs/UploadMediaRequest.md b/docs/UploadMediaRequest.md
index c6b506f4..e4125441 100644
--- a/docs/UploadMediaRequest.md
+++ b/docs/UploadMediaRequest.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mediaUrl** | **String** | The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB. |
-**ttlSecs** | **Integer** | The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years. | [optional]
-**mediaName** | **String** | The unique identifier of a file. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mediaUrl** | **String** | The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB. | |
+|**ttlSecs** | **Integer** | The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years. | [optional] |
+|**mediaName** | **String** | The unique identifier of a file. | [optional] |
diff --git a/docs/UploadPortingOrderDocuments201Response.md b/docs/UploadPortingOrderDocuments201Response.md
new file mode 100644
index 00000000..75544ed3
--- /dev/null
+++ b/docs/UploadPortingOrderDocuments201Response.md
@@ -0,0 +1,13 @@
+
+
+# UploadPortingOrderDocuments201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<PortingOrderDocument>**](PortingOrderDocument.md) | | [optional] |
+
+
+
diff --git a/docs/UploadPortingOrderDocumentsRequest.md b/docs/UploadPortingOrderDocumentsRequest.md
new file mode 100644
index 00000000..d533e8be
--- /dev/null
+++ b/docs/UploadPortingOrderDocumentsRequest.md
@@ -0,0 +1,13 @@
+
+
+# UploadPortingOrderDocumentsRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**documents** | [**List<UploadPortingOrderDocumentsRequestDocumentsInner>**](UploadPortingOrderDocumentsRequestDocumentsInner.md) | A list of documents to be associated with a porting order. | |
+
+
+
diff --git a/docs/UploadPortingOrderDocumentsRequestDocumentsInner.md b/docs/UploadPortingOrderDocumentsRequestDocumentsInner.md
new file mode 100644
index 00000000..d744d8a7
--- /dev/null
+++ b/docs/UploadPortingOrderDocumentsRequestDocumentsInner.md
@@ -0,0 +1,24 @@
+
+
+# UploadPortingOrderDocumentsRequestDocumentsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**documentType** | [**DocumentTypeEnum**](#DocumentTypeEnum) | The type of the document. | |
+|**documentId** | **String** | Uniquely identifies a document uploaded via the <code><a href=\"https://developers.telnyx.com/docs/api/v2/documents/Documents#createDocument\">/v2/documents</a></code> endpoint. | |
+
+
+
+## Enum: DocumentTypeEnum
+
+| Name | Value |
+|---- | -----|
+| LOA | "loa" |
+| INVOICE | "invoice" |
+| OTHER | "other" |
+
+
+
diff --git a/docs/Url.md b/docs/Url.md
index 17b71e42..763488ef 100644
--- a/docs/Url.md
+++ b/docs/Url.md
@@ -6,10 +6,10 @@ Standard Values: HOME, WORK
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | URL | [optional]
-**type** | **String** | Standard Values: HOME, WORK | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**url** | **String** | URL | [optional] |
+|**type** | **String** | Standard Values: HOME, WORK | [optional] |
diff --git a/docs/UrlShortenerSettings.md b/docs/UrlShortenerSettings.md
index c41f0926..270c8b8b 100644
--- a/docs/UrlShortenerSettings.md
+++ b/docs/UrlShortenerSettings.md
@@ -6,12 +6,12 @@ The URL shortener feature allows automatic replacement of URLs that were generat
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**domain** | **String** | One of the domains provided by the Telnyx URL shortener service. |
-**prefix** | **String** | Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name. | [optional]
-**replaceBlacklistOnly** | **Boolean** | Use the link replacement tool only for links that are specifically blacklisted by Telnyx. | [optional]
-**sendWebhooks** | **Boolean** | Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**domain** | **String** | One of the domains provided by the Telnyx URL shortener service. | |
+|**prefix** | **String** | Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name. | [optional] |
+|**replaceBlacklistOnly** | **Boolean** | Use the link replacement tool only for links that are specifically blacklisted by Telnyx. | [optional] |
+|**sendWebhooks** | **Boolean** | Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile. | [optional] |
diff --git a/docs/UserBalance.md b/docs/UserBalance.md
index feebfc5f..522826f4 100644
--- a/docs/UserBalance.md
+++ b/docs/UserBalance.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional]
-**balance** | **BigDecimal** | The account's current balance. | [optional]
-**creditLimit** | **BigDecimal** | The account's credit limit. | [optional]
-**availableCredit** | **BigDecimal** | Available amount to spend (balance + credit limit) | [optional]
-**currency** | **String** | The ISO 4217 currency identifier. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | [**RecordTypeEnum**](#RecordTypeEnum) | Identifies the type of the resource. | [optional] |
+|**balance** | **BigDecimal** | The account's current balance. | [optional] |
+|**creditLimit** | **BigDecimal** | The account's credit limit. | [optional] |
+|**availableCredit** | **BigDecimal** | Available amount to spend (balance + credit limit) | [optional] |
+|**currency** | **String** | The ISO 4217 currency identifier. | [optional] |
## Enum: RecordTypeEnum
-Name | Value
----- | -----
-BALANCE | "balance"
+| Name | Value |
+|---- | -----|
+| BALANCE | "balance" |
diff --git a/docs/Verification.md b/docs/Verification.md
index 10bf908d..b4a24b2e 100644
--- a/docs/Verification.md
+++ b/docs/Verification.md
@@ -5,18 +5,18 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional]
-**verificationType** | **VerificationType** | | [optional]
-**recordType** | **VerificationRecordType** | | [optional]
-**phoneNumber** | **String** | +E164 formatted phone number. | [optional]
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | [optional]
-**timeoutSecs** | **Integer** | This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the `default_verification_timeout_secs` on the Verify profile. | [optional]
-**callTimeoutSecs** | **Integer** | This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the `default_call_timeout_secs` on the Verify profile. | [optional]
-**status** | **VerificationStatus** | | [optional]
-**createdAt** | **String** | | [optional]
-**updatedAt** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] |
+|**verificationType** | **VerificationType** | | [optional] |
+|**recordType** | **VerificationRecordType** | | [optional] |
+|**phoneNumber** | **String** | +E164 formatted phone number. | [optional] |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | [optional] |
+|**timeoutSecs** | **Integer** | This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the `default_verification_timeout_secs` on the Verify profile. | [optional] |
+|**callTimeoutSecs** | **Integer** | This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the `default_call_timeout_secs` on the Verify profile. | [optional] |
+|**status** | **VerificationStatus** | | [optional] |
+|**createdAt** | **String** | | [optional] |
+|**updatedAt** | **String** | | [optional] |
diff --git a/docs/VerifiedCallsDisplayProfile.md b/docs/VerifiedCallsDisplayProfile.md
index bef46cbb..f9b061dd 100644
--- a/docs/VerifiedCallsDisplayProfile.md
+++ b/docs/VerifiedCallsDisplayProfile.md
@@ -5,31 +5,31 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional] [readonly]
-**id** | **UUID** | | [optional] [readonly]
-**name** | **String** | The Verified Calls Display Profile's name | [optional]
-**displayName** | **String** | The display name to be shown as the caller name in phones | [optional]
-**logoUrl** | **String** | The URL pointing to a public image file that will be displayed during calls in phones | [optional]
-**status** | [**StatusEnum**](#StatusEnum) | The approval status of the Verified Calls Display Profile in Google | [optional] [readonly]
-**businessIdentity** | [**VerifiedCallsDisplayProfileBusinessIdentity**](VerifiedCallsDisplayProfileBusinessIdentity.md) | | [optional]
-**phoneNumbers** | [**List<VerifiedCallsDisplayProfilePhoneNumbers>**](VerifiedCallsDisplayProfilePhoneNumbers.md) | | [optional]
-**callReasons** | [**List<VerifiedCallsDisplayProfileCallReasons>**](VerifiedCallsDisplayProfileCallReasons.md) | | [optional]
-**createdAt** | **String** | An ISO 8601 datetime string for when the display profile was added to the Telnyx platform | [optional] [readonly]
-**updatedAt** | **String** | An ISO 8601 datetime string for when the display profile was updated | [optional] [readonly]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**id** | **UUID** | | [optional] [readonly] |
+|**name** | **String** | The Verified Calls Display Profile's name | [optional] |
+|**displayName** | **String** | The display name to be shown as the caller name in phones | [optional] |
+|**logoUrl** | **String** | The URL pointing to a public image file that will be displayed during calls in phones | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The approval status of the Verified Calls Display Profile in Google | [optional] [readonly] |
+|**businessIdentity** | [**VerifiedCallsDisplayProfileBusinessIdentity**](VerifiedCallsDisplayProfileBusinessIdentity.md) | | [optional] |
+|**phoneNumbers** | [**List<VerifiedCallsDisplayProfilePhoneNumbersInner>**](VerifiedCallsDisplayProfilePhoneNumbersInner.md) | | [optional] |
+|**callReasons** | [**List<VerifiedCallsDisplayProfileCallReasonsInner>**](VerifiedCallsDisplayProfileCallReasonsInner.md) | | [optional] |
+|**createdAt** | **String** | An ISO 8601 datetime string for when the display profile was added to the Telnyx platform | [optional] [readonly] |
+|**updatedAt** | **String** | An ISO 8601 datetime string for when the display profile was updated | [optional] [readonly] |
## Enum: StatusEnum
-Name | Value
----- | -----
-UNSPECIFIED | "VERIFICATION_STATE_UNSPECIFIED"
-UNVERIFIED | "VERIFICATION_STATE_UNVERIFIED"
-PENDING | "VERIFICATION_STATE_PENDING"
-VERIFIED | "VERIFICATION_STATE_VERIFIED"
-SUSPENDED_IN_GMB | "VERIFICATION_STATE_SUSPENDED_IN_GMB"
+| Name | Value |
+|---- | -----|
+| UNSPECIFIED | "VERIFICATION_STATE_UNSPECIFIED" |
+| UNVERIFIED | "VERIFICATION_STATE_UNVERIFIED" |
+| PENDING | "VERIFICATION_STATE_PENDING" |
+| VERIFIED | "VERIFICATION_STATE_VERIFIED" |
+| SUSPENDED_IN_GMB | "VERIFICATION_STATE_SUSPENDED_IN_GMB" |
diff --git a/docs/VerifiedCallsDisplayProfileBusinessIdentity.md b/docs/VerifiedCallsDisplayProfileBusinessIdentity.md
index 714969fc..61e7200d 100644
--- a/docs/VerifiedCallsDisplayProfileBusinessIdentity.md
+++ b/docs/VerifiedCallsDisplayProfileBusinessIdentity.md
@@ -6,10 +6,10 @@ The associated Business Identity
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recordType** | **String** | | [optional]
-**name** | **String** | The name of the business identity on the telnyx platform | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] |
+|**name** | **String** | The name of the business identity on the telnyx platform | [optional] |
diff --git a/docs/VerifiedCallsDisplayProfileCallReasonsInner.md b/docs/VerifiedCallsDisplayProfileCallReasonsInner.md
new file mode 100644
index 00000000..bc52399d
--- /dev/null
+++ b/docs/VerifiedCallsDisplayProfileCallReasonsInner.md
@@ -0,0 +1,32 @@
+
+
+# VerifiedCallsDisplayProfileCallReasonsInner
+
+The Call Reason to be displayed to the call recipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**id** | **UUID** | | [optional] [readonly] |
+|**reason** | **String** | The Call Reason text to be displayed to the call recipient | [optional] |
+|**googleVerificationStatus** | [**GoogleVerificationStatusEnum**](#GoogleVerificationStatusEnum) | The approval status of this individual call reason in Google | [optional] [readonly] |
+|**googleApprovalInfo** | **String** | Additional information about the decision, if available. | [optional] [readonly] |
+|**displayProfileId** | **UUID** | | [optional] [readonly] |
+|**delete** | **Boolean** | Marks the Phone Number to be removed from the Display Profile | [optional] |
+
+
+
+## Enum: GoogleVerificationStatusEnum
+
+| Name | Value |
+|---- | -----|
+| STATE_UNSPECIFIED | "STATE_UNSPECIFIED" |
+| PENDING_APPROVAL | "PENDING_APPROVAL" |
+| APPROVED | "APPROVED" |
+| DENIED | "DENIED" |
+| PENDING_REMOVAL | "PENDING_REMOVAL" |
+
+
+
diff --git a/docs/VerifiedCallsDisplayProfilePhoneNumbersInner.md b/docs/VerifiedCallsDisplayProfilePhoneNumbersInner.md
new file mode 100644
index 00000000..2737b3c3
--- /dev/null
+++ b/docs/VerifiedCallsDisplayProfilePhoneNumbersInner.md
@@ -0,0 +1,32 @@
+
+
+# VerifiedCallsDisplayProfilePhoneNumbersInner
+
+A Phone Number that can make phone calls displaying the configured brand information
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | | [optional] [readonly] |
+|**id** | **UUID** | | [optional] [readonly] |
+|**phoneNumber** | **String** | The phone number in e164 format | [optional] |
+|**googleVerificationStatus** | [**GoogleVerificationStatusEnum**](#GoogleVerificationStatusEnum) | The approval status of this individual phone number in Google | [optional] [readonly] |
+|**googleApprovalInfo** | **String** | Additional information about the decision, if available. | [optional] [readonly] |
+|**displayProfileId** | **UUID** | | [optional] [readonly] |
+|**delete** | **Boolean** | Marks the Phone Number to be removed from the Display Profile | [optional] |
+
+
+
+## Enum: GoogleVerificationStatusEnum
+
+| Name | Value |
+|---- | -----|
+| STATE_UNSPECIFIED | "STATE_UNSPECIFIED" |
+| PENDING_APPROVAL | "PENDING_APPROVAL" |
+| APPROVED | "APPROVED" |
+| DENIED | "DENIED" |
+| PENDING_REMOVAL | "PENDING_REMOVAL" |
+
+
+
diff --git a/docs/VerifyDetailRecord.md b/docs/VerifyDetailRecord.md
index 05c9ad45..44bc7473 100644
--- a/docs/VerifyDetailRecord.md
+++ b/docs/VerifyDetailRecord.md
@@ -5,34 +5,34 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | Unique ID of the verification | [optional]
-**verifyProfileId** | **UUID** | | [optional]
-**deliveryStatus** | **String** | | [optional]
-**verificationStatus** | **String** | | [optional]
-**destinationPhoneNumber** | **String** | E.164 formatted phone number | [optional]
-**verifyChannelType** | [**VerifyChannelTypeEnum**](#VerifyChannelTypeEnum) | Depending on the type of verification, the `verify_channel_id` points to one of the following channel ids; --- verify_channel_type | verify_channel_id ------------------- | ----------------- sms, psd2 | messaging_id call, flashcall | call_control_id whatsapp | messaging_whatsapp_id --- | [optional]
-**verifyChannelId** | **UUID** | | [optional]
-**createdAt** | **String** | | [optional]
-**updatedAt** | **String** | | [optional]
-**rate** | **String** | Currency amount per billing unit used to calculate the Telnyx billing costs | [optional]
-**rateMeasuredIn** | **String** | Billing unit used to calculate the Telnyx billing costs | [optional]
-**verifyUsageFee** | **String** | Currency amount for Verify Usage Fee | [optional]
-**currency** | **String** | Telnyx account currency used to describe monetary values, including billing costs | [optional]
-**recordType** | **String** | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the verification | [optional] |
+|**verifyProfileId** | **UUID** | | [optional] |
+|**deliveryStatus** | **String** | | [optional] |
+|**verificationStatus** | **String** | | [optional] |
+|**destinationPhoneNumber** | **String** | E.164 formatted phone number | [optional] |
+|**verifyChannelType** | [**VerifyChannelTypeEnum**](#VerifyChannelTypeEnum) | Depending on the type of verification, the `verify_channel_id` points to one of the following channel ids; --- verify_channel_type | verify_channel_id ------------------- | ----------------- sms, psd2 | messaging_id call, flashcall | call_control_id whatsapp | messaging_whatsapp_id --- | [optional] |
+|**verifyChannelId** | **UUID** | | [optional] |
+|**createdAt** | **String** | | [optional] |
+|**updatedAt** | **String** | | [optional] |
+|**rate** | **String** | Currency amount per billing unit used to calculate the Telnyx billing costs | [optional] |
+|**rateMeasuredIn** | **String** | Billing unit used to calculate the Telnyx billing costs | [optional] |
+|**verifyUsageFee** | **String** | Currency amount for Verify Usage Fee | [optional] |
+|**currency** | **String** | Telnyx account currency used to describe monetary values, including billing costs | [optional] |
+|**recordType** | **String** | | |
## Enum: VerifyChannelTypeEnum
-Name | Value
----- | -----
-SMS | "sms"
-PSD2 | "psd2"
-CALL | "call"
-FLASHCALL | "flashcall"
-WHATSAPP | "whatsapp"
+| Name | Value |
+|---- | -----|
+| SMS | "sms" |
+| PSD2 | "psd2" |
+| CALL | "call" |
+| FLASHCALL | "flashcall" |
+| WHATSAPP | "whatsapp" |
diff --git a/docs/VerifyPhoneNumberCoverage201Response.md b/docs/VerifyPhoneNumberCoverage201Response.md
new file mode 100644
index 00000000..95191fbf
--- /dev/null
+++ b/docs/VerifyPhoneNumberCoverage201Response.md
@@ -0,0 +1,13 @@
+
+
+# VerifyPhoneNumberCoverage201Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CustomerServiceRequestPhoneNumberCoverage>**](CustomerServiceRequestPhoneNumberCoverage.md) | | [optional] |
+
+
+
diff --git a/docs/VerifyPhoneNumberCoverageRequest.md b/docs/VerifyPhoneNumberCoverageRequest.md
new file mode 100644
index 00000000..68ea4154
--- /dev/null
+++ b/docs/VerifyPhoneNumberCoverageRequest.md
@@ -0,0 +1,13 @@
+
+
+# VerifyPhoneNumberCoverageRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumbers** | **List<String>** | The phone numbers list to be verified. | |
+
+
+
diff --git a/docs/VerifyProfileCallResponse.md b/docs/VerifyProfileCallResponse.md
index 59add5fc..550cca08 100644
--- a/docs/VerifyProfileCallResponse.md
+++ b/docs/VerifyProfileCallResponse.md
@@ -5,11 +5,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**speechTemplate** | **String** | Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional]
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**defaultCallTimeoutSecs** | **Integer** | Must be less than default_verification_timeout_secs | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**speechTemplate** | **String** | Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional] |
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**defaultCallTimeoutSecs** | **Integer** | Must be less than default_verification_timeout_secs | [optional] |
diff --git a/docs/VerifyProfileFlashcallResponse.md b/docs/VerifyProfileFlashcallResponse.md
index 11acbba8..e4faa3f7 100644
--- a/docs/VerifyProfileFlashcallResponse.md
+++ b/docs/VerifyProfileFlashcallResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
diff --git a/docs/VerifyProfilePSD2Response.md b/docs/VerifyProfilePSD2Response.md
index d69989d9..54c3c100 100644
--- a/docs/VerifyProfilePSD2Response.md
+++ b/docs/VerifyProfilePSD2Response.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
diff --git a/docs/VerifyProfileResponse.md b/docs/VerifyProfileResponse.md
index 6abdd947..c6d441ca 100644
--- a/docs/VerifyProfileResponse.md
+++ b/docs/VerifyProfileResponse.md
@@ -5,21 +5,21 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **UUID** | | [optional]
-**name** | **String** | | [optional]
-**webhookUrl** | **String** | | [optional]
-**webhookFailoverUrl** | **String** | | [optional]
-**recordType** | **VerificationProfileRecordType** | | [optional]
-**createdAt** | **String** | | [optional]
-**updatedAt** | **String** | | [optional]
-**sms** | **VerifyProfileSMSResponse** | | [optional]
-**psd2** | **VerifyProfilePSD2Response** | | [optional]
-**whatsapp** | **VerifyProfileWhatsappResponse** | | [optional]
-**call** | **VerifyProfileCallResponse** | | [optional]
-**flashcall** | **VerifyProfileFlashcallResponse** | | [optional]
-**language** | **String** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | | [optional] |
+|**name** | **String** | | [optional] |
+|**webhookUrl** | **String** | | [optional] |
+|**webhookFailoverUrl** | **String** | | [optional] |
+|**recordType** | **VerificationProfileRecordType** | | [optional] |
+|**createdAt** | **String** | | [optional] |
+|**updatedAt** | **String** | | [optional] |
+|**sms** | **VerifyProfileSMSResponse** | | [optional] |
+|**psd2** | **VerifyProfilePSD2Response** | | [optional] |
+|**whatsapp** | **VerifyProfileWhatsappResponse** | | [optional] |
+|**call** | **VerifyProfileCallResponse** | | [optional] |
+|**flashcall** | **VerifyProfileFlashcallResponse** | | [optional] |
+|**language** | **String** | | [optional] |
diff --git a/docs/VerifyProfileResponseDataWrapper.md b/docs/VerifyProfileResponseDataWrapper.md
index 94b0b142..b34fdb8d 100644
--- a/docs/VerifyProfileResponseDataWrapper.md
+++ b/docs/VerifyProfileResponseDataWrapper.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **VerifyProfileResponse** | | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | **VerifyProfileResponse** | | [optional] |
diff --git a/docs/VerifyProfileSMSResponse.md b/docs/VerifyProfileSMSResponse.md
index 4584ebb6..841a981f 100644
--- a/docs/VerifyProfileSMSResponse.md
+++ b/docs/VerifyProfileSMSResponse.md
@@ -5,13 +5,13 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messagingEnabled** | **Boolean** | Enables SMS text messaging for the Verify profile. | [optional]
-**rcsEnabled** | **Boolean** | Enables RCS messaging for the Verify profile. | [optional]
-**messagingTemplate** | **String** | Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional]
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**vsmsEnabled** | **Boolean** | Enables VSMS for the Verify profile. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**messagingEnabled** | **Boolean** | Enables SMS text messaging for the Verify profile. | [optional] |
+|**rcsEnabled** | **Boolean** | Enables RCS messaging for the Verify profile. | [optional] |
+|**messagingTemplate** | **String** | Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code. | [optional] |
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**vsmsEnabled** | **Boolean** | Enables VSMS for the Verify profile. | [optional] |
diff --git a/docs/VerifyProfileWhatsappResponse.md b/docs/VerifyProfileWhatsappResponse.md
index ba12b6ec..47c82d02 100644
--- a/docs/VerifyProfileWhatsappResponse.md
+++ b/docs/VerifyProfileWhatsappResponse.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional]
-**appName** | **String** | The name that identifies the application requesting 2fa in the verification message. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**defaultVerificationTimeoutSecs** | **Integer** | For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity. | [optional] |
+|**appName** | **String** | The name that identifies the application requesting 2fa in the verification message. | [optional] |
diff --git a/docs/VerifyVerificationCodeRequest.md b/docs/VerifyVerificationCodeRequest.md
index 471e2d96..a255a1e2 100644
--- a/docs/VerifyVerificationCodeRequest.md
+++ b/docs/VerifyVerificationCodeRequest.md
@@ -5,10 +5,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** | This is the code the user submits for verification. |
-**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **String** | This is the code the user submits for verification. | |
+|**verifyProfileId** | **UUID** | The identifier of the associated Verify profile. | |
diff --git a/docs/VerifyVerificationCodeResponse.md b/docs/VerifyVerificationCodeResponse.md
index 085027e0..e832ea95 100644
--- a/docs/VerifyVerificationCodeResponse.md
+++ b/docs/VerifyVerificationCodeResponse.md
@@ -5,9 +5,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**VerifyVerificationCodeResponseData**](VerifyVerificationCodeResponseData.md) | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**VerifyVerificationCodeResponseData**](VerifyVerificationCodeResponseData.md) | | |
diff --git a/docs/VerifyVerificationCodeResponseData.md b/docs/VerifyVerificationCodeResponseData.md
index 59ce1c63..9650ff37 100644
--- a/docs/VerifyVerificationCodeResponseData.md
+++ b/docs/VerifyVerificationCodeResponseData.md
@@ -5,19 +5,19 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | +E164 formatted phone number. |
-**responseCode** | [**ResponseCodeEnum**](#ResponseCodeEnum) | Identifies if the verification code has been accepted or rejected. |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | +E164 formatted phone number. | |
+|**responseCode** | [**ResponseCodeEnum**](#ResponseCodeEnum) | Identifies if the verification code has been accepted or rejected. | |
## Enum: ResponseCodeEnum
-Name | Value
----- | -----
-ACCEPTED | "accepted"
-REJECTED | "rejected"
+| Name | Value |
+|---- | -----|
+| ACCEPTED | "accepted" |
+| REJECTED | "rejected" |
diff --git a/docs/Video.md b/docs/Video.md
index 8506b843..15686939 100644
--- a/docs/Video.md
+++ b/docs/Video.md
@@ -6,11 +6,11 @@ The media object containing a video
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The media object ID returned when the media is successfully uploaded to the media endpoint. | [optional]
-**link** | **String** | The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both. | [optional]
-**caption** | **String** | Describes the specified media. | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The media object ID returned when the media is successfully uploaded to the media endpoint. | [optional] |
+|**link** | **String** | The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both. | [optional] |
+|**caption** | **String** | Describes the specified media. | [optional] |
diff --git a/docs/Video1.md b/docs/Video1.md
new file mode 100644
index 00000000..8909bc36
--- /dev/null
+++ b/docs/Video1.md
@@ -0,0 +1,16 @@
+
+
+# Video1
+
+Contains the media object for this video.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The media object ID returned when the media is successfully uploaded to the media endpoint. | [optional] |
+|**link** | **String** | The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both. | [optional] |
+|**caption** | **String** | Describes the specified media. | [optional] |
+
+
+
diff --git a/docs/VideoRegion.md b/docs/VideoRegion.md
index d2d3be0f..734d0e0f 100644
--- a/docs/VideoRegion.md
+++ b/docs/VideoRegion.md
@@ -5,16 +5,16 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**xPos** | **Integer** | X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport. | [optional]
-**yPos** | **Integer** | Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport. | [optional]
-**zPos** | **Integer** | Regions with higher z_pos values are stacked on top of regions with lower z_pos values | [optional]
-**height** | **Integer** | Height of the video region | [optional]
-**width** | **Integer** | Width of the video region | [optional]
-**maxColumns** | **Integer** | Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources. | [optional]
-**maxRows** | **Integer** | Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources. | [optional]
-**videoSources** | **List<UUID>** | Array of video recording ids to be composed in the region. Can be \"*\" to specify all video recordings in the session | [optional]
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**xPos** | **Integer** | X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport. | [optional] |
+|**yPos** | **Integer** | Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport. | [optional] |
+|**zPos** | **Integer** | Regions with higher z_pos values are stacked on top of regions with lower z_pos values | [optional] |
+|**height** | **Integer** | Height of the video region | [optional] |
+|**width** | **Integer** | Width of the video region | [optional] |
+|**maxColumns** | **Integer** | Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources. | [optional] |
+|**maxRows** | **Integer** | Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources. | [optional] |
+|**videoSources** | **List<UUID>** | Array of video recording ids to be composed in the region. Can be \"*\" to specify all video recordings in the session | [optional] |
diff --git a/docs/ViewRoomParticipant200Response.md b/docs/ViewRoomParticipant200Response.md
new file mode 100644
index 00000000..585cdf42
--- /dev/null
+++ b/docs/ViewRoomParticipant200Response.md
@@ -0,0 +1,13 @@
+
+
+# ViewRoomParticipant200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**RoomParticipant**](RoomParticipant.md) | | [optional] |
+
+
+
diff --git a/docs/ViewRoomRecording200Response.md b/docs/ViewRoomRecording200Response.md
new file mode 100644
index 00000000..b6077ab8
--- /dev/null
+++ b/docs/ViewRoomRecording200Response.md
@@ -0,0 +1,13 @@
+
+
+# ViewRoomRecording200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**RoomRecording**](RoomRecording.md) | | [optional] |
+
+
+
diff --git a/docs/ViewRoomSession200Response.md b/docs/ViewRoomSession200Response.md
new file mode 100644
index 00000000..ebf74c00
--- /dev/null
+++ b/docs/ViewRoomSession200Response.md
@@ -0,0 +1,13 @@
+
+
+# ViewRoomSession200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**RoomSession**](RoomSession.md) | | [optional] |
+
+
+
diff --git a/docs/VirtaulCrossConnectList200Response.md b/docs/VirtaulCrossConnectList200Response.md
new file mode 100644
index 00000000..71b229fe
--- /dev/null
+++ b/docs/VirtaulCrossConnectList200Response.md
@@ -0,0 +1,14 @@
+
+
+# VirtaulCrossConnectList200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<VirtualCrossConnectCombined>**](VirtualCrossConnectCombined.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/VirtaulCrossConnectRegionList200Response.md b/docs/VirtaulCrossConnectRegionList200Response.md
new file mode 100644
index 00000000..df84fa79
--- /dev/null
+++ b/docs/VirtaulCrossConnectRegionList200Response.md
@@ -0,0 +1,14 @@
+
+
+# VirtaulCrossConnectRegionList200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<VirtualCrossConnectRegion>**](VirtualCrossConnectRegion.md) | | [optional] |
+|**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] |
+
+
+
diff --git a/docs/VirtualCrossConnect.md b/docs/VirtualCrossConnect.md
new file mode 100644
index 00000000..8bffb688
--- /dev/null
+++ b/docs/VirtualCrossConnect.md
@@ -0,0 +1,43 @@
+
+
+# VirtualCrossConnect
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | [optional] |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**cloudProvider** | [**CloudProviderEnum**](#CloudProviderEnum) | The Virtual Private Cloud with which you would like to establish a cross connect. | [optional] |
+|**cloudRegion** | **String** | The region where your Virtual Private Cloud hosts are located.<br /><br />The available regions can be found using the /virtual_cross_connect_regions endpoint. | [optional] |
+|**bgpAsn** | **BigDecimal** | The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx. | [optional] |
+|**bandwidthMbps** | **BigDecimal** | The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.<br /><br />The available bandwidths can be found using the /virtual_cross_connect_regions endpoint. | [optional] |
+|**primaryEnabled** | **Boolean** | Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] [readonly] |
+|**primaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider. | [optional] |
+|**primaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+|**secondaryEnabled** | **Boolean** | Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] [readonly] |
+|**secondaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.<br /><br />This attribute is only necessary for GCE. | [optional] |
+|**secondaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+
+
+
+## Enum: CloudProviderEnum
+
+| Name | Value |
+|---- | -----|
+| AWS | "aws" |
+| AZURE | "azure" |
+| GCE | "gce" |
+
+
+
diff --git a/docs/VirtualCrossConnect1.md b/docs/VirtualCrossConnect1.md
new file mode 100644
index 00000000..ed3af397
--- /dev/null
+++ b/docs/VirtualCrossConnect1.md
@@ -0,0 +1,37 @@
+
+
+# VirtualCrossConnect1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**cloudProvider** | [**CloudProviderEnum**](#CloudProviderEnum) | The Virtual Private Cloud with which you would like to establish a cross connect. | [optional] |
+|**cloudRegion** | **String** | The region where your Virtual Private Cloud hosts are located.<br /><br />The available regions can be found using the /virtual_cross_connect_regions endpoint. | [optional] |
+|**bgpAsn** | **BigDecimal** | The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx. | [optional] |
+|**bandwidthMbps** | **BigDecimal** | The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.<br /><br />The available bandwidths can be found using the /virtual_cross_connect_regions endpoint. | [optional] |
+|**primaryEnabled** | **Boolean** | Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] [readonly] |
+|**primaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider. | [optional] |
+|**primaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+|**secondaryEnabled** | **Boolean** | Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] [readonly] |
+|**secondaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.<br /><br />This attribute is only necessary for GCE. | [optional] |
+|**secondaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+
+
+
+## Enum: CloudProviderEnum
+
+| Name | Value |
+|---- | -----|
+| AWS | "aws" |
+| AZURE | "azure" |
+| GCE | "gce" |
+
+
+
diff --git a/docs/VirtualCrossConnectCombined.md b/docs/VirtualCrossConnectCombined.md
new file mode 100644
index 00000000..bd1599e3
--- /dev/null
+++ b/docs/VirtualCrossConnectCombined.md
@@ -0,0 +1,47 @@
+
+
+# VirtualCrossConnectCombined
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**cloudProvider** | [**CloudProviderEnum**](#CloudProviderEnum) | The Virtual Private Cloud with which you would like to establish a cross connect. | |
+|**cloudRegion** | **String** | The region where your Virtual Private Cloud hosts are located.<br /><br />The available regions can be found using the /virtual_cross_connect_regions endpoint. | |
+|**bgpAsn** | **BigDecimal** | The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx. | |
+|**bandwidthMbps** | **BigDecimal** | The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.<br /><br />The available bandwidths can be found using the /virtual_cross_connect_regions endpoint. | [optional] |
+|**primaryEnabled** | **Boolean** | Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] |
+|**primaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider. | |
+|**primaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. | [optional] |
+|**primaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+|**secondaryEnabled** | **Boolean** | Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] |
+|**secondaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.<br /><br />This attribute is only necessary for GCE. | [optional] |
+|**secondaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. | [optional] |
+|**secondaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+|**regionCode** | **String** | The region interface is deployed to. | |
+|**primaryRoutingAnnouncement** | **Boolean** | Whether the primary BGP route is being announced. | [optional] |
+|**secondaryRoutingAnnouncement** | **Boolean** | Whether the secondary BGP route is being announced. | [optional] |
+|**region** | [**RegionOutRegion**](RegionOutRegion.md) | | [optional] |
+
+
+
+## Enum: CloudProviderEnum
+
+| Name | Value |
+|---- | -----|
+| AWS | "aws" |
+| AZURE | "azure" |
+| GCE | "gce" |
+
+
+
diff --git a/docs/VirtualCrossConnectCreate.md b/docs/VirtualCrossConnectCreate.md
new file mode 100644
index 00000000..689663d6
--- /dev/null
+++ b/docs/VirtualCrossConnectCreate.md
@@ -0,0 +1,44 @@
+
+
+# VirtualCrossConnectCreate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**networkId** | **UUID** | The id of the network associated with the interface. | |
+|**name** | **String** | A user specified name for the interface. | [optional] |
+|**status** | **InterfaceStatus** | | [optional] |
+|**cloudProvider** | [**CloudProviderEnum**](#CloudProviderEnum) | The Virtual Private Cloud with which you would like to establish a cross connect. | |
+|**cloudRegion** | **String** | The region where your Virtual Private Cloud hosts are located.<br /><br />The available regions can be found using the /virtual_cross_connect_regions endpoint. | |
+|**bgpAsn** | **BigDecimal** | The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx. | |
+|**bandwidthMbps** | **BigDecimal** | The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.<br /><br />The available bandwidths can be found using the /virtual_cross_connect_regions endpoint. | [optional] |
+|**primaryEnabled** | **Boolean** | Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] [readonly] |
+|**primaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider. | |
+|**primaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**primaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+|**secondaryEnabled** | **Boolean** | Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] [readonly] |
+|**secondaryCloudAccountId** | **String** | The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.<br /><br />This attribute is only necessary for GCE. | [optional] |
+|**secondaryTelnyxIp** | **String** | The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. | [optional] |
+|**secondaryBgpKey** | **String** | The authentication key for BGP peer configuration. | [optional] |
+|**regionCode** | **String** | The region the interface should be deployed to. | |
+
+
+
+## Enum: CloudProviderEnum
+
+| Name | Value |
+|---- | -----|
+| AWS | "aws" |
+| AZURE | "azure" |
+| GCE | "gce" |
+
+
+
diff --git a/docs/VirtualCrossConnectCreate200Response.md b/docs/VirtualCrossConnectCreate200Response.md
new file mode 100644
index 00000000..d1a1f5b0
--- /dev/null
+++ b/docs/VirtualCrossConnectCreate200Response.md
@@ -0,0 +1,13 @@
+
+
+# VirtualCrossConnectCreate200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**VirtualCrossConnectCombined**](VirtualCrossConnectCombined.md) | | [optional] |
+
+
+
diff --git a/docs/VirtualCrossConnectPatch.md b/docs/VirtualCrossConnectPatch.md
new file mode 100644
index 00000000..785b4ccf
--- /dev/null
+++ b/docs/VirtualCrossConnectPatch.md
@@ -0,0 +1,18 @@
+
+
+# VirtualCrossConnectPatch
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**primaryEnabled** | **Boolean** | Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] |
+|**primaryRoutingAnnouncement** | **Boolean** | Whether the primary BGP route is being announced. | [optional] |
+|**primaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. | [optional] |
+|**secondaryEnabled** | **Boolean** | Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] |
+|**secondaryRoutingAnnouncement** | **Boolean** | Whether the secondary BGP route is being announced. | [optional] |
+|**secondaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. | [optional] |
+
+
+
diff --git a/docs/VirtualCrossConnectPatch1.md b/docs/VirtualCrossConnectPatch1.md
new file mode 100644
index 00000000..5264deb9
--- /dev/null
+++ b/docs/VirtualCrossConnectPatch1.md
@@ -0,0 +1,18 @@
+
+
+# VirtualCrossConnectPatch1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**primaryEnabled** | **Boolean** | Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] |
+|**primaryRoutingAnnouncement** | **Boolean** | Whether the primary BGP route is being announced. | [optional] |
+|**primaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. | [optional] |
+|**secondaryEnabled** | **Boolean** | Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. | [optional] |
+|**secondaryRoutingAnnouncement** | **Boolean** | Whether the secondary BGP route is being announced. | [optional] |
+|**secondaryCloudIp** | **String** | The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. | [optional] |
+
+
+
diff --git a/docs/VirtualCrossConnectRegion.md b/docs/VirtualCrossConnectRegion.md
new file mode 100644
index 00000000..17074e7b
--- /dev/null
+++ b/docs/VirtualCrossConnectRegion.md
@@ -0,0 +1,30 @@
+
+
+# VirtualCrossConnectRegion
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Identifies the resource. | [optional] [readonly] |
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**createdAt** | **String** | ISO 8601 formatted date-time indicating when the resource was created. | [optional] [readonly] |
+|**updatedAt** | **String** | ISO 8601 formatted date-time indicating when the resource was updated. | [optional] [readonly] |
+|**regionCode** | **String** | The region the interface is deployed to. | [optional] |
+|**cloudProvider** | [**CloudProviderEnum**](#CloudProviderEnum) | The Virtual Private Cloud with which you would like to establish a cross connect. | [optional] |
+|**cloudRegion** | **String** | The region where your Virtual Private Cloud hosts are located. | [optional] |
+|**bandwidthMbps** | **List<BigDecimal>** | The available throughput in Megabits per Second (Mbps) for your Virtual Cross Connect. | [optional] |
+
+
+
+## Enum: CloudProviderEnum
+
+| Name | Value |
+|---- | -----|
+| AWS | "aws" |
+| AZURE | "azure" |
+| GCE | "gce" |
+
+
+
diff --git a/docs/VirtualCrossConnectRegion1.md b/docs/VirtualCrossConnectRegion1.md
new file mode 100644
index 00000000..60977131
--- /dev/null
+++ b/docs/VirtualCrossConnectRegion1.md
@@ -0,0 +1,27 @@
+
+
+# VirtualCrossConnectRegion1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordType** | **String** | Identifies the type of the resource. | [optional] [readonly] |
+|**regionCode** | **String** | The region the interface is deployed to. | [optional] |
+|**cloudProvider** | [**CloudProviderEnum**](#CloudProviderEnum) | The Virtual Private Cloud with which you would like to establish a cross connect. | [optional] |
+|**cloudRegion** | **String** | The region where your Virtual Private Cloud hosts are located. | [optional] |
+|**bandwidthMbps** | **List<BigDecimal>** | The available throughput in Megabits per Second (Mbps) for your Virtual Cross Connect. | [optional] |
+
+
+
+## Enum: CloudProviderEnum
+
+| Name | Value |
+|---- | -----|
+| AWS | "aws" |
+| AZURE | "azure" |
+| GCE | "gce" |
+
+
+
diff --git a/docs/VirtualCrossConnectRegionGet200Response.md b/docs/VirtualCrossConnectRegionGet200Response.md
new file mode 100644
index 00000000..4da06d47
--- /dev/null
+++ b/docs/VirtualCrossConnectRegionGet200Response.md
@@ -0,0 +1,13 @@
+
+
+# VirtualCrossConnectRegionGet200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**VirtualCrossConnectRegion**](VirtualCrossConnectRegion.md) | | [optional] |
+
+
+
diff --git a/docs/VirtualCrossConnectsApi.md b/docs/VirtualCrossConnectsApi.md
new file mode 100644
index 00000000..9ce7a2c6
--- /dev/null
+++ b/docs/VirtualCrossConnectsApi.md
@@ -0,0 +1,603 @@
+# VirtualCrossConnectsApi
+
+All URIs are relative to *https://api.telnyx.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**virtaulCrossConnectList**](VirtualCrossConnectsApi.md#virtaulCrossConnectList) | **GET** /virtual_cross_connects | List all Virtual Cross Connects
+[**virtaulCrossConnectRegionList**](VirtualCrossConnectsApi.md#virtaulCrossConnectRegionList) | **GET** /virtual_cross_connect_regions | List all Virtual Cross Connect Cloud Regions
+[**virtualCrossConnectCreate**](VirtualCrossConnectsApi.md#virtualCrossConnectCreate) | **POST** /virtual_cross_connects | Create a Virtual Cross Connect
+[**virtualCrossConnectDelete**](VirtualCrossConnectsApi.md#virtualCrossConnectDelete) | **DELETE** /virtual_cross_connects/{id} | Delete a Virtual Cross Connect
+[**virtualCrossConnectGet**](VirtualCrossConnectsApi.md#virtualCrossConnectGet) | **GET** /virtual_cross_connects/{id} | Retrieve a Virtual Cross Connect
+[**virtualCrossConnectProvision**](VirtualCrossConnectsApi.md#virtualCrossConnectProvision) | **POST** /virtual_cross_connects/{id}/actions/provision | Provision a Virtual Cross Connect
+[**virtualCrossConnectRegionGet**](VirtualCrossConnectsApi.md#virtualCrossConnectRegionGet) | **GET** /virtual_cross_connect_regions/{id} | Retrieve a Virtual Cross Connect Cloud Regions
+[**virtualCrossConnectUpdate**](VirtualCrossConnectsApi.md#virtualCrossConnectUpdate) | **PATCH** /virtual_cross_connects/{id} | Update the Virtual Cross Connect
+
+
+
+## virtaulCrossConnectList
+
+> VirtaulCrossConnectList200Response virtaulCrossConnectList(pageNumber, pageSize, filterNetworkId)
+
+List all Virtual Cross Connects
+
+List all Virtual Cross Connects.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.VirtualCrossConnectsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+ // Configure HTTP bearer authorization: bearerAuth
+ HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+ bearerAuth.setBearerToken("BEARER TOKEN");
+
+ VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
+ Integer pageNumber = 1; // Integer | The page number to load
+ Integer pageSize = 20; // Integer | The size of the page
+ String filterNetworkId = "6a09cdc3-8948-47f0-aa62-74ac943d6c58"; // String | The associated network id to filter on.
+ try {
+ VirtaulCrossConnectList200Response result = apiInstance.virtaulCrossConnectList(pageNumber, pageSize, filterNetworkId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling VirtualCrossConnectsApi#virtaulCrossConnectList");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **filterNetworkId** | **String**| The associated network id to filter on. | [optional]
+
+### Return type
+
+[**VirtaulCrossConnectList200Response**](VirtaulCrossConnectList200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response | - |
+| **0** | Unexpected error | - |
+
+
+## virtaulCrossConnectRegionList
+
+> VirtaulCrossConnectRegionList200Response virtaulCrossConnectRegionList(pageNumber, pageSize, filterRegionCode, filterCloudProvider)
+
+List all Virtual Cross Connect Cloud Regions
+
+List all Virtual Cross Connects Cloud Regions.address_book flag set to the given value.",
- "schema": {
- "type": "string",
- "default": "null"
- }
- },
"FilterAddressByAdministrativeArea": {
"name": "filter[address.administrative_area]",
"description": "Filter by state or province where the address is located.",
@@ -21223,7 +22810,6 @@
"FilterApplicationName": {
"name": "filter[application_name][contains]",
"in": "query",
- "required": false,
"description": "If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.",
"schema": {
"type": "string",
@@ -21245,6 +22831,17 @@
"example": "in-progress"
}
},
+ "FilterBulkSIMCardActionId": {
+ "name": "filter[bulk_sim_card_action_id]",
+ "description": "Filter by a bulk SIM card action ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "format": "uuid",
+ "type": "string",
+ "example": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"
+ }
+ },
"FilterByPhoneNumber": {
"name": "filter[phone_number]",
"in": "query",
@@ -21501,24 +23098,6 @@
},
"in": "query"
},
- "FilterCustomerReferenceContains": {
- "name": "filter[customer_reference][contains]",
- "in": "query",
- "required": false,
- "description": "If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive.",
- "schema": {
- "type": "string"
- }
- },
- "FilterCustomerReferenceEquals": {
- "name": "filter[customer_reference][eq]",
- "in": "query",
- "required": false,
- "description": "Filter addresses via the customer reference set. Matching is not case-sensitive.",
- "schema": {
- "type": "string"
- }
- },
"FilterEmailContains": {
"name": "filter[email][contains]",
"in": "query",
@@ -21549,15 +23128,6 @@
"example": "1293384261075731499"
}
},
- "FilterIpAddressEquals": {
- "name": "filter[ip_address][eq]",
- "in": "query",
- "required": false,
- "description": "Filter access control IPs via the ip_address sent.",
- "schema": {
- "type": "string"
- }
- },
"FilterName": {
"name": "filter[name]",
"in": "query",
@@ -21567,9 +23137,8 @@
}
},
"FilterOutboundVoiceProfileId": {
- "name": "filter[outbound.outbound_voice_profile_id]",
+ "name": "filter[outbound_voice_profile_id]",
"in": "query",
- "required": false,
"description": "Identifies the associated outbound voice profile.",
"schema": {
"type": "string",
@@ -21639,16 +23208,6 @@
"type": "string"
}
},
- "FilterStreetAddress": {
- "name": "filter[street_address][contains]",
- "in": "query",
- "required": false,
- "description": "If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.",
- "schema": {
- "type": "string",
- "default": "null"
- }
- },
"FilterUpdatedAt": {
"name": "filter[updated_at]",
"description": "Filter by ISO 8601 formatted date-time string matching resource last update date-time.",
@@ -21659,16 +23218,6 @@
},
"in": "query"
},
- "FilterUsedAsEmergency": {
- "name": "filter[used_as_emergency]",
- "in": "query",
- "required": false,
- "description": "If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false', the opposite happens: only addresses not used as the emergency address from phone-numbers will be returned.",
- "schema": {
- "type": "string",
- "default": "null"
- }
- },
"FqdnId": {
"name": "id",
"description": "Identifies the resource.",
@@ -21702,13 +23251,23 @@
},
"Id": {
"name": "id",
- "description": "Identifies the resource.",
"in": "path",
+ "description": "The id of the resource.",
"required": true,
"schema": {
- "format": "uuid",
"type": "string",
- "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
+ "format": "uuid"
+ }
+ },
+ "IncludeCancelledAccounts": {
+ "name": "include_cancelled_accounts",
+ "in": "query",
+ "required": false,
+ "description": "Specifies if cancelled accounts should be included in the results.",
+ "schema": {
+ "type": "boolean",
+ "example": "true",
+ "default": "false"
}
},
"IncludeOTAUpdates": {
@@ -22051,24 +23610,6 @@
"default": "created_at"
}
},
- "SortAddress": {
- "name": "sort",
- "in": "query",
- "required": false,
- "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.street_address: sorts the result by the\n street_address field in ascending order.\n -street_address: sorts the result by the\n street_address field in descending order.\n created_at in descending order.",
- "schema": {
- "type": "string",
- "enum": [
- "created_at",
- "first_name",
- "last_name",
- "business_name",
- "street_address"
- ],
- "example": "street_address",
- "default": "created_at"
- }
- },
"SortAuthenticationProvider": {
"name": "sort",
"in": "query",
@@ -22095,7 +23636,6 @@
"SortConnection": {
"name": "sort",
"in": "query",
- "required": false,
"description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.connection_name: sorts the result by the\n connection_name field in ascending order.\n -connection_name: sorts the result by the\n connection_name field in descending order.\n created_at in descending order.",
"schema": {
"type": "string",
@@ -22212,7 +23752,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Customer Service Request",
"required": [
"phone_number"
],
@@ -22239,7 +23778,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Porting Order Documents",
"required": [
"documents"
],
@@ -22277,13 +23815,23 @@
}
}
},
+ "DialogflowConnectionRequest": {
+ "description": "The params expected to create/update a Dialogflow Connection for given connection_id.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialogflowConnection"
+ }
+ }
+ }
+ },
"VerifyCustomerServiceRequestPhoneNumberCoverage": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Verify Customer Service Request Phone Number Coverage",
"required": [
"phone_numbers"
],
@@ -22305,29 +23853,12 @@
}
},
"responses": {
- "AccessControlIpResponse": {
- "description": "Successful response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "title": "Access Control Ip Response",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/AccessControlIp"
- }
- }
- }
- }
- }
- },
"ActionSuccessResponse": {
"description": "Success Action Response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Action Success Response",
"properties": {
"data": {
"type": "object",
@@ -22343,29 +23874,12 @@
}
}
},
- "AddressResponse": {
- "description": "Successful response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "title": "Address Response",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/Address"
- }
- }
- }
- }
- }
- },
"AuthenticationProviderResponse": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Authentication Provider Response",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthenticationProvider"
@@ -22421,13 +23935,63 @@
}
}
},
+ "BulkSIMCardActionCollectionResponse": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/BulkSIMCardActionDetailed"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ },
+ "description": "Successful response"
+ },
+ "BulkSIMCardActionDetailedResponse": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/BulkSIMCardActionDetailed"
+ }
+ }
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "BulkSIMCardActionResponse": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/BulkSIMCardAction"
+ }
+ }
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
"BulkSIMCardNetworkPreferenceResponse": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Bulk SIM Card Network Preference Response",
"properties": {
"data": {
"description": "Multi requested SIM cards network preferences.",
@@ -22453,7 +24017,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Bulk Upload Doc Service Documents Response",
"properties": {
"data": {
"type": "array",
@@ -22498,6 +24061,122 @@
}
}
},
+ "CancelFaxResponse": {
+ "description": "Successful response upon accepting cancel fax command",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "Successful response upon accepting cancel fax command",
+ "example": {
+ "data": {
+ "result": "ok"
+ }
+ },
+ "properties": {
+ "result": {
+ "type": "string",
+ "example": "ok"
+ }
+ }
+ }
+ }
+ }
+ },
+ "CancelPortingOrderResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/PortingOrder"
+ },
+ "meta": {
+ "type": "object",
+ "properties": {
+ "phone_numbers_url": {
+ "type": "string",
+ "description": "Link to list all phone numbers"
+ }
+ }
+ }
+ },
+ "example": {
+ "data": {
+ "activation_settings": {
+ "activation_status": null,
+ "fast_port_eligible": true,
+ "foc_datetime_actual": null,
+ "foc_datetime_requested": "2022-04-08T15:00:00Z"
+ },
+ "created_at": "2022-03-24T14:22:28Z",
+ "customer_reference": "Test1234",
+ "description": "FP Telnyx",
+ "documents": {
+ "loa": "3a5b98a0-5049-47c3-96e1-aa6c8d119117",
+ "invoice": "3a5b98a0-5049-47c3-96e1-aa6c8d119117"
+ },
+ "end_user": {
+ "admin": {
+ "account_number": "123abc",
+ "auth_person_name": "Porter McPortersen II",
+ "billing_phone_number": "+13035551234",
+ "business_identifier": "abc123",
+ "entity_name": "Porter McPortersen",
+ "pin_passcode": "1234",
+ "tax_identifier": "1234abcd"
+ },
+ "location": {
+ "administrative_area": "IL",
+ "country_code": "US",
+ "extended_address": "Suite 504",
+ "locality": "Chicago",
+ "postal_code": "60654",
+ "street_address": "311 W. Superior St"
+ }
+ },
+ "id": "eef10fb8-f3df-4c67-97c5-e18179723222",
+ "misc": {
+ "new_billing_phone_number": null,
+ "remaining_numbers_action": null,
+ "type": "full"
+ },
+ "old_service_provider_ocn": "Unreal Communications",
+ "parent_support_key": "pr_4bec1a",
+ "phone_number_configuration": {
+ "connection_id": "1752379429071357070",
+ "emergency_address_id": null,
+ "messaging_profile_id": null,
+ "tags": []
+ },
+ "phone_number_type": "local",
+ "porting_phone_numbers_count": 1,
+ "record_type": "porting_order",
+ "requirements": [],
+ "requirements_met": true,
+ "status": {
+ "details": [],
+ "value": "cancel-pending"
+ },
+ "support_key": "sr_10b316",
+ "updated_at": "2022-03-24T16:43:35Z",
+ "user_feedback": {
+ "user_comment": null,
+ "user_rating": null
+ },
+ "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
+ "webhook_url": "https://example.com/porting_webhooks"
+ },
+ "meta": {
+ "phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222"
+ }
+ }
+ }
+ }
+ }
+ },
"CheckContactResponse": {
"description": "Successful response with details about WhatsApp contact(s).",
"content": {
@@ -22523,7 +24202,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Comment Response",
"properties": {
"data": {
"allOf": [
@@ -22572,6 +24250,100 @@
}
}
},
+ "ConfirmPortingOrderResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/PortingOrder"
+ },
+ "meta": {
+ "type": "object",
+ "properties": {
+ "phone_numbers_url": {
+ "type": "string",
+ "description": "Link to list all phone numbers"
+ }
+ }
+ }
+ },
+ "example": {
+ "data": {
+ "activation_settings": {
+ "activation_status": null,
+ "fast_port_eligible": true,
+ "foc_datetime_actual": null,
+ "foc_datetime_requested": "2022-04-08T15:00:00Z"
+ },
+ "created_at": "2022-03-24T14:22:28Z",
+ "customer_reference": "Test1234",
+ "description": "FP Telnyx",
+ "documents": {
+ "loa": "3a5b98a0-5049-47c3-96e1-aa6c8d119117",
+ "invoice": "3a5b98a0-5049-47c3-96e1-aa6c8d119117"
+ },
+ "end_user": {
+ "admin": {
+ "account_number": "123abc",
+ "auth_person_name": "Porter McPortersen II",
+ "billing_phone_number": "+13035551234",
+ "business_identifier": "abc123",
+ "entity_name": "Porter McPortersen",
+ "pin_passcode": "1234",
+ "tax_identifier": "1234abcd"
+ },
+ "location": {
+ "administrative_area": "IL",
+ "country_code": "US",
+ "extended_address": "Suite 504",
+ "locality": "Chicago",
+ "postal_code": "60654",
+ "street_address": "311 W. Superior St"
+ }
+ },
+ "id": "eef10fb8-f3df-4c67-97c5-e18179723222",
+ "misc": {
+ "new_billing_phone_number": null,
+ "remaining_numbers_action": null,
+ "type": "full"
+ },
+ "old_service_provider_ocn": "Unreal Communications",
+ "parent_support_key": "pr_4bec1a",
+ "phone_number_configuration": {
+ "connection_id": "1752379429071357070",
+ "emergency_address_id": null,
+ "messaging_profile_id": null,
+ "tags": []
+ },
+ "phone_number_type": "local",
+ "porting_phone_numbers_count": 1,
+ "record_type": "porting_order",
+ "requirements": [],
+ "requirements_met": true,
+ "status": {
+ "details": [],
+ "value": "in-process"
+ },
+ "support_key": "sr_10b316",
+ "updated_at": "2022-03-24T16:42:43Z",
+ "user_feedback": {
+ "user_comment": null,
+ "user_rating": null
+ },
+ "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
+ "webhook_url": "https://example.com/porting_webhooks"
+ },
+ "meta": {
+ "phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222"
+ }
+ }
+ }
+ }
+ }
+ },
"ConnectionResponse": {
"description": "Successful response with details about a connection.",
"content": {
@@ -22594,7 +24366,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Billing Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/BillingGroup"
@@ -22610,7 +24381,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Ledger Billing Group Report Response",
"properties": {
"data": {
"$ref": "#/components/schemas/LedgerBillingGroupReport"
@@ -22626,7 +24396,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create PortOut Supporting Documents Response",
"properties": {
"data": {
"type": "array",
@@ -22645,7 +24414,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Private Wireless Gateway Response",
"properties": {
"data": {
"$ref": "#/components/schemas/PrivateWirelessGateway"
@@ -22661,7 +24429,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Room Client Token Response",
"properties": {
"data": {
"type": "object",
@@ -22707,7 +24474,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Room Composition Response",
"properties": {
"data": {
"$ref": "#/components/schemas/RoomComposition"
@@ -22723,7 +24489,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Room Response",
"properties": {
"data": {
"$ref": "#/components/schemas/Room"
@@ -22739,7 +24504,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Sim Card Data Usage Notification Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SimCardDataUsageNotification"
@@ -22754,7 +24518,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Sim Card Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardGroup"
@@ -22770,7 +24533,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Sim Card Order Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardOrder"
@@ -22787,7 +24549,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Create Wdr Report Response",
"properties": {
"data": {
"$ref": "#/components/schemas/WdrReport"
@@ -22818,7 +24579,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Credentials Response Body",
"$ref": "#/components/schemas/CredentialsResponse"
}
}
@@ -22849,7 +24609,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete SIM Card Network Preference Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
@@ -22865,7 +24624,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete Billing Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/BillingGroup"
@@ -22897,7 +24655,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete Private Wireless Gateway Response",
"properties": {
"data": {
"$ref": "#/components/schemas/PrivateWirelessGateway"
@@ -22913,7 +24670,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete Sim Card Data Usage Notification Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SimCardDataUsageNotification"
@@ -22928,7 +24684,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete Sim Card Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardGroup"
@@ -22945,7 +24700,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete Sim Card Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCard"
@@ -22961,7 +24715,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Delete Wdr Report Response",
"properties": {
"data": {
"$ref": "#/components/schemas/WdrReport"
@@ -22971,13 +24724,22 @@
}
}
},
+ "DialogflowConnectionResponseBody": {
+ "description": "Return details of the Dialogflow connection associated with the given CallControl connection.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialogflowConnectionResponse"
+ }
+ }
+ }
+ },
"DocReqsListRequirementTypesResponse": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Doc Reqs List Requirement Types Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DocReqsRequirementTypeList"
@@ -22996,7 +24758,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Doc Reqs Requirement Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DocReqsRequirement"
@@ -23012,7 +24773,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Doc Reqs Requirement Type Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DocReqsRequirementType"
@@ -23028,7 +24788,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Doc Service Document Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DocServiceDocument"
@@ -23043,7 +24802,6 @@
"content": {
"*": {
"schema": {
- "title": "Download Doc Service Documents Response",
"type": "string",
"format": "binary"
}
@@ -23055,7 +24813,6 @@
"content": {
"application/pdf": {
"schema": {
- "title": "Download LOA Tempalte",
"type": "string",
"format": "binary"
}
@@ -23068,7 +24825,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Dynamic Emergency Address Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DynamicEmergencyAddress"
@@ -23084,7 +24840,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Dynamic Emergency Endpoint Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DynamicEmergencyEndpoint"
@@ -23115,7 +24870,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Forbidden",
"$ref": "#/components/schemas/Error"
}
}
@@ -23126,7 +24880,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Forbidden Error Response",
"properties": {
"errors": {
"type": "array",
@@ -23176,63 +24929,17 @@
"content": {
"application/json": {
"schema": {
- "title": "Generic Error Response",
"$ref": "#/components/schemas/Errors"
}
}
}
},
- "GetAllAccessControlIpResponse": {
- "description": "Successful response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "title": "Get All Access Control Ip Response",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AccessControlIp"
- }
- },
- "meta": {
- "$ref": "#/components/schemas/PaginationMeta"
- }
- }
- }
- }
- }
- },
- "GetAllAddressResponse": {
- "description": "Successful response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "title": "Get All Address Response",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Address"
- }
- },
- "meta": {
- "$ref": "#/components/schemas/PaginationMeta"
- }
- }
- }
- }
- }
- },
"GetAllAuthenticationProviderResponse": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Get All Authentication Providers Response",
"properties": {
"data": {
"type": "array",
@@ -23276,7 +24983,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get All Private Wireless Gateways Response",
"properties": {
"data": {
"type": "array",
@@ -23297,12 +25003,11 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get All Sim Card Groups Response",
"properties": {
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SIMCardGroup"
+ "$ref": "#/components/schemas/SearchedSIMCardGroup"
}
},
"meta": {
@@ -23319,7 +25024,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get All Sim Card Order Response",
"properties": {
"data": {
"type": "array",
@@ -23401,7 +25105,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Get Gcb Channel Zone Request Response",
"$ref": "#/components/schemas/GcbChannelZone"
}
}
@@ -23413,7 +25116,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Gcb Channel Zones Request Response",
"properties": {
"data": {
"type": "array",
@@ -23435,7 +25137,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Gcb Phone Numbers Request Response",
"properties": {
"data": {
"type": "array",
@@ -23457,7 +25158,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Private Wireless Gateway Response",
"properties": {
"data": {
"$ref": "#/components/schemas/PrivateWirelessGateway"
@@ -23473,7 +25173,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Room Composition Response",
"properties": {
"data": {
"$ref": "#/components/schemas/RoomComposition"
@@ -23489,7 +25188,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Room Participant Response",
"properties": {
"data": {
"$ref": "#/components/schemas/RoomParticipant"
@@ -23505,7 +25203,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Room Recording Response",
"properties": {
"data": {
"$ref": "#/components/schemas/RoomRecording"
@@ -23521,7 +25218,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Room Response",
"properties": {
"data": {
"$ref": "#/components/schemas/Room"
@@ -23537,7 +25233,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Room Session Response",
"properties": {
"data": {
"$ref": "#/components/schemas/RoomSession"
@@ -23553,7 +25248,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Sim Card Data Usage Notification Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SimCardDataUsageNotification"
@@ -23568,7 +25262,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Sim Card Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardGroup"
@@ -23584,7 +25277,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Sim Card Order Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardOrder"
@@ -23601,7 +25293,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Sim Card Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCard"
@@ -23617,7 +25308,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Wdr Report Response",
"properties": {
"data": {
"$ref": "#/components/schemas/WdrReport"
@@ -23633,7 +25323,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Get Wdr Reports Response",
"properties": {
"data": {
"type": "array",
@@ -23652,7 +25341,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Inventory Coverage Response",
"properties": {
"data": {
"type": "array",
@@ -23706,7 +25394,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Allowed Foc Window",
"properties": {
"data": {
"type": "array",
@@ -23772,7 +25459,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Billing Groups Response",
"properties": {
"data": {
"type": "array",
@@ -23948,7 +25634,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Customer Service Request PhoneNumber Coverage",
"properties": {
"data": {
"type": "array",
@@ -23967,7 +25652,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Customer Service Requests",
"properties": {
"data": {
"type": "array",
@@ -23989,7 +25673,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Doc Service Document Links Response",
"properties": {
"data": {
"type": "array",
@@ -24011,7 +25694,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Doc Service Documents Resposne",
"properties": {
"data": {
"type": "array",
@@ -24033,7 +25715,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Draft Porting Order Without Pagination",
"properties": {
"data": {
"type": "array",
@@ -24041,85 +25722,85 @@
"$ref": "#/components/schemas/PortingOrder"
}
}
- }
- },
- "example": {
- "data": [
- {
- "activation_settings": {
- "activation_status": null,
- "fast_port_eligible": true,
- "foc_datetime_actual": null,
- "foc_datetime_requested": null
- },
- "created_at": "2022-03-17T18:01:01Z",
- "customer_reference": null,
- "description": "FP Telnyx",
- "documents": {
- "loa": null,
- "invoice": null
- },
- "end_user": {
- "admin": {
- "account_number": null,
- "auth_person_name": null,
- "billing_phone_number": null,
- "business_identifier": null,
- "entity_name": null,
- "pin_passcode": null,
- "tax_identifier": null
- },
- "location": {
- "administrative_area": null,
- "country_code": null,
- "extended_address": null,
- "locality": null,
- "postal_code": null,
- "street_address": null
- }
- },
- "id": "b0ea6d6f-de31-4079-a536-992e0c98b037",
- "misc": null,
- "old_service_provider_ocn": "Unreal Communications",
- "parent_support_key": null,
- "phone_number_configuration": {
- "connection_id": null,
- "emergency_address_id": null,
- "messaging_profile_id": null,
- "tags": []
- },
- "phone_number_type": "local",
- "phone_numbers": [
- {
+ },
+ "example": {
+ "data": [
+ {
+ "activation_settings": {
"activation_status": null,
- "phone_number": "{e.164 TN}",
- "phone_number_type": "local",
- "portability_status": "confirmed",
- "porting_order_id": "b0ea6d6f-de31-4079-a536-992e0c98b037",
- "porting_order_status": "draft",
- "record_type": "porting_phone_number",
- "requirements_status": "requirement-info-pending",
- "support_key": null
- }
- ],
- "porting_phone_numbers_count": 1,
- "record_type": "porting_order",
- "requirements": [],
- "requirements_met": false,
- "status": {
- "details": [],
- "value": "draft"
- },
- "support_key": null,
- "updated_at": "2022-03-17T18:01:01Z",
- "user_feedback": {
- "user_comment": null,
- "user_rating": null
- },
- "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
- "webhook_url": null
- }
- ]
+ "fast_port_eligible": true,
+ "foc_datetime_actual": null,
+ "foc_datetime_requested": null
+ },
+ "created_at": "2022-03-17T18:01:01Z",
+ "customer_reference": null,
+ "description": "FP Telnyx",
+ "documents": {
+ "loa": null,
+ "invoice": null
+ },
+ "end_user": {
+ "admin": {
+ "account_number": null,
+ "auth_person_name": null,
+ "billing_phone_number": null,
+ "business_identifier": null,
+ "entity_name": null,
+ "pin_passcode": null,
+ "tax_identifier": null
+ },
+ "location": {
+ "administrative_area": null,
+ "country_code": null,
+ "extended_address": null,
+ "locality": null,
+ "postal_code": null,
+ "street_address": null
+ }
+ },
+ "id": "b0ea6d6f-de31-4079-a536-992e0c98b037",
+ "misc": null,
+ "old_service_provider_ocn": "Unreal Communications",
+ "parent_support_key": null,
+ "phone_number_configuration": {
+ "connection_id": null,
+ "emergency_address_id": null,
+ "messaging_profile_id": null,
+ "tags": []
+ },
+ "phone_number_type": "local",
+ "phone_numbers": [
+ {
+ "activation_status": null,
+ "phone_number": "{e.164 TN}",
+ "phone_number_type": "local",
+ "portability_status": "confirmed",
+ "porting_order_id": "b0ea6d6f-de31-4079-a536-992e0c98b037",
+ "porting_order_status": "draft",
+ "record_type": "porting_phone_number",
+ "requirements_status": "requirement-info-pending",
+ "support_key": null
+ }
+ ],
+ "porting_phone_numbers_count": 1,
+ "record_type": "porting_order",
+ "requirements": [],
+ "requirements_met": false,
+ "status": {
+ "details": [],
+ "value": "draft"
+ },
+ "support_key": null,
+ "updated_at": "2022-03-17T18:01:01Z",
+ "user_feedback": {
+ "user_comment": null,
+ "user_rating": null
+ },
+ "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
+ "webhook_url": null
+ }
+ ]
+ }
}
}
}
@@ -24243,7 +25924,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Managed Accounts Response",
"properties": {
"data": {
"type": "array",
@@ -24683,7 +26363,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Porting Order",
"properties": {
"data": {
"type": "array",
@@ -24705,7 +26384,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Porting Order Documents",
"properties": {
"data": {
"type": "array",
@@ -24721,13 +26399,33 @@
}
}
},
+ "ListPortingOrderRequirements": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PortingOrderRequirementDetail"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
"ListPortingOrdersActivationJobs": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "List Porting Orders Activation Jobs",
"properties": {
"data": {
"type": "array",
@@ -24749,7 +26447,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Porting Orders Comments",
"properties": {
"data": {
"type": "array",
@@ -24771,7 +26468,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Porting Orders Exception Types",
"properties": {
"data": {
"type": "array",
@@ -24790,7 +26486,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Porting Phone Numbers",
"properties": {
"data": {
"type": "array",
@@ -24818,7 +26513,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Portout Comments",
"properties": {
"data": {
"type": "array",
@@ -24840,7 +26534,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Portout Response",
"properties": {
"data": {
"type": "array",
@@ -24856,6 +26549,28 @@
}
}
},
+ "ListPushCredentialsResponse": {
+ "description": "Mobile mobile push credentials",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "List Push Credentials Response",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PushCredential"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
"ListQueueCallsResponse": {
"description": "Successful response with a list of calls in a queue.",
"content": {
@@ -24906,7 +26621,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Requirements Response",
"properties": {
"data": {
"$ref": "#/components/schemas/DocReqsRequirementList"
@@ -24925,7 +26639,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Room Compositions Response",
"properties": {
"data": {
"type": "array",
@@ -24947,7 +26660,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Room Participants Response",
"properties": {
"data": {
"type": "array",
@@ -24969,7 +26681,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Room Recordings Response",
"properties": {
"data": {
"type": "array",
@@ -24991,7 +26702,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Room Sessions Response",
"properties": {
"data": {
"type": "array",
@@ -25013,7 +26723,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Rooms Response",
"properties": {
"data": {
"type": "array",
@@ -25133,7 +26842,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Webhook Deliveries Response",
"properties": {
"data": {
"type": "array",
@@ -25199,7 +26907,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Managed Account Response",
"properties": {
"data": {
"$ref": "#/components/schemas/ManagedAccount"
@@ -25214,7 +26921,6 @@
"content": {
"*/*": {
"schema": {
- "title": "Media Download Response",
"type": "string",
"format": "binary"
}
@@ -25301,8 +27007,65 @@
}
}
},
+ "NetworkInterfaceListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NetworkInterface"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NetworkListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Network"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NetworkResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/Network"
+ }
+ }
+ }
+ }
+ }
+ },
"NotFoundResponse": {
- "description": "Conference does not exist"
+ "description": "Fax does not exist"
},
"NumberBlockOrderResponse": {
"description": "Successful response with details about a number block order.",
@@ -25406,7 +27169,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "OTA Update Response",
"properties": {
"data": {
"$ref": "#/components/schemas/CompleteOTAUpdate"
@@ -25438,7 +27200,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "PUT SIM Card Network Preference Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
@@ -25453,7 +27214,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Patch Gcb Channel Zone Request Response",
"$ref": "#/components/schemas/GcbChannelZone"
}
}
@@ -25465,7 +27225,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Patch Room Response",
"properties": {
"data": {
"$ref": "#/components/schemas/Room"
@@ -25529,7 +27288,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "PortOut List Supporting Documents Response",
"properties": {
"data": {
"type": "array",
@@ -25548,7 +27306,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Portability Check Response",
"properties": {
"data": {
"type": "array",
@@ -25567,7 +27324,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Porting Order Documents Created",
"properties": {
"data": {
"type": "array",
@@ -25586,7 +27342,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Portout Comment Resposne",
"properties": {
"data": {
"$ref": "#/components/schemas/PortoutComment"
@@ -25602,7 +27357,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Portout Response",
"properties": {
"data": {
"$ref": "#/components/schemas/PortoutDetails"
@@ -25617,12 +27371,63 @@
"content": {
"application/json": {
"schema": {
- "title": "Post Gcb Phone Number Request Response",
"$ref": "#/components/schemas/GcbPhoneNumber"
}
}
}
},
+ "PublicInternetGatewayListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PublicInternetGatewayRead"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "PublicInternetGatewayResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/PublicInternetGatewayRead"
+ }
+ }
+ }
+ }
+ }
+ },
+ "PushCredentialResponse": {
+ "description": "Success response with details about a push credential",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "Queue Call Response",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/QueueCall"
+ }
+ }
+ }
+ }
+ }
+ },
"QueueCallResponse": {
"description": "Successful response with details about a call in a queue.",
"content": {
@@ -25661,7 +27466,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Read Comment Response",
"properties": {
"data": {
"allOf": [
@@ -25722,7 +27526,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Refresh Room Client Token Response",
"properties": {
"data": {
"type": "object",
@@ -25749,6 +27552,24 @@
}
}
},
+ "RegionListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Region"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"RegisterCallResponse": {
"description": "Successful response upon making a register call command.",
"content": {
@@ -25781,7 +27602,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Register SimCards Response",
"properties": {
"data": {
"description": "Successfully registered SIM cards.",
@@ -25834,7 +27654,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Retrieve Billing Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/BillingGroup"
@@ -25866,7 +27685,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Retrieve Ledger Billing Group Report Response",
"properties": {
"data": {
"$ref": "#/components/schemas/LedgerBillingGroupReport"
@@ -25898,7 +27716,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Retrieve Portout Response",
"properties": {
"data": {
"$ref": "#/components/schemas/PortoutDetails"
@@ -25913,7 +27730,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SIM Card Action Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardAction"
@@ -25924,12 +27740,26 @@
},
"description": "Successful Response"
},
+ "SIMCardDeviceDetailsResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/SIMCardDeviceDetails"
+ }
+ }
+ }
+ }
+ }
+ },
"SIMCardGroupActionResponse": {
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "SIM Card Group Action Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardGroupAction"
@@ -25946,7 +27776,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SIM Card Network Preference Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardNetworkPreference"
@@ -25962,7 +27791,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SIM Card Network Preference With OTA Updates Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
@@ -25978,7 +27806,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SIMCard Orders Preview Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardOrderPreview"
@@ -25994,7 +27821,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SIMCard Public IP Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardPublicIP"
@@ -26010,7 +27836,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Search Mobile Operator Networks Response",
"properties": {
"data": {
"type": "array",
@@ -26032,7 +27857,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Search OTA Update Response",
"properties": {
"data": {
"type": "array",
@@ -26054,7 +27878,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Search SimCards Response",
"properties": {
"data": {
"type": "array",
@@ -26108,7 +27931,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Show Customer Service Request",
"properties": {
"data": {
"$ref": "#/components/schemas/CustomerServiceRequest"
@@ -26124,7 +27946,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Show Porting Order",
"properties": {
"data": {
"$ref": "#/components/schemas/PortingOrder"
@@ -26135,7 +27956,7 @@
"phone_numbers_url": {
"type": "string",
"description": "Link to list all phone numbers",
- "example": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
+ "example": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222"
}
}
}
@@ -26150,7 +27971,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Show Porting Orders Activation Job",
"properties": {
"data": {
"$ref": "#/components/schemas/PortingOrdersActivationJob"
@@ -26166,7 +27986,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Show Porting Order Comment",
"properties": {
"data": {
"$ref": "#/components/schemas/PortingOrdersComment"
@@ -26182,7 +28001,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Show Porting Phone Number",
"properties": {
"data": {
"$ref": "#/components/schemas/PortingPhoneNumber"
@@ -26208,7 +28026,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SimCard Action Collection Response",
"properties": {
"data": {
"type": "array",
@@ -26230,7 +28047,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SimCard Data Usage Notification Collection",
"properties": {
"data": {
"type": "array",
@@ -26252,7 +28068,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "SimCard Group Action Collection Response",
"properties": {
"data": {
"type": "array",
@@ -26275,7 +28090,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Simple SimCard Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SimpleSIMCard"
@@ -26307,7 +28121,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Sub Request By Porting Order",
"properties": {
"data": {
"$ref": "#/components/schemas/GetSubRequestByPortingOrder"
@@ -26354,7 +28167,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Unauthorized Error Response",
"properties": {
"errors": {
"type": "array",
@@ -26368,14 +28180,13 @@
}
},
"UnauthorizedResponse": {
- "description": "Unauthorized"
+ "description": "Unauthorized response. Happens when the current user is not a manager account."
},
"UnexpectedErrorResponse": {
"description": "An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
- "title": "Unexpected Error Response",
"properties": {
"errors": {
"type": "array",
@@ -26403,7 +28214,6 @@
"content": {
"application/json": {
"schema": {
- "title": "Unprocessable Enttiy Error Response",
"properties": {
"errors": {
"type": "array",
@@ -26425,7 +28235,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Unprocessable Managed Account Entity",
"properties": {
"errors": {
"type": "array",
@@ -26444,7 +28253,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Update Billing Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/BillingGroup"
@@ -26454,13 +28262,106 @@
}
}
},
+ "UpdatePortingOrderResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/PortingOrder"
+ },
+ "meta": {
+ "type": "object",
+ "properties": {
+ "phone_numbers_url": {
+ "type": "string",
+ "description": "Link to list all phone numbers"
+ }
+ }
+ }
+ },
+ "example": {
+ "data": {
+ "activation_settings": {
+ "activation_status": null,
+ "fast_port_eligible": true,
+ "foc_datetime_actual": null,
+ "foc_datetime_requested": "2022-04-08T15:00:00Z"
+ },
+ "created_at": "2022-03-24T14:22:28Z",
+ "customer_reference": "Test1234",
+ "description": "FP Telnyx",
+ "documents": {
+ "loa": null,
+ "invoice": null
+ },
+ "end_user": {
+ "admin": {
+ "account_number": "123abc",
+ "auth_person_name": "Porter McPortersen II",
+ "billing_phone_number": "+13035551234",
+ "business_identifier": "abc123",
+ "entity_name": "Porter McPortersen",
+ "pin_passcode": "1234",
+ "tax_identifier": "1234abcd"
+ },
+ "location": {
+ "administrative_area": "IL",
+ "country_code": "US",
+ "extended_address": "Suite 504",
+ "locality": "Chicago",
+ "postal_code": "60654",
+ "street_address": "311 W. Superior St"
+ }
+ },
+ "id": "eef10fb8-f3df-4c67-97c5-e18179723222",
+ "misc": {
+ "new_billing_phone_number": null,
+ "remaining_numbers_action": null,
+ "type": "full"
+ },
+ "old_service_provider_ocn": "Unreal Communications",
+ "parent_support_key": null,
+ "phone_number_configuration": {
+ "connection_id": "1752379429071357070",
+ "emergency_address_id": null,
+ "messaging_profile_id": null,
+ "tags": []
+ },
+ "phone_number_type": "local",
+ "porting_phone_numbers_count": 1,
+ "record_type": "porting_order",
+ "requirements": [],
+ "requirements_met": false,
+ "status": {
+ "details": [],
+ "value": "draft"
+ },
+ "support_key": null,
+ "updated_at": "2022-03-24T14:26:53Z",
+ "user_feedback": {
+ "user_comment": null,
+ "user_rating": null
+ },
+ "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
+ "webhook_url": "https://example.com/porting_webhooks"
+ },
+ "meta": {
+ "phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222"
+ }
+ }
+ }
+ }
+ }
+ },
"UpdatePortoutResponse": {
"description": "Expected portout response to a valid request",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Update Portout Response",
"properties": {
"data": {
"$ref": "#/components/schemas/PortoutDetails"
@@ -26476,7 +28377,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Update Sim Card Data Usage Notification Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SimCardDataUsageNotification"
@@ -26491,7 +28391,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Update SimCard Group Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCardGroup"
@@ -26508,7 +28407,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "Update SimCard Response",
"properties": {
"data": {
"$ref": "#/components/schemas/SIMCard"
@@ -26518,13 +28416,29 @@
}
}
},
+ "UpdateTeXMLCallResponse": {
+ "description": "Successful response upon updating a TeXml call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "TeXml REST Command Response",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/UpdateCommandResult"
+ }
+ }
+ }
+ }
+ }
+ },
"UploadMediaResponse": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Upload Media",
+ "title": "Upload Media.",
"properties": {
"data": {
"type": "array",
@@ -26555,7 +28469,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "User Balance Response",
"properties": {
"data": {
"$ref": "#/components/schemas/UserBalance"
@@ -26565,16 +28478,72 @@
}
}
},
- "ValidateAddressResponse": {
- "description": "Action response",
+ "VirtualCrossConnectListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/VirtualCrossConnectCombined"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "VirtualCrossConnectRegionListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/VirtualCrossConnectRegion"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "VirtualCrossConnectRegionResponse": {
+ "description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Validate Address Response",
"properties": {
"data": {
- "$ref": "#/components/schemas/ValidateAddressResult"
+ "$ref": "#/components/schemas/VirtualCrossConnectRegion"
+ }
+ }
+ }
+ }
+ }
+ },
+ "VirtualCrossConnectResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/VirtualCrossConnectCombined"
}
}
}
@@ -26587,7 +28556,7 @@
"application/json": {
"schema": {
"type": "object",
- "title": "WhatsApp Message Response",
+ "title": "Successful response with details about the WhatsApp message sent.",
"properties": {
"data": {
"$ref": "#/components/schemas/Message"
@@ -26597,12 +28566,119 @@
}
}
},
+ "WireguardInterfaceListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WireguardInterfaceRead"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "WireguardInterfaceResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/WireguardInterfaceRead"
+ }
+ }
+ }
+ }
+ }
+ },
+ "WireguardPeerAllowedIPListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WireguardPeerAllowedIP"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "WireguardPeerAllowedIPResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/WireguardPeerAllowedIP"
+ }
+ }
+ }
+ }
+ }
+ },
+ "WireguardPeerListResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WireguardPeer"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ }
+ }
+ }
+ },
+ "WireguardPeerResponse": {
+ "description": "Successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/WireguardPeer"
+ }
+ }
+ }
+ }
+ }
+ },
"WirelessConnectivityLogCollectionResponse": {
"content": {
"application/json": {
"schema": {
"type": "object",
- "title": "Wireless Connectivity Log Collection Response",
"properties": {
"data": {
"type": "array",
@@ -26657,7 +28733,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Comments Response",
"properties": {
"data": {
"type": "array",
@@ -26679,7 +28754,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Dynamic Emergency Addresses",
"properties": {
"data": {
"type": "array",
@@ -26701,7 +28775,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Dynamic Emergency Endpoints",
"properties": {
"data": {
"type": "array",
@@ -26723,7 +28796,6 @@
"application/json": {
"schema": {
"type": "object",
- "title": "List Regulatory Requirements",
"properties": {
"data": {
"type": "array",
@@ -26741,73 +28813,6 @@
}
},
"schemas": {
- "AccessControlIp": {
- "type": "object",
- "title": "AccessControlIp",
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "description": "Uniquely identifies the access control IP.",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
- },
- "record_type": {
- "type": "string",
- "description": "Identifies the type of the resource.",
- "example": "access_control_ip"
- },
- "ip_address": {
- "$ref": "#/components/schemas/access_control_ip_ip_address"
- },
- "ip_address_type": {
- "$ref": "#/components/schemas/access_control_ip_ip_address_type"
- },
- "description": {
- "$ref": "#/components/schemas/access_control_ip_description"
- },
- "created_at": {
- "type": "string",
- "description": "ISO 8601 formatted date indicating when the resource was created.",
- "example": "2018-02-02T22:25:27.521Z"
- },
- "updated_at": {
- "type": "string",
- "description": "ISO 8601 formatted date indicating when the resource was updated.",
- "example": "2018-02-02T22:25:27.521Z"
- }
- }
- },
- "AccessControlIpCreate": {
- "type": "object",
- "required": [
- "ip_address"
- ],
- "properties": {
- "ip_address": {
- "$ref": "#/components/schemas/access_control_ip_ip_address"
- },
- "ip_address_type": {
- "$ref": "#/components/schemas/access_control_ip_ip_address_type"
- },
- "description": {
- "$ref": "#/components/schemas/access_control_ip_description"
- }
- }
- },
- "AccessControlIpUpdate": {
- "type": "object",
- "properties": {
- "ip_address": {
- "$ref": "#/components/schemas/access_control_ip_ip_address"
- },
- "ip_address_type": {
- "$ref": "#/components/schemas/access_control_ip_ip_address_type"
- },
- "description": {
- "$ref": "#/components/schemas/access_control_ip_description"
- }
- }
- },
"AccessIPAddressListResponseSchema": {
"title": "AccessIPAddressListResponseSchema",
"required": [
@@ -27003,136 +29008,6 @@
}
}
},
- "Address": {
- "type": "object",
- "title": "Address",
- "properties": {
- "id": {
- "type": "string",
- "format": "int64",
- "description": "Uniquely identifies the address.",
- "example": "1293384261075731499"
- },
- "record_type": {
- "type": "string",
- "description": "Identifies the type of the resource.",
- "example": "address"
- },
- "customer_reference": {
- "$ref": "#/components/schemas/customer_reference"
- },
- "first_name": {
- "$ref": "#/components/schemas/first_name"
- },
- "last_name": {
- "$ref": "#/components/schemas/last_name"
- },
- "business_name": {
- "$ref": "#/components/schemas/business_name"
- },
- "phone_number": {
- "$ref": "#/components/schemas/phone_number"
- },
- "street_address": {
- "$ref": "#/components/schemas/street_address"
- },
- "extended_address": {
- "$ref": "#/components/schemas/extended_address"
- },
- "locality": {
- "$ref": "#/components/schemas/locality"
- },
- "administrative_area": {
- "$ref": "#/components/schemas/administrative_area"
- },
- "neighborhood": {
- "$ref": "#/components/schemas/neighborhood"
- },
- "borough": {
- "$ref": "#/components/schemas/borough"
- },
- "postal_code": {
- "$ref": "#/components/schemas/postal_code"
- },
- "country_code": {
- "$ref": "#/components/schemas/country_code"
- },
- "address_book": {
- "$ref": "#/components/schemas/address_book"
- },
- "validate_address": {
- "$ref": "#/components/schemas/validate_address"
- },
- "created_at": {
- "type": "string",
- "description": "ISO 8601 formatted date indicating when the resource was created.",
- "example": "2018-02-02T22:25:27.521Z"
- },
- "updated_at": {
- "type": "string",
- "description": "ISO 8601 formatted date indicating when the resource was updated.",
- "example": "2018-02-02T22:25:27.521Z"
- }
- }
- },
- "AddressCreate": {
- "type": "object",
- "required": [
- "first_name",
- "last_name",
- "business_name",
- "street_address",
- "locality",
- "country_code"
- ],
- "properties": {
- "customer_reference": {
- "$ref": "#/components/schemas/customer_reference"
- },
- "first_name": {
- "$ref": "#/components/schemas/first_name"
- },
- "last_name": {
- "$ref": "#/components/schemas/last_name"
- },
- "business_name": {
- "$ref": "#/components/schemas/business_name"
- },
- "phone_number": {
- "$ref": "#/components/schemas/phone_number"
- },
- "street_address": {
- "$ref": "#/components/schemas/street_address"
- },
- "extended_address": {
- "$ref": "#/components/schemas/extended_address"
- },
- "locality": {
- "$ref": "#/components/schemas/locality"
- },
- "administrative_area": {
- "$ref": "#/components/schemas/administrative_area"
- },
- "neighborhood": {
- "$ref": "#/components/schemas/neighborhood"
- },
- "borough": {
- "$ref": "#/components/schemas/borough"
- },
- "postal_code": {
- "$ref": "#/components/schemas/postal_code"
- },
- "country_code": {
- "$ref": "#/components/schemas/country_code"
- },
- "address_book": {
- "$ref": "#/components/schemas/address_book"
- },
- "validate_address": {
- "$ref": "#/components/schemas/validate_address"
- }
- }
- },
"AmdDetailRecord": {
"type": "object",
"properties": {
@@ -27269,10 +29144,6 @@
"example": "wss://www.example.com/websocket"
},
"sound_modifications": {
- "description": "Use this field to modify sound effects, for example adjust the pitch.",
- "example": {
- "pitch": 0.8
- },
"$ref": "#/components/schemas/SoundModifications"
},
"stream_track": {
@@ -27737,6 +29608,81 @@
"connection_id": "804252963366242252"
}
},
+ "BulkSIMCardAction": {
+ "type": "object",
+ "description": "This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup.",
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/Id"
+ },
+ "record_type": {
+ "type": "string",
+ "example": "bulk_sim_card_action",
+ "readOnly": true
+ },
+ "action_type": {
+ "type": "string",
+ "description": "The operation type. It can be one of the following: bulk_set_public_ips - set a public IP for each specified SIM cardbulk_set_public_ips - set a public IP for each specified SIM cardandroid here",
+ "type": "string",
+ "enum": [
+ "android"
+ ]
+ },
"server_key": {
"description": "Server key as received from Google firebase",
"type": "string",
- "example": "BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja9L8B1FrxJbc1z2btoiFYkda9Simkkda_0SJNidSan9-jkda-nieD3js9SdhfazonSbLN5VXQDqXFRuPW4kdo_fdnaxdai3y9z9DKXie0"
+ "example": "BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja..."
},
"alias": {
"description": "Alias to uniquely identify the credential",
@@ -34627,22 +36896,30 @@
},
"CreateIosPushCredentialRequest": {
"type": "object",
- "title": "Create IOS Push Credential Request",
+ "title": "Create iOS push credential request",
"required": [
+ "type",
"certificate",
"private_key",
"alias"
],
"properties": {
+ "type": {
+ "description": "Type of mobile push credential. Should be ios here",
+ "type": "string",
+ "enum": [
+ "ios"
+ ]
+ },
"certificate": {
"description": "Certificate as received from APNs",
"type": "string",
- "example": "Bag Attributes\n friendlyName: VoIP Services: com.telnyx.webrtcapp\n localKeyID: AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA\nsubject=/UID=com.telnyx.webrtcapp.voip/CN=VoIP Services: com.telnyx.webrtcapp/OU=YKUVNPU9FS/O=Telnyx LLC/C=US\nissuer=/C=US/O=Apple Inc./OU=Apple Worldwide Developer Relations/CN=Apple Worldwide Developer Relations Certification Authority\n-----BEGIN CERTIFICATE-----\nMIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ\nDbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H\nFsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM\nUNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcH6HpirBQkrjJkak\nqqk5bC8Ye2PIcY0+nVFNWCoQqJadGduy1kHFmEsvkmaemfQdRIwn9q5lpNUnMSo3\no6Cx0igYEHryauzg2hv14ylyvoCBxPOvl95NO86s9XS0CB2Qq6t9V59qkJiCPgKt\nhRtU70gavh5L0K/FPEO2FnjaNa/2kVeU8LWgqxH8dhIl/QQSipS49PDQR7DIJUWQ\ncakwR34j97t6UTxz7Yx05uUhjlcB4+hq2+RLA6LOOEcGnpECAwEAAaOCAqgwggKk\nMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUiCcXCam2GGCL7Ou69kdZxVJUo7cw\nPwYIKwYBBQUHAQEEMzAxMC8GCCsGAQUFBzABhiNodHRwOi8vb2NzcC5hcHBsZS5j\nb20vb2NzcDAzLXd3ZHIwMTCCAR0GA1UdIASCARQwggEQMIIBDAbWVudHMuMDYGCC\nDRHGx1ngGt7fn3aobpf0CL+k8F1CcwkL8GZaAf3Pe6nxxWaTyaIU/LoBd8OU4aHq\ndGacHGp5tlgli8WhXNJuvHFmNnm0prQUeWjfTrHvAV2fEYJKoZIhvdjZAUBGAQUF\nMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNh\ndGUgYnkgYW55IHaiZDeWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhaiZDeaiZDeaiZD\nIsit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P\n5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5\ndnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3\nrpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9\nvG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjkknqoojqpiu109\nCfO37+af5amMDmgKHLWYqpIuF856urhODCRuprjCYwkyHX+cDbuB7E6BKjtyUCRx\ncHBsaWNhYmxlIHN0OIIJDKDAU094NOJujfoLmFwcGxlLmNvbS99w0BAQsFAAOCAQ\nY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0\nYXRlpX2LTQJsyzUjVKmbCjyATg5Y4QCqgDzrYUOBjL79dJzGwPKNQYG8YW5kYXJk\nLLuJX3jda0o393hnz03nz0jdah+m30lcS/iZkGAutno3MPd0EU9q3HyjyE0MjpHj\n/xXNgBL6zty06oXzUF+wXy1yNhUfouDLA3Yhv/uAbxN0NDart5s4kT/E3AAKIX3d\nBPYcCd3ran8CHgFW+dt3AIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwg==\n-----END CERTIFICATE-----\n"
+ "example": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----"
},
"private_key": {
"description": "Corresponding private key to the certificate as received from APNs",
"type": "string",
- "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ\nDbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H\nFsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM\nUNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcw6HpirBQkrjJkak\nqqk5bC8Ye2PIcY0+nVFNWCoQqxuFc9/xYtCzPhd7SLfj+sDp4ZU1u18WYAoD5E3u\nIsit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P\n5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5\ndnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3\nrpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9\nvG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjk+pMugWkBGwJ9r\nB8AfqXwV4qalv7/DPVj72OtBi79oiOltNsHWp4cChGkp8FxEaMhy5d6tT7lz/jY2\nZgu2Jz2pAoGBANuey3lj6dgTPc7ZDgcUKVz96aC1dDzrqBRKrIPsodFTVUSdiZP4\n3TLrD4niE0+yVD/9YvohdIlczWEQwvTy4feBcubkbKeU0LiAaAILfY1x/2twPuvG\nwfYU1uVpxUxYcKvrCxHVEBbw8iuf6PABaROZItM2MMrJy+sWf9SQ2rwdAoGBAM4k\nwsJSER7NNGw08L1QhmSYqNzxZtd2sOqJJXny32zOOW4c2UUbdqoXmfAgPceeAec0\ncE1W0SOzi06aNSjI1LQf5mKN4nFIt1Nw19zl9/YDZgbNkysuwsSlBQhZz+TwembC\n3icGC8dLMLTpZPrXZ+bsmbj5QO5B0DY8hgXpzZn/AoGASr1Eo6AD8bvCmgU2B+St\nmu7yNfXqg9zyy00KXq8F9rW0W/B85HWZ2X0zQYpFZibbExfJOjRuc1y4rCLHJhMO\nIWvVTYxJCdLUISXZv3Bnnt4/vTFqyFRQp805wML5GN00It2PW9c1bYk78OqvnBXu\ny3Oe7WAQxMJd+jgi8pUFS2UCgYEAnr92cDjM0GCMn0vBnLi3Vh6t47/PR9wyb9r/\nzkK3xk2lsmNq+iolHuWf+WiKyv+mTYt3dEeINSsd+4ELsQW/r5rlSz4ihMTP0OUU\nhxtd8ck6N8D2NYoEGXVPQ9gOHisGx74HYBvq1CXWM2uNBRL/A7luxCDG3PQ3yJyh\nRUqAt7cCgYEAmp5WdnTZJxkYFwaQ/MYebU4KAMMsvGoMkF+x7MJuB/0oXdpJnMyV\nQOwLXF/NZrWCyEqstGRN+rSKJXF/slD4wgAZBjfRkXMeYcsCEEPXQLLnj8SF5QIv\n8+rvyN9fX+MnxRY9PqCXRaXRl7G/3ORxbPRPsefQAsDQ5NsN5lay2l4=\n-----END RSA PRIVATE KEY-----"
+ "example": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----"
},
"alias": {
"description": "Alias to uniquely identify the credential",
@@ -35111,26 +37388,6 @@
}
}
},
- "CreateMobileApplicationRequest": {
- "type": "object",
- "title": "Create Mobile Application Request",
- "required": [
- "application_name",
- "type"
- ],
- "properties": {
- "application_name": {
- "description": "Name of the appplication to be created",
- "type": "string",
- "example": "FlashEmergency"
- },
- "type": {
- "description": "Type of application to be created (IOS or Android)",
- "type": "string",
- "example": "android"
- }
- }
- },
"CreateMultiPartDocServiceDocumentRequest": {
"type": "object",
"properties": {
@@ -36422,16 +38679,6 @@
"video": {
"$ref": "#/components/schemas/Video"
},
- "hsm": {
- "$ref": "#/components/schemas/Hsm"
- },
- "contacts": {
- "description": "",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Contact"
- }
- },
"location": {
"$ref": "#/components/schemas/Location"
},
@@ -36452,11 +38699,120 @@
}
}
},
+ "CreateWhatsappMessageTemplateRequestBody": {
+ "type": "object",
+ "title": "Create WhatsApp Message Template Request Body",
+ "properties": {
+ "category": {
+ "description": "The template category",
+ "enum": [
+ "ACCOUNT_UPDATE",
+ "PAYMENT_UPDATE",
+ "PERSONAL_FINANCE_UPDATE",
+ "SHIPPING_UPDATE",
+ "RESERVATION_UPDATE",
+ "ISSUE_RESOLUTION",
+ "APPOINTMENT_UPDATE",
+ "TRANSPORTATION_UPDATE",
+ "TICKET_UPDATE",
+ "ALERT_UPDATE",
+ "AUTO_REPLY"
+ ],
+ "type": "string"
+ },
+ "language": {
+ "description": "The language of the whatsapp message template",
+ "type": "string",
+ "enum": [
+ "af",
+ "sq",
+ "ar",
+ "az",
+ "bn",
+ "bg",
+ "ca",
+ "zh_CN",
+ "zh_HK",
+ "zh_TW",
+ "hr",
+ "cs",
+ "da",
+ "nl",
+ "en",
+ "en_GB",
+ "en_US",
+ "et",
+ "fil",
+ "fi",
+ "fr",
+ "ka",
+ "de",
+ "el",
+ "gu",
+ "ha",
+ "he",
+ "hi",
+ "hu",
+ "id",
+ "ga",
+ "it",
+ "ja",
+ "kn",
+ "kk",
+ "rw_RW",
+ "ko",
+ "ky_KG",
+ "lo",
+ "lv",
+ "lt",
+ "mk",
+ "ms",
+ "ml",
+ "mr",
+ "nb",
+ "fa",
+ "pl",
+ "pt_BR",
+ "pt_PT",
+ "pa",
+ "ro",
+ "ru",
+ "sr",
+ "sk",
+ "sl",
+ "es",
+ "es_AR",
+ "es_ES",
+ "es_MX",
+ "sw",
+ "sv",
+ "ta",
+ "te",
+ "th",
+ "tr",
+ "uk",
+ "ur",
+ "uz",
+ "vi",
+ "zu"
+ ]
+ },
+ "name": {
+ "description": "A name identifying this whatsapp message template",
+ "type": "string"
+ },
+ "components": {
+ "description": "The JSON-formatted components for the this whatsapp message template, please refer to whatsapp documentation on the correct structure for this field",
+ "type": "string",
+ "format": "json"
+ }
+ }
+ },
"CreatedAt": {
- "title": "Created At",
"type": "string",
- "description": "ISO 8601 formatted date indicating when the resource was created.",
- "example": "2020-02-02T22:25:27.521Z"
+ "description": "ISO 8601 formatted date-time indicating when the resource was created.",
+ "readOnly": true,
+ "example": "2018-02-02T22:25:27.521Z"
},
"CredentialConnection": {
"type": "object",
@@ -36908,6 +39264,40 @@
"amount_1000": 100990
}
},
+ "CursorPagination": {
+ "type": "object",
+ "properties": {
+ "cursors": {
+ "type": "object",
+ "properties": {
+ "before": {
+ "type": "string",
+ "description": "A cursor to use for paginating results."
+ },
+ "after": {
+ "type": "string",
+ "description": "A cursor to use for paginating results."
+ }
+ }
+ },
+ "next": {
+ "type": "string",
+ "description": "A URL to the next page of results."
+ },
+ "previous": {
+ "type": "string",
+ "description": "A URL to the previous page of results."
+ }
+ },
+ "example": {
+ "cursors": {
+ "after": "MQZDZD",
+ "before": "MQZDZD"
+ },
+ "next": "/v2/whatsapp_business_accounts/4444451-4222-9222-3bd5555501c0/whatsapp_message_templates?page[after]=MQZDZD&page[limit]=1",
+ "previous": "/v2/whatsapp_business_accounts/4444451-4222-9222-3bd5555501c0/whatsapp_message_templates?page[before]=MQZDZD&page[limit]=1"
+ }
+ },
"CustomSipHeader": {
"type": "object",
"title": "Custom SIP Header",
@@ -36932,6 +39322,83 @@
"value": "val_1"
}
},
+ "CustomerFacingFQDNsGetIPResponse": {
+ "title": "CustomerFacingFQDNsGetIP",
+ "type": "object",
+ "properties": {
+ "data": {
+ "title": "Data",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IpItem"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ },
+ "CustomerFacingFQDNsListResponse": {
+ "title": "CustomerFacingFQDNsListResponse",
+ "type": "object",
+ "properties": {
+ "data": {
+ "title": "Data",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CustomerFacingFQDNsResponseSchema"
+ }
+ },
+ "meta": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ }
+ },
+ "CustomerFacingFQDNsPost": {
+ "title": "CustomerFacingFQDNsResponseSchema",
+ "type": "object",
+ "required": [
+ "fqdn"
+ ],
+ "properties": {
+ "fqdn": {
+ "title": "Fully Qualified Domain Name (FQDN)",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "type": "string"
+ }
+ }
+ },
+ "CustomerFacingFQDNsResponseSchema": {
+ "title": "CustomerFacingFQDNsResponseSchema",
+ "type": "object",
+ "properties": {
+ "id": {
+ "title": "Id",
+ "type": "string"
+ },
+ "fqdn": {
+ "title": "Fully Qualified Domain Name (FQDN)",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "type": "string"
+ },
+ "created_at": {
+ "title": "Created At",
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "title": "Updated At",
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
"CustomerServiceRequest": {
"type": "object",
"properties": {
@@ -37220,28 +39687,40 @@
"description": "An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records",
"oneOf": [
{
- "$ref": "#/components/schemas/MessageDetailRecord"
+ "$ref": "#/components/schemas/MessageDetailRecord",
+ "title": "Message"
+ },
+ {
+ "$ref": "#/components/schemas/ConferenceDetailRecord",
+ "title": "Conference"
},
{
- "$ref": "#/components/schemas/ConferenceDetailRecord"
+ "$ref": "#/components/schemas/ConferenceParticipantDetailRecord",
+ "title": "Conference Participant"
},
{
- "$ref": "#/components/schemas/ConferenceParticipantDetailRecord"
+ "$ref": "#/components/schemas/WhatsAppDetailRecord",
+ "title": "WhatsApp Message"
},
{
- "$ref": "#/components/schemas/WhatsAppDetailRecord"
+ "$ref": "#/components/schemas/WhatsAppConversationDetailRecord",
+ "title": "WhatsApp Conversation"
},
{
- "$ref": "#/components/schemas/AmdDetailRecord"
+ "$ref": "#/components/schemas/AmdDetailRecord",
+ "title": "AMD"
},
{
- "$ref": "#/components/schemas/VerifyDetailRecord"
+ "$ref": "#/components/schemas/VerifyDetailRecord",
+ "title": "Verify 2FA"
},
{
- "$ref": "#/components/schemas/SimCardUsageDetailRecord"
+ "$ref": "#/components/schemas/SimCardUsageDetailRecord",
+ "title": "Sim Card Usage"
},
{
- "$ref": "#/components/schemas/MediaStorageDetailRecord"
+ "$ref": "#/components/schemas/MediaStorageDetailRecord",
+ "title": "Media Storage"
}
],
"required": [
@@ -37265,6 +39744,118 @@
}
}
},
+ "DialogflowConfig": {
+ "type": "object",
+ "title": "Dialogflow Config",
+ "properties": {
+ "analyze_sentiment": {
+ "description": "Enable sentiment analysis from Dialogflow.",
+ "type": "boolean",
+ "example": "true",
+ "default": false
+ },
+ "partial_automated_agent_reply": {
+ "description": "Enable partial automated agent reply from Dialogflow.",
+ "type": "boolean",
+ "example": true,
+ "default": false
+ }
+ }
+ },
+ "DialogflowConnection": {
+ "type": "object",
+ "title": "Dialogflow Connection Params",
+ "required": [
+ "service_account"
+ ],
+ "properties": {
+ "service_account": {
+ "description": "The JSON map to connect your Dialoglow account.",
+ "type": "object",
+ "example": "{\"service_account\":{\"type\":\"service_account\",\"project_id\":\"your-project-id\",\"private_key_id\":\"your-private-key\",\"private_key\":\"-----BEGIN PRIVATE KEY-----n-----END PRIVATE\",\"client_email\":\"example@example.com\",\"client_id\":\"your-client-id\",\"auth_uri\":\"http://example.com\",\"token_uri\":\"http://example.com\",\"auth_provider_x509_cert_url\":\"http://example.com\",\"client_x509_cert_url\":\"http://example.com\"}}"
+ },
+ "dialogflow_api": {
+ "description": "Determin which Dialogflow will be used.",
+ "type": "string",
+ "enum": [
+ "cx",
+ "es"
+ ],
+ "example": "cx",
+ "default": "es"
+ },
+ "conversation_profile_id": {
+ "description": "The id of a configured conversation profile on your Dialogflow account. (If you use Dialogflow CX, this param is required)",
+ "type": "string",
+ "example": "a-VMHLWzTmKjiJw5S6O0-w"
+ },
+ "location": {
+ "description": "The region of your agent is. (If you use Dialogflow CX, this param is required)",
+ "type": "string",
+ "example": "global"
+ },
+ "environment": {
+ "description": "Which Dialogflow environment will be used.",
+ "type": "string",
+ "example": "development"
+ }
+ },
+ "example": {
+ "service_Account": "{\"type\":\"service_account\",\"project_id\":\"your-project-id\",\"private_key_id\":\"your-private-key\",\"private_key\":\"-----BEGIN PRIVATE KEY-----n-----END PRIVATE\",\"client_email\":\"example@example.com\",\"client_id\":\"your-client-id\",\"auth_uri\":\"http://example.com\",\"token_uri\":\"http://example.com\",\"auth_provider_x509_cert_url\":\"http://example.com\",\"client_x509_cert_url\":\"http://example.com\"}",
+ "dialogflow_api": "cx",
+ "conversation_profile_id": "a-VMHLWzTmKjiJw5S6O0-w",
+ "location": "global",
+ "environment": "development"
+ }
+ },
+ "DialogflowConnectionResponse": {
+ "type": "object",
+ "title": "Dialogflow Connection Response",
+ "required": [
+ "data"
+ ],
+ "properties": {
+ "data": {
+ "type": "object",
+ "title": "Dialogflow Connection",
+ "properties": {
+ "record_type": {
+ "type": "string",
+ "example": "dialogflow_connections"
+ },
+ "connection_id": {
+ "type": "string",
+ "example": "1234541231",
+ "description": "Uniquely identifies a Telnyx application (Call Control)."
+ },
+ "conversation_profile_id": {
+ "type": "string",
+ "description": "The id of a configured conversation profile on your Dialogflow account. (If you use Dialogflow CX, this param is required)",
+ "example": "a-VMHLWzTmKjiJw5S6O0-w"
+ },
+ "environment": {
+ "type": "string",
+ "description": "Which Dialogflow environment will be used.",
+ "example": "development"
+ },
+ "service_account": {
+ "type": "string",
+ "description": "The JSON map to connect your Dialoglow account.",
+ "example": "****"
+ }
+ }
+ }
+ }
+ },
+ "Direction": {
+ "description": "The direction of the fax.",
+ "type": "string",
+ "example": "outbound",
+ "enum": [
+ "inbound",
+ "outbound"
+ ]
+ },
"DocReqsRequirement": {
"type": "object",
"properties": {
@@ -37902,6 +40493,7 @@
"queue_name": {
"description": "The name of the queue the call should be put in. If a queue with a given name doesn't exist yet it will be created.",
"type": "string",
+ "required": ["true"],
"example": "tier_1_support"
},
"client_state": {
@@ -37927,7 +40519,7 @@
}
},
"example": {
- "queue": "support",
+ "queue_name": "support",
"max_wait_time_secs": 600,
"max_size": 20,
"client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
@@ -37942,7 +40534,7 @@
"properties": {
"code": {
"type": "string",
- "format": "int"
+ "format": "integer"
},
"title": {
"type": "string"
@@ -38090,50 +40682,28 @@
]
},
"id": {
- "description": "Identifies the fax.",
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
+ "$ref": "#/components/schemas/Id"
},
"connection_id": {
- "description": "The connection ID to send the fax with.",
- "type": "string",
- "example": "234423"
+ "$ref": "#/components/schemas/ConnectionId"
},
"direction": {
- "description": "The direction of the fax.",
- "type": "string",
- "example": "outbound",
- "enum": [
- "inbound",
- "outbound"
- ]
+ "$ref": "#/components/schemas/Direction"
},
"media_url": {
- "description": "The URL to the PDF used for the fax's media. If media_name was supplied, this is omitted.",
- "type": "string",
- "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ "$ref": "#/components/schemas/MediaUrl"
},
"media_name": {
- "description": "The media_name of a file used for the fax's media.",
- "type": "string",
- "example": "my_media_uploaded_to_media_storage_api"
+ "$ref": "#/components/schemas/MediaName"
},
"to": {
- "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI",
- "type": "string",
- "example": "+13127367276"
+ "$ref": "#/components/schemas/To"
},
"from": {
- "description": "The phone number, in E.164 format, the fax will be sent from.",
- "type": "string",
- "example": "+13125790015"
+ "$ref": "#/components/schemas/From"
},
"quality": {
- "description": "The quality of the fax. Can be normal, high, very_high",
- "type": "string",
- "example": "high",
- "default": "high"
+ "$ref": "#/components/schemas/Quality"
},
"status": {
"description": "Status of the fax",
@@ -38142,6 +40712,7 @@
"enum": [
"queued",
"media.processed",
+ "originated",
"sending",
"delivered",
"failed",
@@ -38160,7 +40731,7 @@
"type": "string"
},
"store_media": {
- "description": "Should fax media be stored on temporary URL.",
+ "description": "Should fax media be stored on temporary URL. It does not support media_name.",
"type": "boolean"
},
"stored_media_url": {
@@ -38324,18 +40895,10 @@
},
"properties": {
"record_type": {
- "type": "string",
- "example": "event",
- "enum": [
- "event"
- ],
- "description": "Identifies the type of the resource."
+ "$ref": "#/components/schemas/RecordType"
},
"id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the type of resource."
+ "$ref": "#/components/schemas/Id"
},
"event_type": {
"type": "string",
@@ -38354,50 +40917,28 @@
"example": 25
},
"connection_id": {
- "description": "The ID of the connection that was used to send the fax.",
- "type": "string",
- "example": "234423"
+ "$ref": "#/components/schemas/ConnectionId"
},
"direction": {
- "description": "The direction of the fax.",
- "type": "string",
- "example": "outbound",
- "enum": [
- "inbound",
- "outbound"
- ]
+ "$ref": "#/components/schemas/Direction"
},
"fax_id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the fax."
+ "$ref": "#/components/schemas/FaxId"
},
"original_media_url": {
- "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted",
- "type": "string",
- "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ "$ref": "#/components/schemas/OriginalMediaUrl"
},
"media_name": {
- "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization",
- "type": "string",
- "example": "my_media_uploaded_to_media_storage_api"
+ "$ref": "#/components/schemas/MediaName"
},
"to": {
- "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI",
- "type": "string",
- "example": "+13127367276"
+ "$ref": "#/components/schemas/To"
},
"from": {
- "description": "The phone number, in E.164 format, the fax will be sent from.",
- "type": "string",
- "example": "+13125790015"
+ "$ref": "#/components/schemas/From"
},
"user_id": {
- "description": "Identifier of the user to whom the fax belongs",
- "type": "string",
- "format": "uuid",
- "example": "yfff7c54-4df3-4bca-a65a-3da1ecc777f0"
+ "$ref": "#/components/schemas/UserId"
},
"page_count": {
"description": "Number of transferred pages",
@@ -38448,18 +40989,10 @@
},
"properties": {
"record_type": {
- "type": "string",
- "example": "event",
- "enum": [
- "event"
- ],
- "description": "Identifies the type of the resource."
+ "$ref": "#/components/schemas/RecordType"
},
"id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the type of resource."
+ "$ref": "#/components/schemas/Id"
},
"event_type": {
"type": "string",
@@ -38473,50 +41006,28 @@
"type": "object",
"properties": {
"connection_id": {
- "description": "The ID of the connection that was used to send the fax.",
- "type": "string",
- "example": "234423"
+ "$ref": "#/components/schemas/ConnectionId"
},
"direction": {
- "description": "The direction of the fax.",
- "type": "string",
- "example": "outbound",
- "enum": [
- "inbound",
- "outbound"
- ]
+ "$ref": "#/components/schemas/Direction"
},
"fax_id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the fax."
+ "$ref": "#/components/schemas/FaxId"
},
"original_media_url": {
- "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted",
- "type": "string",
- "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ "$ref": "#/components/schemas/OriginalMediaUrl"
},
"media_name": {
- "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization",
- "type": "string",
- "example": "my_media_uploaded_to_media_storage_api"
+ "$ref": "#/components/schemas/MediaName"
},
"to": {
- "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI",
- "type": "string",
- "example": "+13127367276"
+ "$ref": "#/components/schemas/To"
},
"from": {
- "description": "The phone number, in E.164 format, the fax will be sent from.",
- "type": "string",
- "example": "+13125790015"
+ "$ref": "#/components/schemas/From"
},
"user_id": {
- "description": "Identifier of the user to whom the fax belongs",
- "type": "string",
- "format": "uuid",
- "example": "yfff7c54-4df3-4bca-a65a-3da1ecc777f0"
+ "$ref": "#/components/schemas/UserId"
},
"failure_reason": {
"type": "string",
@@ -38537,6 +41048,12 @@
}
}
},
+ "FaxId": {
+ "type": "string",
+ "format": "uuid",
+ "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
+ "description": "Identifies the fax."
+ },
"FaxMediaProcessed": {
"type": "object",
"example": {
@@ -38559,18 +41076,10 @@
},
"properties": {
"record_type": {
- "type": "string",
- "example": "event",
- "enum": [
- "event"
- ],
- "description": "Identifies the type of the resource."
+ "$ref": "#/components/schemas/RecordType"
},
"id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the type of resource."
+ "$ref": "#/components/schemas/Id"
},
"event_type": {
"type": "string",
@@ -38584,50 +41093,28 @@
"type": "object",
"properties": {
"connection_id": {
- "description": "The ID of the connection that was used to send the fax.",
- "type": "string",
- "example": "234423"
+ "$ref": "#/components/schemas/ConnectionId"
},
"direction": {
- "description": "The direction of the fax.",
- "type": "string",
- "example": "outbound",
- "enum": [
- "inbound",
- "outbound"
- ]
+ "$ref": "#/components/schemas/Direction"
},
"fax_id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the fax."
+ "$ref": "#/components/schemas/FaxId"
},
"original_media_url": {
- "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted",
- "type": "string",
- "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ "$ref": "#/components/schemas/OriginalMediaUrl"
},
"media_name": {
- "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization",
- "type": "string",
- "example": "my_media_uploaded_to_media_storage_api"
+ "$ref": "#/components/schemas/MediaName"
},
"to": {
- "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI",
- "type": "string",
- "example": "+13127367276"
+ "$ref": "#/components/schemas/To"
},
"from": {
- "description": "The phone number, in E.164 format, the fax will be sent from.",
- "type": "string",
- "example": "+13125790015"
+ "$ref": "#/components/schemas/From"
},
"user_id": {
- "description": "Identifier of the user to whom the fax belongs",
- "type": "string",
- "format": "uuid",
- "example": "yfff7c54-4df3-4bca-a65a-3da1ecc777f0"
+ "$ref": "#/components/schemas/UserId"
},
"status": {
"type": "string",
@@ -38663,18 +41150,10 @@
},
"properties": {
"record_type": {
- "type": "string",
- "example": "event",
- "enum": [
- "event"
- ],
- "description": "Identifies the type of the resource."
+ "$ref": "#/components/schemas/RecordType"
},
"id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the type of resource."
+ "$ref": "#/components/schemas/Id"
},
"event_type": {
"type": "string",
@@ -38688,50 +41167,28 @@
"type": "object",
"properties": {
"connection_id": {
- "description": "The ID of the connection that was used to send the fax.",
- "type": "string",
- "example": "234423"
+ "$ref": "#/components/schemas/ConnectionId"
},
"direction": {
- "description": "The direction of the fax.",
- "type": "string",
- "example": "outbound",
- "enum": [
- "inbound",
- "outbound"
- ]
+ "$ref": "#/components/schemas/Direction"
},
"fax_id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the fax."
+ "$ref": "#/components/schemas/FaxId"
},
"original_media_url": {
- "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted",
- "type": "string",
- "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ "$ref": "#/components/schemas/OriginalMediaUrl"
},
"media_name": {
- "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization",
- "type": "string",
- "example": "my_media_uploaded_to_media_storage_api"
+ "$ref": "#/components/schemas/MediaName"
},
"to": {
- "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI",
- "type": "string",
- "example": "+13127367276"
+ "$ref": "#/components/schemas/To"
},
"from": {
- "description": "The phone number, in E.164 format, the fax will be sent from.",
- "type": "string",
- "example": "+13125790015"
+ "$ref": "#/components/schemas/From"
},
"user_id": {
- "description": "Identifier of the user to whom the fax belongs",
- "type": "string",
- "format": "uuid",
- "example": "yfff7c54-4df3-4bca-a65a-3da1ecc777f0"
+ "$ref": "#/components/schemas/UserId"
},
"status": {
"type": "string",
@@ -38767,18 +41224,10 @@
},
"properties": {
"record_type": {
- "type": "string",
- "example": "event",
- "enum": [
- "event"
- ],
- "description": "Identifies the type of the resource."
+ "$ref": "#/components/schemas/RecordType"
},
"id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the type of resource."
+ "$ref": "#/components/schemas/Id"
},
"event_type": {
"type": "string",
@@ -38792,50 +41241,28 @@
"type": "object",
"properties": {
"connection_id": {
- "description": "The ID of the connection that was used to send the fax.",
- "type": "string",
- "example": "234423"
+ "$ref": "#/components/schemas/ConnectionId"
},
"direction": {
- "description": "The direction of the fax.",
- "type": "string",
- "example": "outbound",
- "enum": [
- "inbound",
- "outbound"
- ]
+ "$ref": "#/components/schemas/Direction"
},
"fax_id": {
- "type": "string",
- "format": "uuid",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "description": "Identifies the fax."
+ "$ref": "#/components/schemas/FaxId"
},
"original_media_url": {
- "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted",
- "type": "string",
- "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ "$ref": "#/components/schemas/OriginalMediaUrl"
},
"media_name": {
- "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization",
- "type": "string",
- "example": "my_media_uploaded_to_media_storage_api"
+ "$ref": "#/components/schemas/MediaName"
},
"to": {
- "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI",
- "type": "string",
- "example": "+13127367276"
+ "$ref": "#/components/schemas/To"
},
"from": {
- "description": "The phone number, in E.164 format, the fax will be sent from.",
- "type": "string",
- "example": "+13125790015"
+ "$ref": "#/components/schemas/From"
},
"user_id": {
- "description": "Identifier of the user to whom the fax belongs",
- "type": "string",
- "format": "uuid",
- "example": "yfff7c54-4df3-4bca-a65a-3da1ecc777f0"
+ "$ref": "#/components/schemas/UserId"
},
"status": {
"type": "string",
@@ -39160,6 +41587,11 @@
"TLS"
]
},
+ "From": {
+ "description": "The phone number, in E.164 format, the fax will be sent from.",
+ "type": "string",
+ "example": "+13125790015"
+ },
"GCSConfiguration": {
"type": "object",
"title": "Google Cloud Storage Configuration",
@@ -39192,6 +41624,69 @@
}
}
},
+ "GatherRequest": {
+ "type": "object",
+ "title": "Gather",
+ "properties": {
+ "minimum_digits": {
+ "description": "The minimum number of digits to fetch. This parameter has a minimum value of 1.",
+ "default": 1,
+ "type": "integer",
+ "example": 1,
+ "format": "int32"
+ },
+ "maximum_digits": {
+ "description": "The maximum number of digits to fetch. This parameter has a maximum value of 128.",
+ "default": 128,
+ "type": "integer",
+ "example": 10,
+ "format": "int32"
+ },
+ "timeout_millis": {
+ "description": "The number of milliseconds to wait to complete the request.",
+ "default": 60000,
+ "type": "integer",
+ "example": 60000,
+ "format": "int32"
+ },
+ "inter_digit_timeout_millis": {
+ "description": "The number of milliseconds to wait for input between digits.",
+ "default": 5000,
+ "type": "integer",
+ "example": 10000,
+ "format": "int32"
+ },
+ "initial_timeout_millis": {
+ "description": "The number of milliseconds to wait for the first DTMF.",
+ "default": 5000,
+ "type": "integer",
+ "example": 10000,
+ "format": "int32"
+ },
+ "terminating_digit": {
+ "description": "The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.",
+ "default": "#",
+ "type": "string",
+ "example": "#"
+ },
+ "valid_digits": {
+ "description": "A list of all digits accepted as valid.",
+ "default": "0123456789#*",
+ "type": "string",
+ "example": "123"
+ },
+ "client_state": {
+ "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.",
+ "type": "string",
+ "example": "aGF2ZSBhIG5pY2UgZGF5ID1d"
+ },
+ "command_id": {
+ "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.",
+ "type": "string",
+ "example": "891510ac-f3e4-11e8-af5b-de00688a4901"
+ }
+ }
+ },
"GatherUsingAudioRequest": {
"type": "object",
"title": "Gather Using Audio Request",
@@ -39663,50 +42158,6 @@
}
}
},
- "Hsm": {
- "title": "Hsm",
- "description": "The containing element for the message content \u2014 Indicates that the message is highly structured. Parameters contained within provide the structure.",
- "required": [
- "namespace",
- "element_name",
- "language",
- "localizable_params"
- ],
- "type": "object",
- "properties": {
- "namespace": {
- "description": "The namespace that will be used",
- "type": "string"
- },
- "element_name": {
- "description": "The element name that indicates which template to use within the namespace",
- "type": "string"
- },
- "language": {
- "$ref": "#/components/schemas/Language"
- },
- "localizable_params": {
- "description": "This field is an array of values to apply to variables in the template",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalizableParam"
- }
- }
- },
- "example": {
- "namespace": "business_a_namespace",
- "element_name": "hello_world",
- "language": {
- "policy": "deterministic",
- "code": "en"
- },
- "localizable_params": [
- {
- "default": "1234"
- }
- ]
- }
- },
"Id": {
"type": "string",
"format": "uuid",
@@ -40432,6 +42883,334 @@
"description": "Uniquely identifies the resource.",
"example": "1293384261075731499"
},
+ "Interactive": {
+ "title": "Interactive",
+ "required": [
+ "type",
+ "action"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveType"
+ }
+ ],
+ "description": "The type of interactive message you want to send."
+ },
+ "header": {
+ "title": "Header",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveHeader"
+ }
+ ],
+ "description": "Header content displayed on top of a message. See header object for more information. You cannot set a header if your interactive object is of product type. Required for type product_list. Optional for other types."
+ },
+ "body": {
+ "title": "Body",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveBody"
+ }
+ ],
+ "description": "The body of the message. Emojis and markdown are supported. Optional for type product. Required for other message types."
+ },
+ "footer": {
+ "title": "Footer",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveFooter"
+ }
+ ],
+ "description": "The footer of the message. Emojis and markdown are supported."
+ },
+ "action": {
+ "title": "Action",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveAction"
+ }
+ ],
+ "description": "Action you want the user to perform after reading the message."
+ }
+ }
+ },
+ "InteractiveAction": {
+ "title": "InteractiveAction",
+ "type": "object",
+ "properties": {
+ "button": {
+ "title": "Button",
+ "type": "string",
+ "description": "Button content. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Required for List Messages."
+ },
+ "buttons": {
+ "title": "Buttons",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InteractiveButton"
+ },
+ "description": "A list of buttons. Required for Reply Button Messages."
+ },
+ "sections": {
+ "title": "Sections",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InteractiveSection"
+ },
+ "description": "Array of section objects. Required for List Messages and Multi-Product Messages."
+ },
+ "catalog_id": {
+ "title": "Catalog Id",
+ "type": "string",
+ "description": "Unique identifier of the Facebook catalog linked to your WhatsApp Business Account. This ID can be retrieved via Commerce Manager. Required for Single Product Messages and Multi-Product Messages."
+ },
+ "product_retailer_id": {
+ "title": "Product Retailer Id",
+ "type": "string",
+ "description": "Unique identifier of the product in a catalog. To get this ID, go to Commerce Manager, select your Facebook Business account, and you will see a list of shops connected to your account. Click the shop you want to use. On the left-side panel, click Catalog > Items, and find the item you want to mention. The ID for that item is displayed under the item's name."
+ }
+ }
+ },
+ "InteractiveBody": {
+ "title": "InteractiveBody",
+ "required": [
+ "text"
+ ],
+ "type": "object",
+ "properties": {
+ "text": {
+ "title": "Text",
+ "type": "string",
+ "description": "The body content of the message. Emojis and markdown are supported. Links are supported."
+ }
+ }
+ },
+ "InteractiveButton": {
+ "title": "InteractiveButton",
+ "required": [
+ "reply"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveButtonType"
+ }
+ ],
+ "description": "The only supported type is reply (for Reply Button Messages).",
+ "default": "reply"
+ },
+ "reply": {
+ "title": "Reply",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/InteractiveButtonReply"
+ }
+ ],
+ "description": "Reply button details."
+ }
+ }
+ },
+ "InteractiveButtonReply": {
+ "title": "InteractiveButtonReply",
+ "required": [
+ "title",
+ "id"
+ ],
+ "type": "object",
+ "properties": {
+ "title": {
+ "title": "Title",
+ "type": "string",
+ "description": "Button title. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not."
+ },
+ "id": {
+ "title": "Id",
+ "type": "string",
+ "description": "Unique identifier for your button. This ID is returned in the webhook when the button is clicked by the user. You cannot have leading or trailing spaces when setting the ID."
+ }
+ }
+ },
+ "InteractiveButtonType": {
+ "title": "InteractiveButtonType",
+ "enum": [
+ "reply"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "InteractiveFooter": {
+ "title": "InteractiveFooter",
+ "required": [
+ "text"
+ ],
+ "type": "object",
+ "properties": {
+ "text": {
+ "title": "Text",
+ "type": "string",
+ "description": "The footer content. Emojis and markdown are supported. Links are supported."
+ }
+ }
+ },
+ "InteractiveHeader": {
+ "title": "InteractiveHeader",
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "description": "The header type you would like to use."
+ },
+ "text": {
+ "title": "Text",
+ "type": "string",
+ "description": "Text for the header. Formatting allows emojis, but not markdown."
+ },
+ "video": {
+ "title": "Video",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Video"
+ }
+ ],
+ "description": "Contains the media object for this video."
+ },
+ "image": {
+ "title": "Image",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Image"
+ }
+ ],
+ "description": "Contains the media object for this image."
+ },
+ "document": {
+ "title": "Document",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Document"
+ }
+ ],
+ "description": "Contains the media object for this document."
+ }
+ }
+ },
+ "InteractiveProduct": {
+ "title": "InteractiveProduct",
+ "required": [
+ "product_retailer_id"
+ ],
+ "type": "object",
+ "properties": {
+ "product_retailer_id": {
+ "title": "Product Retailer Id",
+ "type": "string",
+ "description": "Unique identifier of the product in a catalog. To get this ID, go to Commerce Manager, select your Facebook Business account, and you will see a list of shops connected to your account. Click the shop you want to use. On the left-side panel, click Catalog > Items, and find the item you want to mention. The ID for that item is displayed under the item's name."
+ }
+ }
+ },
+ "InteractiveSection": {
+ "title": "InteractiveSection",
+ "type": "object",
+ "properties": {
+ "title": {
+ "title": "Title",
+ "type": "string",
+ "description": "Title of the section. Required if the message has more than one section."
+ },
+ "rows": {
+ "title": "Rows",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InteractiveSectionRow"
+ },
+ "description": "Contains a list of rows. Limited to 10 rows across all sections. Required for List Messages."
+ },
+ "product_items": {
+ "title": "Product Items",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InteractiveProduct"
+ },
+ "description": "Array of product objects. There is a minimum of 1 product per section. There is a maximum of 30 products across all sections."
+ }
+ }
+ },
+ "InteractiveSectionRow": {
+ "title": "InteractiveSectionRow",
+ "required": [
+ "id",
+ "title"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "title": "Id",
+ "type": "string",
+ "description": "Maximum length: 200 characters"
+ },
+ "title": {
+ "title": "Title",
+ "type": "string",
+ "description": "Maximum length: 24 characters"
+ },
+ "description": {
+ "title": "Description",
+ "type": "string",
+ "description": "Maximum length: 72 characters"
+ }
+ }
+ },
+ "InteractiveType": {
+ "title": "InteractiveType",
+ "enum": [
+ "list",
+ "button",
+ "product",
+ "product_list"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "Interface": {
+ "type": "object",
+ "properties": {
+ "network_id": {
+ "description": "The id of the network associated with the interface.",
+ "type": "string",
+ "format": "uuid",
+ "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
+ },
+ "name": {
+ "type": "string",
+ "description": "A user specified name for the interface.",
+ "example": "test interface"
+ },
+ "status": {
+ "$ref": "#/components/schemas/InterfaceStatus"
+ }
+ }
+ },
+ "InterfaceStatus": {
+ "type": "string",
+ "enum": [
+ "created",
+ "provisioning",
+ "provisioned",
+ "deleting"
+ ],
+ "description": "The current status of the interface deployment.",
+ "readOnly": true,
+ "example": "provisioned"
+ },
"InventoryCoverage": {
"type": "object",
"properties": {
@@ -40497,7 +43276,6 @@
},
"InventoryCoverageMetadata": {
"type": "object",
- "title": "InventoryCoverageMetadata",
"example": {
"total_results": 25
},
@@ -40735,6 +43513,31 @@
}
}
},
+ "IpItem": {
+ "title": "IP Item",
+ "type": "object",
+ "properties": {
+ "ip_address": {
+ "title": "IP address",
+ "type": "string",
+ "format": "ipv4"
+ },
+ "fqdn": {
+ "title": "Fully Qualified Domain Name (FQDN)",
+ "type": "string"
+ },
+ "created_at": {
+ "title": "Created At",
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "title": "Updated At",
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
"JoinConferenceRequest": {
"required": [
"call_control_id"
@@ -41020,28 +43823,6 @@
}
}
},
- "LocalizableParam": {
- "title": "LocalizableParam",
- "required": [
- "default"
- ],
- "type": "object",
- "properties": {
- "default": {
- "description": "Default text if localization fails",
- "type": "string"
- },
- "currency": {
- "$ref": "#/components/schemas/Currency"
- },
- "date_time": {
- "$ref": "#/components/schemas/DateTimeObject"
- }
- },
- "example": {
- "default": ""
- }
- },
"Location": {
"title": "Location",
"required": [
@@ -41780,6 +44561,11 @@
"t38_fax_gateway_enabled": true
}
},
+ "MediaName": {
+ "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_name and media_url/contents can't be submitted together.",
+ "type": "string",
+ "example": "my_media_uploaded_to_media_storage_api"
+ },
"MediaRequestBody": {
"title": "Media Request Body",
"description": "",
@@ -41926,6 +44712,11 @@
"record_type"
]
},
+ "MediaUrl": {
+ "description": "The URL to the PDF used for the fax's media. media_url and media_name/contents can't be submitted together.",
+ "type": "string",
+ "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ },
"Message": {
"title": "Message",
"description": "",
@@ -42145,7 +44936,6 @@
"audio",
"contacts",
"document",
- "hsm",
"image",
"location",
"template",
@@ -42588,59 +45378,6 @@
}
}
},
- "MobileApplication": {
- "type": "object",
- "required": [
- "id",
- "application_name",
- "type",
- "record_type",
- "created_at",
- "updated_at"
- ],
- "properties": {
- "id": {
- "description": "ID of the appplication that was created",
- "type": "string",
- "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
- },
- "application_name": {
- "description": "Name of the appplication to be created",
- "type": "string",
- "example": "FlashEmergency"
- },
- "type": {
- "description": "Type of application to be created (IOS or Android)",
- "type": "string",
- "example": "android"
- },
- "record_type": {
- "type": "string",
- "example": "mobile_application",
- "readOnly": true
- },
- "created_at": {
- "description": "ISO 8601 timestamp when the room was created.",
- "type": "string",
- "format": "datetime",
- "example": "2021-03-26T17:51:59.588408Z"
- },
- "updated_at": {
- "description": "ISO 8601 timestamp when the room was updated.",
- "type": "string",
- "format": "datetime",
- "example": "2021-03-26T17:51:59.588408Z"
- }
- }
- },
- "MobileApplicationResponse": {
- "description": "Success response with details about a mobile application",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/MobileApplication"
- }
- }
- },
"MobileOperatorNetwork": {
"type": "object",
"title": "MobileOperatorNetwork",
@@ -42757,6 +45494,11 @@
}
}
},
+ "Monochrome": {
+ "description": "The flag to enable monochrome, true black and white fax results.",
+ "type": "boolean",
+ "default": false
+ },
"Name": {
"title": "Name",
"description": "Full contact name",
@@ -42792,6 +45534,75 @@
"last_name": "Smith"
}
},
+ "Network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Record"
+ },
+ {
+ "type": "object",
+ "title": "Network",
+ "properties": {
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "readOnly": true,
+ "example": "network"
+ },
+ "name": {
+ "type": "string",
+ "description": "A user specified name for the network.",
+ "example": "test network"
+ }
+ }
+ }
+ ]
+ },
+ "NetworkCreate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Network"
+ },
+ {
+ "type": "object",
+ "title": "NetworkCreate",
+ "required": [
+ "name"
+ ]
+ }
+ ]
+ },
+ "NetworkInterface": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Record"
+ },
+ {
+ "$ref": "#/components/schemas/Interface"
+ },
+ {
+ "$ref": "#/components/schemas/RegionOut"
+ },
+ {
+ "type": "object",
+ "title": "NetworkInterface",
+ "properties": {
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "readOnly": true,
+ "example": "network_interface"
+ },
+ "type": {
+ "type": "string",
+ "description": "Identifies the type of the interface.",
+ "readOnly": true,
+ "example": "wireguard_interface"
+ }
+ }
+ }
+ ]
+ },
"NewBillingGroup": {
"properties": {
"name": {
@@ -43683,6 +46494,11 @@
"title": "Manager"
}
},
+ "OriginalMediaUrl": {
+ "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted",
+ "type": "string",
+ "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+ },
"OutboundCallRecording": {
"type": "object",
"example": {
@@ -44357,6 +47173,24 @@
"format": "int64",
"example": "1293384261075731499"
},
+ "PWGAssignedResourcesSummary": {
+ "type": "object",
+ "description": "The summary of the resource that have been assigned to the Private Wireless Gateway",
+ "properties": {
+ "record_type": {
+ "type": "string",
+ "description": "The type of the resource assigned to the Private Wireless Gateway",
+ "example": "sim_card_group",
+ "readOnly": true
+ },
+ "count": {
+ "type": "integer",
+ "description": "The current count of a resource type assigned to the Private Wireless Gateway",
+ "example": 1,
+ "readOnly": true
+ }
+ }
+ },
"PaginationMeta": {
"type": "object",
"properties": {
@@ -45166,12 +48000,12 @@
},
"number_level_routing": {
"type": "string",
- "description": "Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level.",
+ "description": "Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to disabled or the value set on your user profile in default_number_routing_setting. There are performance advantages to using disabled and setting all routing information at the connection level.",
"enum": [
"enabled",
"disabled"
],
- "default": "enabled"
+ "default": "disabled"
},
"phone_number_type": {
"type": "string",
@@ -45337,12 +48171,12 @@
},
"number_level_routing": {
"type": "string",
- "description": "Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level.",
+ "description": "Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to disabled or the value set on your user profile in default_number_routing_setting. There are performance advantages to using disabled and setting all routing information at the connection level.",
"enum": [
"enabled",
"disabled"
],
- "default": "enabled"
+ "default": "disabled"
},
"phone_number_type": {
"type": "string",
@@ -45999,6 +48833,11 @@
"default": true,
"example": true
},
+ "playback_content": {
+ "description": "Allows a user to provide base64 encoded mp3. Note: when using this parameter, `media_url` and `media_name` in the `playback_started` and `playback_ended` webhooks will be empty",
+ "type": "string",
+ "example": "SUQzAwAAAAADf1..."
+ },
"client_state": {
"description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.",
"type": "string",
@@ -46249,6 +49088,11 @@
"example": "f1486bae-f067-460c-ad43-73a92848f902",
"readOnly": true
},
+ "customer_reference": {
+ "type": "string",
+ "description": "A customer-specified reference number for customer bookkeeping purposes",
+ "example": "Acct 123abc"
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -46305,6 +49149,19 @@
"phone_number_configuration": {
"$ref": "#/components/schemas/PortingOrderPhoneNumberConfiguration"
},
+ "phone_number_type": {
+ "type": "string",
+ "description": "The type of the phone number",
+ "example": "local",
+ "enum": [
+ "landline",
+ "local",
+ "mobile",
+ "national",
+ "shared_cost",
+ "toll_free"
+ ]
+ },
"description": {
"type": "string",
"description": "A description of the porting order",
@@ -46318,19 +49175,25 @@
"$ref": "#/components/schemas/PortingOrderRequirement"
}
},
+ "requirements_met": {
+ "type": "boolean",
+ "description": "Is true when the required documentation is met",
+ "example": false
+ },
"user_feedback": {
"$ref": "#/components/schemas/PortingOrderUserFeedback"
},
+ "user_id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Identifies the user (or organization) who requested the porting order",
+ "example": "40d68ba2-0847-4df2-be9c-b0e0cb673e75"
+ },
"webhook_url": {
"type": "string",
"format": "uri",
"example": "https://example.com/porting_webhooks"
},
- "user_reference": {
- "type": "string",
- "description": "A customer-specified reference number for customer bookkeeping purposes",
- "example": "Acct 123abc"
- },
"record_type": {
"type": "string",
"example": "porting_order",
@@ -46606,6 +49469,73 @@
}
}
},
+ "PortingOrderRequirementDetail": {
+ "type": "object",
+ "properties": {
+ "field_type": {
+ "type": "string",
+ "description": "Type of value expected on field_value field",
+ "enum": [
+ "document",
+ "textual"
+ ],
+ "example": "document"
+ },
+ "field_value": {
+ "type": "string",
+ "description": "Identifies the document that satisfies this requirement",
+ "example": "9787fb5f-cbe5-4de4-b765-3303774ee9fe"
+ },
+ "requirement_type": {
+ "type": "object",
+ "description": "Identifies the requirement type that meets this requirement",
+ "properties": {
+ "acceptance_criteria": {
+ "type": "object",
+ "description": "The acceptance criteria for the requirement type",
+ "example": {
+ "acceptable_values": []
+ }
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the requirement type",
+ "example": "A copy of the latest phone bill from the current provider"
+ },
+ "example": {
+ "type": "string",
+ "description": "An example of the requirement type",
+ "example": "Most recent phone bill"
+ },
+ "id": {
+ "type": "string",
+ "description": "Identifies the requirement type",
+ "example": "53970723-fbff-4f46-a975-f62be6c1a585"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the requirement type",
+ "example": "Latest Invoice"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the requirement type",
+ "example": "document"
+ }
+ }
+ },
+ "requirement_status": {
+ "type": "string",
+ "description": "Status of the requirement",
+ "example": "approved"
+ },
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "example": "porting_requirement"
+ }
+ }
+ },
"PortingOrderStatus": {
"type": "object",
"description": "Porting order status",
@@ -46951,11 +49881,68 @@
"+35312345678"
]
},
+ "authorized_name": {
+ "type": "string",
+ "description": "Name of person authorizing the porting order",
+ "example": "McPortersen"
+ },
"carrier_name": {
"type": "string",
"description": "Carrier the number will be ported out to",
"example": "test"
},
+ "current_carrier": {
+ "type": "string",
+ "description": "The current carrier",
+ "example": "telnyx"
+ },
+ "end_user_name": {
+ "type": "string",
+ "description": "Person name or company name requesting the port",
+ "example": "McPortersen"
+ },
+ "city": {
+ "type": "string",
+ "description": "City or municipality of billing address",
+ "example": "Chicago"
+ },
+ "state": {
+ "type": "string",
+ "description": "State, province, or similar of billing address",
+ "example": "IL"
+ },
+ "zip": {
+ "type": "string",
+ "description": "Postal Code of billing address",
+ "example": "00000"
+ },
+ "lsr": {
+ "type": "array",
+ "description": "The Local Service Request",
+ "items": {
+ "type": "string",
+ "format": "uri",
+ "description": "A link to the Local Service Request"
+ },
+ "example": [
+ "https://example.com/files/lsr.pdf"
+ ]
+ },
+ "pon": {
+ "type": "string",
+ "description": "Port order number assigned by the carrier the number will be ported out to",
+ "example": "00000000"
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason why the order is being rejected by the user. If the order is authorized, this field can be left null",
+ "example": null
+ },
+ "service_address": {
+ "type": "string",
+ "description": "First line of billing address (street address)",
+ "example": "000 Example Street"
+ },
"foc_date": {
"type": "string",
"description": "ISO 8601 formatted Date/Time of the FOC date",
@@ -46971,6 +49958,11 @@
"description": "New service provider spid",
"example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
},
+ "support_key": {
+ "type": "string",
+ "description": "A key to reference this port out request when contacting Telnyx customer support",
+ "example": "PO_764725"
+ },
"status": {
"type": "string",
"description": "Status of portout request",
@@ -46984,30 +49976,38 @@
],
"example": "rejected"
},
+ "already_ported": {
+ "type": "boolean",
+ "description": "Is true when the number is already ported",
+ "example": false
+ },
+ "user_id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Identifies the user (or organization) who requested the port out",
+ "example": "7865816a-ee85-4e50-b19e-52983dcc6d4a"
+ },
+ "vendor": {
+ "type": "string",
+ "description": "Telnyx partner providing network coverage",
+ "format": "uuid",
+ "example": "0e66ed3b-37e6-4fed-93d6-a30ce2493661"
+ },
"created_at": {
"type": "string",
"description": "ISO 8601 formatted date of when the portout was created",
"example": "2018-02-02T22:25:27.521Z"
},
+ "inserted_at": {
+ "type": "string",
+ "description": "ISO 8601 formatted date of when the portout was created",
+ "example": "2018-02-02T22:25:27.521Z"
+ },
"updated_at": {
"type": "string",
"description": "ISO 8601 formatted date of when the portout was last updated",
"example": "2018-02-02T22:25:27.521Z"
}
- },
- "example": {
- "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "record_type": "portout",
- "phone_numbers": [
- "+35312345678"
- ],
- "carrier_name": "test",
- "foc_date": "2018-02-02T22:25:27.521Z",
- "requested_foc_date": "2018-02-02T22:25:27.521Z",
- "spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
- "status": "pending",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z"
}
},
"PrivateWirelessGateway": {
@@ -47063,6 +50063,13 @@
"example": "100.64.1.0/24",
"readOnly": true,
"default": null
+ },
+ "assigned_resources": {
+ "type": "array",
+ "description": "A list of the resources that have been assigned to the Private Wireless Gateway",
+ "items": {
+ "$ref": "#/components/schemas/PWGAssignedResourcesSummary"
+ }
}
}
},
@@ -47119,6 +50126,62 @@
}
}
},
+ "PublicInternetGateway": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Record"
+ },
+ {
+ "$ref": "#/components/schemas/Interface"
+ },
+ {
+ "type": "object",
+ "title": "PublicInternetGateway",
+ "properties": {
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "readOnly": true,
+ "example": "public_internet_gateway"
+ },
+ "public_ip": {
+ "description": "The publically accessible ip for this interface.",
+ "type": "string",
+ "example": "127.0.0.1",
+ "readOnly": true
+ }
+ }
+ }
+ ]
+ },
+ "PublicInternetGatewayCreate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PublicInternetGateway"
+ },
+ {
+ "$ref": "#/components/schemas/RegionIn"
+ },
+ {
+ "type": "object",
+ "title": "PublicInternetGatewayCreate",
+ "required": [
+ "network_id",
+ "region"
+ ]
+ }
+ ]
+ },
+ "PublicInternetGatewayRead": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PublicInternetGateway"
+ },
+ {
+ "$ref": "#/components/schemas/RegionOut"
+ }
+ ]
+ },
"PushCredential": {
"type": "object",
"title": "Successful response with details about a push credential",
@@ -47128,6 +50191,7 @@
"private_key",
"server_key",
"alias",
+ "type",
"record_type",
"created_at",
"updated_at"
@@ -47139,25 +50203,30 @@
"example": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7"
},
"certificate": {
- "description": "Apple certificate for sending push notifications",
+ "description": "Apple certificate for sending push notifications. For iOS only",
"type": "string",
- "example": "Bag Attributes\n friendlyName: VoIP Services: com.telnyx.webrtcapp\n localKeyID: AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA\nsubject=/UID=com.telnyx.webrtcapp.voip/CN=VoIP Services: com.telnyx.webrtcapp/OU=YKUVNPU9FS/O=Telnyx LLC/C=US\nissuer=/C=US/O=Apple Inc./OU=Apple Worldwide Developer Relations/CN=Apple Worldwide Developer Relations Certification Authority\n-----BEGIN CERTIFICATE-----\nMIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ\nDbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H\nFsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM\nUNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcH6HpirBQkrjJkak\nqqk5bC8Ye2PIcY0+nVFNWCoQqJadGduy1kHFmEsvkmaemfQdRIwn9q5lpNUnMSo3\no6Cx0igYEHryauzg2hv14ylyvoCBxPOvl95NO86s9XS0CB2Qq6t9V59qkJiCPgKt\nhRtU70gavh5L0K/FPEO2FnjaNa/2kVeU8LWgqxH8dhIl/QQSipS49PDQR7DIJUWQ\ncakwR34j97t6UTxz7Yx05uUhjlcB4+hq2+RLA6LOOEcGnpECAwEAAaOCAqgwggKk\nMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUiCcXCam2GGCL7Ou69kdZxVJUo7cw\nPwYIKwYBBQUHAQEEMzAxMC8GCCsGAQUFBzABhiNodHRwOi8vb2NzcC5hcHBsZS5j\nb20vb2NzcDAzLXd3ZHIwMTCCAR0GA1UdIASCARQwggEQMIIBDAbWVudHMuMDYGCC\nDRHGx1ngGt7fn3aobpf0CL+k8F1CcwkL8GZaAf3Pe6nxxWaTyaIU/LoBd8OU4aHq\ndGacHGp5tlgli8WhXNJuvHFmNnm0prQUeWjfTrHvAV2fEYJKoZIhvdjZAUBGAQUF\nMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNh\ndGUgYnkgYW55IHaiZDeWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhaiZDeaiZDeaiZD\nIsit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P\n5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5\ndnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3\nrpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9\nvG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjkknqoojqpiu109\nCfO37+af5amMDmgKHLWYqpIuF856urhODCRuprjCYwkyHX+cDbuB7E6BKjtyUCRx\ncHBsaWNhYmxlIHN0OIIJDKDAU094NOJujfoLmFwcGxlLmNvbS99w0BAQsFAAOCAQ\nY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0\nYXRlpX2LTQJsyzUjVKmbCjyATg5Y4QCqgDzrYUOBjL79dJzGwPKNQYG8YW5kYXJk\nLLuJX3jda0o393hnz03nz0jdah+m30lcS/iZkGAutno3MPd0EU9q3HyjyE0MjpHj\n/xXNgBL6zty06oXzUF+wXy1yNhUfouDLA3Yhv/uAbxN0NDart5s4kT/E3AAKIX3d\nBPYcCd3ran8CHgFW+dt3AIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwg==\n-----END CERTIFICATE-----\n"
+ "example": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----"
},
"private_key": {
- "description": "Apple private key for a given certificate for sending push notifications",
+ "description": "Apple private key for a given certificate for sending push notifications. For iOS only",
"type": "string",
- "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czspJg4tZZ7NpSCGdeeUo8Vjw4MdZ\nDbQacxmVkK5FJ28G8rDAokPKsYAtDpgCpcza/sLteg/R/JMyMPkyTzzFGplpZe6H\nFsVCQTiFknRYwhNQhz4Q4GkXMkxCPUnMgrQwrDYcxwk4A05vnS1c7ogMGDJErElM\nUNFPJyUc58wwlqVYCTvqPv33odv1rGdWtqY9sGXQAaoscXdWcw6HpirBQkrjJkak\nqqk5bC8Ye2PIcY0+nVFNWCoQqxuFc9/xYtCzPhd7SLfj+sDp4ZU1u18WYAoD5E3u\nIsit2Bn6jXtow1YtMY7wjIcIq3f6Z04/DIe14wIDAQABAoIBAQCQHHcYowHSTm1P\n5v0wL/Um+gbP8BUqATSQ9/uYolor2htoQGpcVWCcXMPZg3mM+dfCmrBPSkj5Pgb5\ndnvp2ja3Fedo6U1nshdbeyY5Fb9UvqD51Fc3AgXMmh+WycKuXAjqPHSKOnkRnrz3\nrpS+CdID85CdzPBdGWSww4+QPUMFz03cyttsIbEL46dR0ikRyRwRUejRTNS8I5+9\nvG4J2/d40ejk9cWEB21lXqOv2qa3KYSkXgIbFq4BBIajGKmixjk+pMugWkBGwJ9r\nB8AfqXwV4qalv7/DPVj72OtBi79oiOltNsHWp4cChGkp8FxEaMhy5d6tT7lz/jY2\nZgu2Jz2pAoGBANuey3lj6dgTPc7ZDgcUKVz96aC1dDzrqBRKrIPsodFTVUSdiZP4\n3TLrD4niE0+yVD/9YvohdIlczWEQwvTy4feBcubkbKeU0LiAaAILfY1x/2twPuvG\nwfYU1uVpxUxYcKvrCxHVEBbw8iuf6PABaROZItM2MMrJy+sWf9SQ2rwdAoGBAM4k\nwsJSER7NNGw08L1QhmSYqNzxZtd2sOqJJXny32zOOW4c2UUbdqoXmfAgPceeAec0\ncE1W0SOzi06aNSjI1LQf5mKN4nFIt1Nw19zl9/YDZgbNkysuwsSlBQhZz+TwembC\n3icGC8dLMLTpZPrXZ+bsmbj5QO5B0DY8hgXpzZn/AoGASr1Eo6AD8bvCmgU2B+St\nmu7yNfXqg9zyy00KXq8F9rW0W/B85HWZ2X0zQYpFZibbExfJOjRuc1y4rCLHJhMO\nIWvVTYxJCdLUISXZv3Bnnt4/vTFqyFRQp805wML5GN00It2PW9c1bYk78OqvnBXu\ny3Oe7WAQxMJd+jgi8pUFS2UCgYEAnr92cDjM0GCMn0vBnLi3Vh6t47/PR9wyb9r/\nzkK3xk2lsmNq+iolHuWf+WiKyv+mTYt3dEeINSsd+4ELsQW/r5rlSz4ihMTP0OUU\nhxtd8ck6N8D2NYoEGXVPQ9gOHisGx74HYBvq1CXWM2uNBRL/A7luxCDG3PQ3yJyh\nRUqAt7cCgYEAmp5WdnTZJxkYFwaQ/MYebU4KAMMsvGoMkF+x7MJuB/0oXdpJnMyV\nQOwLXF/NZrWCyEqstGRN+rSKJXF/slD4wgAZBjfRkXMeYcsCEEPXQLLnj8SF5QIv\n8+rvyN9fX+MnxRY9PqCXRaXRl7G/3ORxbPRPsefQAsDQ5NsN5lay2l4=\n-----END RSA PRIVATE KEY-----"
+ "example": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----"
},
"server_key": {
- "description": "Google server key for sending push notifications",
+ "description": "Google server key for sending push notifications. For Android only",
"type": "string",
- "example": "BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja9L8B1FrxJbc1z2btoiFYkda9Simkkda_0SJNidSan9-jkda-nieD3js9SdhfazonSbLN5VXQDqXFRuPW4kdo_fdnaxdai3y9z9DKXie0"
+ "example": ""
},
"alias": {
"description": "Alias to uniquely identify a credential",
"type": "string",
"example": "LucyCredential"
},
+ "type": {
+ "description": "Type of mobile push credential. Either ios or android",
+ "type": "string",
+ "example": "ios"
+ },
"record_type": {
"type": "string",
"example": "push_credential",
@@ -47177,13 +50246,11 @@
}
}
},
- "PushCredentialResponse": {
- "description": "Success response with details about a push credential",
- "properties": {
- "data": {
- "$ref": "#/components/schemas/PushCredential"
- }
- }
+ "Quality": {
+ "description": "The quality of the fax. Can be normal, high, very_high",
+ "type": "string",
+ "example": "high",
+ "default": "high"
},
"Queue": {
"type": "object",
@@ -47362,6 +50429,36 @@
}
]
},
+ "Record": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Identifies the resource.",
+ "readOnly": true,
+ "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
+ },
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "readOnly": true,
+ "example": "sample_record_type"
+ },
+ "created_at": {
+ "type": "string",
+ "description": "ISO 8601 formatted date-time indicating when the resource was created.",
+ "readOnly": true,
+ "example": "2018-02-02T22:25:27.521Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "description": "ISO 8601 formatted date-time indicating when the resource was updated.",
+ "readOnly": true,
+ "example": "2018-02-02T22:25:27.521Z"
+ }
+ }
+ },
"RecordType": {
"type": "string",
"description": "Identifies record type.",
@@ -47783,6 +50880,58 @@
"refresh_token"
]
},
+ "Region": {
+ "type": "object",
+ "title": "Region",
+ "properties": {
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "readOnly": true,
+ "example": "region"
+ },
+ "code": {
+ "type": "string",
+ "description": "A code for the region.",
+ "example": "ashburn-va"
+ },
+ "name": {
+ "type": "string",
+ "description": "A name for the region.",
+ "example": "Ashburn"
+ },
+ "supported_interfaces": {
+ "type": "array",
+ "description": "List of interface types supported in this region.",
+ "items": {
+ "type": "string",
+ "example": "wireguard_interface"
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "description": "ISO 8601 formatted date-time indicating when the resource was created.",
+ "readOnly": true,
+ "example": "2018-02-02T22:25:27.521Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "description": "ISO 8601 formatted date-time indicating when the resource was updated.",
+ "readOnly": true,
+ "example": "2018-02-02T22:25:27.521Z"
+ }
+ }
+ },
+ "RegionIn": {
+ "type": "object",
+ "properties": {
+ "region_code": {
+ "description": "The region the interface should be deployed to.",
+ "type": "string",
+ "example": "ashburn-va"
+ }
+ }
+ },
"RegionInformation": {
"properties": {
"region_type": {
@@ -47805,6 +50954,37 @@
"region_name": "US"
}
},
+ "RegionOut": {
+ "type": "object",
+ "properties": {
+ "region_code": {
+ "description": "The region interface is deployed to.",
+ "type": "string",
+ "example": "ashburn-va"
+ },
+ "region": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Region code of the interface.",
+ "type": "string",
+ "example": "ashburn-va"
+ },
+ "name": {
+ "description": "Region name of the interface.",
+ "type": "string",
+ "example": "Ashburn"
+ },
+ "record_type": {
+ "type": "string",
+ "description": "Identifies the type of the resource.",
+ "readOnly": true,
+ "example": "region"
+ }
+ }
+ }
+ }
+ },
"RegisterCallRequest": {
"type": "object",
"title": "RegisterCallRequest",
@@ -48708,6 +51888,26 @@
}
}
},
+ "authorized_imeis": {
+ "type": "array",
+ "description": "List of IMEIs authorized to use a given SIM card.",
+ "items": {
+ "type": "string",
+ "format": "int64"
+ },
+ "example": [
+ "106516771852751",
+ "534051870479563",
+ "508821468377961"
+ ]
+ },
+ "current_imei": {
+ "type": "string",
+ "format": "int64",
+ "description": "IMEI of the device where a given SIM card is currently being used.",
+ "readOnly": true,
+ "example": "457032284023794"
+ },
"created_at": {
"type": "string",
"description": "ISO 8601 formatted date-time indicating when the resource was created.",
@@ -48769,6 +51969,17 @@
"readOnly": true,
"description": "Mobile Country Code of the current network to which the SIM card is connected. It's a three decimal digit that identifies a country.| 422 | Bad request | - |
| 422 | Bad request | - |
| 422 | Bad request | - |
| 422 | Bad request | - |
| 404 | Resource not found | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| 422 | Bad request | - |
| 422 | Bad request | - |
| 422 | Bad request | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a call control command. | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a call control command. | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a call control command. | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a call control command. | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a call control command. | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a call control command. | - |
| 0 | Unexpected error | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a call control application. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a call control application. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a call control application. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a call control application. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a call control application. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a call control application. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Resource not found | - |
| 422 | Bad request | - |
| 0 | Unexpected error | - |
| 200 | A list of channel zones | - |
| 200 | A list of channel zones | - |
| 200 | A list of phone numbers | - |
| 200 | A list of phone numbers | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response upon making a conference command. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a conference. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a conference. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with a list of conference participants. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with a list of conference participants. | - |
| 401 | Unauthorized | - |
| 404 | Conference does not exist | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 404 | Fax does not exist | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with a list of conferences. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with a list of conferences. | - |
| 401 | Unauthorized | - |
| 401 | Unauthorized response. Happens when the current user is not a manager account. | - |
| 422 | Unprocessable entity | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a conference. | - |
| 404 | Conference does not exist | - |
| 404 | Fax does not exist | - |
| Status Code | Description | Response Headers |
| 200 | Successful response with details about a conference. | - |
| 404 | Conference does not exist | - |
| 404 | Fax does not exist | - |
| Status Code | Description | Response Headers |
| 201 | Successful Response | - |
| 401 | The required authentication headers were either invalid or not included in the request. | - |
| 403 | You do not have permission to perform the requested action on the specified resource or resources. | - |
| 422 | Unprocessable entity. Check the 'detail' field in response for details. | - |
| 500 | An unexpected error occurred. | - |
| Status Code | Description | Response Headers |
| 201 | Successful Response | - |
| 401 | The required authentication headers were either invalid or not included in the request. | - |
| 403 | You do not have permission to perform the requested action on the specified resource or resources. | - |
| 422 | Unprocessable entity. Check the 'detail' field in response for details. | - |
| 500 | An unexpected error occurred. | - |
| 500 | An unexpected error occurred. | - |
| 500 | An unexpected error occurred. | - |
| Status Code | Description | Response Headers |
| 200 | Successful Response | - |
| 401 | The required authentication headers were either invalid or not included in the request. | - |
| 403 | You do not have permission to perform the requested action on the specified resource or resources. | - |
| 422 | Unprocessable entity. Check the 'detail' field in response for details. | - |
| 500 | An unexpected error occurred. | - |
| Status Code | Description | Response Headers |
| 200 | Successful Response | - |
| 401 | The required authentication headers were either invalid or not included in the request. | - |
| 403 | You do not have permission to perform the requested action on the specified resource or resources. | - |
| 422 | Unprocessable entity. Check the 'detail' field in response for details. | - |
| 500 | An unexpected error occurred. | - |