{"id":19035742,"url":"https://github.com/freeclimbapi/ruby-sdk","last_synced_at":"2025-04-23T18:54:33.108Z","repository":{"id":42122268,"uuid":"243300931","full_name":"FreeClimbAPI/ruby-sdk","owner":"FreeClimbAPI","description":"Ruby SDK for the FreeClimb API","archived":false,"fork":false,"pushed_at":"2025-03-07T20:32:26.000Z","size":2090,"stargazers_count":0,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-18T04:12:48.524Z","etag":null,"topics":["library","sdk"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FreeClimbAPI.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-26T15:47:34.000Z","updated_at":"2025-03-07T20:15:18.000Z","dependencies_parsed_at":"2024-04-09T21:39:07.363Z","dependency_job_id":"c75a2f1e-e121-48c5-9abb-e2e987b1dd93","html_url":"https://github.com/FreeClimbAPI/ruby-sdk","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2Fruby-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2Fruby-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2Fruby-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2Fruby-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FreeClimbAPI","download_url":"https://codeload.github.com/FreeClimbAPI/ruby-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250496941,"owners_count":21440231,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","sdk"],"created_at":"2024-11-08T21:51:57.935Z","updated_at":"2025-04-23T18:54:33.087Z","avatar_url":"https://github.com/FreeClimbAPI.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# freeclimb\n\nFreeclimb - the Ruby gem for the FreeClimb API\n\nFreeClimb 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.\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 5.2.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\nFor more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)\n\n## Installation\n\nAdd this to the Gemfile:\n\n    gem 'freeclimb', '~\u003e 5.2.0'\n\nand run from your terminal\n\n    bundle install\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: e.g. https://https://github.com/freeclimbapi/ruby-sdk, then add the following in the Gemfile:\n\n    gem 'freeclimb', :git =\u003e 'https://https://github.com/freeclimbapi/ruby-sdk.git'\n\n### Install from RubyGems\n\n    gem install freeclimb\nor\n\n    bundle add freeclimb\n\n### Install/Build locally\nTo build the Ruby code into a gem:\n\n```shell\ngem build freeclimb.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./freeclimb-5.2.0.gem\n```\n(for development, run `gem install --dev ./freeclimb-5.2.0.gem` to install the development dependencies)\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n\n```ruby\n# Load the gem\nrequire 'freeclimb'\n\n# Setup authorization\nFreeclimb.configure do |config|\n  # Configure HTTP basic authorization: fc\n  config.username = 'ACCOUNT_ID'\n  config.password = 'API_KEY'\nend\n\napi_instance = Freeclimb::DefaultApi.new\n\nbuy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new({phone_number: 'phone_number_example'}) # BuyIncomingNumberRequest | Incoming Number transaction details\n\n\nbegin\n  #Buy a Phone Number\n  result = api_instance.buy_a_phone_number(buy_incoming_number_request)\n  p result\nrescue Freeclimb::ApiError =\u003e e\n  puts \"Exception when calling DefaultApi-\u003ebuy_a_phone_number: #{e}\"\nend\n\n```\n\n## Documentation for PerCL\n\nThe Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts.\nPerCL commands are a part of the model schema and can be serialized into JSON like so:\n\n```ruby\nrequire 'freeclimb'\n\nsay = Freeclimb::Say.new(text: \"Hello, World\")\nplay = Freeclimb::Play.new(file: \"Example File\")\nget_digits = Freeclimb::GetDigits.new(action_url: \"Example Action URL\", prompts: [say, play])\npercl_script = Freeclimb::PerclScript.new(commands: [get_digits])\nputs percl_script.to_json\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://www.freeclimb.com/apiserver*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Freeclimb::DefaultApi* | [**buy_a_phone_number**](docs/DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number\n*Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference\n*Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue\n*Freeclimb::DefaultApi* | [**create_an_application**](docs/DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application\n*Freeclimb::DefaultApi* | [**create_knowledge_base_completion**](docs/DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base\n*Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording\n*Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application\n*Freeclimb::DefaultApi* | [**delete_an_incoming_number**](docs/DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number\n*Freeclimb::DefaultApi* | [**dequeue_a_member**](docs/DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member\n*Freeclimb::DefaultApi* | [**dequeue_head_member**](docs/DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member\n*Freeclimb::DefaultApi* | [**download_a_recording_file**](docs/DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File\n*Freeclimb::DefaultApi* | [**filter_logs**](docs/DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs\n*Freeclimb::DefaultApi* | [**get_a_call**](docs/DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call\n*Freeclimb::DefaultApi* | [**get_a_conference**](docs/DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference\n*Freeclimb::DefaultApi* | [**get_a_member**](docs/DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member\n*Freeclimb::DefaultApi* | [**get_a_participant**](docs/DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant\n*Freeclimb::DefaultApi* | [**get_a_queue**](docs/DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue\n*Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording\n*Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account\n*Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application\n*Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number\n*Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message\n*Freeclimb::DefaultApi* | [**get_head_member**](docs/DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member\n*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_brand**](docs/DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand\n*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_brands**](docs/DefaultApi.md#get_ten_dlc_sms_brands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands\n*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_campaign**](docs/DefaultApi.md#get_ten_dlc_sms_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign\n*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_campaigns**](docs/DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns\n*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_partner_campaign**](docs/DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign\n*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_partner_campaigns**](docs/DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns\n*Freeclimb::DefaultApi* | [**get_toll_free_sms_campaign**](docs/DefaultApi.md#get_toll_free_sms_campaign) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign\n*Freeclimb::DefaultApi* | [**get_toll_free_sms_campaigns**](docs/DefaultApi.md#get_toll_free_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns\n*Freeclimb::DefaultApi* | [**list_active_queues**](docs/DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues\n*Freeclimb::DefaultApi* | [**list_all_account_logs**](docs/DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs\n*Freeclimb::DefaultApi* | [**list_applications**](docs/DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications\n*Freeclimb::DefaultApi* | [**list_available_numbers**](docs/DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers\n*Freeclimb::DefaultApi* | [**list_call_logs**](docs/DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs\n*Freeclimb::DefaultApi* | [**list_call_recordings**](docs/DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings\n*Freeclimb::DefaultApi* | [**list_calls**](docs/DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls\n*Freeclimb::DefaultApi* | [**list_conference_recordings**](docs/DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings\n*Freeclimb::DefaultApi* | [**list_conferences**](docs/DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences\n*Freeclimb::DefaultApi* | [**list_incoming_numbers**](docs/DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers\n*Freeclimb::DefaultApi* | [**list_members**](docs/DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members\n*Freeclimb::DefaultApi* | [**list_participants**](docs/DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants\n*Freeclimb::DefaultApi* | [**list_recordings**](docs/DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings\n*Freeclimb::DefaultApi* | [**list_sms_messages**](docs/DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages\n*Freeclimb::DefaultApi* | [**make_a_call**](docs/DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call\n*Freeclimb::DefaultApi* | [**make_a_webrtc_jwt**](docs/DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling\n*Freeclimb::DefaultApi* | [**remove_a_participant**](docs/DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant\n*Freeclimb::DefaultApi* | [**send_an_sms_message**](docs/DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message\n*Freeclimb::DefaultApi* | [**stream_a_recording_file**](docs/DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File\n*Freeclimb::DefaultApi* | [**update_a_conference**](docs/DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference\n*Freeclimb::DefaultApi* | [**update_a_live_call**](docs/DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call\n*Freeclimb::DefaultApi* | [**update_a_participant**](docs/DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant\n*Freeclimb::DefaultApi* | [**update_a_queue**](docs/DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue\n*Freeclimb::DefaultApi* | [**update_an_account**](docs/DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account\n*Freeclimb::DefaultApi* | [**update_an_application**](docs/DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application\n*Freeclimb::DefaultApi* | [**update_an_incoming_number**](docs/DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number\n*FreeClimb::DefaultApi* | [**get_next_page**](docs/DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource \n\n## Documentation for Models\n\n - [Freeclimb::AccountRequest](docs/AccountRequest.md)\n - [Freeclimb::AccountResult](docs/AccountResult.md)\n - [Freeclimb::AccountStatus](docs/AccountStatus.md)\n - [Freeclimb::AccountType](docs/AccountType.md)\n - [Freeclimb::AddToConference](docs/AddToConference.md)\n - [Freeclimb::AddToConferenceNotificationWebhook](docs/AddToConferenceNotificationWebhook.md)\n - [Freeclimb::AddToQueueNotificationWebhook](docs/AddToQueueNotificationWebhook.md)\n - [Freeclimb::AnsweredBy](docs/AnsweredBy.md)\n - [Freeclimb::ApplicationList](docs/ApplicationList.md)\n - [Freeclimb::ApplicationRequest](docs/ApplicationRequest.md)\n - [Freeclimb::ApplicationResult](docs/ApplicationResult.md)\n - [Freeclimb::AvailableNumber](docs/AvailableNumber.md)\n - [Freeclimb::AvailableNumberList](docs/AvailableNumberList.md)\n - [Freeclimb::BargeInReason](docs/BargeInReason.md)\n - [Freeclimb::BuyIncomingNumberRequest](docs/BuyIncomingNumberRequest.md)\n - [Freeclimb::CallControlWebhook](docs/CallControlWebhook.md)\n - [Freeclimb::CallDirection](docs/CallDirection.md)\n - [Freeclimb::CallEndedReason](docs/CallEndedReason.md)\n - [Freeclimb::CallList](docs/CallList.md)\n - [Freeclimb::CallResult](docs/CallResult.md)\n - [Freeclimb::CallStatus](docs/CallStatus.md)\n - [Freeclimb::CallStatusWebhook](docs/CallStatusWebhook.md)\n - [Freeclimb::Capabilities](docs/Capabilities.md)\n - [Freeclimb::CompletionRequest](docs/CompletionRequest.md)\n - [Freeclimb::CompletionResult](docs/CompletionResult.md)\n - [Freeclimb::CompletionResultStatus](docs/CompletionResultStatus.md)\n - [Freeclimb::ConferenceList](docs/ConferenceList.md)\n - [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)\n - [Freeclimb::ConferenceParticipantResult](docs/ConferenceParticipantResult.md)\n - [Freeclimb::ConferenceRecordingStatusWebhook](docs/ConferenceRecordingStatusWebhook.md)\n - [Freeclimb::ConferenceResult](docs/ConferenceResult.md)\n - [Freeclimb::ConferenceStatus](docs/ConferenceStatus.md)\n - [Freeclimb::ConferenceStatusWebhook](docs/ConferenceStatusWebhook.md)\n - [Freeclimb::CreateConference](docs/CreateConference.md)\n - [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)\n - [Freeclimb::CreateConferenceWebhook](docs/CreateConferenceWebhook.md)\n - [Freeclimb::CreateWebRTCToken](docs/CreateWebRTCToken.md)\n - [Freeclimb::Dequeue](docs/Dequeue.md)\n - [Freeclimb::DequeueWebhook](docs/DequeueWebhook.md)\n - [Freeclimb::Enqueue](docs/Enqueue.md)\n - [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)\n - [Freeclimb::GetDigits](docs/GetDigits.md)\n - [Freeclimb::GetDigitsReason](docs/GetDigitsReason.md)\n - [Freeclimb::GetDigitsWebhook](docs/GetDigitsWebhook.md)\n - [Freeclimb::GetSpeech](docs/GetSpeech.md)\n - [Freeclimb::GetSpeechReason](docs/GetSpeechReason.md)\n - [Freeclimb::GetSpeechWebhook](docs/GetSpeechWebhook.md)\n - [Freeclimb::GrammarFileBuiltIn](docs/GrammarFileBuiltIn.md)\n - [Freeclimb::GrammarType](docs/GrammarType.md)\n - [Freeclimb::Hangup](docs/Hangup.md)\n - [Freeclimb::IfMachine](docs/IfMachine.md)\n - [Freeclimb::InboundCallWebhook](docs/InboundCallWebhook.md)\n - [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)\n - [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)\n - [Freeclimb::IncomingNumberResult](docs/IncomingNumberResult.md)\n - [Freeclimb::Language](docs/Language.md)\n - [Freeclimb::LeaveConferenceWebhook](docs/LeaveConferenceWebhook.md)\n - [Freeclimb::LogLevel](docs/LogLevel.md)\n - [Freeclimb::LogList](docs/LogList.md)\n - [Freeclimb::LogResult](docs/LogResult.md)\n - [Freeclimb::MachineDetectedWebhook](docs/MachineDetectedWebhook.md)\n - [Freeclimb::MachineType](docs/MachineType.md)\n - [Freeclimb::MakeCallRequest](docs/MakeCallRequest.md)\n - [Freeclimb::MessageDeliveryWebhook](docs/MessageDeliveryWebhook.md)\n - [Freeclimb::MessageDirection](docs/MessageDirection.md)\n - [Freeclimb::MessageRequest](docs/MessageRequest.md)\n - [Freeclimb::MessageResult](docs/MessageResult.md)\n - [Freeclimb::MessageStatus](docs/MessageStatus.md)\n - [Freeclimb::MessageStatusWebhook](docs/MessageStatusWebhook.md)\n - [Freeclimb::MessagesList](docs/MessagesList.md)\n - [Freeclimb::MutableResourceModel](docs/MutableResourceModel.md)\n - [Freeclimb::OutDial](docs/OutDial.md)\n - [Freeclimb::OutDialApiConnectWebhook](docs/OutDialApiConnectWebhook.md)\n - [Freeclimb::OutDialConnectWebhook](docs/OutDialConnectWebhook.md)\n - [Freeclimb::OutDialStartWebhook](docs/OutDialStartWebhook.md)\n - [Freeclimb::PaginationModel](docs/PaginationModel.md)\n - [Freeclimb::Park](docs/Park.md)\n - [Freeclimb::Pause](docs/Pause.md)\n - [Freeclimb::PerclCommand](docs/PerclCommand.md)\n - [Freeclimb::PerclScript](docs/PerclScript.md)\n - [Freeclimb::Play](docs/Play.md)\n - [Freeclimb::PlayBeep](docs/PlayBeep.md)\n - [Freeclimb::PlayEarlyMedia](docs/PlayEarlyMedia.md)\n - [Freeclimb::QueueList](docs/QueueList.md)\n - [Freeclimb::QueueMember](docs/QueueMember.md)\n - [Freeclimb::QueueMemberList](docs/QueueMemberList.md)\n - [Freeclimb::QueueRequest](docs/QueueRequest.md)\n - [Freeclimb::QueueResult](docs/QueueResult.md)\n - [Freeclimb::QueueResultStatus](docs/QueueResultStatus.md)\n - [Freeclimb::QueueWaitWebhook](docs/QueueWaitWebhook.md)\n - [Freeclimb::RecordUtterance](docs/RecordUtterance.md)\n - [Freeclimb::RecordUtteranceTermReason](docs/RecordUtteranceTermReason.md)\n - [Freeclimb::RecordWebhook](docs/RecordWebhook.md)\n - [Freeclimb::RecordingList](docs/RecordingList.md)\n - [Freeclimb::RecordingResult](docs/RecordingResult.md)\n - [Freeclimb::Redirect](docs/Redirect.md)\n - [Freeclimb::RedirectWebhook](docs/RedirectWebhook.md)\n - [Freeclimb::Reject](docs/Reject.md)\n - [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)\n - [Freeclimb::RemoveFromQueueNotificationWebhook](docs/RemoveFromQueueNotificationWebhook.md)\n - [Freeclimb::RequestType](docs/RequestType.md)\n - [Freeclimb::SMSTenDLCBrand](docs/SMSTenDLCBrand.md)\n - [Freeclimb::SMSTenDLCBrandAltBusinessIdType](docs/SMSTenDLCBrandAltBusinessIdType.md)\n - [Freeclimb::SMSTenDLCBrandEntityType](docs/SMSTenDLCBrandEntityType.md)\n - [Freeclimb::SMSTenDLCBrandIdentityStatus](docs/SMSTenDLCBrandIdentityStatus.md)\n - [Freeclimb::SMSTenDLCBrandRelationship](docs/SMSTenDLCBrandRelationship.md)\n - [Freeclimb::SMSTenDLCBrandStockExchange](docs/SMSTenDLCBrandStockExchange.md)\n - [Freeclimb::SMSTenDLCBrandsListResult](docs/SMSTenDLCBrandsListResult.md)\n - [Freeclimb::SMSTenDLCCampaign](docs/SMSTenDLCCampaign.md)\n - [Freeclimb::SMSTenDLCCampaignStatus](docs/SMSTenDLCCampaignStatus.md)\n - [Freeclimb::SMSTenDLCCampaignsListResult](docs/SMSTenDLCCampaignsListResult.md)\n - [Freeclimb::SMSTenDLCPartnerCampaign](docs/SMSTenDLCPartnerCampaign.md)\n - [Freeclimb::SMSTenDLCPartnerCampaignBrand](docs/SMSTenDLCPartnerCampaignBrand.md)\n - [Freeclimb::SMSTenDLCPartnerCampaignStatus](docs/SMSTenDLCPartnerCampaignStatus.md)\n - [Freeclimb::SMSTenDLCPartnerCampaignsListResult](docs/SMSTenDLCPartnerCampaignsListResult.md)\n - [Freeclimb::SMSTollFreeCampaign](docs/SMSTollFreeCampaign.md)\n - [Freeclimb::SMSTollFreeCampaignRegistrationStatus](docs/SMSTollFreeCampaignRegistrationStatus.md)\n - [Freeclimb::SMSTollFreeCampaignsListResult](docs/SMSTollFreeCampaignsListResult.md)\n - [Freeclimb::Say](docs/Say.md)\n - [Freeclimb::SendDigits](docs/SendDigits.md)\n - [Freeclimb::SetDTMFPassThrough](docs/SetDTMFPassThrough.md)\n - [Freeclimb::SetListen](docs/SetListen.md)\n - [Freeclimb::SetTalk](docs/SetTalk.md)\n - [Freeclimb::Sms](docs/Sms.md)\n - [Freeclimb::StartRecordCall](docs/StartRecordCall.md)\n - [Freeclimb::TFN](docs/TFN.md)\n - [Freeclimb::TFNCampaign](docs/TFNCampaign.md)\n - [Freeclimb::TerminateConference](docs/TerminateConference.md)\n - [Freeclimb::TranscribeReason](docs/TranscribeReason.md)\n - [Freeclimb::TranscribeTermReason](docs/TranscribeTermReason.md)\n - [Freeclimb::TranscribeUtterance](docs/TranscribeUtterance.md)\n - [Freeclimb::TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)\n - [Freeclimb::TranscribeWebhook](docs/TranscribeWebhook.md)\n - [Freeclimb::Unpark](docs/Unpark.md)\n - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)\n - [Freeclimb::UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)\n - [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)\n - [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)\n - [Freeclimb::UpdateConferenceRequestStatus](docs/UpdateConferenceRequestStatus.md)\n - [Freeclimb::Webhook](docs/Webhook.md)\n\n\n## Documentation for Authorization\n\n\n### fc\n\n- **Type**: HTTP basic authentication\n\n\n\u003ca name=\"documentation-for-verify-request-signature\"\u003e\u003c/a\u003e\n\n## Documentation for verifying request signature\n\n- To verify the signature request, we will need to use the verifySignatureRequest method within the Request Verifier class\n\n  Freeclimb::RequestVerifier.verify_request_signature(requestBody, requestHeader, signingSecret, tolerance)\n\n  This is a method that you can call directly from the request verifier class, it will throw exceptions depending on whether all parts of the request signature is valid otherwise it will throw a specific error message depending on which request signature part is causing issues\n\n  This method requires a requestBody of type string, a requestHeader of type string, a signingSecret of type string, and a tolerance value of type int\n\n  Example code down below\n\n  ```ruby\n  class RequestVerifier\n    def verify_request_signature_example()\n        request_header = \"t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8\"\n        signing_secret = \"sigsec_ead6d3b6904196c60835d039e91b3341c77a7793\"\n        tolerance = (5 * 60)\n        request_body =  \"{\\\"accountId\\\":\\\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\\\",\\\"callId\\\":\\\"CAccb0b00506553cda09b51c5477f672a49e0b2213\\\",\\\"callStatus\\\":\\\"ringing\\\",\\\"conferenceId\\\":null,\\\"direction\\\":\\\"inbound\\\",\\\"from\\\":\\\"+13121000109\\\",\\\"parentCallId\\\":null,\\\"queueId\\\":null,\\\"requestType\\\":\\\"inboundCall\\\",\\\"to\\\":\\\"+13121000096\\\"}\"\n        Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance)\n  ```\n\n\n## Getting Help\n\nIf you are experiencing difficulties, [contact support](https://freeclimb.com/support).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreeclimbapi%2Fruby-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreeclimbapi%2Fruby-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreeclimbapi%2Fruby-sdk/lists"}