apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/pmt.rb

@@ -0,0 +1,89 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a product material type entry for a program, including the
+  # program code, material type, and default flag.
+  class Pmt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The program code associated with this product material type.
+    # @return [String]
+    attr_accessor :programcode
+
+    # The product material type (e.g., "plastic", "virtual") for the program.
+    # @return [String]
+    attr_accessor :productmaterialtype
+
+    # Indicates whether this product material type is the default for the
+    # program.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :isdefault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['programcode'] = 'programcode'
+      @_hash['productmaterialtype'] = 'productmaterialtype'
+      @_hash['isdefault'] = 'isdefault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        programcode
+        productmaterialtype
+        isdefault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        programcode
+        productmaterialtype
+      ]
+    end
+
+    def initialize(programcode: SKIP, productmaterialtype: SKIP,
+                   isdefault: SKIP)
+      @programcode = programcode unless programcode == SKIP
+      @productmaterialtype = productmaterialtype unless productmaterialtype == SKIP
+      @isdefault = isdefault unless isdefault == 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.
+      programcode = hash.key?('programcode') ? hash['programcode'] : SKIP
+      productmaterialtype =
+        hash.key?('productmaterialtype') ? hash['productmaterialtype'] : SKIP
+      isdefault = hash.key?('isdefault') ? hash['isdefault'] : SKIP
+
+      # Create object from extracted values.
+      Pmt.new(programcode: programcode,
+              productmaterialtype: productmaterialtype,
+              isdefault: isdefault)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} programcode: #{@programcode}, productmaterialtype: #{@productmaterialtype},"\
+      " isdefault: #{@isdefault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} programcode: #{@programcode.inspect}, productmaterialtype:"\
+      " #{@productmaterialtype.inspect}, isdefault: #{@isdefault.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/pos_entry_mode.rb

