bandwidth-sdk 10.1.0 → 11.0.0.pre.beta.1

data/spec/unit/api/calls_api_spec.rb

@@ -0,0 +1,89 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Bandwidth::CallsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CallsApi' do
+  before do
+    # run before each test
+    @api_instance = Bandwidth::CallsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CallsApi' do
+    it 'should create an instance of CallsApi' do
+      expect(@api_instance).to be_instance_of(Bandwidth::CallsApi)
+    end
+  end
+
+  # unit tests for create_call
+  # Create Call
+  # Creates an outbound phone call.  All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand.  <b>Please note:</b> Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
+  # @param account_id Your Bandwidth Account ID
+  # @param create_call JSON object containing information to create an outbound call
+  # @param [Hash] opts the optional parameters
+  # @return [CreateCallResponse]
+  describe 'create_call test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_call_state
+  # Get Call State Information
+  # Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint.  **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
+  # @param account_id Your Bandwidth Account ID
+  # @param call_id Programmable Voice API Call ID
+  # @param [Hash] opts the optional parameters
+  # @return [CallState]
+  describe 'get_call_state test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_call
+  # Update Call
+  # Interrupts and redirects a call to a different URL that should return a BXML document.
+  # @param account_id Your Bandwidth Account ID
+  # @param call_id Programmable Voice API Call ID
+  # @param update_call JSON object containing information to redirect an existing call to a new BXML document
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_call test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_call_bxml
+  # Update Call BXML
+  # Interrupts and replaces an active call's BXML document.
+  # @param account_id Your Bandwidth Account ID
+  # @param call_id Programmable Voice API Call ID
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_call_bxml test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/unit/api/conferences_api_spec.rb

@@ -0,0 +1,163 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Bandwidth::ConferencesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ConferencesApi' do
+  before do
+    # run before each test
+    @api_instance = Bandwidth::ConferencesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ConferencesApi' do
+    it 'should create an instance of ConferencesApi' do
+      expect(@api_instance).to be_instance_of(Bandwidth::ConferencesApi)
+    end
+  end
+
+  # unit tests for download_conference_recording
+  # Download Conference Recording
+  # Downloads the specified recording file.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param recording_id Programmable Voice API Recording ID
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'download_conference_recording test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_conference
+  # Get Conference Information
+  # Returns information about the specified conference.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param [Hash] opts the optional parameters
+  # @return [Conference]
+  describe 'get_conference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_conference_member
+  # Get Conference Member
+  # Returns information about the specified conference member.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param member_id Programmable Voice API Conference Member ID
+  # @param [Hash] opts the optional parameters
+  # @return [ConferenceMember]
+  describe 'get_conference_member test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_conference_recording
+  # Get Conference Recording Information
+  # Returns metadata for the specified recording.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param recording_id Programmable Voice API Recording ID
+  # @param [Hash] opts the optional parameters
+  # @return [ConferenceRecordingMetadata]
+  describe 'get_conference_recording test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_conference_recordings
+  # Get Conference Recordings
+  # Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ConferenceRecordingMetadata>]
+  describe 'list_conference_recordings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_conferences
+  # Get Conferences
+  # Returns a max of 1000 conferences, sorted by &#x60;createdTime&#x60; from oldest to newest.  **NOTE:** If the number of conferences in the account is bigger than &#x60;pageSize&#x60;, a &#x60;Link&#x60; header (with format &#x60;&lt;{url}&gt;; rel&#x3D;\&quot;next\&quot;&#x60;) will be returned in the response. The url can be used to retrieve the next page of conference records.
+  # @param account_id Your Bandwidth Account ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name Filter results by the &#x60;name&#x60; field.
+  # @option opts [String] :min_created_time Filter results to conferences which have a &#x60;createdTime&#x60; after or at &#x60;minCreatedTime&#x60; (in ISO8601 format).
+  # @option opts [String] :max_created_time Filter results to conferences which have a &#x60;createdTime&#x60; before or at &#x60;maxCreatedTime&#x60; (in ISO8601 format).
+  # @option opts [Integer] :page_size Specifies the max number of conferences that will be returned.
+  # @option opts [String] :page_token Not intended for explicit use. To use pagination, follow the links in the &#x60;Link&#x60; header of the response, as indicated in the endpoint description.
+  # @return [Array<Conference>]
+  describe 'list_conferences test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_conference
+  # Update Conference
+  # Update the conference state.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param update_conference 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_conference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_conference_bxml
+  # Update Conference BXML
+  # Update the conference BXML document.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_conference_bxml test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_conference_member
+  # Update Conference Member
+  # Updates settings for a particular conference member.
+  # @param account_id Your Bandwidth Account ID
+  # @param conference_id Programmable Voice API Conference ID
+  # @param member_id Programmable Voice API Conference Member ID
+  # @param update_conference_member 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_conference_member test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/unit/api/media_api_spec.rb

