apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/switch_attempt.rb

@@ -0,0 +1,187 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents the details of a direct deposit switch attempt, including
+  # identifiers, vendor information, status, and event history.
+  class SwitchAttempt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique reference number for the switch attempt.
+    # @return [String]
+    attr_accessor :reference_number
+
+    # The unique identifier for the switch attempt.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the vendor handling the direct deposit switch.
+    # @return [String]
+    attr_accessor :vendor
+
+    # The reference identifier provided by the vendor for this switch attempt.
+    # @return [String]
+    attr_accessor :vendor_reference
+
+    # The amount associated with the switch attempt.
+    # @return [String]
+    attr_accessor :amount
+
+    # The type of amount (e.g., "fixed", "percentage") for the switch attempt.
+    # @return [String]
+    attr_accessor :amount_type
+
+    # The current status of the switch attempt (e.g., "Pending", "Completed",
+    # "Failed").
+    # @return [String]
+    attr_accessor :status
+
+    # The reason for the current status, if applicable.
+    # @return [String]
+    attr_accessor :status_reason
+
+    # The UTC date and time of the last event related to this switch attempt.
+    # @return [DateTime]
+    attr_accessor :last_event_date_utc
+
+    # The name of the depositor associated with the switch attempt.
+    # @return [String]
+    attr_accessor :depositor
+
+    # The list of event identifiers associated with this switch attempt.
+    # @return [Array[String]]
+    attr_accessor :event_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_number'] = 'referenceNumber'
+      @_hash['id'] = 'id'
+      @_hash['vendor'] = 'vendor'
+      @_hash['vendor_reference'] = 'vendorReference'
+      @_hash['amount'] = 'amount'
+      @_hash['amount_type'] = 'amountType'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'statusReason'
+      @_hash['last_event_date_utc'] = 'lastEventDateUtc'
+      @_hash['depositor'] = 'depositor'
+      @_hash['event_ids'] = 'eventIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference_number
+        id
+        vendor
+        vendor_reference
+        amount
+        amount_type
+        status
+        status_reason
+        last_event_date_utc
+        depositor
+        event_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reference_number
+        id
+        vendor
+        vendor_reference
+        amount
+        amount_type
+        status
+        status_reason
+        depositor
+        event_ids
+      ]
+    end
+
+    def initialize(reference_number: SKIP, id: SKIP, vendor: SKIP,
+                   vendor_reference: SKIP, amount: SKIP, amount_type: SKIP,
+                   status: SKIP, status_reason: SKIP, last_event_date_utc: SKIP,
+                   depositor: SKIP, event_ids: SKIP)
+      @reference_number = reference_number unless reference_number == SKIP
+      @id = id unless id == SKIP
+      @vendor = vendor unless vendor == SKIP
+      @vendor_reference = vendor_reference unless vendor_reference == SKIP
+      @amount = amount unless amount == SKIP
+      @amount_type = amount_type unless amount_type == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == SKIP
+      @last_event_date_utc = last_event_date_utc unless last_event_date_utc == SKIP
+      @depositor = depositor unless depositor == SKIP
+      @event_ids = event_ids unless event_ids == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reference_number =
+        hash.key?('referenceNumber') ? hash['referenceNumber'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      vendor = hash.key?('vendor') ? hash['vendor'] : SKIP
+      vendor_reference =
+        hash.key?('vendorReference') ? hash['vendorReference'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      amount_type = hash.key?('amountType') ? hash['amountType'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('statusReason') ? hash['statusReason'] : SKIP
+      last_event_date_utc = if hash.key?('lastEventDateUtc')
+                              (DateTimeHelper.from_rfc3339(hash['lastEventDateUtc']) if hash['lastEventDateUtc'])
+                            else
+                              SKIP
+                            end
+      depositor = hash.key?('depositor') ? hash['depositor'] : SKIP
+      event_ids = hash.key?('eventIds') ? hash['eventIds'] : SKIP
+
+      # Create object from extracted values.
+      SwitchAttempt.new(reference_number: reference_number,
+                        id: id,
+                        vendor: vendor,
+                        vendor_reference: vendor_reference,
+                        amount: amount,
+                        amount_type: amount_type,
+                        status: status,
+                        status_reason: status_reason,
+                        last_event_date_utc: last_event_date_utc,
+                        depositor: depositor,
+                        event_ids: event_ids)
+    end
+
+    def to_custom_last_event_date_utc
+      DateTimeHelper.to_rfc3339(last_event_date_utc)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_number: #{@reference_number}, id: #{@id}, vendor: #{@vendor},"\
+      " vendor_reference: #{@vendor_reference}, amount: #{@amount}, amount_type: #{@amount_type},"\
+      " status: #{@status}, status_reason: #{@status_reason}, last_event_date_utc:"\
+      " #{@last_event_date_utc}, depositor: #{@depositor}, event_ids: #{@event_ids}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_number: #{@reference_number.inspect}, id: #{@id.inspect}, vendor:"\
+      " #{@vendor.inspect}, vendor_reference: #{@vendor_reference.inspect}, amount:"\
+      " #{@amount.inspect}, amount_type: #{@amount_type.inspect}, status: #{@status.inspect},"\
+      " status_reason: #{@status_reason.inspect}, last_event_date_utc:"\
+      " #{@last_event_date_utc.inspect}, depositor: #{@depositor.inspect}, event_ids:"\
+      " #{@event_ids.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/terms_acceptance.rb

@@ -0,0 +1,100 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a record of a user's acceptance of specific terms and conditions.
+  # Contains the identifier of the terms, the date and time of acceptance, and a
+  # flag indicating whether the terms were accepted. Used to track user consent
+  # for legal, compliance, or business requirements during onboarding or other
+  # operations.
+  class TermsAcceptance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the terms and conditions that were presented to
+    # the user.
+    # @return [String]
+    attr_accessor :terms_identifier
+
+    # The date and time when the user accepted the terms, typically in ISO 8601
+    # format (e.g., "2023-07-01T12:34:56Z").
+    # @return [String]
+    attr_accessor :terms_acceptance_date_time
+
+    # Indicates whether the user accepted the terms (true) or declined (false).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :terms_acceptance_flag
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['terms_identifier'] = 'termsIdentifier'
+      @_hash['terms_acceptance_date_time'] = 'termsAcceptanceDateTime'
+      @_hash['terms_acceptance_flag'] = 'termsAcceptanceFlag'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        terms_identifier
+        terms_acceptance_date_time
+        terms_acceptance_flag
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        terms_identifier
+        terms_acceptance_date_time
+        terms_acceptance_flag
+      ]
+    end
+
+    def initialize(terms_identifier: SKIP, terms_acceptance_date_time: SKIP,
+                   terms_acceptance_flag: SKIP)
+      @terms_identifier = terms_identifier unless terms_identifier == SKIP
+      unless terms_acceptance_date_time == SKIP
+        @terms_acceptance_date_time =
+          terms_acceptance_date_time
+      end
+      @terms_acceptance_flag = terms_acceptance_flag unless terms_acceptance_flag == 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.
+      terms_identifier =
+        hash.key?('termsIdentifier') ? hash['termsIdentifier'] : SKIP
+      terms_acceptance_date_time =
+        hash.key?('termsAcceptanceDateTime') ? hash['termsAcceptanceDateTime'] : SKIP
+      terms_acceptance_flag =
+        hash.key?('termsAcceptanceFlag') ? hash['termsAcceptanceFlag'] : SKIP
+
+      # Create object from extracted values.
+      TermsAcceptance.new(terms_identifier: terms_identifier,
+                          terms_acceptance_date_time: terms_acceptance_date_time,
+                          terms_acceptance_flag: terms_acceptance_flag)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} terms_identifier: #{@terms_identifier}, terms_acceptance_date_time:"\
+      " #{@terms_acceptance_date_time}, terms_acceptance_flag: #{@terms_acceptance_flag}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} terms_identifier: #{@terms_identifier.inspect}, terms_acceptance_date_time:"\
+      " #{@terms_acceptance_date_time.inspect}, terms_acceptance_flag:"\
+      " #{@terms_acceptance_flag.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/test_event_web_hook_set_config_request.rb

@@ -0,0 +1,129 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to configure the test event webhook behavior for
+  # integration testing. Allows simulation of webhook response delays, HTTP
+  # status codes, and custom response bodies/content types. Used to test webhook
+  # consumers by controlling the timing and content of webhook responses.
+  class TestEventWebHookSetConfigRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the minimum amount of time (in milliseconds) to delay the
+    # webhook response.
+    # A value of 0 means no delay will be applied.
+    # @return [Integer]
+    attr_accessor :minimum
+
+    # Gets or sets the maximum amount of time (in milliseconds) to delay the
+    # webhook response.
+    # A value of 0 means no delay will be applied.
+    # @return [Integer]
+    attr_accessor :maximum
+
+    # Gets or sets the HTTP status code to be returned in the simulated webhook
+    # response.
+    # If not provided, the default status code will be used.
+    # @return [ResponseHttpStatusCode]
+    attr_accessor :response_http_status_code
+
+    # Gets or sets the HTTP response body to be returned when
+    # Gd.Bos.DataTransfer.Request.TestEventWebHookSetConfigRequest.ResponseHttpS
+    # tatusCode is provided.
+    # If null or empty, the response will not include a body.
+    # @return [String]
+    attr_accessor :response_body
+
+    # Gets or sets the content type to return with the
+    # Gd.Bos.DataTransfer.Request.TestEventWebHookSetConfigRequest.ResponseHttpS
+    # tatusCode.
+    # If null or empty, defaults to "application/json" or as determined by the
+    # server.
+    # @return [String]
+    attr_accessor :response_content_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['minimum'] = 'minimum'
+      @_hash['maximum'] = 'maximum'
+      @_hash['response_http_status_code'] = 'responseHttpStatusCode'
+      @_hash['response_body'] = 'responseBody'
+      @_hash['response_content_type'] = 'responseContentType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        minimum
+        maximum
+        response_http_status_code
+        response_body
+        response_content_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_http_status_code
+        response_body
+        response_content_type
+      ]
+    end
+
+    def initialize(minimum: SKIP, maximum: SKIP,
+                   response_http_status_code: SKIP, response_body: SKIP,
+                   response_content_type: SKIP)
+      @minimum = minimum unless minimum == SKIP
+      @maximum = maximum unless maximum == SKIP
+      unless response_http_status_code == SKIP
+        @response_http_status_code =
+          response_http_status_code
+      end
+      @response_body = response_body unless response_body == SKIP
+      @response_content_type = response_content_type unless response_content_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.
+      minimum = hash.key?('minimum') ? hash['minimum'] : SKIP
+      maximum = hash.key?('maximum') ? hash['maximum'] : SKIP
+      response_http_status_code =
+        hash.key?('responseHttpStatusCode') ? hash['responseHttpStatusCode'] : SKIP
+      response_body = hash.key?('responseBody') ? hash['responseBody'] : SKIP
+      response_content_type =
+        hash.key?('responseContentType') ? hash['responseContentType'] : SKIP
+
+      # Create object from extracted values.
+      TestEventWebHookSetConfigRequest.new(minimum: minimum,
+                                           maximum: maximum,
+                                           response_http_status_code: response_http_status_code,
+                                           response_body: response_body,
+                                           response_content_type: response_content_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} minimum: #{@minimum}, maximum: #{@maximum}, response_http_status_code:"\
+      " #{@response_http_status_code}, response_body: #{@response_body}, response_content_type:"\
+      " #{@response_content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} minimum: #{@minimum.inspect}, maximum: #{@maximum.inspect},"\
+      " response_http_status_code: #{@response_http_status_code.inspect}, response_body:"\
+      " #{@response_body.inspect}, response_content_type: #{@response_content_type.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/track_my_mail_response.rb

