splitit-apimatic-sdk 1.0.0

data/lib/splitit_web_api_v4/models/installment_plan_search_details_response.rb

@@ -0,0 +1,71 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # InstallmentPlanSearchDetailsResponse Model.
+  class InstallmentPlanSearchDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[InstallmentPlanDetailsResponse]]
+    attr_accessor :plan_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['plan_list'] = 'PlanList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_list = SKIP)
+      @plan_list = plan_list unless plan_list == 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.
+      # Parameter is an array, so we need to iterate through it
+      plan_list = nil
+      unless hash['PlanList'].nil?
+        plan_list = []
+        hash['PlanList'].each do |structure|
+          plan_list << (InstallmentPlanDetailsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      plan_list = SKIP unless hash.key?('PlanList')
+
+      # Create object from extracted values.
+      InstallmentPlanSearchDetailsResponse.new(plan_list)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_list: #{@plan_list}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_list: #{@plan_list.inspect}>"
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/installment_plan_search_request.rb

@@ -0,0 +1,79 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # InstallmentPlanSearchRequest Model.
+  class InstallmentPlanSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :installment_plan_numbers
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :merchant_order_reference_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['installment_plan_numbers'] = 'InstallmentPlanNumbers'
+      @_hash['merchant_order_reference_ids'] = 'MerchantOrderReferenceIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        installment_plan_numbers
+        merchant_order_reference_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(installment_plan_numbers = SKIP,
+                   merchant_order_reference_ids = SKIP)
+      @installment_plan_numbers = installment_plan_numbers unless installment_plan_numbers == SKIP
+      unless merchant_order_reference_ids == SKIP
+        @merchant_order_reference_ids =
+          merchant_order_reference_ids
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      installment_plan_numbers =
+        hash.key?('InstallmentPlanNumbers') ? hash['InstallmentPlanNumbers'] : SKIP
+      merchant_order_reference_ids =
+        hash.key?('MerchantOrderReferenceIds') ? hash['MerchantOrderReferenceIds'] : SKIP
+
+      # Create object from extracted values.
+      InstallmentPlanSearchRequest.new(installment_plan_numbers,
+                                       merchant_order_reference_ids)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} installment_plan_numbers: #{@installment_plan_numbers},"\
+      " merchant_order_reference_ids: #{@merchant_order_reference_ids}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} installment_plan_numbers: #{@installment_plan_numbers.inspect},"\
+      " merchant_order_reference_ids: #{@merchant_order_reference_ids.inspect}>"
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/installment_plan_status_enum.rb