@@ -0,0 +1,233 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the point-of-sale entry mode details for a payment transaction.
+  # Contains card input, authentication, and terminal capability information.
+  class PosEntryMode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card input capability of the terminal (e.g., "Chip", "Magstripe",
+    # "Contactless").
+    # @return [String]
+    attr_accessor :card_input_capability
+
+    # The cardholder authentication capability of the terminal.
+    # @return [String]
+    attr_accessor :cardholder_authentication_capability
+
+    # The card capture capability of the terminal.
+    # @return [String]
+    attr_accessor :card_capture_capability
+
+    # The operating environment of the terminal (e.g., "Attended",
+    # "Unattended").
+    # @return [String]
+    attr_accessor :operating_environment
+
+    # Indicates whether the cardholder is present at the terminal.
+    # @return [String]
+    attr_accessor :cardholder_presence
+
+    # Indicates whether the card is present at the terminal.
+    # @return [String]
+    attr_accessor :card_presence
+
+    # The card data input mode (e.g., "Manual", "Swipe", "Chip").
+    # @return [String]
+    attr_accessor :card_data_input_mode
+
+    # The cardholder authentication method used (e.g., "PIN", "Signature").
+    # @return [String]
+    attr_accessor :cardholder_authentication_method
+
+    # The entity responsible for cardholder authentication.
+    # @return [String]
+    attr_accessor :cardholder_authentication_entity
+
+    # The card data output capability of the terminal.
+    # @return [String]
+    attr_accessor :card_data_output_capability
+
+    # The terminal output capability (e.g., "Display", "Print").
+    # @return [String]
+    attr_accessor :terminal_output_capability
+
+    # The PIN capture capability of the terminal.
+    # @return [String]
+    attr_accessor :pin_capture_capability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_input_capability'] = 'cardInputCapability'
+      @_hash['cardholder_authentication_capability'] =
+        'cardholderAuthenticationCapability'
+      @_hash['card_capture_capability'] = 'cardCaptureCapability'
+      @_hash['operating_environment'] = 'operatingEnvironment'
+      @_hash['cardholder_presence'] = 'cardholderPresence'
+      @_hash['card_presence'] = 'cardPresence'
+      @_hash['card_data_input_mode'] = 'cardDataInputMode'
+      @_hash['cardholder_authentication_method'] =
+        'cardholderAuthenticationMethod'
+      @_hash['cardholder_authentication_entity'] =
+        'cardholderAuthenticationEntity'
+      @_hash['card_data_output_capability'] = 'cardDataOutputCapability'
+      @_hash['terminal_output_capability'] = 'terminalOutputCapability'
+      @_hash['pin_capture_capability'] = 'pinCaptureCapability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_input_capability
+        cardholder_authentication_capability
+        card_capture_capability
+        operating_environment
+        cardholder_presence
+        card_presence
+        card_data_input_mode
+        cardholder_authentication_method
+        cardholder_authentication_entity
+        card_data_output_capability
+        terminal_output_capability
+        pin_capture_capability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        card_input_capability
+        cardholder_authentication_capability
+        card_capture_capability
+        operating_environment
+        cardholder_presence
+        card_presence
+        card_data_input_mode
+        cardholder_authentication_method
+        cardholder_authentication_entity
+        card_data_output_capability
+        terminal_output_capability
+        pin_capture_capability
+      ]
+    end
+
+    def initialize(card_input_capability: SKIP,
+                   cardholder_authentication_capability: SKIP,
+                   card_capture_capability: SKIP, operating_environment: SKIP,
+                   cardholder_presence: SKIP, card_presence: SKIP,
+                   card_data_input_mode: SKIP,
+                   cardholder_authentication_method: SKIP,
+                   cardholder_authentication_entity: SKIP,
+                   card_data_output_capability: SKIP,
+                   terminal_output_capability: SKIP,
+                   pin_capture_capability: SKIP)
+      @card_input_capability = card_input_capability unless card_input_capability == SKIP
+      unless cardholder_authentication_capability == SKIP
+        @cardholder_authentication_capability =
+          cardholder_authentication_capability
+      end
+      @card_capture_capability = card_capture_capability unless card_capture_capability == SKIP
+      @operating_environment = operating_environment unless operating_environment == SKIP
+      @cardholder_presence = cardholder_presence unless cardholder_presence == SKIP
+      @card_presence = card_presence unless card_presence == SKIP
+      @card_data_input_mode = card_data_input_mode unless card_data_input_mode == SKIP
+      unless cardholder_authentication_method == SKIP
+        @cardholder_authentication_method =
+          cardholder_authentication_method
+      end
+      unless cardholder_authentication_entity == SKIP
+        @cardholder_authentication_entity =
+          cardholder_authentication_entity
+      end
+      unless card_data_output_capability == SKIP
+        @card_data_output_capability =
+          card_data_output_capability
+      end
+      unless terminal_output_capability == SKIP
+        @terminal_output_capability =
+          terminal_output_capability
+      end
+      @pin_capture_capability = pin_capture_capability unless pin_capture_capability == 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.
+      card_input_capability =
+        hash.key?('cardInputCapability') ? hash['cardInputCapability'] : SKIP
+      cardholder_authentication_capability =
+        hash.key?('cardholderAuthenticationCapability') ? hash['cardholderAuthenticationCapability'] : SKIP
+      card_capture_capability =
+        hash.key?('cardCaptureCapability') ? hash['cardCaptureCapability'] : SKIP
+      operating_environment =
+        hash.key?('operatingEnvironment') ? hash['operatingEnvironment'] : SKIP
+      cardholder_presence =
+        hash.key?('cardholderPresence') ? hash['cardholderPresence'] : SKIP
+      card_presence = hash.key?('cardPresence') ? hash['cardPresence'] : SKIP
+      card_data_input_mode =
+        hash.key?('cardDataInputMode') ? hash['cardDataInputMode'] : SKIP
+      cardholder_authentication_method =
+        hash.key?('cardholderAuthenticationMethod') ? hash['cardholderAuthenticationMethod'] : SKIP
+      cardholder_authentication_entity =
+        hash.key?('cardholderAuthenticationEntity') ? hash['cardholderAuthenticationEntity'] : SKIP
+      card_data_output_capability =
+        hash.key?('cardDataOutputCapability') ? hash['cardDataOutputCapability'] : SKIP
+      terminal_output_capability =
+        hash.key?('terminalOutputCapability') ? hash['terminalOutputCapability'] : SKIP
+      pin_capture_capability =
+        hash.key?('pinCaptureCapability') ? hash['pinCaptureCapability'] : SKIP
+
+      # Create object from extracted values.
+      PosEntryMode.new(card_input_capability: card_input_capability,
+                       cardholder_authentication_capability: cardholder_authentication_capability,
+                       card_capture_capability: card_capture_capability,
+                       operating_environment: operating_environment,
+                       cardholder_presence: cardholder_presence,
+                       card_presence: card_presence,
+                       card_data_input_mode: card_data_input_mode,
+                       cardholder_authentication_method: cardholder_authentication_method,
+                       cardholder_authentication_entity: cardholder_authentication_entity,
+                       card_data_output_capability: card_data_output_capability,
+                       terminal_output_capability: terminal_output_capability,
+                       pin_capture_capability: pin_capture_capability)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_input_capability: #{@card_input_capability},"\
+      " cardholder_authentication_capability: #{@cardholder_authentication_capability},"\
+      " card_capture_capability: #{@card_capture_capability}, operating_environment:"\
+      " #{@operating_environment}, cardholder_presence: #{@cardholder_presence}, card_presence:"\
+      " #{@card_presence}, card_data_input_mode: #{@card_data_input_mode},"\
+      " cardholder_authentication_method: #{@cardholder_authentication_method},"\
+      " cardholder_authentication_entity: #{@cardholder_authentication_entity},"\
+      " card_data_output_capability: #{@card_data_output_capability}, terminal_output_capability:"\
+      " #{@terminal_output_capability}, pin_capture_capability: #{@pin_capture_capability}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_input_capability: #{@card_input_capability.inspect},"\
+      " cardholder_authentication_capability: #{@cardholder_authentication_capability.inspect},"\
+      " card_capture_capability: #{@card_capture_capability.inspect}, operating_environment:"\
+      " #{@operating_environment.inspect}, cardholder_presence: #{@cardholder_presence.inspect},"\
+      " card_presence: #{@card_presence.inspect}, card_data_input_mode:"\
+      " #{@card_data_input_mode.inspect}, cardholder_authentication_method:"\
+      " #{@cardholder_authentication_method.inspect}, cardholder_authentication_entity:"\
+      " #{@cardholder_authentication_entity.inspect}, card_data_output_capability:"\
+      " #{@card_data_output_capability.inspect}, terminal_output_capability:"\
+      " #{@terminal_output_capability.inspect}, pin_capture_capability:"\
+      " #{@pin_capture_capability.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/post_order_request.rb

