freeclimb 4.9.0 → 5.0.0

data/docs/RecordWebhook.md

@@ -0,0 +1,50 @@
+# Freeclimb::RecordWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | The context or reason why this request is being made. Will be record - The RecordUtterance command has completed and its actionUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
+| **recording_id** | **String** | ID of the recording. | [optional] |
+| **recording_url** | **String** | URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download a recording file via the REST API. | [optional] |
+| **recording_size** | **String** | Size of the recording in bytes | [optional] |
+| **recording_format** | **String** | File type of the recording (audio/wav) | [optional] |
+| **recording_duration_sec** | **Integer** | Duration of the recorded audio rounded up to the nearest second (in seconds) | [optional] |
+| **term_reason** | [**RecordUtteranceTermReason**](RecordUtteranceTermReason.md) |  | [optional] |
+| **parent_call_id** | **String** | ID of Call that created this leg (child call). | [optional] |
+| **privacy_mode** | **Boolean** | If true then it indicates the recording will only be available for download for two minutes prior to it being deleted. This is to minimize risk of anyone else getting access to the url and attempting to access it. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RecordWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  recording_id: null,
+  recording_url: null,
+  recording_size: null,
+  recording_format: null,
+  recording_duration_sec: null,
+  term_reason: null,
+  parent_call_id: null,
+  privacy_mode: null
+)
+```
+

data/docs/RedirectWebhook.md

@@ -0,0 +1,36 @@
+# Freeclimb::RedirectWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be redirect - The Redirect command is executing and its actionUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
+| **parent_call_id** | **String** | ID of Call that created this leg (child call). | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RedirectWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  parent_call_id: null
+)
+```
+

data/docs/RemoveFromQueueNotificationWebhook.md

@@ -0,0 +1,38 @@
+# Freeclimb::RemoveFromQueueNotificationWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be removeFromQueueNotification - A Call has been removed from a Queue and the Enqueue command’s actionUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
+| **queue_result** | [**QueueResultStatus**](QueueResultStatus.md) |  | [optional] |
+| **queue_time** | **Integer** | Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RemoveFromQueueNotificationWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  queue_result: null,
+  queue_time: null
+)
+```
+

data/docs/SMSTenDLCBrand.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **account_id** | **String** | ID of the account that created this Queue. | [optional] |
-| **entity_type** | **String** | Entity type behind the brand. This is the form of business establishment. |  |
+| **entity_type** | [**SMSTenDLCBrandEntityType**](SMSTenDLCBrandEntityType.md) |  |  |
 | **csp_id** | **String** | Unique identifier assigned to the csp by the registry. | [optional][readonly] |
 | **brand_id** | **String** | Unique identifier assigned to the brand by the registry. | [optional][readonly] |
 | **first_name** | **String** | First or given name.  | [optional] |
@@ -22,18 +22,18 @@
 | **country** | **String** | ISO2 2 characters country code. Example: US - United States |  |
 | **email** | **String** | Valid email address of brand support contact. |  |
 | **stock_symbol** | **String** | (Required for public company) stock symbol. | [optional] |
-| **stock_exchange** | **String** | (Required for public company) stock exchange. | [optional] |
+| **stock_exchange** | [**SMSTenDLCBrandStockExchange**](SMSTenDLCBrandStockExchange.md) |  | [optional] |
 | **ip_address** | **String** | IP address of the browser requesting to create brand identity. | [optional] |
 | **website** | **String** | Brand website URL. | [optional] |
-| **brand_relationship** | **String** | Brand relationship to the CSP |  |
+| **brand_relationship** | [**SMSTenDLCBrandRelationship**](SMSTenDLCBrandRelationship.md) |  |  |
 | **vertical** | **String** | Vertical or industry segment of the brand. |  |
 | **alt_business_id** | **String** | Alternate business identifier such as DUNS, LEI, or GIIN | [optional] |
-| **alt_business_id_type** | **String** | The type of the Alternative business identifier | [optional] |
+| **alt_business_id_type** | [**SMSTenDLCBrandAltBusinessIdType**](SMSTenDLCBrandAltBusinessIdType.md) |  | [optional] |
 | **universal_ein** | **String** | Universal EIN of Brand, Read Only. | [optional][readonly] |
 | **reference_id** | **String** | Caller supplied brand reference ID. If supplied, the value must be unique across all submitted brands. Can be used to prevent duplicate brand registrations. | [optional] |
 | **optional_attributes** | **Hash<String, Object>** | Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names. | [optional] |
 | **mock** | **Boolean** | Test brand. |  |
-| **identity_status** | **String** | TCR assessment of the brand identification status. |  |
+| **identity_status** | [**SMSTenDLCBrandIdentityStatus**](SMSTenDLCBrandIdentityStatus.md) |  |  |
 | **create_date** | **Time** | Unix timestamp when brand was created. | [optional] |
 
 ## Example
@@ -60,7 +60,7 @@ instance = Freeclimb::SMSTenDLCBrand.new(
   country: US,
   email: null,
   stock_symbol: ABC,
-  stock_exchange: NASDAQ,
+  stock_exchange: null,
   ip_address: null,
   website: http://www.abcmobile.com,
   brand_relationship: null,

data/docs/SMSTenDLCBrandAltBusinessIdType.md

@@ -0,0 +1,19 @@
+# Freeclimb::SMSTenDLCBrandAltBusinessIdType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **NONE** | **SMSTenDLCBrandAltBusinessIdType** |  | Represented in Ruby as "NONE" |
+| **DUNS** | **SMSTenDLCBrandAltBusinessIdType** |  | Represented in Ruby as "DUNS" |
+| **GIIN** | **SMSTenDLCBrandAltBusinessIdType** |  | Represented in Ruby as "GIIN" |
+| **LEI** | **SMSTenDLCBrandAltBusinessIdType** |  | Represented in Ruby as "LEI" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCBrandAltBusinessIdType::[NAME OF ENUM]
+```
+

