card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/delivery_addresses.rb

@@ -0,0 +1,258 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # DeliveryAddresses Model.
+  class DeliveryAddresses < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address Id
+    # @return [Integer]
+    attr_accessor :address_id
+
+    # AddressLine1
+    # @return [String]
+    attr_accessor :address_line1
+
+    # AddressLine2
+    # @return [String]
+    attr_accessor :address_line2
+
+    # AddressLine3
+    # @return [String]
+    attr_accessor :address_line3
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # Account Name
+    # @return [String]
+    attr_accessor :company_name
+
+    # Contact fore name of the delivery address.
+    # @return [String]
+    attr_accessor :contact_fore_name
+
+    # Contact last name of the delivery address.
+    # @return [String]
+    attr_accessor :contact_last_name
+
+    # Contact middle name of the delivery address.
+    # @return [String]
+    attr_accessor :contact_middle_name
+
+    # ContactTitle
+    # @return [String]
+    attr_accessor :contact_title
+
+    # Country
+    # @return [String]
+    attr_accessor :country
+
+    # Country Id
+    # @return [Integer]
+    attr_accessor :country_id
+
+    # Country ISO code
+    # @return [String]
+    attr_accessor :country_iso_code
+
+    # Fax number of the address contact.
+    # @return [String]
+    attr_accessor :fax
+
+    # Region of the Card Delivery address
+    # @return [String]
+    attr_accessor :region
+
+    # Region Id of the address.
+    # @return [Integer]
+    attr_accessor :region_id
+
+    # Telephone number of the address contact
+    # @return [String]
+    attr_accessor :telephone
+
+    # Delivery Zip code
+    # @return [String]
+    attr_accessor :zip_code
+
+    # Delivery address type.
+    # Possible Values:
+    # 1 – Card and PIN delivery address
+    # 2 – Card delivery address
+    # 3 – PIN delivery address
+    # @return [Integer]
+    attr_accessor :address_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_id'] = 'AddressId'
+      @_hash['address_line1'] = 'AddressLine1'
+      @_hash['address_line2'] = 'AddressLine2'
+      @_hash['address_line3'] = 'AddressLine3'
+      @_hash['city'] = 'City'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash['contact_fore_name'] = 'ContactForeName'
+      @_hash['contact_last_name'] = 'ContactLastName'
+      @_hash['contact_middle_name'] = 'ContactMiddleName'
+      @_hash['contact_title'] = 'ContactTitle'
+      @_hash['country'] = 'Country'
+      @_hash['country_id'] = 'CountryId'
+      @_hash['country_iso_code'] = 'CountryISOCode'
+      @_hash['fax'] = 'Fax'
+      @_hash['region'] = 'Region'
+      @_hash['region_id'] = 'RegionId'
+      @_hash['telephone'] = 'Telephone'
+      @_hash['zip_code'] = 'ZipCode'
+      @_hash['address_type'] = 'AddressType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_id
+        address_line1
+        address_line2
+        address_line3
+        city
+        company_name
+        contact_fore_name
+        contact_last_name
+        contact_middle_name
+        contact_title
+        country
+        country_id
+        country_iso_code
+        fax
+        region
+        region_id
+        telephone
+        zip_code
+        address_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        address_id
+        address_line1
+        address_line2
+        address_line3
+        city
+        company_name
+        contact_fore_name
+        contact_last_name
+        contact_middle_name
+        contact_title
+        country
+        country_id
+        country_iso_code
+        fax
+        region
+        region_id
+        telephone
+        zip_code
+        address_type
+      ]
+    end
+
+    def initialize(address_id = SKIP,
+                   address_line1 = SKIP,
+                   address_line2 = SKIP,
+                   address_line3 = SKIP,
+                   city = SKIP,
+                   company_name = SKIP,
+                   contact_fore_name = SKIP,
+                   contact_last_name = SKIP,
+                   contact_middle_name = SKIP,
+                   contact_title = SKIP,
+                   country = SKIP,
+                   country_id = SKIP,
+                   country_iso_code = SKIP,
+                   fax = SKIP,
+                   region = SKIP,
+                   region_id = SKIP,
+                   telephone = SKIP,
+                   zip_code = SKIP,
+                   address_type = SKIP)
+      @address_id = address_id unless address_id == SKIP
+      @address_line1 = address_line1 unless address_line1 == SKIP
+      @address_line2 = address_line2 unless address_line2 == SKIP
+      @address_line3 = address_line3 unless address_line3 == SKIP
+      @city = city unless city == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @contact_fore_name = contact_fore_name unless contact_fore_name == SKIP
+      @contact_last_name = contact_last_name unless contact_last_name == SKIP
+      @contact_middle_name = contact_middle_name unless contact_middle_name == SKIP
+      @contact_title = contact_title unless contact_title == SKIP
+      @country = country unless country == SKIP
+      @country_id = country_id unless country_id == SKIP
+      @country_iso_code = country_iso_code unless country_iso_code == SKIP
+      @fax = fax unless fax == SKIP
+      @region = region unless region == SKIP
+      @region_id = region_id unless region_id == SKIP
+      @telephone = telephone unless telephone == SKIP
+      @zip_code = zip_code unless zip_code == SKIP
+      @address_type = address_type unless address_type == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      address_id = hash.key?('AddressId') ? hash['AddressId'] : SKIP
+      address_line1 = hash.key?('AddressLine1') ? hash['AddressLine1'] : SKIP
+      address_line2 = hash.key?('AddressLine2') ? hash['AddressLine2'] : SKIP
+      address_line3 = hash.key?('AddressLine3') ? hash['AddressLine3'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : SKIP
+      contact_fore_name =
+        hash.key?('ContactForeName') ? hash['ContactForeName'] : SKIP
+      contact_last_name =
+        hash.key?('ContactLastName') ? hash['ContactLastName'] : SKIP
+      contact_middle_name =
+        hash.key?('ContactMiddleName') ? hash['ContactMiddleName'] : SKIP
+      contact_title = hash.key?('ContactTitle') ? hash['ContactTitle'] : SKIP
+      country = hash.key?('Country') ? hash['Country'] : SKIP
+      country_id = hash.key?('CountryId') ? hash['CountryId'] : SKIP
+      country_iso_code =
+        hash.key?('CountryISOCode') ? hash['CountryISOCode'] : SKIP
+      fax = hash.key?('Fax') ? hash['Fax'] : SKIP
+      region = hash.key?('Region') ? hash['Region'] : SKIP
+      region_id = hash.key?('RegionId') ? hash['RegionId'] : SKIP
+      telephone = hash.key?('Telephone') ? hash['Telephone'] : SKIP
+      zip_code = hash.key?('ZipCode') ? hash['ZipCode'] : SKIP
+      address_type = hash.key?('AddressType') ? hash['AddressType'] : SKIP
+
+      # Create object from extracted values.
+      DeliveryAddresses.new(address_id,
+                            address_line1,
+                            address_line2,
+                            address_line3,
+                            city,
+                            company_name,
+                            contact_fore_name,
+                            contact_last_name,
+                            contact_middle_name,
+                            contact_title,
+                            country,
+                            country_id,
+                            country_iso_code,
+                            fax,
+                            region,
+                            region_id,
+                            telephone,
+                            zip_code,
+                            address_type)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/eid_access.rb

@@ -0,0 +1,75 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # EIDAccess Model.
+  class EIDAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting company id.
+    # @return [String]
+    attr_accessor :col_co_id
+
+    # Collecting company Code
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Identifier for the EID account group configured for the user.
+    # @return [String]
+    attr_accessor :account_group_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['account_group_id'] = 'AccountGroupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        account_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        account_group_id
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   account_group_id = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @account_group_id = account_group_id unless account_group_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      account_group_id =
+        hash.key?('AccountGroupId') ? hash['AccountGroupId'] : SKIP
+
+      # Create object from extracted values.
+      EIDAccess.new(col_co_id,
+                    col_co_code,
+                    account_group_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/error_details.rb

@@ -0,0 +1,81 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ErrorDetails Model.
+  class ErrorDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code representing the error encountered
+    # @return [String]
+    attr_accessor :code
+
+    # Error type description
+    # @return [String]
+    attr_accessor :title
+
+    # Detailed inforamtion about the error
+    # @return [String]
+    attr_accessor :detail
+
+    # Applicable when more details related to error to be returned
+    # @return [Object]
+    attr_accessor :additional_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['title'] = 'Title'
+      @_hash['detail'] = 'Detail'
+      @_hash['additional_info'] = 'AdditionalInfo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        title
+        detail
+        additional_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP,
+                   title = SKIP,
+                   detail = SKIP,
+                   additional_info = SKIP)
+      @code = code unless code == SKIP
+      @title = title unless title == SKIP
+      @detail = detail unless detail == SKIP
+      @additional_info = additional_info unless additional_info == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      title = hash.key?('Title') ? hash['Title'] : SKIP
+      detail = hash.key?('Detail') ? hash['Detail'] : SKIP
+      additional_info =
+        hash.key?('AdditionalInfo') ? hash['AdditionalInfo'] : SKIP
+
+      # Create object from extracted values.
+      ErrorDetails.new(code,
+                       title,
+                       detail,
+                       additional_info)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/error_status.rb

@@ -0,0 +1,60 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ErrorStatus Model.
+  class ErrorStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error Code
+    # @return [String]
+    attr_accessor :code
+
+    # Error Description
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP,
+                   description = SKIP)
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+
+      # Create object from extracted values.
+      ErrorStatus.new(code,
+                      description)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/error_user_access.rb

