data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/eid_document_response.rb

@@ -0,0 +1,140 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # EIDDocumentResponse Model.
+  class EIDDocumentResponse < 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
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED
+    # @return [Array[EIDDocument]]
+    attr_accessor :data
+
+    # Number of records returned in the response
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Current page
+    # @return [Integer]
+    attr_accessor :page
+
+    # Total number of pages available for the requested data
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Total number of elements corresponding to the request
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # True if it is the first page, false otherwise
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_first_page
+
+    # True if it is the last page, false, otherwise.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_last_page
+
+    # 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['data'] = 'Data'
+      @_hash['page_size'] = 'PageSize'
+      @_hash['page'] = 'Page'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['total_records'] = 'TotalRecords'
+      @_hash['is_first_page'] = 'IsFirstPage'
+      @_hash['is_last_page'] = 'IsLastPage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        page_size
+        page
+        total_pages
+        total_records
+        is_first_page
+        is_last_page
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   page_size = SKIP,
+                   page = SKIP,
+                   total_pages = SKIP,
+                   total_records = SKIP,
+                   is_first_page = SKIP,
+                   is_last_page = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @page = page unless page == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @total_records = total_records unless total_records == SKIP
+      @is_first_page = is_first_page unless is_first_page == SKIP
+      @is_last_page = is_last_page unless is_last_page == 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
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (EIDDocument.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
+      is_first_page = hash.key?('IsFirstPage') ? hash['IsFirstPage'] : SKIP
+      is_last_page = hash.key?('IsLastPage') ? hash['IsLastPage'] : SKIP
+
+      # Create object from extracted values.
+      EIDDocumentResponse.new(request_id,
+                              status,
+                              data,
+                              page_size,
+                              page,
+                              total_pages,
+                              total_records,
+                              is_first_page,
+                              is_last_page)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/eid_download_req.rb

@@ -0,0 +1,86 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # EIDDownloadReq Model.
+  class EIDDownloadReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory
+    # @return [Array[String]]
+    attr_accessor :eid_list
+
+    # ColCo code associated with the Account Group IDs of the given EID/EDI
+    # files.
+    # Mandatory
+    # @return [Integer]
+    attr_accessor :account_group_country
+
+    # ColCo code associated with the Account Group IDs of the given EID/EDI
+    # files.
+    # Mandatory
+    # @return [Array[String]]
+    attr_accessor :account_group_id_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['eid_list'] = 'EIDList'
+      @_hash['account_group_country'] = 'AccountGroupCountry'
+      @_hash['account_group_id_list'] = 'AccountGroupIdList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        account_group_country
+      ]
+    end
+
+    def initialize(col_co_code = nil,
+                   eid_list = nil,
+                   account_group_country = nil,
+                   account_group_id_list = nil)
+      @col_co_code = col_co_code
+      @eid_list = eid_list
+      @account_group_country = account_group_country
+      @account_group_id_list = account_group_id_list
+    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
+      eid_list = hash.key?('EIDList') ? hash['EIDList'] : nil
+      account_group_country =
+        hash.key?('AccountGroupCountry') ? hash['AccountGroupCountry'] : nil
+      account_group_id_list =
+        hash.key?('AccountGroupIdList') ? hash['AccountGroupIdList'] : nil
+
+      # Create object from extracted values.
+      EIDDownloadReq.new(col_co_code,
+                         eid_list,
+                         account_group_country,
+                         account_group_id_list)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/eid_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
+  # EIDDownloadRequest Model.
+  class EIDDownloadRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EIDDownloadReq]
+    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 = EIDDownloadReq.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      EIDDownloadRequest.new(filters)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/eid_search_req.rb

