dialmycalls_client 2.0.1

data/lib/dialmycalls_client/models/verify_caller_id_by_id_parameters.rb

@@ -0,0 +1,200 @@
+=begin
+#DialMyCalls API
+
+#The DialMyCalls API
+
+OpenAPI spec version: 2.0.1
+Contact: support@dialmycalls.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module DialMyCalls
+
+  class VerifyCallerIdByIdParameters
+    # (Required)  Verification PIN number received from making add caller ID request.
+    attr_accessor :pin
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pin' => :'pin'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'pin' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'pin')
+        self.pin = attributes[:'pin']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          pin == o.pin
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [pin].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DialMyCalls.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/dialmycalls_client/version.rb

@@ -0,0 +1,26 @@
+=begin
+#DialMyCalls API
+
+#The DialMyCalls API
+
+OpenAPI spec version: 2.0.1
+Contact: support@dialmycalls.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+module DialMyCalls
+  VERSION = "2.0.1"
+end

data/lib/dialmycalls_client.rb

@@ -0,0 +1,99 @@
+=begin
+#DialMyCalls API
+
+#The DialMyCalls API
+
+OpenAPI spec version: 2.0.1
+Contact: support@dialmycalls.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+# Common files
+require 'dialmycalls_client/api_client'
+require 'dialmycalls_client/api_error'
+require 'dialmycalls_client/version'
+require 'dialmycalls_client/configuration'
+
+# Models
+require 'dialmycalls_client/models/accessaccount'
+require 'dialmycalls_client/models/account'
+require 'dialmycalls_client/models/call_recipient'
+require 'dialmycalls_client/models/callerid'
+require 'dialmycalls_client/models/callservice'
+require 'dialmycalls_client/models/contact'
+require 'dialmycalls_client/models/contact_attributes'
+require 'dialmycalls_client/models/create_access_account_parameters'
+require 'dialmycalls_client/models/create_call_parameters'
+require 'dialmycalls_client/models/create_caller_id_parameters'
+require 'dialmycalls_client/models/create_contact_parameters'
+require 'dialmycalls_client/models/create_group_parameters'
+require 'dialmycalls_client/models/create_recording_by_phone_parameters'
+require 'dialmycalls_client/models/create_recording_by_url_parameters'
+require 'dialmycalls_client/models/create_recording_parameters'
+require 'dialmycalls_client/models/create_text_parameters'
+require 'dialmycalls_client/models/create_unverified_caller_id_parameters'
+require 'dialmycalls_client/models/donotcontact'
+require 'dialmycalls_client/models/group'
+require 'dialmycalls_client/models/identifier'
+require 'dialmycalls_client/models/incomingtext'
+require 'dialmycalls_client/models/keyword'
+require 'dialmycalls_client/models/polling'
+require 'dialmycalls_client/models/push_to_listen_again'
+require 'dialmycalls_client/models/push_to_opt_out'
+require 'dialmycalls_client/models/push_to_record'
+require 'dialmycalls_client/models/push_to_talk'
+require 'dialmycalls_client/models/recording'
+require 'dialmycalls_client/models/service'
+require 'dialmycalls_client/models/shortcode'
+require 'dialmycalls_client/models/text_recipient'
+require 'dialmycalls_client/models/update_access_account_by_id_parameters'
+require 'dialmycalls_client/models/update_caller_id_by_id_parameters'
+require 'dialmycalls_client/models/update_contact_by_id_parameters'
+require 'dialmycalls_client/models/update_group_by_id_parameters'
+require 'dialmycalls_client/models/update_recording_by_id_parameters'
+require 'dialmycalls_client/models/update_vanity_number_by_id_parameters'
+require 'dialmycalls_client/models/vanitynumber'
+require 'dialmycalls_client/models/verify_caller_id_by_id_parameters'
+
+# APIs
+require 'dialmycalls_client/api/accounts_api'
+require 'dialmycalls_client/api/caller_ids_api'
+require 'dialmycalls_client/api/calls_api'
+require 'dialmycalls_client/api/contacts_api'
+require 'dialmycalls_client/api/do_not_contacts_api'
+require 'dialmycalls_client/api/groups_api'
+require 'dialmycalls_client/api/keywords_api'
+require 'dialmycalls_client/api/recordings_api'
+require 'dialmycalls_client/api/texts_api'
+require 'dialmycalls_client/api/vanity_numbers_api'
+
+module DialMyCalls
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DialMyCalls.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/accounts_api_spec.rb

