newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/create_oidc_identity_provider_config.rb

@@ -0,0 +1,104 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CreateOidcIdentityProviderConfig Model.
+  class CreateOidcIdentityProviderConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Client ID of an OIDC client
+    # @return [String]
+    attr_accessor :client_id
+
+    # Client secret of an OIDC client
+    # @return [String]
+    attr_accessor :client_secret
+
+    # Directory ID for Microsoft OIDC client and Okta domain for OKTA OIDC
+    # @return [String]
+    attr_accessor :directory_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash['directory_id'] = 'directory_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, client_secret = nil, directory_id = nil)
+      @client_id = client_id
+      @client_secret = client_secret
+      @directory_id = directory_id
+    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_id = hash.key?('client_id') ? hash['client_id'] : nil
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : nil
+      directory_id = hash.key?('directory_id') ? hash['directory_id'] : nil
+
+      # Create object from extracted values.
+      CreateOidcIdentityProviderConfig.new(client_id,
+                                           client_secret,
+                                           directory_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateOidcIdentityProviderConfig | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.client_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.client_secret,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.directory_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['client_id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['client_secret'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['directory_id'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, client_secret: #{@client_secret}, directory_id:"\
+      " #{@directory_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, client_secret: #{@client_secret.inspect},"\
+      " directory_id: #{@directory_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_package_tracking_custom_adapter.rb

@@ -0,0 +1,125 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # CreatePackageTrackingCustomAdapter Model.
+  class CreatePackageTrackingCustomAdapter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [TrackingStatusEnum]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tracking_code
+
+    # Set by carrier. It is the time at which the event has been
+    # recorded/generated by the carrier.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['status'] = 'status'
+      @_hash['tracking_code'] = 'tracking_code'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason
+      ]
+    end
+
+    def initialize(status = nil, tracking_code = nil, updated_at = nil,
+                   reason = SKIP)
+      @reason = reason unless reason == SKIP
+      @status = status
+      @tracking_code = tracking_code
+      @updated_at = updated_at
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : nil
+      tracking_code = hash.key?('tracking_code') ? hash['tracking_code'] : nil
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      CreatePackageTrackingCustomAdapter.new(status,
+                                             tracking_code,
+                                             updated_at,
+                                             reason)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreatePackageTrackingCustomAdapter | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.status,
+                                ->(val) { TrackingStatusEnum.validate(val) }) and
+            APIHelper.valid_type?(value.tracking_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.updated_at,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['status'],
+                              ->(val) { TrackingStatusEnum.validate(val) }) and
+          APIHelper.valid_type?(value['tracking_code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['updated_at'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}, status: #{@status}, tracking_code: #{@tracking_code},"\
+      " updated_at: #{@updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}, status: #{@status.inspect}, tracking_code:"\
+      " #{@tracking_code.inspect}, updated_at: #{@updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_package_tracking_easypost_adapter.rb

@@ -0,0 +1,75 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CreatePackageTrackingEasypostAdapter Model.
+  class CreatePackageTrackingEasypostAdapter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :easypost_marker
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['easypost_marker'] = 'easypost_marker'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(easypost_marker = nil)
+      @easypost_marker = easypost_marker
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      easypost_marker =
+        hash.key?('easypost_marker') ? hash['easypost_marker'] : nil
+
+      # Create object from extracted values.
+      CreatePackageTrackingEasypostAdapter.new(easypost_marker)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreatePackageTrackingEasypostAdapter | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.easypost_marker,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['easypost_marker'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} easypost_marker: #{@easypost_marker}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} easypost_marker: #{@easypost_marker.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_package_type_request.rb

@@ -0,0 +1,79 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Request body for creating a new package type. Package types define the
+  # packages available for an associate to choose from during the packing flow
+  # in the Associate App.
+  class CreatePackageTypeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The physical dimensions of a package type.
+    # @return [PackageDimensions]
+    attr_accessor :dimensions
+
+    # Display name shown to associates when selecting a package.
+    # @return [String]
+    attr_accessor :name
+
+    # The weight of a package type.
+    # @return [PackageWeight]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['name'] = 'name'
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(dimensions = nil, name = nil, weight = nil)
+      @dimensions = dimensions
+      @name = name
+      @weight = weight
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      dimensions = PackageDimensions.from_hash(hash['dimensions']) if hash['dimensions']
+      name = hash.key?('name') ? hash['name'] : nil
+      weight = PackageWeight.from_hash(hash['weight']) if hash['weight']
+
+      # Create object from extracted values.
+      CreatePackageTypeRequest.new(dimensions,
+                                   name,
+                                   weight)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dimensions: #{@dimensions}, name: #{@name}, weight: #{@weight}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dimensions: #{@dimensions.inspect}, name: #{@name.inspect}, weight:"\
+      " #{@weight.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_payment_link_request.rb

@@ -0,0 +1,105 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CreatePaymentLinkRequest Model.
+  class CreatePaymentLinkRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [ProcessorMetadata]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+      ]
+    end
+
+    def initialize(amount = nil, currency = nil, metadata = SKIP)
+      @amount = amount
+      @currency = currency
+      @metadata = metadata unless metadata == 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.
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreatePaymentLinkRequestAmount), hash['amount']
+      ) : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      metadata = ProcessorMetadata.from_hash(hash['metadata']) if hash['metadata']
+
+      # Create object from extracted values.
+      CreatePaymentLinkRequest.new(amount,
+                                   currency,
+                                   metadata)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreatePaymentLinkRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:CreatePaymentLinkRequestAmount)
+                         .validate(value.amount) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:CreatePaymentLinkRequestAmount)
+                       .validate(value['amount']) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}, metadata:"\
+      " #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_profile_request.rb

