card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/update_m_pay_reg_status_request.rb

@@ -0,0 +1,112 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateMPayRegStatusRequest Model.
+  class UpdateMPayRegStatusRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id  of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Code (Shell Code) of the selected payer. 
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. It is optional for other countries if ColCoID is provided.
+    # Example:
+    # 86-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id  of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number (Ex: GB000000123) of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # List of MPay Request to be updated for Fleet Manager approval status.
+    # Mandatory
+    # Maximum number of requests that can be submitted are 50
+    # @return [Array[UpdateMPayRegStatusRequestMPayRequestsItems]]
+    attr_accessor :m_pay_requests
+
+    # 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['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['m_pay_requests'] = 'MPayRequests'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        m_pay_requests
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   m_pay_requests = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @m_pay_requests = m_pay_requests unless m_pay_requests == 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
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      m_pay_requests = nil
+      unless hash['MPayRequests'].nil?
+        m_pay_requests = []
+        hash['MPayRequests'].each do |structure|
+          m_pay_requests << (UpdateMPayRegStatusRequestMPayRequestsItems.from_hash(structure) if structure)
+        end
+      end
+
+      m_pay_requests = SKIP unless hash.key?('MPayRequests')
+
+      # Create object from extracted values.
+      UpdateMPayRegStatusRequest.new(col_co_id,
+                                     col_co_code,
+                                     payer_id,
+                                     payer_number,
+                                     m_pay_requests)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_m_pay_reg_status_request_m_pay_requests_items.rb

