freeclimb 5.2.0 → 5.4.0

data/docs/ExportList.md

@@ -0,0 +1,32 @@
+# Freeclimb::ExportList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total amount of requested resource. | [optional] |
+| **start** | **Integer** | Resource index at start of current page | [optional] |
+| **_end** | **Integer** | Resource index at end of current page | [optional] |
+| **page** | **Integer** | Current page | [optional] |
+| **num_pages** | **Integer** | Total number of pages | [optional] |
+| **page_size** | **Integer** | Number of items per page | [optional] |
+| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
+| **exports** | [**Array<ExportResult>**](ExportResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportList.new(
+  total: null,
+  start: null,
+  _end: null,
+  page: null,
+  num_pages: null,
+  page_size: null,
+  next_page_uri: null,
+  exports: null
+)
+```
+

data/docs/ExportOutputType.md

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

data/docs/ExportRequest.md

@@ -0,0 +1,24 @@
+# Freeclimb::ExportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_type** | [**ExportResourceType**](ExportResourceType.md) |  |  |
+| **format** | **Array<String>** |  | [optional] |
+| **output** | [**ExportRequestOutput**](ExportRequestOutput.md) |  |  |
+| **query** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportRequest.new(
+  resource_type: null,
+  format: null,
+  output: null,
+  query: null
+)
+```
+

data/docs/ExportRequestOutput.md

@@ -0,0 +1,18 @@
+# Freeclimb::ExportRequestOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ExportOutputType**](ExportOutputType.md) |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportRequestOutput.new(
+  type: null
+)
+```
+

data/docs/ExportResourceType.md

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

data/docs/ExportResult.md

@@ -0,0 +1,40 @@
+# Freeclimb::ExportResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | String that uniquely identifies this account resource. |  |
+| **uri** | **String** |  |  |
+| **date_created** | **String** |  |  |
+| **date_updated** | **String** |  |  |
+| **revision** | **Integer** |  |  |
+| **export_id** | **String** | String that uniquely identifies this export resource |  |
+| **status** | [**ExportStatus**](ExportStatus.md) |  |  |
+| **size** | **Integer** |  |  |
+| **resource_type** | [**ExportResourceType**](ExportResourceType.md) |  |  |
+| **query** | **Object** | Query params used to filter exported documents |  |
+| **format** | **Array<String>** | Desired fields of exported documents |  |
+| **output** | [**ExportResultOutput**](ExportResultOutput.md) |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportResult.new(
+  account_id: null,
+  uri: null,
+  date_created: null,
+  date_updated: null,
+  revision: null,
+  export_id: null,
+  status: null,
+  size: null,
+  resource_type: null,
+  query: null,
+  format: null,
+  output: null
+)
+```
+

data/docs/ExportResultOutput.md

@@ -0,0 +1,18 @@
+# Freeclimb::ExportResultOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ExportOutputType**](ExportOutputType.md) |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportResultOutput.new(
+  type: null
+)
+```
+

data/docs/ExportStatus.md

@@ -0,0 +1,21 @@
+# Freeclimb::ExportStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **INTAKING** | **ExportStatus** |  | Represented in Ruby as "intaking" |
+| **QUEUED** | **ExportStatus** |  | Represented in Ruby as "queued" |
+| **IN_PROGRESS** | **ExportStatus** |  | Represented in Ruby as "inProgress" |
+| **COMPLETED** | **ExportStatus** |  | Represented in Ruby as "completed" |
+| **FAILED** | **ExportStatus** |  | Represented in Ruby as "failed" |
+| **DELETED** | **ExportStatus** |  | Represented in Ruby as "deleted" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportStatus::[NAME OF ENUM]
+```
+

data/docs/IncomingNumberResult.md

@@ -17,8 +17,6 @@
 | **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] |
 | **region** | **String** | State or province of this phone number. | [optional] |
 | **country** | **String** | Country of this phone number. | [optional] |
-| **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] |
-| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] |
 | **offnet** | **Boolean** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
 | **tfn** | [**TFN**](TFN.md) |  | [optional] |
 
@@ -41,8 +39,6 @@ instance = Freeclimb::IncomingNumberResult.new(
   _alias: null,
   region: null,
   country: null,
-  voice_enabled: null,
-  sms_enabled: null,
   offnet: null,
   tfn: null
 )

data/docs/ModifyBlobRequest.md

@@ -0,0 +1,20 @@
+# Freeclimb::ModifyBlobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blob** | **Object** |  |  |
+| **_alias** | **String** | Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ModifyBlobRequest.new(
+  blob: null,
+  _alias: null
+)
+```
+

data/docs/PlatformError.md

@@ -0,0 +1,24 @@
+# Freeclimb::PlatformError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **call** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **details** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PlatformError.new(
+  code: null,
+  call: null,
+  url: null,
+  details: null
+)
+```
+

data/docs/ReplaceBlobRequest.md

@@ -0,0 +1,18 @@
+# Freeclimb::ReplaceBlobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blob** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ReplaceBlobRequest.new(
+  blob: null
+)
+```
+

data/docs/Say.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. |  |
 | **language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional] |
+| **engine** | [**TTSEngine**](TTSEngine.md) |  | [optional] |
 | **loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional][default to 1] |
 | **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
 
@@ -17,6 +18,7 @@ require 'freeclimb'
 instance = Freeclimb::Say.new(
   text: null,
   language: null,
+  engine: null,
   loop: null,
   privacy_mode: null
 )

data/docs/TTSEngine.md

@@ -0,0 +1,20 @@
+# Freeclimb::TTSEngine
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | [**TTSEngineName**](TTSEngineName.md) |  | [optional] |
+| **parameters** | **Hash<String, Object>** | Parameters for the TTS engine. The parameters are specific to the engine and are documented in the engine's documentation. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TTSEngine.new(
+  name: null,
+  parameters: null
+)
+```
+

data/docs/TTSEngineName.md

@@ -0,0 +1,18 @@
+# Freeclimb::TTSEngineName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **FREECLIMB_STANDARD** | **TTSEngineName** |  | Represented in Ruby as "freeclimb.standard" |
+| **FREECLIMB_NEURAL** | **TTSEngineName** |  | Represented in Ruby as "freeclimb.neural" |
+| **ELEVEN_LABS** | **TTSEngineName** |  | Represented in Ruby as "ElevenLabs" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TTSEngineName::[NAME OF ENUM]
+```
+