data/docs/SMSTenDLCBrandEntityType.md

@@ -0,0 +1,20 @@
+# Freeclimb::SMSTenDLCBrandEntityType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **PRIVATE_PROFIT** | **SMSTenDLCBrandEntityType** |  | Represented in Ruby as "PRIVATE_PROFIT" |
+| **PUBLIC_PROFIT** | **SMSTenDLCBrandEntityType** |  | Represented in Ruby as "PUBLIC_PROFIT" |
+| **NON_PROFIT** | **SMSTenDLCBrandEntityType** |  | Represented in Ruby as "NON_PROFIT" |
+| **GOVERNMENT** | **SMSTenDLCBrandEntityType** |  | Represented in Ruby as "GOVERNMENT" |
+| **SOLE_PROPRIETOR** | **SMSTenDLCBrandEntityType** |  | Represented in Ruby as "SOLE_PROPRIETOR" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCBrandEntityType::[NAME OF ENUM]
+```
+

data/docs/SMSTenDLCBrandIdentityStatus.md

@@ -0,0 +1,19 @@
+# Freeclimb::SMSTenDLCBrandIdentityStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **SELF_DECLARED** | **SMSTenDLCBrandIdentityStatus** |  | Represented in Ruby as "SELF_DECLARED" |
+| **UNVERIFIED** | **SMSTenDLCBrandIdentityStatus** |  | Represented in Ruby as "UNVERIFIED" |
+| **VERIFIED** | **SMSTenDLCBrandIdentityStatus** |  | Represented in Ruby as "VERIFIED" |
+| **VETTED_VERIFIED** | **SMSTenDLCBrandIdentityStatus** |  | Represented in Ruby as "VETTED_VERIFIED" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCBrandIdentityStatus::[NAME OF ENUM]
+```
+

data/docs/SMSTenDLCBrandRelationship.md

@@ -0,0 +1,20 @@
+# Freeclimb::SMSTenDLCBrandRelationship
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **BASIC_ACCOUNT** | **SMSTenDLCBrandRelationship** |  | Represented in Ruby as "BASIC_ACCOUNT" |
+| **SMALL_ACCOUNT** | **SMSTenDLCBrandRelationship** |  | Represented in Ruby as "SMALL_ACCOUNT" |
+| **MEDIUM_ACCOUNT** | **SMSTenDLCBrandRelationship** |  | Represented in Ruby as "MEDIUM_ACCOUNT" |
+| **LARGE_ACCOUNT** | **SMSTenDLCBrandRelationship** |  | Represented in Ruby as "LARGE_ACCOUNT" |
+| **KEY_ACCOUNT** | **SMSTenDLCBrandRelationship** |  | Represented in Ruby as "KEY_ACCOUNT" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCBrandRelationship::[NAME OF ENUM]
+```
+

data/docs/SMSTenDLCBrandStockExchange.md

@@ -0,0 +1,42 @@
+# Freeclimb::SMSTenDLCBrandStockExchange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **NONE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "NONE" |
+| **NASDAQ** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "NASDAQ" |
+| **NYSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "NYSE" |
+| **AMEX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "AMEX" |
+| **AMX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "AMX" |
+| **ASX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "ASX" |
+| **B3** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "B3" |
+| **BME** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "BME" |
+| **BSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "BSE" |
+| **FRA** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "FRA" |
+| **ICEX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "ICEX" |
+| **JPX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "JPX" |
+| **JSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "JSE" |
+| **KRX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "KRX" |
+| **LON** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "LON" |
+| **NSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "NSE" |
+| **OMX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "OMX" |
+| **SEHK** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "SEHK" |
+| **SGX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "SGX" |
+| **SSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "SSE" |
+| **STO** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "STO" |
+| **SWX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "SWX" |
+| **SZSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "SZSE" |
+| **TSX** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "TSX" |
+| **TWSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "TWSE" |
+| **VSE** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "VSE" |
+| **OTHER** | **SMSTenDLCBrandStockExchange** |  | Represented in Ruby as "OTHER" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCBrandStockExchange::[NAME OF ENUM]
+```
+