@@ -0,0 +1,50 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ErrorUserAccess Model.
+  class ErrorUserAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ErrorUserAccessError]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error = SKIP)
+      @error = error unless error == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      error = ErrorUserAccessError.from_hash(hash['Error']) if hash['Error']
+
+      # Create object from extracted values.
+      ErrorUserAccess.new(error)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/error_user_access_error.rb

@@ -0,0 +1,60 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ErrorUserAccessError Model.
+  class ErrorUserAccessError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error Code
+    # @return [String]
+    attr_accessor :code
+
+    # Description
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP,
+                   description = SKIP)
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+
+      # Create object from extracted values.
+      ErrorUserAccessError.new(code,
+                               description)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/finance_currency.rb

@@ -0,0 +1,98 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # This entity will not be present in the response if the
+  # ‘IncludeFinanceCurrency’ flag in the request is ‘false’
+  class FinanceCurrency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency ISO Code used for the Finance Widget.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Currency Symbol
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Factor to be used for converting the amounts in invoice currency to
+    # finance widget currency. (If finance currency is same as invoice currency,
+    # then the value of this field will be “1” so that the value does not
+    # change)
+    # @return [Float]
+    attr_accessor :invoice_exchange_rate
+
+    # Factor to be used for converting the amounts in credit limit currency to
+    # finance widget currency. (If finance currency is same as credit limit
+    # currency, then the value of this field will be “1” so that the value does
+    # not change)
+    # @return [Float]
+    attr_accessor :credit_limit_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['invoice_exchange_rate'] = 'Invoice_ExchangeRate'
+      @_hash['credit_limit_exchange_rate'] = 'CreditLimit_ExchangeRate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency_code
+        currency_symbol
+        invoice_exchange_rate
+        credit_limit_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency_code
+        currency_symbol
+        invoice_exchange_rate
+        credit_limit_exchange_rate
+      ]
+    end
+
+    def initialize(currency_code = SKIP,
+                   currency_symbol = SKIP,
+                   invoice_exchange_rate = SKIP,
+                   credit_limit_exchange_rate = SKIP)
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @invoice_exchange_rate = invoice_exchange_rate unless invoice_exchange_rate == SKIP
+      unless credit_limit_exchange_rate == SKIP
+        @credit_limit_exchange_rate =
+          credit_limit_exchange_rate
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      invoice_exchange_rate =
+        hash.key?('Invoice_ExchangeRate') ? hash['Invoice_ExchangeRate'] : SKIP
+      credit_limit_exchange_rate =
+        hash.key?('CreditLimit_ExchangeRate') ? hash['CreditLimit_ExchangeRate'] : SKIP
+
+      # Create object from extracted values.
+      FinanceCurrency.new(currency_code,
+                          currency_symbol,
+                          invoice_exchange_rate,
+                          credit_limit_exchange_rate)
+    end
+  end
+end