clicksend_client 1.0.2

data/lib/clicksend_client/models/voice_message_collection.rb

@@ -0,0 +1,192 @@
+=begin
+#ClickSend v3 API
+
+# This is an official SDK for [ClickSend](https://clicksend.com)  Below you will find a current list of the available methods for clicksend.  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+OpenAPI spec version: 3.1
+Contact: support@clicksend.com
+Generated by: https://github.com/clicksend-api/clicksend-codegen.git
+ClickSend Codegen version: 2.4.1-SNAPSHOT
+
+=end
+
+require 'date'
+
+module ClickSendClient
+  # Array of VoiceMessage items
+  class VoiceMessageCollection
+    # Array of VoiceMessage items
+    attr_accessor :messages
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'messages' => :'messages'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.clicksend_types
+      {
+        :'messages' => :'Array<VoiceMessage>'
+      }
+    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?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @messages.nil?
+        invalid_properties.push('invalid value for "messages", messages cannot be nil.')
+      end
+
+      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 false if @messages.nil?
+      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 &&
+          messages == o.messages
+    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
+      [messages].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.clicksend_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/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 =~ /\A(true|t|yes|y|1)\z/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 = ClickSendClient.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/clicksend_client/version.rb

@@ -0,0 +1,15 @@
+=begin
+#ClickSend v3 API
+
+# This is an official SDK for [ClickSend](https://clicksend.com)  Below you will find a current list of the available methods for clicksend.  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+OpenAPI spec version: 3.1
+Contact: support@clicksend.com
+Generated by: https://github.com/clicksend-api/clicksend-codegen.git
+ClickSend Codegen version: 2.4.1-SNAPSHOT
+
+=end
+
+module ClickSendClient
+  VERSION = '1.0.2'
+end

data/spec/api/account_api_spec.rb

@@ -0,0 +1,131 @@
+=begin
+#ClickSend v3 API
+
+# This is an official SDK for [ClickSend](https://clicksend.com)  Below you will find a current list of the available methods for clicksend.  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+OpenAPI spec version: 3.1
+Contact: support@clicksend.com
+Generated by: https://github.com/clicksend-api/clicksend-codegen.git
+ClickSend Codegen version: 2.4.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ClickSendClient::AccountApi
+# Automatically generated by clicksend-codegen (github.com/clicksend-api/clicksend-codegen)
+# Please update as you see appropriate
+describe 'AccountApi' do
+  before do
+    # run before each test
+    @instance = ClickSendClient::AccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountApi' do
+    it 'should create an instance of AccountApi' do
+      expect(@instance).to be_instance_of(ClickSendClient::AccountApi)
+    end
+  end
+
+  # unit tests for account_get
+  # Get account information
+  # Get account details
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'account_get 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 account_post
+  # Create a new account
+  # Create An Account
+  # @param account Account model
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'account_post 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 account_useage_by_subaccount_get
+  # Get account useage by subaccount
+  # Get account useage by subaccount
+  # @param year Year to filter by (yyyy)
+  # @param month Month to filter by (mm)
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'account_useage_by_subaccount_get 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 account_verify_send_put
+  # Send account activation token
+  # Send account activation token
+  # @param account_verify Account details
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'account_verify_send_put 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 account_verify_verify_by_activation_token_put
+  # Verify new account
+  # Verify new account
+  # @param activation_token 
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'account_verify_verify_by_activation_token_put 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 forgot_password_put
+  # Forgot password
+  # Forgot password
+  # @param [Hash] opts the optional parameters
+  # @option opts [ForgotPassword] :forgot_password 
+  # @return [String]
+  describe 'forgot_password_put 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 forgot_password_verify_put
+  # Verify forgot password
+  # Verify forgot password
+  # @param verify_password verifyPassword data
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'forgot_password_verify_put 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 forgot_username_put
+  # Forgot username
+  # Forgot username
+  # @param [Hash] opts the optional parameters
+  # @option opts [ForgotUsername] :forgot_username 
+  # @return [String]
+  describe 'forgot_username_put 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/account_recharge_api_spec.rb