data/docs/SMSTenDLCCampaign.md

@@ -8,7 +8,7 @@
 | **campaign_id** | **String** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. |  |
 | **csp_id** | **String** | Alphanumeric identifier of the CSP associated with this campaign. |  |
 | **reseller_id** | **String** | Alphanumeric identifier of the reseller that you want to associate with this campaign. | [optional] |
-| **status** | **String** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.  | [optional] |
+| **status** | [**SMSTenDLCCampaignStatus**](SMSTenDLCCampaignStatus.md) |  | [optional] |
 | **create_date** | **Time** | Unix timestamp when campaign was created. | [optional] |
 | **auto_renewal** | **Boolean** | Campaign subscription auto-renewal status. | [optional] |
 | **billed_date** | **Time** | Campaign recent billed date. | [optional] |

data/docs/SMSTenDLCCampaignStatus.md

@@ -0,0 +1,17 @@
+# Freeclimb::SMSTenDLCCampaignStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ACTIVE** | **SMSTenDLCCampaignStatus** |  | Represented in Ruby as "ACTIVE" |
+| **EXPIRED** | **SMSTenDLCCampaignStatus** |  | Represented in Ruby as "EXPIRED" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCCampaignStatus::[NAME OF ENUM]
+```
+

data/docs/SMSTenDLCPartnerCampaign.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **account_id** | **String** | ID of the account that created this Queue. | [optional] |
 | **campaign_id** | **String** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. |  |
-| **status** | **String** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.  | [optional] |
+| **status** | [**SMSTenDLCPartnerCampaignStatus**](SMSTenDLCPartnerCampaignStatus.md) |  | [optional] |
 | **create_date** | **Time** | Unix timestamp when campaign was created. | [optional] |
 | **brand_id** | **String** | Alphanumeric identifier of the brand associated with this campaign. |  |
 | **usecase** | **String** | Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. |  |

data/docs/SMSTenDLCPartnerCampaignStatus.md

@@ -0,0 +1,17 @@
+# Freeclimb::SMSTenDLCPartnerCampaignStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ACTIVE** | **SMSTenDLCPartnerCampaignStatus** |  | Represented in Ruby as "ACTIVE" |
+| **EXPIRED** | **SMSTenDLCPartnerCampaignStatus** |  | Represented in Ruby as "EXPIRED" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCPartnerCampaignStatus::[NAME OF ENUM]
+```
+

data/docs/SMSTollFreeCampaign.md

@@ -7,7 +7,7 @@
 | **account_id** | **String** | ID of the account that created this toll-free campaign |  |
 | **campaign_id** | **String** | Alphanumeric identifier used by the platform to identify this toll-free campaign |  |
 | **use_case** | **String** |  |  |
-| **registration_status** | **String** | Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status.  |  |
+| **registration_status** | [**SMSTollFreeCampaignRegistrationStatus**](SMSTollFreeCampaignRegistrationStatus.md) |  |  |
 | **date_created** | **String** |  |  |
 | **date_updated** | **String** |  |  |
 | **revision** | **Integer** |  |  |

data/docs/SMSTollFreeCampaignRegistrationStatus.md

@@ -0,0 +1,20 @@
+# Freeclimb::SMSTollFreeCampaignRegistrationStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **UNREGISTERED** | **SMSTollFreeCampaignRegistrationStatus** |  | Represented in Ruby as "UNREGISTERED" |
+| **INITIATED** | **SMSTollFreeCampaignRegistrationStatus** |  | Represented in Ruby as "INITIATED" |
+| **PENDING** | **SMSTollFreeCampaignRegistrationStatus** |  | Represented in Ruby as "PENDING" |
+| **DECLINED** | **SMSTollFreeCampaignRegistrationStatus** |  | Represented in Ruby as "DECLINED" |
+| **REGISTERED** | **SMSTollFreeCampaignRegistrationStatus** |  | Represented in Ruby as "REGISTERED" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTollFreeCampaignRegistrationStatus::[NAME OF ENUM]
+```
+

data/docs/TranscribeReason.md

@@ -0,0 +1,20 @@
+# Freeclimb::TranscribeReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **INTERNAL_ERROR** | **TranscribeReason** |  | Represented in Ruby as "internalError" |
+| **HANGUP** | **TranscribeReason** |  | Represented in Ruby as "hangup" |
+| **MAX_LENGTH** | **TranscribeReason** |  | Represented in Ruby as "maxLength" |
+| **DIGIT** | **TranscribeReason** |  | Represented in Ruby as "digit" |
+| **NO_INPUT** | **TranscribeReason** |  | Represented in Ruby as "noInput" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TranscribeReason::[NAME OF ENUM]
+```
+

