freeclimb 5.0.0 → 5.2.0

data/lib/freeclimb.rb

@@ -1,168 +1,167 @@
-=begin
-#FreeClimb API
-
-#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@freeclimb.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.9.0
-
-=end
+# #FreeClimb API
+#
+# FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+#
+# The version of the OpenAPI document: 1.0.0
+# Contact: support@freeclimb.com
+# Generated by: https://openapi-generator.tech
+# OpenAPI Generator version: 7.9.0
+#
 
 # Common files
-require 'freeclimb/api_client'
-require 'freeclimb/api_error'
-require 'freeclimb/version'
-require 'freeclimb/configuration'
+require "freeclimb/api_client"
+require "freeclimb/api_error"
+require "freeclimb/version"
+require "freeclimb/configuration"
 
 # Models
-require 'freeclimb/models/account_request'
-require 'freeclimb/models/account_result'
-require 'freeclimb/models/account_status'
-require 'freeclimb/models/account_type'
-require 'freeclimb/models/answered_by'
-require 'freeclimb/models/application_list'
-require 'freeclimb/models/application_request'
-require 'freeclimb/models/application_result'
-require 'freeclimb/models/available_number'
-require 'freeclimb/models/available_number_list'
-require 'freeclimb/models/barge_in_reason'
-require 'freeclimb/models/buy_incoming_number_request'
-require 'freeclimb/models/call_direction'
-require 'freeclimb/models/call_ended_reason'
-require 'freeclimb/models/call_list'
-require 'freeclimb/models/call_result'
-require 'freeclimb/models/call_status'
-require 'freeclimb/models/capabilities'
-require 'freeclimb/models/completion_request'
-require 'freeclimb/models/completion_result'
-require 'freeclimb/models/completion_result_status'
-require 'freeclimb/models/conference_list'
-require 'freeclimb/models/conference_participant_list'
-require 'freeclimb/models/conference_participant_result'
-require 'freeclimb/models/conference_result'
-require 'freeclimb/models/conference_status'
-require 'freeclimb/models/create_conference_request'
-require 'freeclimb/models/create_web_rtc_token'
-require 'freeclimb/models/filter_logs_request'
-require 'freeclimb/models/get_digits_reason'
-require 'freeclimb/models/get_speech_reason'
-require 'freeclimb/models/grammar_file_built_in'
-require 'freeclimb/models/grammar_type'
-require 'freeclimb/models/if_machine'
-require 'freeclimb/models/incoming_number_list'
-require 'freeclimb/models/incoming_number_request'
-require 'freeclimb/models/incoming_number_result'
-require 'freeclimb/models/language'
-require 'freeclimb/models/log_level'
-require 'freeclimb/models/log_list'
-require 'freeclimb/models/log_result'
-require 'freeclimb/models/machine_type'
-require 'freeclimb/models/make_call_request'
-require 'freeclimb/models/message_direction'
-require 'freeclimb/models/message_request'
-require 'freeclimb/models/message_result'
-require 'freeclimb/models/message_status'
-require 'freeclimb/models/messages_list'
-require 'freeclimb/models/mutable_resource_model'
-require 'freeclimb/models/pagination_model'
-require 'freeclimb/models/percl_command'
-require 'freeclimb/models/percl_script'
-require 'freeclimb/models/play_beep'
-require 'freeclimb/models/queue_list'
-require 'freeclimb/models/queue_member'
-require 'freeclimb/models/queue_member_list'
-require 'freeclimb/models/queue_request'
-require 'freeclimb/models/queue_result'
-require 'freeclimb/models/queue_result_status'
-require 'freeclimb/models/record_utterance_term_reason'
-require 'freeclimb/models/recording_list'
-require 'freeclimb/models/recording_result'
-require 'freeclimb/models/request_type'
-require 'freeclimb/models/sms_ten_dlc_brand'
-require 'freeclimb/models/sms_ten_dlc_brand_alt_business_id_type'
-require 'freeclimb/models/sms_ten_dlc_brand_entity_type'
-require 'freeclimb/models/sms_ten_dlc_brand_identity_status'
-require 'freeclimb/models/sms_ten_dlc_brand_relationship'
-require 'freeclimb/models/sms_ten_dlc_brand_stock_exchange'
-require 'freeclimb/models/sms_ten_dlc_brands_list_result'
-require 'freeclimb/models/sms_ten_dlc_campaign'
-require 'freeclimb/models/sms_ten_dlc_campaign_status'
-require 'freeclimb/models/sms_ten_dlc_campaigns_list_result'
-require 'freeclimb/models/sms_ten_dlc_partner_campaign'
-require 'freeclimb/models/sms_ten_dlc_partner_campaign_brand'
-require 'freeclimb/models/sms_ten_dlc_partner_campaign_status'
-require 'freeclimb/models/sms_ten_dlc_partner_campaigns_list_result'
-require 'freeclimb/models/sms_toll_free_campaign'
-require 'freeclimb/models/sms_toll_free_campaign_registration_status'
-require 'freeclimb/models/sms_toll_free_campaigns_list_result'
-require 'freeclimb/models/tfn'
-require 'freeclimb/models/transcribe_reason'
-require 'freeclimb/models/transcribe_term_reason'
-require 'freeclimb/models/transcribe_utterance_record'
-require 'freeclimb/models/update_call_request'
-require 'freeclimb/models/update_call_request_status'
-require 'freeclimb/models/update_conference_participant_request'
-require 'freeclimb/models/update_conference_request'
-require 'freeclimb/models/update_conference_request_status'
-require 'freeclimb/models/webhook'
-require 'freeclimb/models/add_to_conference'
-require 'freeclimb/models/add_to_conference_notification_webhook'
-require 'freeclimb/models/add_to_queue_notification_webhook'
-require 'freeclimb/models/call_control_webhook'
-require 'freeclimb/models/call_status_webhook'
-require 'freeclimb/models/conference_recording_status_webhook'
-require 'freeclimb/models/conference_status_webhook'
-require 'freeclimb/models/create_conference'
-require 'freeclimb/models/create_conference_webhook'
-require 'freeclimb/models/dequeue'
-require 'freeclimb/models/dequeue_webhook'
-require 'freeclimb/models/enqueue'
-require 'freeclimb/models/get_digits'
-require 'freeclimb/models/get_digits_webhook'
-require 'freeclimb/models/get_speech'
-require 'freeclimb/models/get_speech_webhook'
-require 'freeclimb/models/hangup'
-require 'freeclimb/models/inbound_call_webhook'
-require 'freeclimb/models/leave_conference_webhook'
-require 'freeclimb/models/machine_detected_webhook'
-require 'freeclimb/models/message_delivery_webhook'
-require 'freeclimb/models/message_status_webhook'
-require 'freeclimb/models/out_dial'
-require 'freeclimb/models/out_dial_api_connect_webhook'
-require 'freeclimb/models/out_dial_connect_webhook'
-require 'freeclimb/models/out_dial_start_webhook'
-require 'freeclimb/models/park'
-require 'freeclimb/models/pause'
-require 'freeclimb/models/play'
-require 'freeclimb/models/play_early_media'
-require 'freeclimb/models/queue_wait_webhook'
-require 'freeclimb/models/record_utterance'
-require 'freeclimb/models/record_webhook'
-require 'freeclimb/models/redirect'
-require 'freeclimb/models/redirect_webhook'
-require 'freeclimb/models/reject'
-require 'freeclimb/models/remove_from_conference'
-require 'freeclimb/models/remove_from_queue_notification_webhook'
-require 'freeclimb/models/say'
-require 'freeclimb/models/send_digits'
-require 'freeclimb/models/set_dtmf_pass_through'
-require 'freeclimb/models/set_listen'
-require 'freeclimb/models/set_talk'
-require 'freeclimb/models/sms'
-require 'freeclimb/models/start_record_call'
-require 'freeclimb/models/terminate_conference'
-require 'freeclimb/models/transcribe_utterance'
-require 'freeclimb/models/transcribe_webhook'
-require 'freeclimb/models/unpark'
+require "freeclimb/models/account_request"
+require "freeclimb/models/account_result"
+require "freeclimb/models/account_status"
+require "freeclimb/models/account_type"
+require "freeclimb/models/answered_by"
+require "freeclimb/models/application_list"
+require "freeclimb/models/application_request"
+require "freeclimb/models/application_result"
+require "freeclimb/models/available_number"
+require "freeclimb/models/available_number_list"
+require "freeclimb/models/barge_in_reason"
+require "freeclimb/models/buy_incoming_number_request"
+require "freeclimb/models/call_direction"
+require "freeclimb/models/call_ended_reason"
+require "freeclimb/models/call_list"
+require "freeclimb/models/call_result"
+require "freeclimb/models/call_status"
+require "freeclimb/models/capabilities"
+require "freeclimb/models/completion_request"
+require "freeclimb/models/completion_result"
+require "freeclimb/models/completion_result_status"
+require "freeclimb/models/conference_list"
+require "freeclimb/models/conference_participant_list"
+require "freeclimb/models/conference_participant_result"
+require "freeclimb/models/conference_result"
+require "freeclimb/models/conference_status"
+require "freeclimb/models/create_conference_request"
+require "freeclimb/models/create_web_rtc_token"
+require "freeclimb/models/filter_logs_request"
+require "freeclimb/models/get_digits_reason"
+require "freeclimb/models/get_speech_reason"
+require "freeclimb/models/grammar_file_built_in"
+require "freeclimb/models/grammar_type"
+require "freeclimb/models/if_machine"
+require "freeclimb/models/incoming_number_list"
+require "freeclimb/models/incoming_number_request"
+require "freeclimb/models/incoming_number_result"
+require "freeclimb/models/language"
+require "freeclimb/models/log_level"
+require "freeclimb/models/log_list"
+require "freeclimb/models/log_result"
+require "freeclimb/models/machine_type"
+require "freeclimb/models/make_call_request"
+require "freeclimb/models/message_direction"
+require "freeclimb/models/message_request"
+require "freeclimb/models/message_result"
+require "freeclimb/models/message_status"
+require "freeclimb/models/messages_list"
+require "freeclimb/models/mutable_resource_model"
+require "freeclimb/models/pagination_model"
+require "freeclimb/models/percl_command"
+require "freeclimb/models/percl_script"
+require "freeclimb/models/play_beep"
+require "freeclimb/models/queue_list"
+require "freeclimb/models/queue_member"
+require "freeclimb/models/queue_member_list"
+require "freeclimb/models/queue_request"
+require "freeclimb/models/queue_result"
+require "freeclimb/models/queue_result_status"
+require "freeclimb/models/record_utterance_term_reason"
+require "freeclimb/models/recording_list"
+require "freeclimb/models/recording_result"
+require "freeclimb/models/request_type"
+require "freeclimb/models/sms_ten_dlc_brand"
+require "freeclimb/models/sms_ten_dlc_brand_alt_business_id_type"
+require "freeclimb/models/sms_ten_dlc_brand_entity_type"
+require "freeclimb/models/sms_ten_dlc_brand_identity_status"
+require "freeclimb/models/sms_ten_dlc_brand_relationship"
+require "freeclimb/models/sms_ten_dlc_brand_stock_exchange"
+require "freeclimb/models/sms_ten_dlc_brands_list_result"
+require "freeclimb/models/sms_ten_dlc_campaign"
+require "freeclimb/models/sms_ten_dlc_campaign_status"
+require "freeclimb/models/sms_ten_dlc_campaigns_list_result"
+require "freeclimb/models/sms_ten_dlc_partner_campaign"
+require "freeclimb/models/sms_ten_dlc_partner_campaign_brand"
+require "freeclimb/models/sms_ten_dlc_partner_campaign_status"
+require "freeclimb/models/sms_ten_dlc_partner_campaigns_list_result"
+require "freeclimb/models/sms_toll_free_campaign"
+require "freeclimb/models/sms_toll_free_campaign_registration_status"
+require "freeclimb/models/sms_toll_free_campaigns_list_result"
+require "freeclimb/models/tfn"
+require "freeclimb/models/tfn_campaign"
+require "freeclimb/models/transcribe_reason"
+require "freeclimb/models/transcribe_term_reason"
+require "freeclimb/models/transcribe_utterance_record"
+require "freeclimb/models/update_call_request"
+require "freeclimb/models/update_call_request_status"
+require "freeclimb/models/update_conference_participant_request"
+require "freeclimb/models/update_conference_request"
+require "freeclimb/models/update_conference_request_status"
+require "freeclimb/models/webhook"
+require "freeclimb/models/add_to_conference"
+require "freeclimb/models/add_to_conference_notification_webhook"
+require "freeclimb/models/add_to_queue_notification_webhook"
+require "freeclimb/models/call_control_webhook"
+require "freeclimb/models/call_status_webhook"
+require "freeclimb/models/conference_recording_status_webhook"
+require "freeclimb/models/conference_status_webhook"
+require "freeclimb/models/create_conference"
+require "freeclimb/models/create_conference_webhook"
+require "freeclimb/models/dequeue"
+require "freeclimb/models/dequeue_webhook"
+require "freeclimb/models/enqueue"
+require "freeclimb/models/get_digits"
+require "freeclimb/models/get_digits_webhook"
+require "freeclimb/models/get_speech"
+require "freeclimb/models/get_speech_webhook"
+require "freeclimb/models/hangup"
+require "freeclimb/models/inbound_call_webhook"
+require "freeclimb/models/leave_conference_webhook"
+require "freeclimb/models/machine_detected_webhook"
+require "freeclimb/models/message_delivery_webhook"
+require "freeclimb/models/message_status_webhook"
+require "freeclimb/models/out_dial"
+require "freeclimb/models/out_dial_api_connect_webhook"
+require "freeclimb/models/out_dial_connect_webhook"
+require "freeclimb/models/out_dial_start_webhook"
+require "freeclimb/models/park"
+require "freeclimb/models/pause"
+require "freeclimb/models/play"
+require "freeclimb/models/play_early_media"
+require "freeclimb/models/queue_wait_webhook"
+require "freeclimb/models/record_utterance"
+require "freeclimb/models/record_webhook"
+require "freeclimb/models/redirect"
+require "freeclimb/models/redirect_webhook"
+require "freeclimb/models/reject"
+require "freeclimb/models/remove_from_conference"
+require "freeclimb/models/remove_from_queue_notification_webhook"
+require "freeclimb/models/say"
+require "freeclimb/models/send_digits"
+require "freeclimb/models/set_dtmf_pass_through"
+require "freeclimb/models/set_listen"
+require "freeclimb/models/set_talk"
+require "freeclimb/models/sms"
+require "freeclimb/models/start_record_call"
+require "freeclimb/models/terminate_conference"
+require "freeclimb/models/transcribe_utterance"
+require "freeclimb/models/transcribe_webhook"
+require "freeclimb/models/unpark"
 
 # APIs
