cybersource-apimatic-sdk 0.0.1

data/lib/cyber_source_merged_spec/models/reporting_v3_reports_subscriptions_name_get200_response.rb

@@ -0,0 +1,322 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module CyberSourceMergedSpec
+  # Subscription Details
+  class ReportingV3ReportsSubscriptionsNameGet200Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Selected Organization Id
+    # @return [String]
+    attr_accessor :organization_id
+
+    # Report Definition Id
+    # @return [String]
+    attr_accessor :report_definition_id
+
+    # Report Definition Class
+    # @return [String]
+    attr_accessor :report_definition_name
+
+    # Report Format            
+    #             
+    # Valid values:
+    # - application/xml
+    # - text/csv
+    # @return [String]
+    attr_accessor :report_mime_type
+
+    # 'Report Frequency'
+    # **NOTE: Do not document USER_DEFINED Frequency field in developer center**
+    # Valid values:
+    # - DAILY
+    # - WEEKLY
+    # - MONTHLY
+    # - USER_DEFINED
+    # @return [String]
+    attr_accessor :report_frequency
+
+    # If the reportFrequency is User-defined, reportInterval should be in **ISO
+    # 8601 time format**
+    # Please refer the following link to know more about ISO 8601 format.[Rfc
+    # Time Format](https://en.wikipedia.org/wiki/ISO_8601#Durations)
+    # **Example time format for 2 hours and 30 Mins:**
+    #   - PT2H30M
+    # **NOTE: Do not document reportInterval field in developer center**
+    # @return [String]
+    attr_accessor :report_interval
+
+    # Report Name
+    # @return [String]
+    attr_accessor :report_name
+
+    # Time Zone
+    # @return [String]
+    attr_accessor :timezone
+
+    # Start Time
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # Start Day
+    # @return [Integer]
+    attr_accessor :start_day
+
+    # List of all fields String values
+    # @return [Array[String]]
+    attr_accessor :report_fields
+
+    # List of filters to apply
+    # @return [Hash[String, Object]]
+    attr_accessor :report_filters
+
+    # Report Preferences
+    # @return [ReportPreferences]
+    attr_accessor :report_preferences
+
+    # Id for the selected group.
+    # @return [String]
+    attr_accessor :group_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['organization_id'] = 'organizationId'
+      @_hash['report_definition_id'] = 'reportDefinitionId'
+      @_hash['report_definition_name'] = 'reportDefinitionName'
+      @_hash['report_mime_type'] = 'reportMimeType'
+      @_hash['report_frequency'] = 'reportFrequency'
+      @_hash['report_interval'] = 'reportInterval'
+      @_hash['report_name'] = 'reportName'
+      @_hash['timezone'] = 'timezone'
+      @_hash['start_time'] = 'startTime'
+      @_hash['start_day'] = 'startDay'
+      @_hash['report_fields'] = 'reportFields'
+      @_hash['report_filters'] = 'reportFilters'
+      @_hash['report_preferences'] = 'reportPreferences'
+      @_hash['group_id'] = 'groupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        organization_id
+        report_definition_id
+        report_definition_name
+        report_mime_type
+        report_frequency
+        report_interval
+        report_name
+        timezone
+        start_time
+        start_day
+        report_fields
+        report_filters
+        report_preferences
+        group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(organization_id: SKIP, report_definition_id: SKIP,
+                   report_definition_name: SKIP, report_mime_type: SKIP,
+                   report_frequency: SKIP, report_interval: SKIP,
+                   report_name: SKIP, timezone: SKIP, start_time: SKIP,
+                   start_day: SKIP, report_fields: SKIP, report_filters: SKIP,
+                   report_preferences: SKIP, group_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @organization_id = organization_id unless organization_id == SKIP
+      @report_definition_id = report_definition_id unless report_definition_id == SKIP
+      @report_definition_name = report_definition_name unless report_definition_name == SKIP
+      @report_mime_type = report_mime_type unless report_mime_type == SKIP
+      @report_frequency = report_frequency unless report_frequency == SKIP
+      @report_interval = report_interval unless report_interval == SKIP
+      @report_name = report_name unless report_name == SKIP
+      @timezone = timezone unless timezone == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @start_day = start_day unless start_day == SKIP
+      @report_fields = report_fields unless report_fields == SKIP
+      @report_filters = report_filters unless report_filters == SKIP
+      @report_preferences = report_preferences unless report_preferences == SKIP
+      @group_id = group_id unless group_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      organization_id =
+        hash.key?('organizationId') ? hash['organizationId'] : SKIP
+      report_definition_id =
+        hash.key?('reportDefinitionId') ? hash['reportDefinitionId'] : SKIP
+      report_definition_name =
+        hash.key?('reportDefinitionName') ? hash['reportDefinitionName'] : SKIP
+      report_mime_type =
+        hash.key?('reportMimeType') ? hash['reportMimeType'] : SKIP
+      report_frequency =
+        hash.key?('reportFrequency') ? hash['reportFrequency'] : SKIP
+      report_interval =
+        hash.key?('reportInterval') ? hash['reportInterval'] : SKIP
+      report_name = hash.key?('reportName') ? hash['reportName'] : SKIP
+      timezone = hash.key?('timezone') ? hash['timezone'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      start_day = hash.key?('startDay') ? hash['startDay'] : SKIP
+      report_fields = hash.key?('reportFields') ? hash['reportFields'] : SKIP
+      report_filters = hash.key?('reportFilters') ? hash['reportFilters'] : SKIP
+      report_preferences = ReportPreferences.from_hash(hash['reportPreferences']) if
+        hash['reportPreferences']
+      group_id = hash.key?('groupId') ? hash['groupId'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ReportingV3ReportsSubscriptionsNameGet200Response.new(organization_id: organization_id,
+                                                            report_definition_id: report_definition_id,
+                                                            report_definition_name: report_definition_name,
+                                                            report_mime_type: report_mime_type,
+                                                            report_frequency: report_frequency,
+                                                            report_interval: report_interval,
+                                                            report_name: report_name,
+                                                            timezone: timezone,
+                                                            start_time: start_time,
+                                                            start_day: start_day,
+                                                            report_fields: report_fields,
+                                                            report_filters: report_filters,
+                                                            report_preferences: report_preferences,
+                                                            group_id: group_id,
+                                                            additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def self.from_element(root)
+      organization_id = XmlUtilities.from_element(root, 'organizationId',
+                                                  String)
+      report_definition_id = XmlUtilities.from_element(root,
+                                                       'reportDefinitionId',
+                                                       String)
+      report_definition_name = XmlUtilities.from_element(root,
+                                                         'reportDefinitionName',
+                                                         String)
+      report_mime_type = XmlUtilities.from_element(root, 'reportMimeType',
+                                                   String)
+      report_frequency = XmlUtilities.from_element(root, 'reportFrequency',
+                                                   String)
+      report_interval = XmlUtilities.from_element(root, 'reportInterval',
+                                                  String)
+      report_name = XmlUtilities.from_element(root, 'reportName', String)
+      timezone = XmlUtilities.from_element(root, 'timezone', String)
+      start_time = XmlUtilities.from_element(root, 'startTime', String,
+                                             datetime_format: 'rfc3339')
+      start_day = XmlUtilities.from_element(root, 'startDay', Integer)
+      report_fields = XmlUtilities.from_element_to_array(root, 'reportFields',
+                                                         String)
+      report_filters = XmlUtilities.from_element_to_hash(root, 'reportFilters',
+                                                         Hash)
+      report_preferences = XmlUtilities.from_element(root, 'ReportPreferences',
+                                                     ReportPreferences)
+      group_id = XmlUtilities.from_element(root, 'groupId', String)
+
+      new(organization_id: organization_id,
+          report_definition_id: report_definition_id,
+          report_definition_name: report_definition_name,
+          report_mime_type: report_mime_type,
+          report_frequency: report_frequency,
+          report_interval: report_interval,
+          report_name: report_name,
+          timezone: timezone,
+          start_time: start_time,
+          start_day: start_day,
+          report_fields: report_fields,
+          report_filters: report_filters,
+          report_preferences: report_preferences,
+          group_id: group_id,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'organizationId',
+                                     organization_id)
+      XmlUtilities.add_as_subelement(doc, root, 'reportDefinitionId',
+                                     report_definition_id)
+      XmlUtilities.add_as_subelement(doc, root, 'reportDefinitionName',
+                                     report_definition_name)
+      XmlUtilities.add_as_subelement(doc, root, 'reportMimeType',
+                                     report_mime_type)
+      XmlUtilities.add_as_subelement(doc, root, 'reportFrequency',
+                                     report_frequency)
+      XmlUtilities.add_as_subelement(doc, root, 'reportInterval',
+                                     report_interval)
+      XmlUtilities.add_as_subelement(doc, root, 'reportName', report_name)
+      XmlUtilities.add_as_subelement(doc, root, 'timezone', timezone)
+      XmlUtilities.add_as_subelement(doc, root, 'startTime', start_time,
+                                     datetime_format: 'rfc3339')
+      XmlUtilities.add_as_subelement(doc, root, 'startDay', start_day)
+      XmlUtilities.add_array_as_subelement(doc, root, 'reportFields',
+                                           report_fields)
+      XmlUtilities.add_hash_as_subelement(doc, root, 'reportFilters',
+                                          report_filters)
+      XmlUtilities.add_as_subelement(doc, root, 'ReportPreferences',
+                                     report_preferences)
+      XmlUtilities.add_as_subelement(doc, root, 'groupId', group_id)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} organization_id: #{@organization_id}, report_definition_id:"\
+      " #{@report_definition_id}, report_definition_name: #{@report_definition_name},"\
+      " report_mime_type: #{@report_mime_type}, report_frequency: #{@report_frequency},"\
+      " report_interval: #{@report_interval}, report_name: #{@report_name}, timezone:"\
+      " #{@timezone}, start_time: #{@start_time}, start_day: #{@start_day}, report_fields:"\
+      " #{@report_fields}, report_filters: #{@report_filters}, report_preferences:"\
+      " #{@report_preferences}, group_id: #{@group_id}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} organization_id: #{@organization_id.inspect}, report_definition_id:"\
+      " #{@report_definition_id.inspect}, report_definition_name:"\
+      " #{@report_definition_name.inspect}, report_mime_type: #{@report_mime_type.inspect},"\
+      " report_frequency: #{@report_frequency.inspect}, report_interval:"\
+      " #{@report_interval.inspect}, report_name: #{@report_name.inspect}, timezone:"\
+      " #{@timezone.inspect}, start_time: #{@start_time.inspect}, start_day:"\
+      " #{@start_day.inspect}, report_fields: #{@report_fields.inspect}, report_filters:"\
+      " #{@report_filters.inspect}, report_preferences: #{@report_preferences.inspect}, group_id:"\
+      " #{@group_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cyber_source_merged_spec/models/reporting_v3_retrieval_details_get200_response.rb

@@ -0,0 +1,165 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module CyberSourceMergedSpec
+  # ReportingV3RetrievalDetailsGet200Response Model.
+  class ReportingV3RetrievalDetailsGet200Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Organization Id
+    # @return [String]
+    attr_accessor :organization_id
+
+    # Report Start Date (ISO 8601 Extended)
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # Report Start Date (ISO 8601 Extended)
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # List of Retrieval Details list.
+    # @return [Array[RetrievalDetail]]
+    attr_accessor :retrieval_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['organization_id'] = 'organizationId'
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['retrieval_details'] = 'retrievalDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        organization_id
+        start_time
+        end_time
+        retrieval_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(organization_id: SKIP, start_time: SKIP, end_time: SKIP,
+                   retrieval_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @organization_id = organization_id unless organization_id == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @retrieval_details = retrieval_details unless retrieval_details == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      organization_id =
+        hash.key?('organizationId') ? hash['organizationId'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      end_time = if hash.key?('endTime')
+                   (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
+                 else
+                   SKIP
+                 end
+      # Parameter is an array, so we need to iterate through it
+      retrieval_details = nil
+      unless hash['retrievalDetails'].nil?
+        retrieval_details = []
+        hash['retrievalDetails'].each do |structure|
+          retrieval_details << (RetrievalDetail.from_hash(structure) if structure)
+        end
+      end
+
+      retrieval_details = SKIP unless hash.key?('retrievalDetails')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ReportingV3RetrievalDetailsGet200Response.new(organization_id: organization_id,
+                                                    start_time: start_time,
+                                                    end_time: end_time,
+                                                    retrieval_details: retrieval_details,
+                                                    additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_custom_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    end
+
+    def self.from_element(root)
+      organization_id = XmlUtilities.from_attribute(root, 'MerchantId', String)
+      start_time = XmlUtilities.from_attribute(root, 'ReportStartDate', String,
+                                               datetime_format: 'rfc3339')
+      end_time = XmlUtilities.from_attribute(root, 'ReportEndDate', String,
+                                             datetime_format: 'rfc3339')
+      retrieval_details = XmlUtilities.from_element_to_array(root, 'Request',
+                                                             RetrievalDetail)
+
+      new(organization_id: organization_id,
+          start_time: start_time,
+          end_time: end_time,
+          retrieval_details: retrieval_details,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'MerchantId', organization_id)
+      XmlUtilities.add_as_attribute(root, 'ReportStartDate', start_time,
+                                    datetime_format: 'rfc3339')
+      XmlUtilities.add_as_attribute(root, 'ReportEndDate', end_time,
+                                    datetime_format: 'rfc3339')
+      XmlUtilities.add_array_as_subelement(doc, root, 'Request',
+                                           retrieval_details)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} organization_id: #{@organization_id}, start_time: #{@start_time}, end_time:"\
+      " #{@end_time}, retrieval_details: #{@retrieval_details}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} organization_id: #{@organization_id.inspect}, start_time:"\
+      " #{@start_time.inspect}, end_time: #{@end_time.inspect}, retrieval_details:"\
+      " #{@retrieval_details.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cyber_source_merged_spec/models/reporting_v3_retrieval_summaries_get200_response.rb

@@ -0,0 +1,155 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module CyberSourceMergedSpec
+  # ReportingV3RetrievalSummariesGet200Response Model.
+  class ReportingV3RetrievalSummariesGet200Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Organization Id
+    # @return [String]
+    attr_accessor :organization_id
+
+    # Report Start Date
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # Report Start Date
+    # @return [String]
+    attr_accessor :end_time
+
+    # List of Summary values
+    # @return [Array[RetrievalSummary]]
+    attr_accessor :retrieval_summaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['organization_id'] = 'organizationId'
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['retrieval_summaries'] = 'retrievalSummaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        organization_id
+        start_time
+        end_time
+        retrieval_summaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(organization_id: SKIP, start_time: SKIP, end_time: SKIP,
+                   retrieval_summaries: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @organization_id = organization_id unless organization_id == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @retrieval_summaries = retrieval_summaries unless retrieval_summaries == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      organization_id =
+        hash.key?('organizationId') ? hash['organizationId'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      end_time = hash.key?('endTime') ? hash['endTime'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      retrieval_summaries = nil
+      unless hash['retrievalSummaries'].nil?
+        retrieval_summaries = []
+        hash['retrievalSummaries'].each do |structure|
+          retrieval_summaries << (RetrievalSummary.from_hash(structure) if structure)
+        end
+      end
+
+      retrieval_summaries = SKIP unless hash.key?('retrievalSummaries')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ReportingV3RetrievalSummariesGet200Response.new(organization_id: organization_id,
+                                                      start_time: start_time,
+                                                      end_time: end_time,
+                                                      retrieval_summaries: retrieval_summaries,
+                                                      additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def self.from_element(root)
+      organization_id = XmlUtilities.from_attribute(root, 'MerchantId', String)
+      start_time = XmlUtilities.from_attribute(root, 'ReportStartDate', String,
+                                               datetime_format: 'rfc3339')
+      end_time = XmlUtilities.from_attribute(root, 'ReportEndDate', String)
+      retrieval_summaries = XmlUtilities.from_element_to_array(root, 'Request',
+                                                               RetrievalSummary)
+
+      new(organization_id: organization_id,
+          start_time: start_time,
+          end_time: end_time,
+          retrieval_summaries: retrieval_summaries,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'MerchantId', organization_id)
+      XmlUtilities.add_as_attribute(root, 'ReportStartDate', start_time,
+                                    datetime_format: 'rfc3339')
+      XmlUtilities.add_as_attribute(root, 'ReportEndDate', end_time)
+      XmlUtilities.add_array_as_subelement(doc, root, 'Request',
+                                           retrieval_summaries)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} organization_id: #{@organization_id}, start_time: #{@start_time}, end_time:"\
+      " #{@end_time}, retrieval_summaries: #{@retrieval_summaries}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} organization_id: #{@organization_id.inspect}, start_time:"\
+      " #{@start_time.inspect}, end_time: #{@end_time.inspect}, retrieval_summaries:"\
+      " #{@retrieval_summaries.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end