newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/http/auth/o_auth2.rb

@@ -0,0 +1,157 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ClientCredentialsAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(client_credentials_auth_credentials, config)
+      @_o_auth_client_id = client_credentials_auth_credentials.o_auth_client_id unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = client_credentials_auth_credentials.o_auth_client_secret unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = client_credentials_auth_credentials.o_auth_token unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token.nil?
+      @_o_auth_scopes = client_credentials_auth_credentials.o_auth_scopes unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_scopes.nil?
+      @_o_auth_clock_skew = client_credentials_auth_credentials.o_auth_clock_skew unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_clock_skew.nil?
+      @_o_auth_token_provider = client_credentials_auth_credentials.o_auth_token_provider unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token_provider.nil?
+      @_o_auth_on_token_update = client_credentials_auth_credentials.o_auth_on_token_update unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_on_token_update.nil?
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      super({})
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      @_o_auth_token = get_token_from_provider
+      @_o_auth_token.is_a?(OAuthToken) && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_o_auth_client_id, @_o_auth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token(
+        build_basic_auth_header,
+        scope: !@_o_auth_scopes.nil? ? Array(@_o_auth_scopes).compact.join(' ') : @_o_auth_scopes,
+        _field_parameters: additional_params
+      )
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry, @_o_auth_clock_skew)
+    end
+
+    def apply(http_request)
+      auth_params = { 'Authorization' => "Bearer #{@_o_auth_token.access_token}" }
+      AuthHelper.apply(auth_params, http_request.method(:add_header))
+    end
+
+    private
+
+    # This provides the OAuth Token from either the user configured callbacks or from default provider.
+    # @return [OAuthToken] The fetched oauth token.
+    def get_token_from_provider
+      return @_o_auth_token if @_o_auth_token && !token_expired?(@_o_auth_token)
+
+      if @_o_auth_token_provider
+        o_auth_token = @_o_auth_token_provider.call(@_o_auth_token, self)
+        @_o_auth_on_token_update&.call(o_auth_token)
+        return o_auth_token
+      end
+      begin
+        o_auth_token = fetch_token
+        @_o_auth_on_token_update&.call(o_auth_token)
+        o_auth_token
+      rescue ApiException
+        @_o_auth_token
+      end
+    end
+  end
+
+  # Data class for ClientCredentialsAuthCredentials.
+  class ClientCredentialsAuthCredentials
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token,
+                :o_auth_scopes, :o_auth_token_provider, :o_auth_on_token_update,
+                :o_auth_clock_skew
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil,
+                   o_auth_scopes: nil, o_auth_token_provider: nil,
+                   o_auth_on_token_update: nil, o_auth_clock_skew: 0)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_client_secret = o_auth_client_secret
+      @o_auth_token = o_auth_token
+      @o_auth_scopes = o_auth_scopes
+      @o_auth_token_provider = o_auth_token_provider
+      @o_auth_on_token_update = o_auth_on_token_update
+      @o_auth_clock_skew = o_auth_clock_skew
+    end
+
+    def self.from_env
+      o_auth_client_id = ENV['O_AUTH_CLIENT_ID']
+      o_auth_client_secret = ENV['O_AUTH_CLIENT_SECRET']
+      o_auth_scopes = ENV['O_AUTH_SCOPES']
+      o_auth_clock_skew = ENV['O_AUTH_CLOCK_SKEW']
+      all_nil = [
+        o_auth_client_id,
+        o_auth_client_secret
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(o_auth_client_id: o_auth_client_id,
+          o_auth_client_secret: o_auth_client_secret,
+          o_auth_scopes: o_auth_scopes, o_auth_clock_skew: o_auth_clock_skew)
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_token: nil, o_auth_scopes: nil,
+                   o_auth_token_provider: nil, o_auth_on_token_update: nil,
+                   o_auth_clock_skew: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_token ||= self.o_auth_token
+      o_auth_scopes ||= self.o_auth_scopes
+      o_auth_token_provider ||= self.o_auth_token_provider
+      o_auth_on_token_update ||= self.o_auth_on_token_update
+      o_auth_clock_skew ||= self.o_auth_clock_skew
+
+      ClientCredentialsAuthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token,
+        o_auth_scopes: o_auth_scopes,
+        o_auth_token_provider: o_auth_token_provider,
+        o_auth_on_token_update: o_auth_on_token_update,
+        o_auth_clock_skew: o_auth_clock_skew
+      )
+    end
+  end
+end

data/lib/new_store_api/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/new_store_api/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/new_store_api/http/http_request.rb

@@ -0,0 +1,10 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/new_store_api/http/http_response.rb

@@ -0,0 +1,10 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/new_store_api/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end

data/lib/new_store_api/models/accept_enum.rb