@@ -0,0 +1,118 @@
+=begin
+#DialMyCalls API
+
+#The DialMyCalls API
+
+OpenAPI spec version: 2.0.1
+Contact: support@dialmycalls.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DialMyCalls::AccountsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AccountsApi' do
+  before do
+    # run before each test
+    @instance = DialMyCalls::AccountsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountsApi' do
+    it 'should create an instact of AccountsApi' do
+      expect(@instance).to be_instance_of(DialMyCalls::AccountsApi)
+    end
+  end
+
+  # unit tests for create_access_account
+  # Add Access Account
+  # Add a access account. <br><br> Returns a access account object on success, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"email\\\": \\\"test@test.com\\\", \\\"password\\\": \\\"1234A5678\\\", \\\"name\\\": \\\"John Doe\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/accessaccount ```
+  # @param create_access_account_parameters Request body
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'create_access_account 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 delete_access_account_by_id
+  # Delete Access Account
+  # Delete a access account. <br><br> Returns the following if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X DELETE https://$API_KEY@api.dialmycalls.com/2.0/accessaccount/$ACCESSACCOUNT_ID ```
+  # @param access_account_id AccessAccountId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_access_account_by_id 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_access_account_by_id
+  # Get Access Account
+  # Retrieve an access account. <br><br> Returns a access account object if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/accessaccount/$ACCESSACCOUNT_ID ```
+  # @param access_account_id AccessAccountId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'get_access_account_by_id 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_access_accounts
+  # List Access Accounts
+  # Retrieve a list of access accounts. <br><br> Returns a list of access account objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/accessaccounts ```
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :range Range (ie \"records=201-300\") of accessaccounts requested
+  # @return [Object]
+  describe 'get_access_accounts 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_account
+  # Get Account
+  # Retrieve account details. <br><br> Returns a account object if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/account ```
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'get_account 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_access_account_by_id
+  # Update Access Account
+  # Update an existing access account. <br><br> Returns a access account object if a valid identifier was provided and input validation passed, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X PUT -d \"{\\\"name\\\": \\\"New Name\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/accessaccount/$ACCESSACCOUNT_ID ```
+  # @param update_access_account_by_id_parameters Request body
+  # @param access_account_id AccessAccountId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'update_access_account_by_id 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/api/caller_ids_api_spec.rb

@@ -0,0 +1,132 @@
+=begin
+#DialMyCalls API
+
+#The DialMyCalls API
+
+OpenAPI spec version: 2.0.1
+Contact: support@dialmycalls.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DialMyCalls::CallerIdsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CallerIdsApi' do
+  before do
+    # run before each test
+    @instance = DialMyCalls::CallerIdsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CallerIdsApi' do
+    it 'should create an instact of CallerIdsApi' do
+      expect(@instance).to be_instance_of(DialMyCalls::CallerIdsApi)
+    end
+  end
+
+  # unit tests for create_caller_id
+  # Add Caller ID
+  # Add a caller ID. <br><br> Returns a caller ID object on success, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"phone\\\": \\\"5555555555\\\", \\\"name\\\": \\\"New Number\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/callerid ```
+  # @param create_caller_id_parameters Request body
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'create_caller_id 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 create_unverified_caller_id
+  # Add Caller ID (Unverified)
+  # Initiate adding a new caller ID when you need to go through the verification process. You will receive a phone call at the phone number provided and will need to make a subsequent API call with the PIN code that you are provided. <br><br> Returns a caller ID object on success, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"phone\\\": \\\"5555555555\\\", \\\"name\\\": \\\"New Number\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/verify/callerid ```
+  # @param create_unverified_caller_id_parameters Request body
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'create_unverified_caller_id 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 delete_caller_id_by_id
+  # Delete Caller ID
+  # Delete a caller ID. <br><br> Returns the following if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X DELETE https://$API_KEY@api.dialmycalls.com/2.0/callerid/$CALLERID_ID ```
+  # @param callerid_id CalleridId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_caller_id_by_id 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_caller_id_by_id
+  # Get Caller ID
+  # Retrieve a caller ID. <br><br> Returns a caller ID object if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/callerid/$CALLERID_ID ```
+  # @param callerid_id CalleridId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'get_caller_id_by_id 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_caller_ids
+  # List Caller IDs
+  # Retrieve a list of caller IDs. <br><br> Returns a list of caller ID objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/callerids ```
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :range Range (ie \"records=201-300\") of callerids requested
+  # @return [Object]
+  describe 'get_caller_ids 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_caller_id_by_id
+  # Update Caller ID
+  # Update an existing caller ID. <br><br> Returns a caller ID object if a valid identifier was provided and input validation passed, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X PUT -d \"{\\\"name\\\": \\\"New Number Updated\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/callerid/$CALLERID_ID ```
+  # @param update_caller_id_by_id_parameters Request body
+  # @param callerid_id CalleridId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'update_caller_id_by_id 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_caller_id_by_id
+  # Verify Caller ID
+  # Verify a new caller ID. <br><br> Returns a caller ID object if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"phone\\\": \\\"5555555555\\\", \\\"name\\\": \\\"New Number\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/verify/callerid/$CALLERID_ID ```
+  # @param verify_caller_id_by_id_parameters Request body
+  # @param callerid_id CalleridId
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'verify_caller_id_by_id test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end