data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/invoice_distribution_method.rb

@@ -0,0 +1,99 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDistributionMethod Model.
+  class InvoiceDistributionMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If True then this distribution method is the default distribution method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_primary
+
+    # Frequency type unit Id & description
+    # E.g.:
+    # 1- Daily
+    # 2-Weekly
+    # 3-Monthly
+    # 4-Invoicing
+    # 6-Calendar quarter
+    # @return [String]
+    attr_accessor :frequency_type
+
+    # Invoice Distribution Method (Id-Description)
+    # E.g.:
+    # 1-e-mail
+    # 2-Fax
+    # 3-Courier to Customer
+    # 4-Courier to Client
+    # 5-Print
+    # 6-FTP
+    # 7-SMS
+    # @return [String]
+    attr_accessor :distribution_method
+
+    # Invoice output type (Id - Description)
+    # @return [String]
+    attr_accessor :output_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_primary'] = 'IsPrimary'
+      @_hash['frequency_type'] = 'FrequencyType'
+      @_hash['distribution_method'] = 'DistributionMethod'
+      @_hash['output_type'] = 'OutputType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_primary
+        frequency_type
+        distribution_method
+        output_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        frequency_type
+        distribution_method
+        output_type
+      ]
+    end
+
+    def initialize(is_primary = true,
+                   frequency_type = SKIP,
+                   distribution_method = SKIP,
+                   output_type = SKIP)
+      @is_primary = is_primary unless is_primary == SKIP
+      @frequency_type = frequency_type unless frequency_type == SKIP
+      @distribution_method = distribution_method unless distribution_method == SKIP
+      @output_type = output_type unless output_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.
+      is_primary = hash['IsPrimary'] ||= true
+      frequency_type = hash.key?('FrequencyType') ? hash['FrequencyType'] : SKIP
+      distribution_method =
+        hash.key?('DistributionMethod') ? hash['DistributionMethod'] : SKIP
+      output_type = hash.key?('OutputType') ? hash['OutputType'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDistributionMethod.new(is_primary,
+                                    frequency_type,
+                                    distribution_method,
+                                    output_type)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_download_req.rb

@@ -0,0 +1,99 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDownloadReq Model.
+  class InvoiceDownloadReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Number of the selected payer.
+    # Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # List of Account Numbers of the invoices.
+    # Mandatory for customer users else optional.
+    # @return [Array[String]]
+    attr_accessor :account_number
+
+    # Unique reference ids of invoice document (of zip file).
+    # Optional if InvoiceOrSOANumber is passed else Mandatory.
+    # @return [Array[Integer]]
+    attr_accessor :document_reference
+
+    # Invoice or the SOA document reference number issued by Card s Platform.
+    # @return [String]
+    attr_accessor :invoice_or_soa_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['document_reference'] = 'DocumentReference'
+      @_hash['invoice_or_soa_number'] = 'InvoiceOrSOANumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        document_reference
+        invoice_or_soa_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        payer_number
+        invoice_or_soa_number
+      ]
+    end
+
+    def initialize(col_co_code = nil,
+                   payer_number = nil,
+                   account_number = SKIP,
+                   document_reference = SKIP,
+                   invoice_or_soa_number = SKIP)
+      @col_co_code = col_co_code
+      @payer_number = payer_number
+      @account_number = account_number unless account_number == SKIP
+      @document_reference = document_reference unless document_reference == SKIP
+      @invoice_or_soa_number = invoice_or_soa_number unless invoice_or_soa_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.
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : nil
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : nil
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      document_reference =
+        hash.key?('DocumentReference') ? hash['DocumentReference'] : SKIP
+      invoice_or_soa_number =
+        hash.key?('InvoiceOrSOANumber') ? hash['InvoiceOrSOANumber'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDownloadReq.new(col_co_code,
+                             payer_number,
+                             account_number,
+                             document_reference,
+                             invoice_or_soa_number)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_download_request.rb

@@ -0,0 +1,50 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDownloadRequest Model.
+  class InvoiceDownloadRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [InvoiceDownloadReq]
+    attr_accessor :filters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filters'] = 'Filters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filters
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filters = SKIP)
+      @filters = filters unless filters == 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.
+      filters = InvoiceDownloadReq.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      InvoiceDownloadRequest.new(filters)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_search_additional_document.rb

@@ -0,0 +1,80 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Invoice document reference number for the additional invoice files such as
+  # KSeF file (Poland). This field is optional, and it will be missing if
+  # additional documents are not applicable. Also, it will not be populated if
+  # the invoice date is older than 13 months.
+  class InvoiceSearchAdditionalDocument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID for the additional invoice document.
+    # @return [String]
+    attr_accessor :reference
+
+    # Type of the additional document.
+    # Mandatory
+    # Possible values:
+    # •	KSeF - Applicable for Poland market.
+    # @return [String]
+    attr_accessor :type
+
+    # True if a KSeF PDF will be produced for the customer.
+    # @return [String]
+    attr_accessor :is_applicable
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference'] = 'Reference'
+      @_hash['type'] = 'Type'
+      @_hash['is_applicable'] = 'IsApplicable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference
+        type
+        is_applicable
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reference
+        type
+        is_applicable
+      ]
+    end
+
+    def initialize(reference = SKIP,
+                   type = SKIP,
+                   is_applicable = SKIP)
+      @reference = reference unless reference == SKIP
+      @type = type unless type == SKIP
+      @is_applicable = is_applicable unless is_applicable == 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.
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      is_applicable = hash.key?('IsApplicable') ? hash['IsApplicable'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceSearchAdditionalDocument.new(reference,
+                                          type,
+                                          is_applicable)
+    end
+  end
+end