data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/customer_price_list_response.rb

@@ -0,0 +1,82 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CustomerPriceListResponse Model.
+  class CustomerPriceListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # UUID (according to RFC 4122 standards) for requests and responses. This
+    # will be played back in the response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # UUID (according to RFC 4122 standards) for requests and responses. This
+    # will be played back in the response from the request.
+    # @return [Array[PriceList]]
+    attr_accessor :price_list
+
+    # UUID (according to RFC 4122 standards) for requests and responses. This
+    # will be played back in the response from the request.
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['price_list'] = 'PriceList'
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        price_list
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   price_list = SKIP,
+                   error = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @price_list = price_list unless price_list == 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.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      price_list = nil
+      unless hash['PriceList'].nil?
+        price_list = []
+        hash['PriceList'].each do |structure|
+          price_list << (PriceList.from_hash(structure) if structure)
+        end
+      end
+
+      price_list = SKIP unless hash.key?('PriceList')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+
+      # Create object from extracted values.
+      CustomerPriceListResponse.new(request_id,
+                                    price_list,
+                                    error)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/default_error_fault.rb

@@ -0,0 +1,60 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Error object
+  class DefaultErrorFault < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error Description
+    # @return [String]
+    attr_accessor :faultstring
+
+    # Details about the error
+    # @return [DefaultErrorFaultDetail]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['faultstring'] = 'faultstring'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        faultstring
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(faultstring = SKIP,
+                   detail = SKIP)
+      @faultstring = faultstring unless faultstring == SKIP
+      @detail = detail unless detail == 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.
+      faultstring = hash.key?('faultstring') ? hash['faultstring'] : SKIP
+      detail = DefaultErrorFaultDetail.from_hash(hash['detail']) if hash['detail']
+
+      # Create object from extracted values.
+      DefaultErrorFault.new(faultstring,
+                            detail)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/default_error_fault_detail.rb

@@ -0,0 +1,50 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Details about the error
+  class DefaultErrorFaultDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code
+    # @return [String]
+    attr_accessor :errorcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['errorcode'] = 'errorcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        errorcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(errorcode = SKIP)
+      @errorcode = errorcode unless errorcode == 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.
+      errorcode = hash.key?('errorcode') ? hash['errorcode'] : SKIP
+
+      # Create object from extracted values.
+      DefaultErrorFaultDetail.new(errorcode)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/delivery_addresses.rb

@@ -0,0 +1,258 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # 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_data_reporting_ap_is/models/eid_access.rb

@@ -0,0 +1,75 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # 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_data_reporting_ap_is/models/eid_document.rb

@@ -0,0 +1,166 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # EIDDocument Model.
+  class EIDDocument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Technical identifier for the EID file. Should not be stored in database as
+    # it is not guaranteed to stay unchanged over time.
+    # @return [Integer]
+    attr_accessor :document_id
+
+    # Account Group Id
+    # @return [String]
+    attr_accessor :account_group_id
+
+    # Account group name
+    # @return [String]
+    attr_accessor :account_group_name
+
+    # Document type.
+    # Possible values:
+    # •	NAT (National)
+    # •	INT (International)
+    # @return [String]
+    attr_accessor :document_type
+
+    # Document format (CHORUS, DIFI etc.)
+    # @return [String]
+    attr_accessor :document_format
+
+    # Document date.
+    # Example: 20170101
+    # @return [String]
+    attr_accessor :document_date
+
+    # Number of invoices
+    # @return [Integer]
+    attr_accessor :number_of_invoices
+
+    # Document size
+    # @return [Integer]
+    attr_accessor :file_size
+
+    # Document status.
+    # Possible values:
+    # •	NEW
+    # •	VIEWED
+    # •	DOWNLOADED
+    # •	RESTORED
+    # @return [String]
+    attr_accessor :document_status
+
+    # Document file name.
+    # @return [String]
+    attr_accessor :document_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document_id'] = 'DocumentId'
+      @_hash['account_group_id'] = 'AccountGroupId'
+      @_hash['account_group_name'] = 'AccountGroupName'
+      @_hash['document_type'] = 'DocumentType'
+      @_hash['document_format'] = 'DocumentFormat'
+      @_hash['document_date'] = 'DocumentDate'
+      @_hash['number_of_invoices'] = 'NumberOfInvoices'
+      @_hash['file_size'] = 'FileSize'
+      @_hash['document_status'] = 'DocumentStatus'
+      @_hash['document_name'] = 'DocumentName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document_id
+        account_group_id
+        account_group_name
+        document_type
+        document_format
+        document_date
+        number_of_invoices
+        file_size
+        document_status
+        document_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        document_id
+        account_group_id
+        account_group_name
+        document_type
+        document_format
+        document_date
+        number_of_invoices
+        file_size
+        document_status
+        document_name
+      ]
+    end
+
+    def initialize(document_id = SKIP,
+                   account_group_id = SKIP,
+                   account_group_name = SKIP,
+                   document_type = SKIP,
+                   document_format = SKIP,
+                   document_date = SKIP,
+                   number_of_invoices = SKIP,
+                   file_size = SKIP,
+                   document_status = SKIP,
+                   document_name = SKIP)
+      @document_id = document_id unless document_id == SKIP
+      @account_group_id = account_group_id unless account_group_id == SKIP
+      @account_group_name = account_group_name unless account_group_name == SKIP
+      @document_type = document_type unless document_type == SKIP
+      @document_format = document_format unless document_format == SKIP
+      @document_date = document_date unless document_date == SKIP
+      @number_of_invoices = number_of_invoices unless number_of_invoices == SKIP
+      @file_size = file_size unless file_size == SKIP
+      @document_status = document_status unless document_status == SKIP
+      @document_name = document_name unless document_name == 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_id = hash.key?('DocumentId') ? hash['DocumentId'] : SKIP
+      account_group_id =
+        hash.key?('AccountGroupId') ? hash['AccountGroupId'] : SKIP
+      account_group_name =
+        hash.key?('AccountGroupName') ? hash['AccountGroupName'] : SKIP
+      document_type = hash.key?('DocumentType') ? hash['DocumentType'] : SKIP
+      document_format =
+        hash.key?('DocumentFormat') ? hash['DocumentFormat'] : SKIP
+      document_date = hash.key?('DocumentDate') ? hash['DocumentDate'] : SKIP
+      number_of_invoices =
+        hash.key?('NumberOfInvoices') ? hash['NumberOfInvoices'] : SKIP
+      file_size = hash.key?('FileSize') ? hash['FileSize'] : SKIP
+      document_status =
+        hash.key?('DocumentStatus') ? hash['DocumentStatus'] : SKIP
+      document_name = hash.key?('DocumentName') ? hash['DocumentName'] : SKIP
+
+      # Create object from extracted values.
+      EIDDocument.new(document_id,
+                      account_group_id,
+                      account_group_name,
+                      document_type,
+                      document_format,
+                      document_date,
+                      number_of_invoices,
+                      file_size,
+                      document_status,
+                      document_name)
+    end
+  end
+end