data/docs/TranscribeTermReason.md

@@ -0,0 +1,17 @@
+# Freeclimb::TranscribeTermReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ERROR** | **TranscribeTermReason** |  | Represented in Ruby as "error" |
+| **COMPLETED** | **TranscribeTermReason** |  | Represented in Ruby as "completed" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TranscribeTermReason::[NAME OF ENUM]
+```
+

data/docs/TranscribeUtterance.md

@@ -6,10 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **action_url** | **String** |  |  |
 | **play_beep** | **Boolean** |  | [optional][default to false] |
-| **record** | [**TranscribeUtteranceAllOfRecord**](TranscribeUtteranceAllOfRecord.md) |  | [optional] |
+| **record** | [**TranscribeUtteranceRecord**](TranscribeUtteranceRecord.md) |  | [optional] |
 | **privacy_for_logging** | **Boolean** |  | [optional][default to false] |
 | **privacy_for_recording** | **Boolean** |  | [optional][default to false] |
-| **prompts** | **Array<Object>** |  | [optional] |
+| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) |  | [optional] |
 
 ## Example
 

data/docs/TranscribeWebhook.md

@@ -0,0 +1,62 @@
+# Freeclimb::TranscribeWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | The context or reason why this request is being made. Will be transcribe - The TranscribeUtterance command has completed and its actionUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
+| **recording_id** | **String** | The ID of the recording. If no recording was made due to errors or the 'saveRecording' flag being disabled this field will be set to null. | [optional] |
+| **recording_url** | **String** | The URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download the recording file via the REST API. | [optional] |
+| **recording_size** | **Integer** | The size of the recording in bytes. | [optional] |
+| **recording_format** | **String** | The media type of the recording. | [optional] |
+| **recording_duration_ms** | **Integer** | The duration of the recorded audio in milliseconds. | [optional] |
+| **term_reason** | [**TranscribeTermReason**](TranscribeTermReason.md) |  | [optional] |
+| **record_term_reason** | [**RecordUtteranceTermReason**](RecordUtteranceTermReason.md) |  | [optional] |
+| **digit** | **String** | If recordTermReason is digit, this will be the digit that was pressed. Otherwise it will be null. | [optional] |
+| **privacy_for_logging** | **Boolean** | Echo back of the privacyForLogging flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request. | [optional] |
+| **privacy_for_recording** | **Boolean** | Echo back of the privacyForRecording flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request. | [optional] |
+| **barge_in_reason** | [**BargeInReason**](BargeInReason.md) |  | [optional] |
+| **barged_in_prompt_no** | **Integer** |  | [optional] |
+| **barged_in_prompt_ms** | **Integer** | duration in ms bargedInPromptNo prompt was executing until barge-in occurred. | [optional] |
+| **barged_in_prompt_loop_no** | **Integer** |  | [optional] |
+| **barge_in_time_ms** | **Integer** | epoch time in ms | [optional] |
+| **transcript** | **String** | Transcribed text of the recording. Can be empty or null. null means there was a failure in transcribing the audio, refer to transcribeReason for detailed failure reason. | [optional] |
+| **transcribe_reason** | [**TranscribeReason**](TranscribeReason.md) |  | [optional] |
+| **transcription_duration_ms** | **Integer** | The duration of the audio being transcribed in milliseconds | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TranscribeWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  recording_id: null,
+  recording_url: null,
+  recording_size: null,
+  recording_format: null,
+  recording_duration_ms: null,
+  term_reason: null,
+  record_term_reason: null,
+  digit: null,
+  privacy_for_logging: null,
+  privacy_for_recording: null,
+  barge_in_reason: null,
+  barged_in_prompt_no: null,
+  barged_in_prompt_ms: null,
+  barged_in_prompt_loop_no: null,
+  barge_in_time_ms: null,
+  transcript: null,
+  transcribe_reason: null,
+  transcription_duration_ms: null
+)
+```
+

data/docs/UpdateConferenceRequest.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **_alias** | **String** | Description for this conference. Maximum 64 characters. | [optional] |
-| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional][default to 'always'] |
+| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional] |
 | **status** | [**UpdateConferenceRequestStatus**](UpdateConferenceRequestStatus.md) |  | [optional] |
 
 ## Example

data/docs/Webhook.md

@@ -0,0 +1,18 @@
+# Freeclimb::Webhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Type of webhook request | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Webhook.new(
+  request_type: null
+)
+```
+

data/freeclimb.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: support@freeclimb.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+OpenAPI Generator version: 7.9.0
 
 =end