@@ -0,0 +1,107 @@
+=begin
+#ClickSend v3 API
+
+# This is an official SDK for [ClickSend](https://clicksend.com)  Below you will find a current list of the available methods for clicksend.  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+OpenAPI spec version: 3.1
+Contact: support@clicksend.com
+Generated by: https://github.com/clicksend-api/clicksend-codegen.git
+ClickSend Codegen version: 2.4.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ClickSendClient::AccountRechargeApi
+# Automatically generated by clicksend-codegen (github.com/clicksend-api/clicksend-codegen)
+# Please update as you see appropriate
+describe 'AccountRechargeApi' do
+  before do
+    # run before each test
+    @instance = ClickSendClient::AccountRechargeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountRechargeApi' do
+    it 'should create an instance of AccountRechargeApi' do
+      expect(@instance).to be_instance_of(ClickSendClient::AccountRechargeApi)
+    end
+  end
+
+  # unit tests for recharge_credit_card_get
+  # Get Credit Card info
+  # Get Credit Card info
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'recharge_credit_card_get 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 recharge_credit_card_put
+  # Update credit card info
+  # Update credit card info
+  # @param credit_card CreditCard model
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'recharge_credit_card_put 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 recharge_packages_get
+  # Get list of all packages
+  # Get list of all packages
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :country Country code
+  # @return [String]
+  describe 'recharge_packages_get 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 recharge_purchase_by_package_id_put
+  # Purchase a package
+  # Purchase a package
+  # @param package_id ID of package to purchase
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'recharge_purchase_by_package_id_put 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 recharge_transactions_by_transaction_id_get
+  # Get specific Transaction
+  # Get specific Transaction
+  # @param transaction_id ID of transaction to retrieve
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'recharge_transactions_by_transaction_id_get 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 recharge_transactions_get
+  # Purchase a package
+  # Get all transactions
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :limit Number of records per page
+  # @return [String]
+  describe 'recharge_transactions_get 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/contact_api_spec.rb

@@ -0,0 +1,129 @@
+=begin
+#ClickSend v3 API
+
+# This is an official SDK for [ClickSend](https://clicksend.com)  Below you will find a current list of the available methods for clicksend.  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+OpenAPI spec version: 3.1
+Contact: support@clicksend.com
+Generated by: https://github.com/clicksend-api/clicksend-codegen.git
+ClickSend Codegen version: 2.4.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ClickSendClient::ContactApi
+# Automatically generated by clicksend-codegen (github.com/clicksend-api/clicksend-codegen)
+# Please update as you see appropriate
+describe 'ContactApi' do
+  before do
+    # run before each test
+    @instance = ClickSendClient::ContactApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ContactApi' do
+    it 'should create an instance of ContactApi' do
+      expect(@instance).to be_instance_of(ClickSendClient::ContactApi)
+    end
+  end
+
+  # unit tests for lists_contacts_by_list_id_and_contact_id_delete
+  # Delete a contact
+  # Delete a contact
+  # @param list_id List ID
+  # @param contact_id Contact ID
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'lists_contacts_by_list_id_and_contact_id_delete 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 lists_contacts_by_list_id_and_contact_id_get
+  # Get a specific contact
+  # Get a specific contact
+  # @param list_id Your contact list id you want to access.
+  # @param contact_id Your contact id you want to access.
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'lists_contacts_by_list_id_and_contact_id_get 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 lists_contacts_by_list_id_and_contact_id_put
+  # Update specific contact
+  # Update specific contact
+  # @param list_id Contact list id
+  # @param contact_id Contact ID
+  # @param contact Contact model
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'lists_contacts_by_list_id_and_contact_id_put 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 lists_contacts_by_list_id_get
+  # Get all contacts in a list
+  # Get all contacts in a list
+  # @param list_id Contact list ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :limit Number of records per page
+  # @return [String]
+  describe 'lists_contacts_by_list_id_get 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 lists_contacts_by_list_id_post
+  # Create new contact
+  # Create new contact
+  # @param contact Contact model
+  # @param list_id List id
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'lists_contacts_by_list_id_post 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 lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put
+  # Remove all opted out contacts
+  # Remove all opted out contacts
+  # @param list_id Your list id
+  # @param opt_out_list_id Your opt out list id
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put 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 lists_transfer_contact_put
+  # Transfer contact to another list
+  # Transfer contact to another list
+  # @param from_list_id List ID for list that contains contact.
+  # @param contact_id Contact ID
+  # @param to_list_id List ID for list you want to transfer contact to.
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'lists_transfer_contact_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end