@@ -0,0 +1,138 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to post a new order, including client reference, order
+  # lines, delivery details, and contact information. Inherits standard request
+  # metadata from Gd.Bos.DataTransfer.Request.RequestBase.
+  class PostOrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required. The unique client reference number for the order.
+    # Used for tracking and correlation of the order in client systems.
+    # @return [String]
+    attr_accessor :client_reference_number
+
+    # Required. The list of order lines, each representing a product or item in
+    # the order.
+    # @return [Array[Line]]
+    attr_accessor :lines
+
+    # Represents a delivery address including contact information and location
+    # details.
+    # @return [DeliveryAddress]
+    attr_accessor :delivery_address
+
+    # Required. The type of delivery requested (e.g., standard, express).
+    # @return [String]
+    attr_accessor :delivery_type
+
+    # Required. The contact phone number for the order.
+    # @return [String]
+    attr_accessor :phone
+
+    # Required. The name of the company placing the order.
+    # @return [String]
+    attr_accessor :company
+
+    # Required. The unique identifier for the company placing the order.
+    # @return [String]
+    attr_accessor :company_id
+
+    # Required. The contact email address for the order.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_reference_number'] = 'clientReferenceNumber'
+      @_hash['lines'] = 'lines'
+      @_hash['delivery_address'] = 'deliveryAddress'
+      @_hash['delivery_type'] = 'deliveryType'
+      @_hash['phone'] = 'phone'
+      @_hash['company'] = 'company'
+      @_hash['company_id'] = 'companyId'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_reference_number:, lines:, delivery_address:,
+                   delivery_type:, phone:, company:, company_id:, email:)
+      @client_reference_number = client_reference_number
+      @lines = lines
+      @delivery_address = delivery_address
+      @delivery_type = delivery_type
+      @phone = phone
+      @company = company
+      @company_id = company_id
+      @email = email
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      client_reference_number =
+        hash.key?('clientReferenceNumber') ? hash['clientReferenceNumber'] : nil
+      # Parameter is an array, so we need to iterate through it
+      lines = nil
+      unless hash['lines'].nil?
+        lines = []
+        hash['lines'].each do |structure|
+          lines << (Line.from_hash(structure) if structure)
+        end
+      end
+
+      lines = nil unless hash.key?('lines')
+      delivery_address = DeliveryAddress.from_hash(hash['deliveryAddress']) if
+        hash['deliveryAddress']
+      delivery_type = hash.key?('deliveryType') ? hash['deliveryType'] : nil
+      phone = hash.key?('phone') ? hash['phone'] : nil
+      company = hash.key?('company') ? hash['company'] : nil
+      company_id = hash.key?('companyId') ? hash['companyId'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+
+      # Create object from extracted values.
+      PostOrderRequest.new(client_reference_number: client_reference_number,
+                           lines: lines,
+                           delivery_address: delivery_address,
+                           delivery_type: delivery_type,
+                           phone: phone,
+                           company: company,
+                           company_id: company_id,
+                           email: email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_reference_number: #{@client_reference_number}, lines: #{@lines},"\
+      " delivery_address: #{@delivery_address}, delivery_type: #{@delivery_type}, phone:"\
+      " #{@phone}, company: #{@company}, company_id: #{@company_id}, email: #{@email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_reference_number: #{@client_reference_number.inspect}, lines:"\
+      " #{@lines.inspect}, delivery_address: #{@delivery_address.inspect}, delivery_type:"\
+      " #{@delivery_type.inspect}, phone: #{@phone.inspect}, company: #{@company.inspect},"\
+      " company_id: #{@company_id.inspect}, email: #{@email.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/post_order_response.rb

@@ -0,0 +1,129 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents the response returned after posting an order in the order
+  # management API. Inherits standard response metadata and order details from
+  # Gd.Bos.DataTransfer.Response.OrderManagement.Models.OrderResponseBase. Used
+  # to provide feedback about the outcome of a post order operation, including
+  # identifiers, status, and response details.
+  class PostOrderResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the client reference number associated with the order.
+    # Used to correlate the order with the client's internal systems.
+    # @return [String]
+    attr_accessor :client_reference_number
+
+    # Gets or sets the unique identifier for the order.
+    # Used to track and reference the order within the system.
+    # @return [String]
+    attr_accessor :order_identifier
+
+    # Gets or sets the status of the order.
+    # Indicates the current state of the order (e.g., "Pending", "Completed",
+    # "Cancelled").
+    # @return [String]
+    attr_accessor :status
+
+    # Gets or sets the date and time when the order was created.
+    # Nullable; may be omitted if not available.
+    # @return [DateTime]
+    attr_accessor :order_created
+
+    # Represents the details of a response in the order management system.
+    # @return [ResponseDetails]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_reference_number'] = 'clientReferenceNumber'
+      @_hash['order_identifier'] = 'orderIdentifier'
+      @_hash['status'] = 'status'
+      @_hash['order_created'] = 'orderCreated'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_reference_number
+        order_identifier
+        status
+        order_created
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        client_reference_number
+        order_identifier
+        status
+        order_created
+      ]
+    end
+
+    def initialize(client_reference_number: SKIP, order_identifier: SKIP,
+                   status: SKIP, order_created: SKIP, response_details: SKIP)
+      @client_reference_number = client_reference_number unless client_reference_number == SKIP
+      @order_identifier = order_identifier unless order_identifier == SKIP
+      @status = status unless status == SKIP
+      @order_created = order_created unless order_created == SKIP
+      @response_details = response_details unless response_details == 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.
+      client_reference_number =
+        hash.key?('clientReferenceNumber') ? hash['clientReferenceNumber'] : SKIP
+      order_identifier =
+        hash.key?('orderIdentifier') ? hash['orderIdentifier'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      order_created = if hash.key?('orderCreated')
+                        (DateTimeHelper.from_rfc3339(hash['orderCreated']) if hash['orderCreated'])
+                      else
+                        SKIP
+                      end
+      response_details = ResponseDetails.from_hash(hash['responseDetails']) if
+        hash['responseDetails']
+
+      # Create object from extracted values.
+      PostOrderResponse.new(client_reference_number: client_reference_number,
+                            order_identifier: order_identifier,
+                            status: status,
+                            order_created: order_created,
+                            response_details: response_details)
+    end
+
+    def to_custom_order_created
+      DateTimeHelper.to_rfc3339(order_created)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_reference_number: #{@client_reference_number}, order_identifier:"\
+      " #{@order_identifier}, status: #{@status}, order_created: #{@order_created},"\
+      " response_details: #{@response_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_reference_number: #{@client_reference_number.inspect},"\
+      " order_identifier: #{@order_identifier.inspect}, status: #{@status.inspect}, order_created:"\
+      " #{@order_created.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end