data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/recent_transactions_response.rb

@@ -0,0 +1,110 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # RecentTransactionsResponse Model.
+  class RecentTransactionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # RequestID is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
+    # @return [String]
+    attr_accessor :request_id
+
+    # status of the API call
+    # @return [String]
+    attr_accessor :status
+
+    # CurrentPage
+    # @return [Integer]
+    attr_accessor :page
+
+    # RowCount
+    # @return [Integer]
+    attr_accessor :row_count
+
+    # TotalPages
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # API Response
+    # @return [Array[RecentTransactions]]
+    attr_accessor :data
+
+    # 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['page'] = 'Page'
+      @_hash['row_count'] = 'RowCount'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['data'] = 'Data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        page
+        row_count
+        total_pages
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   page = SKIP,
+                   row_count = SKIP,
+                   total_pages = SKIP,
+                   data = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @page = page unless page == SKIP
+      @row_count = row_count unless row_count == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @data = data unless data == 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
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      row_count = hash.key?('RowCount') ? hash['RowCount'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (RecentTransactions.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      RecentTransactionsResponse.new(request_id,
+                                     status,
+                                     page,
+                                     row_count,
+                                     total_pages,
+                                     data)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/role.rb

@@ -0,0 +1,102 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Role Model.
+  class Role < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Role Name of the user
+    # @return [String]
+    attr_accessor :role_name
+
+    # Whether the role is an administrator.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_customer_admin
+
+    # Whether the role is a customer user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_customer_user
+
+    # True if the role is Shell user, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_shell_admin
+
+    # True/False.
+    # True if the role is Service accounts, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_service_account
+
+    # True/False.
+    # True, if the role allows user administration, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_user_admin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['role_name'] = 'RoleName'
+      @_hash['is_customer_admin'] = 'IsCustomerAdmin'
+      @_hash['is_customer_user'] = 'IsCustomerUser'
+      @_hash['is_shell_admin'] = 'IsShellAdmin'
+      @_hash['is_service_account'] = 'IsServiceAccount'
+      @_hash['is_user_admin'] = 'IsUserAdmin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        role_name
+        is_customer_admin
+        is_customer_user
+        is_shell_admin
+        is_service_account
+        is_user_admin
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(role_name = SKIP,
+                   is_customer_admin = true,
+                   is_customer_user = false,
+                   is_shell_admin = false,
+                   is_service_account = false,
+                   is_user_admin = true)
+      @role_name = role_name unless role_name == SKIP
+      @is_customer_admin = is_customer_admin unless is_customer_admin == SKIP
+      @is_customer_user = is_customer_user unless is_customer_user == SKIP
+      @is_shell_admin = is_shell_admin unless is_shell_admin == SKIP
+      @is_service_account = is_service_account unless is_service_account == SKIP
+      @is_user_admin = is_user_admin unless is_user_admin == 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.
+      role_name = hash.key?('RoleName') ? hash['RoleName'] : SKIP
+      is_customer_admin = hash['IsCustomerAdmin'] ||= true
+      is_customer_user = hash['IsCustomerUser'] ||= false
+      is_shell_admin = hash['IsShellAdmin'] ||= false
+      is_service_account = hash['IsServiceAccount'] ||= false
+      is_user_admin = hash['IsUserAdmin'] ||= true
+
+      # Create object from extracted values.
+      Role.new(role_name,
+               is_customer_admin,
+               is_customer_user,
+               is_shell_admin,
+               is_service_account,
+               is_user_admin)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/search_doc_req.rb

@@ -0,0 +1,269 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchDocReq Model.
+  class SearchDocReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payer Number of the selected payer.
+    # Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Account Number of the customer.
+    # Mandatory for customer users else optional.
+    # This input is a search criterion, if given.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account Number of the customers.
+    # optional.
+    # This input is a search criterion, if given.
+    # Example: [“GB00000123”, “GB00000225”]
+    # @return [Array[String]]
+    attr_accessor :account_number_list
+
+    # Invoice number.
+    # Optional if InvoiceNumberList is passed else Mandatory 
+    # This input is a search criterion, if given.
+    # Example: 0123456789
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # List of Invoice number.
+    # Optional if InvoiceNumber is passed else Mandatory 
+    # Example: [“0123456789”, “0123459799”]
+    # @return [Array[String]]
+    attr_accessor :invoice_number_list
+
+    # The status of the invoices
+    # Optional
+    # One of the following values:
+    # •	NEW
+    # •	VIEWED
+    # •	DOWNLOADED
+    # •	RESTORED
+    # @return [String]
+    attr_accessor :invoice_status
+
+    # Invoice Issuing Date Range/From
+    # Optional
+    # Format: yyyy/MM/dd
+    # @return [String]
+    attr_accessor :issuing_date_from
+
+    # Invoice Issuing Date Range/To
+    # Optional
+    # Format: yyyy/MM/dd
+    # @return [String]
+    attr_accessor :issuing_date_to
+
+    # Invoice Due Date Range/From
+    # Optional
+    # Format: yyyy/MM/dd
+    # @return [String]
+    attr_accessor :due_date_from
+
+    # Invoice Due Date Range/To
+    # Optional
+    # Format: yyyy/MM/dd
+    # @return [String]
+    attr_accessor :due_date_to
+
+    # Gross amount of the bill.
+    # Optional
+    # @return [String]
+    attr_accessor :gross_amount
+
+    # Criteria on the gross amount, for instance use GT when to retrieve the
+    # invoices for that gross amount is greater than the given amount on
+    # GrossAmount parameter above.
+    # Optional
+    # This parameter will be ignored if GrossAmount parameter is not set.
+    # One of the following values:
+    # •	LT (Less Than)
+    # •	LE (Lesser or Equal)
+    # •	EQ (equal)
+    # •	GE (Greater or equal)
+    # •	GT (Greater than)
+    # @return [String]
+    attr_accessor :gross_amount_operator
+
+    # Document Type
+    # Optional
+    # One of the following values:
+    # •	NAT (National)
+    # •	INT (International)
+    # •	SOA (Statement of Account)
+    # @return [String]
+    attr_accessor :document_type
+
+    # Two letter ISO country code.
+    # @return [String]
+    attr_accessor :vat_issuer_country
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory
+    # Example:
+    # 86-Philippines
+    # 5-UK
+    # @return [Array[String]]
+    attr_accessor :sorty_by
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory
+    # Example:
+    # 86-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['account_number_list'] = 'AccountNumberList'
+      @_hash['invoice_number'] = 'InvoiceNumber'
+      @_hash['invoice_number_list'] = 'InvoiceNumberList'
+      @_hash['invoice_status'] = 'InvoiceStatus'
+      @_hash['issuing_date_from'] = 'IssuingDateFrom'
+      @_hash['issuing_date_to'] = 'IssuingDateTo'
+      @_hash['due_date_from'] = 'DueDateFrom'
+      @_hash['due_date_to'] = 'DueDateTo'
+      @_hash['gross_amount'] = 'GrossAmount'
+      @_hash['gross_amount_operator'] = 'GrossAmountOperator'
+      @_hash['document_type'] = 'DocumentType'
+      @_hash['vat_issuer_country'] = 'VATIssuerCountry'
+      @_hash['sorty_by'] = 'SortyBy'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        account_number_list
+        invoice_number
+        invoice_number_list
+        invoice_status
+        issuing_date_from
+        issuing_date_to
+        due_date_from
+        due_date_to
+        gross_amount
+        gross_amount_operator
+        document_type
+        vat_issuer_country
+        sorty_by
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payer_number
+        account_number
+        invoice_number
+        invoice_status
+        issuing_date_from
+        issuing_date_to
+        due_date_from
+        due_date_to
+        gross_amount
+        gross_amount_operator
+        document_type
+        vat_issuer_country
+        col_co_code
+      ]
+    end
+
+    def initialize(payer_number = nil,
+                   col_co_code = nil,
+                   account_number = SKIP,
+                   account_number_list = SKIP,
+                   invoice_number = SKIP,
+                   invoice_number_list = SKIP,
+                   invoice_status = SKIP,
+                   issuing_date_from = SKIP,
+                   issuing_date_to = SKIP,
+                   due_date_from = SKIP,
+                   due_date_to = SKIP,
+                   gross_amount = SKIP,
+                   gross_amount_operator = SKIP,
+                   document_type = SKIP,
+                   vat_issuer_country = SKIP,
+                   sorty_by = SKIP)
+      @payer_number = payer_number
+      @account_number = account_number unless account_number == SKIP
+      @account_number_list = account_number_list unless account_number_list == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @invoice_number_list = invoice_number_list unless invoice_number_list == SKIP
+      @invoice_status = invoice_status unless invoice_status == SKIP
+      @issuing_date_from = issuing_date_from unless issuing_date_from == SKIP
+      @issuing_date_to = issuing_date_to unless issuing_date_to == SKIP
+      @due_date_from = due_date_from unless due_date_from == SKIP
+      @due_date_to = due_date_to unless due_date_to == SKIP
+      @gross_amount = gross_amount unless gross_amount == SKIP
+      @gross_amount_operator = gross_amount_operator unless gross_amount_operator == SKIP
+      @document_type = document_type unless document_type == SKIP
+      @vat_issuer_country = vat_issuer_country unless vat_issuer_country == SKIP
+      @sorty_by = sorty_by unless sorty_by == SKIP
+      @col_co_code = col_co_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : nil
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : nil
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      account_number_list =
+        hash.key?('AccountNumberList') ? hash['AccountNumberList'] : SKIP
+      invoice_number = hash.key?('InvoiceNumber') ? hash['InvoiceNumber'] : SKIP
+      invoice_number_list =
+        hash.key?('InvoiceNumberList') ? hash['InvoiceNumberList'] : SKIP
+      invoice_status = hash.key?('InvoiceStatus') ? hash['InvoiceStatus'] : SKIP
+      issuing_date_from =
+        hash.key?('IssuingDateFrom') ? hash['IssuingDateFrom'] : SKIP
+      issuing_date_to =
+        hash.key?('IssuingDateTo') ? hash['IssuingDateTo'] : SKIP
+      due_date_from = hash.key?('DueDateFrom') ? hash['DueDateFrom'] : SKIP
+      due_date_to = hash.key?('DueDateTo') ? hash['DueDateTo'] : SKIP
+      gross_amount = hash.key?('GrossAmount') ? hash['GrossAmount'] : SKIP
+      gross_amount_operator =
+        hash.key?('GrossAmountOperator') ? hash['GrossAmountOperator'] : SKIP
+      document_type = hash.key?('DocumentType') ? hash['DocumentType'] : SKIP
+      vat_issuer_country =
+        hash.key?('VATIssuerCountry') ? hash['VATIssuerCountry'] : SKIP
+      sorty_by = hash.key?('SortyBy') ? hash['SortyBy'] : SKIP
+
+      # Create object from extracted values.
+      SearchDocReq.new(payer_number,
+                       col_co_code,
+                       account_number,
+                       account_number_list,
+                       invoice_number,
+                       invoice_number_list,
+                       invoice_status,
+                       issuing_date_from,
+                       issuing_date_to,
+                       due_date_from,
+                       due_date_to,
+                       gross_amount,
+                       gross_amount_operator,
+                       document_type,
+                       vat_issuer_country,
+                       sorty_by)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/search_documents_invoice.rb

@@ -0,0 +1,204 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchDocumentsInvoice Model.
+  class SearchDocumentsInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Invoice Reference id of the invoice for downloading the zip file
+    # containing PDF and proofing elements.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :document_reference
+
+    # Payment customer number.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # Customer payer name
+    # @return [String]
+    attr_accessor :payer_name
+
+    # Account Number
+    # Example: GB99215176
+    # @return [String]
+    attr_accessor :account_number
+
+    # Invoice account name
+    # @return [String]
+    attr_accessor :account_name
+
+    # Document type
+    # String containing one of the following values:
+    # •	NAT (National)
+    # •	INT (International)
+    # •	SOA (Statement of Account)
+    # @return [String]
+    attr_accessor :document_type
+
+    # Included tax amount in the invoice
+    # @return [Float]
+    attr_accessor :gross_amount
+
+    # Included tax amount in the invoice
+    # @return [Float]
+    attr_accessor :net_amount
+
+    # Included tax amount in the invoice
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # Included tax amount in the invoice
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Included tax amount in the invoice
+    # @return [String]
+    attr_accessor :invoice_status
+
+    # Included tax amount in the invoice
+    # @return [String]
+    attr_accessor :invoice_date
+
+    # Included tax amount in the invoice
+    # @return [String]
+    attr_accessor :due_date
+
+    # Included tax amount in the invoice
+    # @return [String]
+    attr_accessor :vat_country_iso_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document_reference'] = 'DocumentReference'
+      @_hash['invoice_number'] = 'InvoiceNumber'
+      @_hash['payer_name'] = 'PayerName'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['account_name'] = 'AccountName'
+      @_hash['document_type'] = 'DocumentType'
+      @_hash['gross_amount'] = 'GrossAmount'
+      @_hash['net_amount'] = 'NetAmount'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['invoice_status'] = 'InvoiceStatus'
+      @_hash['invoice_date'] = 'InvoiceDate'
+      @_hash['due_date'] = 'DueDate'
+      @_hash['vat_country_iso_code'] = 'VATCountryISOCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document_reference
+        invoice_number
+        payer_name
+        account_number
+        account_name
+        document_type
+        gross_amount
+        net_amount
+        tax_amount
+        currency_code
+        invoice_status
+        invoice_date
+        due_date
+        vat_country_iso_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        invoice_number
+        payer_name
+        account_number
+        account_name
+        document_type
+        gross_amount
+        net_amount
+        tax_amount
+        currency_code
+        invoice_status
+        invoice_date
+        due_date
+        vat_country_iso_code
+      ]
+    end
+
+    def initialize(document_reference = SKIP,
+                   invoice_number = SKIP,
+                   payer_name = SKIP,
+                   account_number = SKIP,
+                   account_name = SKIP,
+                   document_type = SKIP,
+                   gross_amount = SKIP,
+                   net_amount = SKIP,
+                   tax_amount = SKIP,
+                   currency_code = SKIP,
+                   invoice_status = SKIP,
+                   invoice_date = SKIP,
+                   due_date = SKIP,
+                   vat_country_iso_code = SKIP)
+      @document_reference = document_reference unless document_reference == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @payer_name = payer_name unless payer_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @document_type = document_type unless document_type == SKIP
+      @gross_amount = gross_amount unless gross_amount == SKIP
+      @net_amount = net_amount unless net_amount == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @invoice_status = invoice_status unless invoice_status == SKIP
+      @invoice_date = invoice_date unless invoice_date == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @vat_country_iso_code = vat_country_iso_code unless vat_country_iso_code == 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.
+      document_reference =
+        hash.key?('DocumentReference') ? hash['DocumentReference'] : SKIP
+      invoice_number = hash.key?('InvoiceNumber') ? hash['InvoiceNumber'] : SKIP
+      payer_name = hash.key?('PayerName') ? hash['PayerName'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      account_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+      document_type = hash.key?('DocumentType') ? hash['DocumentType'] : SKIP
+      gross_amount = hash.key?('GrossAmount') ? hash['GrossAmount'] : SKIP
+      net_amount = hash.key?('NetAmount') ? hash['NetAmount'] : SKIP
+      tax_amount = hash.key?('TaxAmount') ? hash['TaxAmount'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      invoice_status = hash.key?('InvoiceStatus') ? hash['InvoiceStatus'] : SKIP
+      invoice_date = hash.key?('InvoiceDate') ? hash['InvoiceDate'] : SKIP
+      due_date = hash.key?('DueDate') ? hash['DueDate'] : SKIP
+      vat_country_iso_code =
+        hash.key?('VATCountryISOCode') ? hash['VATCountryISOCode'] : SKIP
+
+      # Create object from extracted values.
+      SearchDocumentsInvoice.new(document_reference,
+                                 invoice_number,
+                                 payer_name,
+                                 account_number,
+                                 account_name,
+                                 document_type,
+                                 gross_amount,
+                                 net_amount,
+                                 tax_amount,
+                                 currency_code,
+                                 invoice_status,
+                                 invoice_date,
+                                 due_date,
+                                 vat_country_iso_code)
+    end
+  end
+end