data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/accounts.rb

@@ -0,0 +1,65 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Accounts Model.
+  class Accounts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id of the customer.
+    # Optional, if AccountNumber is passed, else mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional, if AccountId is passed, else mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+      ]
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == 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.
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+
+      # Create object from extracted values.
+      Accounts.new(account_id,
+                   account_number)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/address.rb

@@ -0,0 +1,174 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Address Model.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address Id in cards platform.
+    # @return [Integer]
+    attr_accessor :address_id
+
+    # Address line1
+    # @return [String]
+    attr_accessor :address_line1
+
+    # Address line2
+    # @return [String]
+    attr_accessor :address_line2
+
+    # AddressLine3
+    # @return [String]
+    attr_accessor :address_line3
+
+    # ZipCode
+    # @return [String]
+    attr_accessor :zip_code
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # Region Id of the address.
+    # @return [Integer]
+    attr_accessor :region_id
+
+    # Country ISO code of the address
+    # @return [String]
+    attr_accessor :country_iso_code
+
+    # Country for the address
+    # @return [String]
+    attr_accessor :country
+
+    # Telephone number of the address contact
+    # @return [String]
+    attr_accessor :telephone
+
+    # Email address of the address contact
+    # @return [String]
+    attr_accessor :email_address
+
+    # Fax number of the address contact
+    # @return [String]
+    attr_accessor :fax
+
+    # 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['zip_code'] = 'ZipCode'
+      @_hash['city'] = 'City'
+      @_hash['region_id'] = 'RegionId'
+      @_hash['country_iso_code'] = 'CountryISOCode'
+      @_hash['country'] = 'Country'
+      @_hash['telephone'] = 'Telephone'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['fax'] = 'Fax'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_id
+        address_line1
+        address_line2
+        address_line3
+        zip_code
+        city
+        region_id
+        country_iso_code
+        country
+        telephone
+        email_address
+        fax
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        address_id
+        address_line1
+        address_line2
+        address_line3
+        zip_code
+        city
+        region_id
+        country_iso_code
+        country
+        telephone
+        email_address
+        fax
+      ]
+    end
+
+    def initialize(address_id = SKIP,
+                   address_line1 = SKIP,
+                   address_line2 = SKIP,
+                   address_line3 = SKIP,
+                   zip_code = SKIP,
+                   city = SKIP,
+                   region_id = SKIP,
+                   country_iso_code = SKIP,
+                   country = SKIP,
+                   telephone = SKIP,
+                   email_address = SKIP,
+                   fax = 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
+      @zip_code = zip_code unless zip_code == SKIP
+      @city = city unless city == SKIP
+      @region_id = region_id unless region_id == SKIP
+      @country_iso_code = country_iso_code unless country_iso_code == SKIP
+      @country = country unless country == SKIP
+      @telephone = telephone unless telephone == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @fax = fax unless fax == 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
+      zip_code = hash.key?('ZipCode') ? hash['ZipCode'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+      region_id = hash.key?('RegionId') ? hash['RegionId'] : SKIP
+      country_iso_code =
+        hash.key?('CountryISOCode') ? hash['CountryISOCode'] : SKIP
+      country = hash.key?('Country') ? hash['Country'] : SKIP
+      telephone = hash.key?('Telephone') ? hash['Telephone'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      fax = hash.key?('Fax') ? hash['Fax'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(address_id,
+                  address_line1,
+                  address_line2,
+                  address_line3,
+                  zip_code,
+                  city,
+                  region_id,
+                  country_iso_code,
+                  country,
+                  telephone,
+                  email_address,
+                  fax)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/associated_account.rb

@@ -0,0 +1,98 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # AssociatedAccount Model.
+  class AssociatedAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier  of the Associated Account associated with the Payer.
+    # @return [Integer]
+    attr_accessor :associated_account_id
+
+    # Account number of the Associated Account associated with the Payer.
+    # @return [String]
+    attr_accessor :associated_account_number
+
+    # Account associated with the Payer.
+    # @return [String]
+    attr_accessor :associated_account_short_name
+
+    # Full name of the Associated Account associated with the Payer.
+    # @return [String]
+    attr_accessor :associated_account_full_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['associated_account_id'] = 'AssociatedAccountId'
+      @_hash['associated_account_number'] = 'AssociatedAccountNumber'
+      @_hash['associated_account_short_name'] = 'AssociatedAccountShortName'
+      @_hash['associated_account_full_name'] = 'AssociatedAccountFullName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associated_account_id
+        associated_account_number
+        associated_account_short_name
+        associated_account_full_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        associated_account_id
+        associated_account_number
+        associated_account_short_name
+        associated_account_full_name
+      ]
+    end
+
+    def initialize(associated_account_id = SKIP,
+                   associated_account_number = SKIP,
+                   associated_account_short_name = SKIP,
+                   associated_account_full_name = SKIP)
+      @associated_account_id = associated_account_id unless associated_account_id == SKIP
+      unless associated_account_number == SKIP
+        @associated_account_number =
+          associated_account_number
+      end
+      unless associated_account_short_name == SKIP
+        @associated_account_short_name =
+          associated_account_short_name
+      end
+      unless associated_account_full_name == SKIP
+        @associated_account_full_name =
+          associated_account_full_name
+      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.
+      associated_account_id =
+        hash.key?('AssociatedAccountId') ? hash['AssociatedAccountId'] : SKIP
+      associated_account_number =
+        hash.key?('AssociatedAccountNumber') ? hash['AssociatedAccountNumber'] : SKIP
+      associated_account_short_name =
+        hash.key?('AssociatedAccountShortName') ? hash['AssociatedAccountShortName'] : SKIP
+      associated_account_full_name =
+        hash.key?('AssociatedAccountFullName') ? hash['AssociatedAccountFullName'] : SKIP
+
+      # Create object from extracted values.
+      AssociatedAccount.new(associated_account_id,
+                            associated_account_number,
+                            associated_account_short_name,
+                            associated_account_full_name)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/audit_request.rb

@@ -0,0 +1,256 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # AuditRequest Model.
+  class AuditRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Status of requests to be fetched.
+    # •	Success
+    # •	Failed
+    # •	InProgress
+    # •	Submitted
+    # •	Rejected
+    # •	PendingApproval
+    # •	All
+    # •	MailedToCSC
+    # Optional
+    # If not passed “All” will be considered as the default value.
+    # @return [String]
+    attr_accessor :status
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Payer Id  of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Id  of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [String]
+    attr_accessor :account_number
+
+    # 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 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id  of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Id  of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1 for Philippines
+    # 5 for UK
+    # @return [Accounts]
+    attr_accessor :accounts
+
+    # Page Size – Number of records to show on a page
+    # Optional
+    # Default value 50
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # To search for requests submitted until this date.
+    # Optional 
+    # Format: yyyyMMdd 
+    # Example: 20200130
+    # If ToDate is not provided and FromDate is provided, then ToDate will be
+    # considered as current date or 30 days from FromDate, whichever is earlier.
+    # However, when both FromDate and ToDate is not provided then last 30 days
+    # will be considered for filtering.
+    # @return [Array[String]]
+    attr_accessor :requested_operation
+
+    # Allowed Sorting Options:
+    # 1.	SubmittedDateDescending
+    # 2.	SubmittedDateAscending 
+    # 3.	AccountNumberAscending
+    # 4.	AccountNumberDescending
+    # Optional: Default value is 1
+    # Example value to be passed: 1,3
+    # @return [String]
+    attr_accessor :sort_order
+
+    # Search text used as criteria to filter the requests.
+    # Optional
+    # Minimum length is 4 characters (configurable). Else, an error (0007) will
+    # be returned. When valid text is provided, MS will return all the records
+    # that contains the Search Text within any of the look up fields
+    # @return [String]
+    attr_accessor :search_text
+
+    # Page Number (as shown to the users)
+    # Optional
+    # Default value 1
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # To search for requests submitted from this date.
+    # Optional
+    # Maximum of X days duration allowed per search. The X value is configurable
+    # and initially set to 180 days.
+    # Format: yyyyMMdd
+    # Example: 20200101
+    # If FromDate is not provided and ToDate is provided, then FromDate will be
+    # considered as 30 days less than ToDate. However, when both FromDate and
+    # ToDate is not provided then last 30 days will be considered for filtering.
+    # @return [String]
+    attr_accessor :from_date
+
+    # To search for requests submitted until this date.
+    # Optional 
+    # Format: yyyyMMdd 
+    # Example: 20200130
+    # If ToDate is not provided and FromDate is provided, then ToDate will be
+    # considered as current date or 30 days from FromDate, whichever is earlier.
+    # However, when both FromDate and ToDate is not provided then last 30 days
+    # will be considered for filtering.
+    # @return [String]
+    attr_accessor :to_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'Status'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['accounts'] = 'Accounts'
+      @_hash['page_size'] = 'PageSize'
+      @_hash['requested_operation'] = 'RequestedOperation'
+      @_hash['sort_order'] = 'SortOrder'
+      @_hash['search_text'] = 'SearchText'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        payer_number
+        payer_id
+        account_number
+        col_co_code
+        col_co_id
+        accounts
+        page_size
+        requested_operation
+        sort_order
+        search_text
+        current_page
+        from_date
+        to_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payer_number
+        payer_id
+        account_number
+        col_co_code
+        col_co_id
+        sort_order
+        search_text
+        current_page
+        from_date
+        to_date
+      ]
+    end
+
+    def initialize(status = SKIP,
+                   payer_number = SKIP,
+                   payer_id = SKIP,
+                   account_number = SKIP,
+                   col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   accounts = SKIP,
+                   page_size = SKIP,
+                   requested_operation = SKIP,
+                   sort_order = SKIP,
+                   search_text = SKIP,
+                   current_page = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP)
+      @status = status unless status == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @accounts = accounts unless accounts == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @requested_operation = requested_operation unless requested_operation == SKIP
+      @sort_order = sort_order unless sort_order == SKIP
+      @search_text = search_text unless search_text == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == 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.
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      accounts = Accounts.from_hash(hash['Accounts']) if hash['Accounts']
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+      requested_operation =
+        hash.key?('RequestedOperation') ? hash['RequestedOperation'] : SKIP
+      sort_order = hash.key?('SortOrder') ? hash['SortOrder'] : SKIP
+      search_text = hash.key?('SearchText') ? hash['SearchText'] : SKIP
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+
+      # Create object from extracted values.
+      AuditRequest.new(status,
+                       payer_number,
+                       payer_id,
+                       account_number,
+                       col_co_code,
+                       col_co_id,
+                       accounts,
+                       page_size,
+                       requested_operation,
+                       sort_order,
+                       search_text,
+                       current_page,
+                       from_date,
+                       to_date)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/audit_response.rb

@@ -0,0 +1,111 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # AuditResponse Model.
+  class AuditResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AuditResponseAuditsItems]]
+    attr_accessor :audits
+
+    # Current Page
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # Total row count matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :row_count
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # API RequestId
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['audits'] = 'Audits'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['row_count'] = 'RowCount'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        audits
+        current_page
+        row_count
+        total_pages
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(audits = SKIP,
+                   current_page = SKIP,
+                   row_count = SKIP,
+                   total_pages = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @audits = audits unless audits == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @row_count = row_count unless row_count == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @error = error unless error == SKIP
+      @request_id = request_id unless request_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.
+      # Parameter is an array, so we need to iterate through it
+      audits = nil
+      unless hash['Audits'].nil?
+        audits = []
+        hash['Audits'].each do |structure|
+          audits << (AuditResponseAuditsItems.from_hash(structure) if structure)
+        end
+      end
+
+      audits = SKIP unless hash.key?('Audits')
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      row_count = hash.key?('RowCount') ? hash['RowCount'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      AuditResponse.new(audits,
+                        current_page,
+                        row_count,
+                        total_pages,
+                        error,
+                        request_id)
+    end
+  end
+end