@@ -0,0 +1,105 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateMPayRegStatusRequestMPayRequestsItems Model.
+  class UpdateMPayRegStatusRequestMPayRequestsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of MPay Request to be updated for Fleet Manager approval status.
+    # Mandatory
+    # Maximum number of requests that can be submitted are 50
+    # @return [String]
+    attr_accessor :global_request_id
+
+    # Status of mobile payment registration request
+    # Mandatory.
+    # Allowed values –
+    # •	Approved
+    # •   Rejected
+    # @return [String]
+    attr_accessor :status
+
+    # Approver’s User ID
+    # ApproverUserID is mandatory when Status is Approved else optional
+    # @return [String]
+    attr_accessor :approver_user_id
+
+    # Approver’s display name
+    # Mandatory when Status is Approved else optional.
+    # @return [String]
+    attr_accessor :approver_user_display_name
+
+    # Reason for Fleet Manager approval/rejection.
+    # Optional
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['global_request_id'] = 'GlobalRequestID'
+      @_hash['status'] = 'Status'
+      @_hash['approver_user_id'] = 'ApproverUserID'
+      @_hash['approver_user_display_name'] = 'ApproverUserDisplayName'
+      @_hash['reason'] = 'Reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        global_request_id
+        status
+        approver_user_id
+        approver_user_display_name
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(global_request_id = SKIP,
+                   status = SKIP,
+                   approver_user_id = SKIP,
+                   approver_user_display_name = SKIP,
+                   reason = SKIP)
+      @global_request_id = global_request_id unless global_request_id == SKIP
+      @status = status unless status == SKIP
+      @approver_user_id = approver_user_id unless approver_user_id == SKIP
+      unless approver_user_display_name == SKIP
+        @approver_user_display_name =
+          approver_user_display_name
+      end
+      @reason = reason unless reason == 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.
+      global_request_id =
+        hash.key?('GlobalRequestID') ? hash['GlobalRequestID'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      approver_user_id =
+        hash.key?('ApproverUserID') ? hash['ApproverUserID'] : SKIP
+      approver_user_display_name =
+        hash.key?('ApproverUserDisplayName') ? hash['ApproverUserDisplayName'] : SKIP
+      reason = hash.key?('Reason') ? hash['Reason'] : SKIP
+
+      # Create object from extracted values.
+      UpdateMPayRegStatusRequestMPayRequestsItems.new(global_request_id,
+                                                      status,
+                                                      approver_user_id,
+                                                      approver_user_display_name,
+                                                      reason)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_m_pay_reg_status_response.rb

@@ -0,0 +1,60 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateMPayRegStatusResponse Model.
+  class UpdateMPayRegStatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # API Response Status
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['status'] = 'Status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == 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.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+
+      # Create object from extracted values.
+      UpdateMPayRegStatusResponse.new(request_id,
+                                      status)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/url_enum.rb

@@ -0,0 +1,23 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # url.
+  class UrlEnum
+    URL_ENUM = [
+      # TODO: Write general description for ENUM_APITESTSHELLCOMTEST
+      ENUM_APITESTSHELLCOMTEST = 'api-test.shell.com/test'.freeze,
+
+      # TODO: Write general description for ENUM_APISHELLCOM
+      ENUM_APISHELLCOM = 'api.shell.com'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      URL_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/usage_restrictions.rb

@@ -0,0 +1,311 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UsageRestrictions Model.
+  class UsageRestrictions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum spend value (amount) allowed per day.
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :daily_spend
+
+    # Maximum spend value (amount) allowed per week. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :weekly_spend
+
+    # Maximum spend value (amount) allowed per month. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :monthly_spend
+
+    # Maximum spend value (amount) allowed per transaction. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :per_transaction_spend
+
+    # Maximum volume (quantity) allowed per day. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Integer]
+    attr_accessor :daily_volume
+
+    # Maximum volume (quantity) allowed per week. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Integer]
+    attr_accessor :weekly_volume
+
+    # Maximum volume (quantity) allowed per month. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Integer]
+    attr_accessor :monthly_volume
+
+    # Maximum volume (quantity) allowed per transaction. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Integer]
+    attr_accessor :per_transaction_volume
+
+    # Maximum number of transactions allowed per day. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :daily_transaction_count
+
+    # Maximum number of transactions allowed per week. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :weekly_transaction_count
+
+    # Maximum number of transactions allowed per month. 
+    # Optional.
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :monthly_transaction_count
+
+    # Maximum spend value (amount) allowed per annum. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :annual_spend
+
+    # Maximum spend value (amount) allowed in card’s life time. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :life_time_spend
+
+    # Maximum volume (quantity) allowed per annum. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :annual_volume
+
+    # Maximum volume (quantity) allowed in card’s life time. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :life_time_volume
+
+    # Maximum number of transactions allowed per annum. 
+    # Optional.
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :annual_transaction_count
+
+    # Maximum number of transactions allowed in card’s lifetime. 
+    # Optional
+    # The value ‘0’ represents not set. If Values is passed as null, will be
+    # considered as inherited.
+    # Valid range: 0 to 9999999999
+    # @return [Float]
+    attr_accessor :life_time_transaction_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['daily_spend'] = 'DailySpend'
+      @_hash['weekly_spend'] = 'WeeklySpend'
+      @_hash['monthly_spend'] = 'MonthlySpend'
+      @_hash['per_transaction_spend'] = 'PerTransactionSpend'
+      @_hash['daily_volume'] = 'DailyVolume'
+      @_hash['weekly_volume'] = 'WeeklyVolume'
+      @_hash['monthly_volume'] = 'MonthlyVolume'
+      @_hash['per_transaction_volume'] = 'PerTransactionVolume'
+      @_hash['daily_transaction_count'] = 'DailyTransactionCount'
+      @_hash['weekly_transaction_count'] = 'WeeklyTransactionCount'
+      @_hash['monthly_transaction_count'] = 'MonthlyTransactionCount'
+      @_hash['annual_spend'] = 'AnnualSpend'
+      @_hash['life_time_spend'] = 'LifeTimeSpend'
+      @_hash['annual_volume'] = 'AnnualVolume'
+      @_hash['life_time_volume'] = 'LifeTimeVolume'
+      @_hash['annual_transaction_count'] = 'AnnualTransactionCount'
+      @_hash['life_time_transaction_count'] = 'LifeTimeTransactionCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        daily_spend
+        weekly_spend
+        monthly_spend
+        per_transaction_spend
+        daily_volume
+        weekly_volume
+        monthly_volume
+        per_transaction_volume
+        daily_transaction_count
+        weekly_transaction_count
+        monthly_transaction_count
+        annual_spend
+        life_time_spend
+        annual_volume
+        life_time_volume
+        annual_transaction_count
+        life_time_transaction_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        daily_spend
+        weekly_spend
+        monthly_spend
+        per_transaction_spend
+        daily_volume
+        weekly_volume
+        monthly_volume
+        per_transaction_volume
+        daily_transaction_count
+        weekly_transaction_count
+        monthly_transaction_count
+        annual_spend
+        life_time_spend
+        annual_volume
+        life_time_volume
+        annual_transaction_count
+        life_time_transaction_count
+      ]
+    end
+
+    def initialize(daily_spend = SKIP,
+                   weekly_spend = SKIP,
+                   monthly_spend = SKIP,
+                   per_transaction_spend = SKIP,
+                   daily_volume = SKIP,
+                   weekly_volume = SKIP,
+                   monthly_volume = SKIP,
+                   per_transaction_volume = SKIP,
+                   daily_transaction_count = SKIP,
+                   weekly_transaction_count = SKIP,
+                   monthly_transaction_count = SKIP,
+                   annual_spend = SKIP,
+                   life_time_spend = SKIP,
+                   annual_volume = SKIP,
+                   life_time_volume = SKIP,
+                   annual_transaction_count = SKIP,
+                   life_time_transaction_count = SKIP)
+      @daily_spend = daily_spend unless daily_spend == SKIP
+      @weekly_spend = weekly_spend unless weekly_spend == SKIP
+      @monthly_spend = monthly_spend unless monthly_spend == SKIP
+      @per_transaction_spend = per_transaction_spend unless per_transaction_spend == SKIP
+      @daily_volume = daily_volume unless daily_volume == SKIP
+      @weekly_volume = weekly_volume unless weekly_volume == SKIP
+      @monthly_volume = monthly_volume unless monthly_volume == SKIP
+      @per_transaction_volume = per_transaction_volume unless per_transaction_volume == SKIP
+      @daily_transaction_count = daily_transaction_count unless daily_transaction_count == SKIP
+      @weekly_transaction_count = weekly_transaction_count unless weekly_transaction_count == SKIP
+      unless monthly_transaction_count == SKIP
+        @monthly_transaction_count =
+          monthly_transaction_count
+      end
+      @annual_spend = annual_spend unless annual_spend == SKIP
+      @life_time_spend = life_time_spend unless life_time_spend == SKIP
+      @annual_volume = annual_volume unless annual_volume == SKIP
+      @life_time_volume = life_time_volume unless life_time_volume == SKIP
+      @annual_transaction_count = annual_transaction_count unless annual_transaction_count == SKIP
+      unless life_time_transaction_count == SKIP
+        @life_time_transaction_count =
+          life_time_transaction_count
+      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.
+      daily_spend = hash.key?('DailySpend') ? hash['DailySpend'] : SKIP
+      weekly_spend = hash.key?('WeeklySpend') ? hash['WeeklySpend'] : SKIP
+      monthly_spend = hash.key?('MonthlySpend') ? hash['MonthlySpend'] : SKIP
+      per_transaction_spend =
+        hash.key?('PerTransactionSpend') ? hash['PerTransactionSpend'] : SKIP
+      daily_volume = hash.key?('DailyVolume') ? hash['DailyVolume'] : SKIP
+      weekly_volume = hash.key?('WeeklyVolume') ? hash['WeeklyVolume'] : SKIP
+      monthly_volume = hash.key?('MonthlyVolume') ? hash['MonthlyVolume'] : SKIP
+      per_transaction_volume =
+        hash.key?('PerTransactionVolume') ? hash['PerTransactionVolume'] : SKIP
+      daily_transaction_count =
+        hash.key?('DailyTransactionCount') ? hash['DailyTransactionCount'] : SKIP
+      weekly_transaction_count =
+        hash.key?('WeeklyTransactionCount') ? hash['WeeklyTransactionCount'] : SKIP
+      monthly_transaction_count =
+        hash.key?('MonthlyTransactionCount') ? hash['MonthlyTransactionCount'] : SKIP
+      annual_spend = hash.key?('AnnualSpend') ? hash['AnnualSpend'] : SKIP
+      life_time_spend =
+        hash.key?('LifeTimeSpend') ? hash['LifeTimeSpend'] : SKIP
+      annual_volume = hash.key?('AnnualVolume') ? hash['AnnualVolume'] : SKIP
+      life_time_volume =
+        hash.key?('LifeTimeVolume') ? hash['LifeTimeVolume'] : SKIP
+      annual_transaction_count =
+        hash.key?('AnnualTransactionCount') ? hash['AnnualTransactionCount'] : SKIP
+      life_time_transaction_count =
+        hash.key?('LifeTimeTransactionCount') ? hash['LifeTimeTransactionCount'] : SKIP
+
+      # Create object from extracted values.
+      UsageRestrictions.new(daily_spend,
+                            weekly_spend,
+                            monthly_spend,
+                            per_transaction_spend,
+                            daily_volume,
+                            weekly_volume,
+                            monthly_volume,
+                            per_transaction_volume,
+                            daily_transaction_count,
+                            weekly_transaction_count,
+                            monthly_transaction_count,
+                            annual_spend,
+                            life_time_spend,
+                            annual_volume,
+                            life_time_volume,
+                            annual_transaction_count,
+                            life_time_transaction_count)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ShellCardManagementApIs
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/shell_card_management_ap_is/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end