@@ -0,0 +1,160 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # EIDSearchReq Model.
+  class EIDSearchReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Country code (colco code) of the account group.
+    # Mandatory
+    # @return [Integer]
+    attr_accessor :account_group_country
+
+    # List of IDs of the account groups that user has access to.
+    # Mandatory
+    # @return [Array[String]]
+    attr_accessor :account_group_id
+
+    # Account group name
+    # Optional.
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :account_group_name
+
+    # EID date searched from this date.
+    # Optional.
+    # @return [String]
+    attr_accessor :from_date
+
+    # Invoice date searched until this date.
+    # Optional.
+    # @return [String]
+    attr_accessor :to_date
+
+    # Invoice type.
+    # Optional.
+    # Possible values:
+    # •	NAT (National)
+    # •	INT (International)
+    # @return [String]
+    attr_accessor :invoice_type
+
+    # Status of the document. 
+    # Optional.
+    # Possible values:
+    # •	NEW
+    # •	VIEWED
+    # •	DOWNLOADED
+    # •	RESTORED
+    # @return [String]
+    attr_accessor :invoice_status
+
+    # Sort option –
+    # •    InvoiceNumber ASC
+    # •    InvoiceDate ASC
+    # •    InvoiceNumber DESC
+    # •    InvoiceDate DESC
+    # Optional
+    # @return [Array[String]]
+    attr_accessor :sort_by
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['account_group_country'] = 'AccountGroupCountry'
+      @_hash['account_group_id'] = 'AccountGroupId'
+      @_hash['account_group_name'] = 'AccountGroupName'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['invoice_type'] = 'InvoiceType'
+      @_hash['invoice_status'] = 'InvoiceStatus'
+      @_hash['sort_by'] = 'SortBy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_group_name
+        from_date
+        to_date
+        invoice_type
+        invoice_status
+        sort_by
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        account_group_country
+        account_group_name
+        from_date
+        to_date
+        invoice_type
+        invoice_status
+      ]
+    end
+
+    def initialize(col_co_code = nil,
+                   account_group_country = nil,
+                   account_group_id = nil,
+                   account_group_name = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   invoice_type = SKIP,
+                   invoice_status = SKIP,
+                   sort_by = SKIP)
+      @col_co_code = col_co_code
+      @account_group_country = account_group_country
+      @account_group_id = account_group_id
+      @account_group_name = account_group_name unless account_group_name == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @invoice_type = invoice_type unless invoice_type == SKIP
+      @invoice_status = invoice_status unless invoice_status == SKIP
+      @sort_by = sort_by unless sort_by == 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
+      account_group_country =
+        hash.key?('AccountGroupCountry') ? hash['AccountGroupCountry'] : nil
+      account_group_id =
+        hash.key?('AccountGroupId') ? hash['AccountGroupId'] : nil
+      account_group_name =
+        hash.key?('AccountGroupName') ? hash['AccountGroupName'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      invoice_type = hash.key?('InvoiceType') ? hash['InvoiceType'] : SKIP
+      invoice_status = hash.key?('InvoiceStatus') ? hash['InvoiceStatus'] : SKIP
+      sort_by = hash.key?('SortBy') ? hash['SortBy'] : SKIP
+
+      # Create object from extracted values.
+      EIDSearchReq.new(col_co_code,
+                       account_group_country,
+                       account_group_id,
+                       account_group_name,
+                       from_date,
+                       to_date,
+                       invoice_type,
+                       invoice_status,
+                       sort_by)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/eid_search_request.rb

@@ -0,0 +1,70 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # EIDSearchRequest Model.
+  class EIDSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EIDSearchReq]
+    attr_accessor :filters
+
+    # Specify the page of results to be returned.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Specify the number of records to returned; Max 1000
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filters'] = 'Filters'
+      @_hash['page'] = 'Page'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filters
+        page
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filters = SKIP,
+                   page = SKIP,
+                   page_size = SKIP)
+      @filters = filters unless filters == SKIP
+      @page = page unless page == SKIP
+      @page_size = page_size unless page_size == 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 = EIDSearchReq.from_hash(hash['Filters']) if hash['Filters']
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+
+      # Create object from extracted values.
+      EIDSearchRequest.new(filters,
+                           page,
+                           page_size)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/error_details.rb

@@ -0,0 +1,81 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # ErrorDetails Model.
+  class ErrorDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code representing the error encountered
+    # @return [String]
+    attr_accessor :code
+
+    # Error type description
+    # @return [String]
+    attr_accessor :title
+
+    # Detailed inforamtion about the error
+    # @return [String]
+    attr_accessor :detail
+
+    # Applicable when more details related to error to be returned
+    # @return [Hash[String, String]]
+    attr_accessor :additional_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['title'] = 'Title'
+      @_hash['detail'] = 'Detail'
+      @_hash['additional_info'] = 'AdditionalInfo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        title
+        detail
+        additional_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP,
+                   title = SKIP,
+                   detail = SKIP,
+                   additional_info = SKIP)
+      @code = code unless code == SKIP
+      @title = title unless title == SKIP
+      @detail = detail unless detail == SKIP
+      @additional_info = additional_info unless additional_info == 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.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      title = hash.key?('Title') ? hash['Title'] : SKIP
+      detail = hash.key?('Detail') ? hash['Detail'] : SKIP
+      additional_info =
+        hash.key?('AdditionalInfo') ? hash['AdditionalInfo'] : SKIP
+
+      # Create object from extracted values.
+      ErrorDetails.new(code,
+                       title,
+                       detail,
+                       additional_info)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/error_status.rb

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

data/lib/shell_data_reporting_ap_is/models/error_user_access.rb

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