@@ -0,0 +1,141 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CreateProfileRequest Model.
+  class CreateProfileRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Email of the customer.
+    # @return [String]
+    attr_accessor :email
+
+    # The identifier of the associate creating profile
+    # @return [String]
+    attr_accessor :created_by
+
+    # Additional attributes for a customer.
+    # @return [Hash[String, ExtendedAttributeModel]]
+    attr_accessor :extended_attributes
+
+    # The first name of the customer.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Full name of the customer, including first, middle and last name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # The last name of the customer.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Phone number of the customer in E.164 format.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The identifier of the store, profile is being created in.
+    # @return [String]
+    attr_accessor :store_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['created_by'] = 'created_by'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['first_name'] = 'first_name'
+      @_hash['full_name'] = 'full_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['store_id'] = 'store_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_by
+        extended_attributes
+        first_name
+        full_name
+        last_name
+        phone_number
+        store_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        created_by
+        first_name
+        full_name
+        last_name
+        phone_number
+        store_id
+      ]
+    end
+
+    def initialize(email = nil, created_by = SKIP, extended_attributes = SKIP,
+                   first_name = SKIP, full_name = SKIP, last_name = SKIP,
+                   phone_number = SKIP, store_id = SKIP)
+      @email = email
+      @created_by = created_by unless created_by == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @full_name = full_name unless full_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @store_id = store_id unless store_id == 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.
+      email = hash.key?('email') ? hash['email'] : nil
+      created_by = hash.key?('created_by') ? hash['created_by'] : SKIP
+      extended_attributes = ExtendedAttributeModel.from_hash(hash['extended_attributes']) if
+        hash['extended_attributes']
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateProfileRequest.new(email,
+                               created_by,
+                               extended_attributes,
+                               first_name,
+                               full_name,
+                               last_name,
+                               phone_number,
+                               store_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, created_by: #{@created_by}, extended_attributes:"\
+      " #{@extended_attributes}, first_name: #{@first_name}, full_name: #{@full_name}, last_name:"\
+      " #{@last_name}, phone_number: #{@phone_number}, store_id: #{@store_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, created_by: #{@created_by.inspect},"\
+      " extended_attributes: #{@extended_attributes.inspect}, first_name: #{@first_name.inspect},"\
+      " full_name: #{@full_name.inspect}, last_name: #{@last_name.inspect}, phone_number:"\
+      " #{@phone_number.inspect}, store_id: #{@store_id.inspect}>"
+    end
+  end
+end