@@ -0,0 +1,90 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Bandwidth::MediaApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MediaApi' do
+  before do
+    # run before each test
+    @api_instance = Bandwidth::MediaApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MediaApi' do
+    it 'should create an instance of MediaApi' do
+      expect(@api_instance).to be_instance_of(Bandwidth::MediaApi)
+    end
+  end
+
+  # unit tests for delete_media
+  # Delete Media
+  # Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete.  If you accidentally delete a media file you can immediately upload a new file with the same name.
+  # @param account_id Your Bandwidth Account ID.
+  # @param media_id Media ID to retrieve.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_media test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_media
+  # Get Media
+  # Downloads a media file you previously uploaded.
+  # @param account_id Your Bandwidth Account ID.
+  # @param media_id Media ID to retrieve.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_media test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_media
+  # List Media
+  # Gets a list of your media files. No query parameters are supported.
+  # @param account_id Your Bandwidth Account ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :continuation_token Continuation token used to retrieve subsequent media.
+  # @return [Array<Media>]
+  describe 'list_media test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for upload_media
+  # Upload Media
+  # Upload a file. You may add headers to the request in order to provide some control to your media file.  If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten.  A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
+  # @param account_id Your Bandwidth Account ID.
+  # @param media_id Media ID to retrieve.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :content_type The media type of the entity-body.
+  # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
+  # @return [nil]
+  describe 'upload_media test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/unit/api/messages_api_spec.rb

@@ -0,0 +1,73 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Bandwidth::MessagesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MessagesApi' do
+  before do
+    # run before each test
+    @api_instance = Bandwidth::MessagesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MessagesApi' do
+    it 'should create an instance of MessagesApi' do
+      expect(@api_instance).to be_instance_of(Bandwidth::MessagesApi)
+    end
+  end
+
+  # unit tests for create_message
+  # Create Message
+  # Endpoint for sending text messages and picture messages using V2 messaging.
+  # @param account_id Your Bandwidth Account ID.
+  # @param message_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Message]
+  describe 'create_message test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_messages
+  # List Messages
+  # Returns a list of messages based on query parameters.
+  # @param account_id Your Bandwidth Account ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :message_id The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
+  # @option opts [String] :source_tn The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
+  # @option opts [String] :destination_tn The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
+  # @option opts [MessageStatusEnum] :message_status The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
+  # @option opts [ListMessageDirectionEnum] :message_direction The direction of the message. One of INBOUND OUTBOUND.
+  # @option opts [String] :carrier_name The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
+  # @option opts [MessageTypeEnum] :message_type The type of message. Either sms or mms.
+  # @option opts [Integer] :error_code The error code of the message.
+  # @option opts [String] :from_date_time The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
+  # @option opts [String] :to_date_time The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
+  # @option opts [String] :sort The field and direction to sort by combined with a colon. Direction is either asc or desc.
+  # @option opts [String] :page_token A base64 encoded value used for pagination of results.
+  # @option opts [Integer] :limit The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
+  # @return [MessagesList]
+  describe 'list_messages test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/unit/api/mfa_api_spec.rb

@@ -0,0 +1,74 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Bandwidth::MFAApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MFAApi' do
+  before do
+    # run before each test
+    @api_instance = Bandwidth::MFAApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MFAApi' do
+    it 'should create an instance of MFAApi' do
+      expect(@api_instance).to be_instance_of(Bandwidth::MFAApi)
+    end
+  end
+
+  # unit tests for generate_messaging_code
+  # Messaging Authentication Code
+  # Send an MFA code via text message (SMS).
+  # @param account_id Bandwidth Account ID with Voice service enabled.
+  # @param code_request MFA code request body.
+  # @param [Hash] opts the optional parameters
+  # @return [MessagingCodeResponse]
+  describe 'generate_messaging_code test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for generate_voice_code
+  # Voice Authentication Code
+  # Send an MFA Code via a phone call.
+  # @param account_id Bandwidth Account ID with Voice service enabled.
+  # @param code_request MFA code request body.
+  # @param [Hash] opts the optional parameters
+  # @return [VoiceCodeResponse]
+  describe 'generate_voice_code test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verify_code
+  # Verify Authentication Code
+  # Verify a previously sent MFA code.
+  # @param account_id Bandwidth Account ID with Voice service enabled.
+  # @param verify_code_request MFA code verify request body.
+  # @param [Hash] opts the optional parameters
+  # @return [VerifyCodeResponse]
+  describe 'verify_code test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/unit/api/phone_number_lookup_api_spec.rb

@@ -0,0 +1,61 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Bandwidth::PhoneNumberLookupApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PhoneNumberLookupApi' do
+  before do
+    # run before each test
+    @api_instance = Bandwidth::PhoneNumberLookupApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PhoneNumberLookupApi' do
+    it 'should create an instance of PhoneNumberLookupApi' do
+      expect(@api_instance).to be_instance_of(Bandwidth::PhoneNumberLookupApi)
+    end
+  end
+
+  # unit tests for create_lookup
+  # Create Lookup
+  # Create a Phone Number Lookup Request.
+  # @param account_id The ID of the Bandwidth account that the user belongs to.
+  # @param lookup_request Phone number lookup request.
+  # @param [Hash] opts the optional parameters
+  # @return [CreateLookupResponse]
+  describe 'create_lookup test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_lookup_status
+  # Get Lookup Request Status
+  # Get an existing Phone Number Lookup Request.
+  # @param account_id The ID of the Bandwidth account that the user belongs to.
+  # @param request_id The phone number lookup request ID from Bandwidth.
+  # @param [Hash] opts the optional parameters
+  # @return [LookupStatus]
+  describe 'get_lookup_status test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end