@@ -0,0 +1,72 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # InstallmentPlanStatus.
+  class InstallmentPlanStatusEnum
+    INSTALLMENT_PLAN_STATUS_ENUM = [
+      # TODO: Write general description for NONE
+      NONE = 'None'.freeze,
+
+      # TODO: Write general description for PENDINGAPPROVAL
+      PENDINGAPPROVAL = 'PendingApproval'.freeze,
+
+      # TODO: Write general description for PENDINGMERCHANTSHIPMENTNOTICE
+      PENDINGMERCHANTSHIPMENTNOTICE = 'PendingMerchantShipmentNotice'.freeze,
+
+      # TODO: Write general description for INPROGRESS
+      INPROGRESS = 'InProgress'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'Deleted'.freeze,
+
+      # TODO: Write general description for CLEARED
+      CLEARED = 'Cleared'.freeze,
+
+      # TODO: Write general description for PENDINGPAYMENTUPDATE
+      PENDINGPAYMENTUPDATE = 'PendingPaymentUpdate'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'Canceled'.freeze,
+
+      # TODO: Write general description for DELAYED
+      DELAYED = 'Delayed'.freeze,
+
+      # TODO: Write general description for INITIALIZING
+      INITIALIZING = 'Initializing'.freeze,
+
+      # TODO: Write general description for ALLSTATUSES
+      ALLSTATUSES = 'AllStatuses'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INSTALLMENT_PLAN_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'pendingapproval' then PENDINGAPPROVAL
+      when 'pendingmerchantshipmentnotice' then PENDINGMERCHANTSHIPMENTNOTICE
+      when 'inprogress' then INPROGRESS
+      when 'deleted' then DELETED
+      when 'cleared' then CLEARED
+      when 'pendingpaymentupdate' then PENDINGPAYMENTUPDATE
+      when 'canceled' then CANCELED
+      when 'delayed' then DELAYED
+      when 'initializing' then INITIALIZING
+      when 'allstatuses' then ALLSTATUSES
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/installment_status_enum.rb

@@ -0,0 +1,60 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # InstallmentStatus.
+  class InstallmentStatusEnum
+    INSTALLMENT_STATUS_ENUM = [
+      # TODO: Write general description for NONE
+      NONE = 'None'.freeze,
+
+      # TODO: Write general description for WAITINGFORPROCESSDATE
+      WAITINGFORPROCESSDATE = 'WaitingForProcessDate'.freeze,
+
+      # TODO: Write general description for FINISHED
+      FINISHED = 'Finished'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'Deleted'.freeze,
+
+      # TODO: Write general description for STOPPED
+      STOPPED = 'Stopped'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'Canceled'.freeze,
+
+      # TODO: Write general description for AWAITINGCAPTURE
+      AWAITINGCAPTURE = 'AwaitingCapture'.freeze,
+
+      # TODO: Write general description for AWAITINGVOID
+      AWAITINGVOID = 'AwaitingVoid'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INSTALLMENT_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'waitingforprocessdate' then WAITINGFORPROCESSDATE
+      when 'finished' then FINISHED
+      when 'deleted' then DELETED
+      when 'stopped' then STOPPED
+      when 'canceled' then CANCELED
+      when 'awaitingcapture' then AWAITINGCAPTURE
+      when 'awaitingvoid' then AWAITINGVOID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/masked_card_details.rb

@@ -0,0 +1,82 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # MaskedCardDetails Model.
+  class MaskedCardDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last4_digits
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :bin
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :issuer_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last4_digits'] = 'Last4Digits'
+      @_hash['bin'] = 'BIN'
+      @_hash['issuer_name'] = 'IssuerName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last4_digits
+        bin
+        issuer_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last4_digits = SKIP, bin = SKIP, issuer_name = SKIP)
+      @last4_digits = last4_digits unless last4_digits == SKIP
+      @bin = bin unless bin == SKIP
+      @issuer_name = issuer_name unless issuer_name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      last4_digits = hash.key?('Last4Digits') ? hash['Last4Digits'] : SKIP
+      bin = hash.key?('BIN') ? hash['BIN'] : SKIP
+      issuer_name = hash.key?('IssuerName') ? hash['IssuerName'] : SKIP
+
+      # Create object from extracted values.
+      MaskedCardDetails.new(last4_digits,
+                            bin,
+                            issuer_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last4_digits: #{@last4_digits}, bin: #{@bin}, issuer_name:"\
+      " #{@issuer_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last4_digits: #{@last4_digits.inspect}, bin: #{@bin.inspect}, issuer_name:"\
+      " #{@issuer_name.inspect}>"
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/metadata_item.rb

@@ -0,0 +1,71 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # MetadataItem Model.
+  class MetadataItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'Key'
+      @_hash['value'] = 'Value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP, value = SKIP)
+      @key = key unless key == SKIP
+      @value = value unless value == 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.
+      key = hash.key?('Key') ? hash['Key'] : SKIP
+      value = hash.key?('Value') ? hash['Value'] : SKIP
+
+      # Create object from extracted values.
+      MetadataItem.new(key,
+                       value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/o_auth_provider_error_enum.rb

@@ -0,0 +1,62 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # OAuth 2 Authorization error codes
+  class OAuthProviderErrorEnum
+    O_AUTH_PROVIDER_ERROR_ENUM = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_PROVIDER_ERROR_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVALID_REQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_client' then INVALID_CLIENT
+      when 'invalid_grant' then INVALID_GRANT
+      when 'unauthorized_client' then UNAUTHORIZED_CLIENT
+      when 'unsupported_grant_type' then UNSUPPORTED_GRANT_TYPE
+      when 'invalid_scope' then INVALID_SCOPE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/o_auth_scope_o_auth2_enum.rb

@@ -0,0 +1,26 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # OAuth 2 scopes supported by the API
+  class OAuthScopeOAuth2Enum
+    O_AUTH_SCOPE_O_AUTH2_ENUM = [
+      # Access to API v4
+      API_V4 = 'api.v4'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_SCOPE_O_AUTH2_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = API_V4)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/splitit_web_api_v4/models/o_auth_token.rb

@@ -0,0 +1,96 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil, token_type = nil, expires_in = SKIP,
+                   scope = SKIP, expiry = SKIP, refresh_token = SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token,
+                     token_type,
+                     expires_in,
+                     scope,
+                     expiry,
+                     refresh_token)
+    end
+  end
+end