freeclimb 1.0.0

data/docs/ApplicationListAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::ApplicationListAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applications** | [**Array<ApplicationResult>**](ApplicationResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ApplicationListAllOf.new(applications: null)
+```
+
+

data/docs/ApplicationRequest.md

@@ -0,0 +1,31 @@
+# Freeclimb::ApplicationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_alias** | **String** | A human readable description of the application, with maximum length 64 characters. | [optional] 
+**voice_url** | **String** | The URL that FreeClimb will request when an inbound call arrives on a phone number assigned to this application. Used only for inbound calls. | [optional] 
+**voice_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only. Note: A PerCL response is expected to control the inbound call. | [optional] 
+**call_connect_url** | **String** | The URL that FreeClimb will request when an outbound call request is complete. Used for outbound calls only.  Note: A PerCL response is expected if the outbound call is connected (status=InProgress) to control the call. | [optional] 
+**status_callback_url** | **String** | The URL that FreeClimb will request to pass call status (such as call ended) to the application.  Note: This is a notification only; any PerCL returned will be ignored. | [optional] 
+**sms_url** | **String** | The URL that FreeClimb will request when a phone number assigned to this application receives an incoming SMS message. Used for inbound SMS only.  Note: Any PerCL returned will be ignored. | [optional] 
+**sms_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only.  Note: Any PerCL returned will be ignored. | [optional] 
+**request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response, e.g. X-Pulse-Request-Id: <requestId> | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ApplicationRequest.new(_alias: null,
+                                 voice_url: null,
+                                 voice_fallback_url: null,
+                                 call_connect_url: null,
+                                 status_callback_url: null,
+                                 sms_url: null,
+                                 sms_fallback_url: null,
+                                 request_id: null)
+```
+
+

data/docs/ApplicationResult.md

@@ -0,0 +1,41 @@
+# Freeclimb::ApplicationResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] 
+**date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] 
+**date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] 
+**revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] 
+**account_id** | **String** | ID of the account that owns this phone number. | [optional] 
+**application_id** | **String** | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] 
+**_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] 
+**voice_url** | **String** | The URL FreeClimb will request when a phone number assigned to this Application receives a Call. Used for inbound calls only. | [optional] 
+**voice_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only. | [optional] 
+**call_connect_url** | **String** | The URL to which FreeClimb will make a POST request informing the result of the outbound Call request. The status property of the request message specifies if the Call was connected or not. | [optional] 
+**status_callback_url** | **String** | A URL to which FreeClimb will make a POST request when the Call ends to notify this app. | [optional] 
+**sms_url** | **String** | The URL FreeClimb will request when a phone number assigned to this Application receives an incoming SMS message. Used for inbound SMS only. | [optional] 
+**sms_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ApplicationResult.new(uri: null,
+                                 date_created: null,
+                                 date_updated: null,
+                                 revision: null,
+                                 account_id: null,
+                                 application_id: null,
+                                 _alias: null,
+                                 voice_url: null,
+                                 voice_fallback_url: null,
+                                 call_connect_url: null,
+                                 status_callback_url: null,
+                                 sms_url: null,
+                                 sms_fallback_url: null)
+```
+
+

data/docs/ApplicationResultAllOf.md

@@ -0,0 +1,33 @@
+# Freeclimb::ApplicationResultAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | ID of the account that owns this phone number. | [optional] 
+**application_id** | **String** | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] 
+**_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] 
+**voice_url** | **String** | The URL FreeClimb will request when a phone number assigned to this Application receives a Call. Used for inbound calls only. | [optional] 
+**voice_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only. | [optional] 
+**call_connect_url** | **String** | The URL to which FreeClimb will make a POST request informing the result of the outbound Call request. The status property of the request message specifies if the Call was connected or not. | [optional] 
+**status_callback_url** | **String** | A URL to which FreeClimb will make a POST request when the Call ends to notify this app. | [optional] 
+**sms_url** | **String** | The URL FreeClimb will request when a phone number assigned to this Application receives an incoming SMS message. Used for inbound SMS only. | [optional] 
+**sms_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ApplicationResultAllOf.new(account_id: null,
+                                 application_id: null,
+                                 _alias: null,
+                                 voice_url: null,
+                                 voice_fallback_url: null,
+                                 call_connect_url: null,
+                                 status_callback_url: null,
+                                 sms_url: null,
+                                 sms_fallback_url: null)
+```
+
+

data/docs/AvailableNumber.md

@@ -0,0 +1,27 @@
+# Freeclimb::AvailableNumber
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | The phone number, in E.164 format (+ country code and phone number: +18003608245). | [optional] 
+**voice_enabled** | **Boolean** | Typically set to true for all numbers. | [optional] 
+**sms_enabled** | **Boolean** | Indicates whether the phone number can send and receive SMS messages. | [optional] 
+**_alias** | **String** | A nicely-formatted version of the phone number. | [optional] 
+**region** | **String** | The state or province of this phone number. | [optional] 
+**country** | **String** | The country of this phone number. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::AvailableNumber.new(phone_number: null,
+                                 voice_enabled: null,
+                                 sms_enabled: null,
+                                 _alias: null,
+                                 region: null,
+                                 country: null)
+```
+
+

data/docs/AvailableNumberList.md

@@ -0,0 +1,31 @@
+# Freeclimb::AvailableNumberList
+
+## 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] 
+**available_phone_numbers** | [**Array<AvailableNumber>**](AvailableNumber.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::AvailableNumberList.new(total: null,
+                                 start: null,
+                                 _end: null,
+                                 page: null,
+                                 num_pages: null,
+                                 page_size: null,
+                                 next_page_uri: null,
+                                 available_phone_numbers: null)
+```
+
+