-require 'freeclimb/api/default_api'
+require "freeclimb/api/default_api"
 
 # Utils
-require 'freeclimb/utils/signature_information'
-require 'freeclimb/utils/request_verifier'
+require "freeclimb/utils/signature_information"
+require "freeclimb/utils/request_verifier"
 
 module Freeclimb
   class << self

data/openapi.json

@@ -151,12 +151,7 @@
       },
       "GetDigitsReason": {
         "type": "string",
-        "enum": [
-          "finishKey",
-          "timeout",
-          "maxDigits",
-          "tone"
-        ],
+        "enum": ["finishKey", "timeout", "maxDigits", "tone"],
         "description": "This field explains how the GetDigits action ended. The value is one of the below: •finishKey - The finish key as specified had been pressed by the caller. Digit string has all keys up to, but not including, the finish key.  •timeout - The timeout limit was reached prior to any other criteria being met. If any digits were collected, they will be included.  •maxDigits - The maximum number of digits was reached and digit collection ended.  •tone - Answering machine or fax tone detection occurred, interrupting digit collection. Any digits received up to this point are included in this webhook."
       },
       "ConferenceStatus": {
@@ -420,12 +415,7 @@
       "SMSTenDLCBrandIdentityStatus": {
         "type": "string",
         "description": "TCR assessment of the brand identification status.",
-        "enum": [
-          "SELF_DECLARED",
-          "UNVERIFIED",
-          "VERIFIED",
-          "VETTED_VERIFIED"
-        ]
+        "enum": ["SELF_DECLARED", "UNVERIFIED", "VERIFIED", "VETTED_VERIFIED"]
       },
       "CompletionResultStatus": {
         "type": "string",
@@ -494,32 +484,32 @@
       "Webhook": {
         "type": "object",
         "discriminator": {
-         "propertyName": "requestType",
-         "mapping": {
-           "addToConferenceNotification":  "#/components/schemas/AddToConferenceNotificationWebhook",
-           "addToQueueNotification": "#/components/schemas/AddToQueueNotificationWebhook",
-           "callControl": "#/components/schemas/CallControlWebhook",
-           "callStatus": "#/components/schemas/CallStatusWebhook",
-           "conferenceRecordingStatus": "#/components/schemas/ConferenceRecordingStatusWebhook",
-           "conferenceStatus": "#/components/schemas/ConferenceStatusWebhook",
-           "createConference": "#/components/schemas/CreateConferenceWebhook",
-           "dequeue": "#/components/schemas/DequeueWebhook",
-           "getDigits": "#/components/schemas/GetDigitsWebhook",
-           "getSpeech": "#/components/schemas/GetSpeechWebhook",
-           "inboundCall": "#/components/schemas/InboundCallWebhook",
-           "leaveConference": "#/components/schemas/LeaveConferenceWebhook",
-           "machineDetected": "#/components/schemas/MachineDetectedWebhook",
-           "messageDelivery": "#/components/schemas/MessageDeliveryWebhook",
-           "messageStatus": "#/components/schemas/MessageStatusWebhook",
-           "outDialApiConnect": "#/components/schemas/OutDialApiConnectWebhook",
-           "outDialConnect": "#/components/schemas/OutDialConnectWebhook",
-           "outDialStart": "#/components/schemas/OutDialStartWebhook",
-           "queueWait": "#/components/schemas/QueueWaitWebhook",
-           "record": "#/components/schemas/RecordWebhook",
-           "redirect": "#/components/schemas/RedirectWebhook",
-           "removeFromQueueNotification": "#/components/schemas/RemoveFromQueueNotificationWebhook",
-           "transcribe": "#/components/schemas/TranscribeWebhook"
-         }
+          "propertyName": "requestType",
+          "mapping": {
+            "addToConferenceNotification": "#/components/schemas/AddToConferenceNotificationWebhook",
+            "addToQueueNotification": "#/components/schemas/AddToQueueNotificationWebhook",
+            "callControl": "#/components/schemas/CallControlWebhook",
+            "callStatus": "#/components/schemas/CallStatusWebhook",
+            "conferenceRecordingStatus": "#/components/schemas/ConferenceRecordingStatusWebhook",
+            "conferenceStatus": "#/components/schemas/ConferenceStatusWebhook",
+            "createConference": "#/components/schemas/CreateConferenceWebhook",
+            "dequeue": "#/components/schemas/DequeueWebhook",
+            "getDigits": "#/components/schemas/GetDigitsWebhook",
+            "getSpeech": "#/components/schemas/GetSpeechWebhook",
+            "inboundCall": "#/components/schemas/InboundCallWebhook",
+            "leaveConference": "#/components/schemas/LeaveConferenceWebhook",
+            "machineDetected": "#/components/schemas/MachineDetectedWebhook",
+            "messageDelivery": "#/components/schemas/MessageDeliveryWebhook",
+            "messageStatus": "#/components/schemas/MessageStatusWebhook",
+            "outDialApiConnect": "#/components/schemas/OutDialApiConnectWebhook",
+            "outDialConnect": "#/components/schemas/OutDialConnectWebhook",
+            "outDialStart": "#/components/schemas/OutDialStartWebhook",
+            "queueWait": "#/components/schemas/QueueWaitWebhook",
+            "record": "#/components/schemas/RecordWebhook",
+            "redirect": "#/components/schemas/RedirectWebhook",
+            "removeFromQueueNotification": "#/components/schemas/RemoveFromQueueNotificationWebhook",
+            "transcribe": "#/components/schemas/TranscribeWebhook"
+          }
         },
         "properties": {
           "requestType": {
@@ -3596,13 +3586,81 @@
                   "format": "uri"
                 },
                 "nullable": true
+              },
+              "tfn": {
+                "$ref": "#/components/schemas/TFN",
+                "nullable": true
+              },
+              "phoneNumberId": {
+                "type": "string",
+                "description": "String that uniquely identifies the phoneNumber resource used to send this Message",
+                "nullable": true
+              },
+              "applicationId": {
+                "type": "string",
+                "description": "String that uniquely identifies the Application resource used to send this Message",
+                "nullable": true
               }
             }
           }
         ]
       },