@@ -0,0 +1,26 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Accept.
+  class AcceptEnum
+    ACCEPT_ENUM = [
+      # TODO: Write general description for ENUM_TEXTCSV
+      ENUM_TEXTCSV = 'text/csv'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCEPT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_TEXTCSV)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/new_store_api/models/action_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Action to be performed with the item(reroute, cancel).
+  class ActionEnum
+    ACTION_ENUM = [
+      # TODO: Write general description for REROUTE
+      REROUTE = 'reroute'.freeze,
+
+      # TODO: Write general description for CANCEL
+      CANCEL = 'cancel'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACTION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = REROUTE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'reroute' then REROUTE
+      when 'cancel' then CANCEL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/actor.rb

@@ -0,0 +1,134 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Who (or what) caused the audited change. Sourced from the caller's JWT;
+  # empty fields are omitted from the payload.
+  class Actor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the actor authenticated (from the JWT `auth_time` claim).
+    # @return [DateTime]
+    attr_accessor :authenticated_at
+
+    # JWT `azp` — channel or integration that called the API.
+    # @return [String]
+    attr_accessor :authorized_party
+
+    # JWT `name`.
+    # @return [String]
+    attr_accessor :display_name
+
+    # JWT `sub` — IDP user id (human or technical user).
+    # @return [String]
+    attr_accessor :idp_user_id
+
+    # JWT `sid` — correlates events in the same auth session.
+    # @return [String]
+    attr_accessor :session_id
+
+    # JWT `jti` — per-token identifier.
+    # @return [String]
+    attr_accessor :token_id
+
+    # Legacy internal NewStore user id.
+    # @return [String]
+    attr_accessor :user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authenticated_at'] = 'authenticated_at'
+      @_hash['authorized_party'] = 'authorized_party'
+      @_hash['display_name'] = 'display_name'
+      @_hash['idp_user_id'] = 'idp_user_id'
+      @_hash['session_id'] = 'session_id'
+      @_hash['token_id'] = 'token_id'
+      @_hash['user_id'] = 'user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authenticated_at
+        authorized_party
+        display_name
+        idp_user_id
+        session_id
+        token_id
+        user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authenticated_at = SKIP, authorized_party = SKIP,
+                   display_name = SKIP, idp_user_id = SKIP, session_id = SKIP,
+                   token_id = SKIP, user_id = SKIP)
+      @authenticated_at = authenticated_at unless authenticated_at == SKIP
+      @authorized_party = authorized_party unless authorized_party == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @idp_user_id = idp_user_id unless idp_user_id == SKIP
+      @session_id = session_id unless session_id == SKIP
+      @token_id = token_id unless token_id == SKIP
+      @user_id = user_id unless user_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.
+      authenticated_at = if hash.key?('authenticated_at')
+                           (DateTimeHelper.from_rfc3339(hash['authenticated_at']) if hash['authenticated_at'])
+                         else
+                           SKIP
+                         end
+      authorized_party =
+        hash.key?('authorized_party') ? hash['authorized_party'] : SKIP
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+      idp_user_id = hash.key?('idp_user_id') ? hash['idp_user_id'] : SKIP
+      session_id = hash.key?('session_id') ? hash['session_id'] : SKIP
+      token_id = hash.key?('token_id') ? hash['token_id'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+
+      # Create object from extracted values.
+      Actor.new(authenticated_at,
+                authorized_party,
+                display_name,
+                idp_user_id,
+                session_id,
+                token_id,
+                user_id)
+    end
+
+    def to_custom_authenticated_at
+      DateTimeHelper.to_rfc3339(authenticated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authenticated_at: #{@authenticated_at}, authorized_party:"\
+      " #{@authorized_party}, display_name: #{@display_name}, idp_user_id: #{@idp_user_id},"\
+      " session_id: #{@session_id}, token_id: #{@token_id}, user_id: #{@user_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authenticated_at: #{@authenticated_at.inspect}, authorized_party:"\
+      " #{@authorized_party.inspect}, display_name: #{@display_name.inspect}, idp_user_id:"\
+      " #{@idp_user_id.inspect}, session_id: #{@session_id.inspect}, token_id:"\
+      " #{@token_id.inspect}, user_id: #{@user_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/adapter_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Adapter.
+  class AdapterEnum
+    ADAPTER_ENUM = [
+      # TODO: Write general description for CUSTOMADAPTER
+      CUSTOMADAPTER = 'custom-adapter'.freeze,
+
+      # TODO: Write general description for EASYPOSTADAPTER
+      EASYPOSTADAPTER = 'easypost-adapter'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADAPTER_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CUSTOMADAPTER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'customadapter' then CUSTOMADAPTER
+      when 'easypostadapter' then EASYPOSTADAPTER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/adapter_http_timeout.rb

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

data/lib/new_store_api/models/add_item_item_price.rb

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