data/docs/AvailableNumberListAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::AvailableNumberListAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**available_phone_numbers** | [**Array<AvailableNumber>**](AvailableNumber.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::AvailableNumberListAllOf.new(available_phone_numbers: null)
+```
+
+

data/docs/BuyIncomingNumberRequest.md

@@ -0,0 +1,23 @@
+# Freeclimb::BuyIncomingNumberRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | Phone number to purchase in E.164 format (as returned in the list of Available Phone Numbers). | 
+**_alias** | **String** | Description for this new incoming phone number (max 64 characters). | [optional] 
+**application_id** | **String** | ID of the application that should handle phone calls to the number. | [optional] 
+**request_id** | **String** | RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response, (e.g., `X-Pulse-Request-Id: <requestId>`). | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::BuyIncomingNumberRequest.new(phone_number: null,
+                                 _alias: null,
+                                 application_id: null,
+                                 request_id: null)
+```
+
+

data/docs/CallList.md

@@ -0,0 +1,31 @@
+# Freeclimb::CallList
+
+## 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] 
+**calls** | [**Array<CallResult>**](CallResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::CallList.new(total: null,
+                                 start: null,
+                                 _end: null,
+                                 page: null,
+                                 num_pages: null,
+                                 page_size: null,
+                                 next_page_uri: null,
+                                 calls: null)
+```
+
+

data/docs/CallListAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::CallListAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calls** | [**Array<CallResult>**](CallResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::CallListAllOf.new(calls: null)
+```
+
+

data/docs/CallResult.md

@@ -0,0 +1,53 @@
+# Freeclimb::CallResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] 
+**date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] 
+**date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] 
+**revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] 
+**call_id** | **String** | String that uniquely identifies this Call resource. | [optional] 
+**parent_call_id** | **String** | ID of the Call that created this leg (child Call). | [optional] 
+**account_id** | **String** | ID of the account that owns this Call. | [optional] 
+**from** | **String** | Phone number that initiated this Call. | [optional] 
+**to** | **String** | Phone number that received this Call. | [optional] 
+**phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] 
+**status** | **String** | * `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered. | [optional] 
+**start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] 
+**connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] 
+**end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] 
+**duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] 
+**connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] 
+**direction** | **String** | Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API,  `outboundDial` for Calls initiated by the `OutDial` PerCL command. | [optional] 
+**answered_by** | **String** | If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise. | [optional] 
+**subresource_uris** | [**Object**](.md) | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::CallResult.new(uri: null,
+                                 date_created: null,
+                                 date_updated: null,
+                                 revision: null,
+                                 call_id: null,
+                                 parent_call_id: null,
+                                 account_id: null,
+                                 from: null,
+                                 to: null,
+                                 phone_number_id: null,
+                                 status: null,
+                                 start_time: null,
+                                 connect_time: null,
+                                 end_time: null,
+                                 duration: null,
+                                 connect_duration: null,
+                                 direction: null,
+                                 answered_by: null,
+                                 subresource_uris: null)
+```
+
+

data/docs/CallResultAllOf.md

@@ -0,0 +1,45 @@
+# Freeclimb::CallResultAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | String that uniquely identifies this Call resource. | [optional] 
+**parent_call_id** | **String** | ID of the Call that created this leg (child Call). | [optional] 
+**account_id** | **String** | ID of the account that owns this Call. | [optional] 
+**from** | **String** | Phone number that initiated this Call. | [optional] 
+**to** | **String** | Phone number that received this Call. | [optional] 
+**phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] 
+**status** | **String** | * `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered. | [optional] 
+**start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] 
+**connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] 
+**end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] 
+**duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] 
+**connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] 
+**direction** | **String** | Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API,  `outboundDial` for Calls initiated by the `OutDial` PerCL command. | [optional] 
+**answered_by** | **String** | If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise. | [optional] 
+**subresource_uris** | [**Object**](.md) | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::CallResultAllOf.new(call_id: null,
+                                 parent_call_id: null,
+                                 account_id: null,
+                                 from: null,
+                                 to: null,
+                                 phone_number_id: null,
+                                 status: null,
+                                 start_time: null,
+                                 connect_time: null,
+                                 end_time: null,
+                                 duration: null,
+                                 connect_duration: null,
+                                 direction: null,
+                                 answered_by: null,
+                                 subresource_uris: null)
+```
+
+

data/docs/ConferenceList.md

@@ -0,0 +1,31 @@
+# Freeclimb::ConferenceList
+
+## 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] 
+**conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ConferenceList.new(total: null,
+                                 start: null,
+                                 _end: null,
+                                 page: null,
+                                 num_pages: null,
+                                 page_size: null,
+                                 next_page_uri: null,
+                                 conferences: null)
+```
+
+

data/docs/ConferenceListAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::ConferenceListAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ConferenceListAllOf.new(conferences: null)
+```
+
+

data/docs/ConferenceParticipantList.md

@@ -0,0 +1,31 @@
+# Freeclimb::ConferenceParticipantList
+
+## 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] 
+**participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Freeclimb'
+
+instance = Freeclimb::ConferenceParticipantList.new(total: null,
+                                 start: null,
+                                 _end: null,
+                                 page: null,
+                                 num_pages: null,
+                                 page_size: null,
+                                 next_page_uri: null,
+                                 participants: null)
+```
+
+