+      "TFNCampaign": {
+        "type": "object",
+        "required": [
+          "accountId",
+          "campaignId",
+          "useCase",
+          "registrationStatus",
+          "dateCreated",
+          "dateUpdated",
+          "dateCreatedISO",
+          "dateUpdatedISO",
+          "revision"
+        ],
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this participant.",
+            "nullable": true
+          },
+          "campaignId": {
+            "$ref": "#/components/schemas/TFNCampaignId"
+          },
+          "useCase": {
+            "type": "string"
+          },
+          "registrationStatus": {
+            "$ref": "#/components/schemas/SMSTollFreeCampaignRegistrationStatus"
+          },
+          "dateCreated": {
+            "type": "string"
+          },
+          "dateUpdated": {
+            "type": "string"
+          },
+          "dateCreatedISO": {
+            "type": "string"
+          },
+          "dateUpdatedISO": {
+            "type": "string"
+          },
+          "revision": {
+            "type": "integer"
+          }
+        }
+      },
+      "TFNCampaignId": {
+        "type": "string",
+        "description": "TFNCampaignId",
+        "pattern": "cmptfn_[a-fA-F0-9]{40}",
+        "example": "cmptfn_387ec3f6e03b340553f35f29c8f118cdf3eae08a"
+      },
       "CreateConferenceRequest": {
         "type": "object",
+        "required": [
+          "statusCallbackUrl"
+        ],
         "properties": {
           "alias": {
             "type": "string",

data/package.json

@@ -2,7 +2,7 @@
   "dependencies": {
     "@stoplight/prism-cli": "5.6.0",
     "fast-xml-parser": "^4.5.0",
-    "jsonpath-plus": "^10.0.0"
+    "jsonpath-plus": "^10.3.0"
   },
   "resolutions": {
     "@stoplight/json": "3.20.0",