@@ -0,0 +1,232 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents the response containing delivery and tracking information for a
+  # mailed payment instrument.
+  class TrackMyMailResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The tracking number provided by the shipping carrier for the mailed
+    # payment instrument.
+    # @return [String]
+    attr_accessor :tracking_number
+
+    # The code representing the delivery method (e.g., "STD" for standard, "EXP"
+    # for express).
+    # @return [String]
+    attr_accessor :delivery_method_code
+
+    # The human-readable name of the delivery method (e.g., "Standard Mail",
+    # "Express Delivery").
+    # @return [String]
+    attr_accessor :delivery_method
+
+    # The code representing the current delivery status (e.g., "IN_TRANSIT",
+    # "DELIVERED").
+    # @return [String]
+    attr_accessor :delivery_status_code
+
+    # The human-readable description of the current delivery status.
+    # @return [String]
+    attr_accessor :delivery_status
+
+    # The date and time when the payment instrument was shipped, if available.
+    # @return [DateTime]
+    attr_accessor :shipped_date
+
+    # The estimated date when the payment instrument is expected to arrive.
+    # @return [DateTime]
+    attr_accessor :estimated_arrival_date
+
+    # The last four digits of the payment instrument's PAN (Primary Account
+    # Number).
+    # @return [String]
+    attr_accessor :last4_pan
+
+    # The Bank Identification Number (BIN) associated with the payment
+    # instrument.
+    # @return [String]
+    attr_accessor :bin
+
+    # The name of the cardholder as it appears on the payment instrument.
+    # @return [String]
+    attr_accessor :card_holder_name
+
+    # The material type of the product (e.g., "plastic", "virtual").
+    # @return [String]
+    attr_accessor :product_material_type
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracking_number'] = 'trackingNumber'
+      @_hash['delivery_method_code'] = 'deliveryMethodCode'
+      @_hash['delivery_method'] = 'deliveryMethod'
+      @_hash['delivery_status_code'] = 'deliveryStatusCode'
+      @_hash['delivery_status'] = 'deliveryStatus'
+      @_hash['shipped_date'] = 'shippedDate'
+      @_hash['estimated_arrival_date'] = 'estimatedArrivalDate'
+      @_hash['last4_pan'] = 'last4Pan'
+      @_hash['bin'] = 'bin'
+      @_hash['card_holder_name'] = 'cardHolderName'
+      @_hash['product_material_type'] = 'productMaterialType'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_number
+        delivery_method_code
+        delivery_method
+        delivery_status_code
+        delivery_status
+        shipped_date
+        estimated_arrival_date
+        last4_pan
+        bin
+        card_holder_name
+        product_material_type
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tracking_number
+        delivery_method_code
+        delivery_method
+        delivery_status_code
+        delivery_status
+        shipped_date
+        estimated_arrival_date
+        last4_pan
+        bin
+        card_holder_name
+        product_material_type
+        response_details
+      ]
+    end
+
+    def initialize(tracking_number: SKIP, delivery_method_code: SKIP,
+                   delivery_method: SKIP, delivery_status_code: SKIP,
+                   delivery_status: SKIP, shipped_date: SKIP,
+                   estimated_arrival_date: SKIP, last4_pan: SKIP, bin: SKIP,
+                   card_holder_name: SKIP, product_material_type: SKIP,
+                   response_details: SKIP)
+      @tracking_number = tracking_number unless tracking_number == SKIP
+      @delivery_method_code = delivery_method_code unless delivery_method_code == SKIP
+      @delivery_method = delivery_method unless delivery_method == SKIP
+      @delivery_status_code = delivery_status_code unless delivery_status_code == SKIP
+      @delivery_status = delivery_status unless delivery_status == SKIP
+      @shipped_date = shipped_date unless shipped_date == SKIP
+      @estimated_arrival_date = estimated_arrival_date unless estimated_arrival_date == SKIP
+      @last4_pan = last4_pan unless last4_pan == SKIP
+      @bin = bin unless bin == SKIP
+      @card_holder_name = card_holder_name unless card_holder_name == SKIP
+      @product_material_type = product_material_type unless product_material_type == 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.
+      tracking_number =
+        hash.key?('trackingNumber') ? hash['trackingNumber'] : SKIP
+      delivery_method_code =
+        hash.key?('deliveryMethodCode') ? hash['deliveryMethodCode'] : SKIP
+      delivery_method =
+        hash.key?('deliveryMethod') ? hash['deliveryMethod'] : SKIP
+      delivery_status_code =
+        hash.key?('deliveryStatusCode') ? hash['deliveryStatusCode'] : SKIP
+      delivery_status =
+        hash.key?('deliveryStatus') ? hash['deliveryStatus'] : SKIP
+      shipped_date = if hash.key?('shippedDate')
+                       (DateTimeHelper.from_rfc3339(hash['shippedDate']) if hash['shippedDate'])
+                     else
+                       SKIP
+                     end
+      estimated_arrival_date = if hash.key?('estimatedArrivalDate')
+                                 (DateTimeHelper.from_rfc3339(hash['estimatedArrivalDate']) if hash['estimatedArrivalDate'])
+                               else
+                                 SKIP
+                               end
+      last4_pan = hash.key?('last4Pan') ? hash['last4Pan'] : SKIP
+      bin = hash.key?('bin') ? hash['bin'] : SKIP
+      card_holder_name =
+        hash.key?('cardHolderName') ? hash['cardHolderName'] : SKIP
+      product_material_type =
+        hash.key?('productMaterialType') ? hash['productMaterialType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      TrackMyMailResponse.new(tracking_number: tracking_number,
+                              delivery_method_code: delivery_method_code,
+                              delivery_method: delivery_method,
+                              delivery_status_code: delivery_status_code,
+                              delivery_status: delivery_status,
+                              shipped_date: shipped_date,
+                              estimated_arrival_date: estimated_arrival_date,
+                              last4_pan: last4_pan,
+                              bin: bin,
+                              card_holder_name: card_holder_name,
+                              product_material_type: product_material_type,
+                              response_details: response_details)
+    end
+
+    def to_custom_shipped_date
+      DateTimeHelper.to_rfc3339(shipped_date)
+    end
+
+    def to_custom_estimated_arrival_date
+      DateTimeHelper.to_rfc3339(estimated_arrival_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tracking_number: #{@tracking_number}, delivery_method_code:"\
+      " #{@delivery_method_code}, delivery_method: #{@delivery_method}, delivery_status_code:"\
+      " #{@delivery_status_code}, delivery_status: #{@delivery_status}, shipped_date:"\
+      " #{@shipped_date}, estimated_arrival_date: #{@estimated_arrival_date}, last4_pan:"\
+      " #{@last4_pan}, bin: #{@bin}, card_holder_name: #{@card_holder_name},"\
+      " product_material_type: #{@product_material_type}, 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} tracking_number: #{@tracking_number.inspect}, delivery_method_code:"\
+      " #{@delivery_method_code.inspect}, delivery_method: #{@delivery_method.inspect},"\
+      " delivery_status_code: #{@delivery_status_code.inspect}, delivery_status:"\
+      " #{@delivery_status.inspect}, shipped_date: #{@shipped_date.inspect},"\
+      " estimated_arrival_date: #{@estimated_arrival_date.inspect}, last4_pan:"\
+      " #{@last4_pan.inspect}, bin: #{@bin.inspect}, card_holder_name:"\
+      " #{@card_holder_name.inspect}, product_material_type: #{@product_material_type.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end