loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/models/method_not_allowed_error.rb

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

data/lib/loyalty_ap_is/models/not_found_error.rb

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

data/lib/loyalty_ap_is/models/not_found_error_response.rb

@@ -0,0 +1,90 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # NotFoundErrorResponse Model.
+  class NotFoundErrorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP error code 404
+    # @return [Float]
+    attr_accessor :error_code
+
+    # HTTP error message - Not Found
+    # @return [String]
+    attr_accessor :message
+
+    # HTTP error message - Not Found
+    # @return [ErrorInfo]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'errorCode'
+      @_hash['message'] = 'message'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code:, message:, error:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_code = error_code
+      @message = message
+      @error = error
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+      error = ErrorInfo.from_hash(hash['error']) if hash['error']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      NotFoundErrorResponse.new(error_code: error_code,
+                                message: message,
+                                error: error,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, message: #{@message}, error: #{@error},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, message: #{@message.inspect}, error:"\
+      " #{@error.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/oauth_provider_error.rb

@@ -0,0 +1,62 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # OAuth 2 Authorization error codes
+  class OauthProviderError
+    OAUTH_PROVIDER_ERROR = [
+      # 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?
+
+      OAUTH_PROVIDER_ERROR.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/loyalty_ap_is/models/oauth_token.rb

@@ -0,0 +1,96 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # 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:, token_type:, 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: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token)
+    end
+  end
+end

data/lib/loyalty_ap_is/models/offer.rb

@@ -0,0 +1,155 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module LoyaltyApIs
+  # Offer Model.
+  class Offer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offer ID provided upon offer configuration
+    # @return [Integer]
+    attr_accessor :offer_id
+
+    # Unique Reference ID for the transaction from the partner. Used to identify
+    # duplicate requests.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # Title of the partner's offer, given upon configuration
+    # @return [String]
+    attr_accessor :title
+
+    # Description of the partner's offer, set up upon offer configuration
+    # @return [String]
+    attr_accessor :description
+
+    # Offer validity start date in JSON recommended format:
+    # "yyyy-MM-ddTHH:mm:ssZ".
+    # The date format must follow ISO_8601. If 'Z' is written immediately after
+    # the time, it is considered UTC.                       
+    # Time offset from UTC can be appended instead of 'Z' using plus or minus
+    # signs. Negative UTC offsets describe a time zone west of UTC�00:00, where
+    # the civil time is behind (or earlier) than UTC. Positive UTC offsets
+    # describe a time zone east of UTC�00:00, where the civil time is ahead (or
+    # later) than UTC
+    # @return [DateTime]
+    attr_accessor :valid_from
+
+    # Offer validity end date in JSON recommended format:
+    # "yyyy-MM-ddTHH:mm:ssZ".
+    # The date format must follow ISO_8601. If 'Z' is written immediately after
+    # the time, it is considered UTC.                       
+    # Time offset from UTC can be appended instead of 'Z' using plus or minus
+    # signs. Negative UTC offsets describe a time zone west of UTC�00:00, where
+    # the civil time is behind (or earlier) than UTC. Positive UTC offsets
+    # describe a time zone east of UTC�00:00, where the civil time is ahead (or
+    # later) than UTC     
+    # Nullable field value, in case of the offer has infinite valid to.
+    # @return [DateTime]
+    attr_accessor :valid_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['offer_id'] = 'offerId'
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['title'] = 'title'
+      @_hash['description'] = 'description'
+      @_hash['valid_from'] = 'validFrom'
+      @_hash['valid_to'] = 'validTo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        valid_to
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        valid_to
+      ]
+    end
+
+    def initialize(offer_id:, reference_id:, title:, description:, valid_from:,
+                   valid_to: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @offer_id = offer_id
+      @reference_id = reference_id
+      @title = title
+      @description = description
+      @valid_from = valid_from
+      @valid_to = valid_to unless valid_to == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      offer_id = hash.key?('offerId') ? hash['offerId'] : nil
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      valid_from = if hash.key?('validFrom')
+                     (DateTimeHelper.from_rfc3339(hash['validFrom']) if hash['validFrom'])
+                   end
+      valid_to = if hash.key?('validTo')
+                   (DateTimeHelper.from_rfc3339(hash['validTo']) if hash['validTo'])
+                 else
+                   SKIP
+                 end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Offer.new(offer_id: offer_id,
+                reference_id: reference_id,
+                title: title,
+                description: description,
+                valid_from: valid_from,
+                valid_to: valid_to,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_valid_from
+      DateTimeHelper.to_rfc3339(valid_from)
+    end
+
+    def to_custom_valid_to
+      DateTimeHelper.to_rfc3339(valid_to)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} offer_id: #{@offer_id}, reference_id: #{@reference_id}, title: #{@title},"\
+      " description: #{@description}, valid_from: #{@valid_from}, valid_to: #{@valid_to},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} offer_id: #{@offer_id.inspect}, reference_id: #{@reference_id.inspect},"\
+      " title: #{@title.inspect}, description: #{@description.inspect}, valid_from:"\
+      " #{@valid_from.inspect}, valid_to: #{@valid_to.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/offer_assignment.rb

@@ -0,0 +1,172 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module LoyaltyApIs
+  # OfferAssignment Model.
+  class OfferAssignment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Reference ID for the transaction from the partner. Used to identify
+    # duplicate requests.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # SSO uuid of the user signed in with Shell credentials
+    # Format: 32 hexadecimal digits grouped the following way:
+    # xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+    # @return [UUID | String]
+    attr_accessor :consumer_uuid
+
+    # Offer identifier shared by Shell. 
+    # Format: string(30)
+    # @return [String]
+    attr_accessor :offer_id
+
+    # Offer validity start date in JSON recommended format:
+    # "yyyy-MM-ddTHH:mm:ssZ".
+    # The date format must follow ISO_8601. If 'Z' is written immediately after
+    # the time, it is considered UTC.                       
+    # Time offset from UTC can be appended instead of 'Z' using plus or minus
+    # signs. Negative UTC offsets describe a time zone west of UTC�00:00, where
+    # the civil time is behind (or earlier) than UTC. Positive UTC offsets
+    # describe a time zone east of UTC�00:00, where the civil time is ahead (or
+    # later) than UTC
+    # @return [DateTime]
+    attr_accessor :valid_from
+
+    # Offer validity period (Number of days)
+    # If validityPeriod is greater than zero, validTo will be ignored. 
+    # The offer will be valid till:
+    #   validfrom + validityperiod
+    #  If the resulting valid to date would be during the day, then its validity
+    # is modified to last until midnight in the timezone of the validFrom date.
+    #  E.g. If valiFrom is "2021-03-08T17:12:55Z+01:00" (Central European time)
+    # and validtyPeriod is 3 then the offer will be valid till
+    # "2021-03-11T23:59:59Z+01:00" (Central European Time)
+    # @return [Float]
+    attr_accessor :validity_period
+
+    # Offer validity end date in JSON recommended format:
+    # "yyyy-MM-ddTHH:mm:ssZ".
+    # Field value is ignored if validityPeriod is bigger than zero. 
+    # The date format must follow ISO_8601. If 'Z' is written immediately after
+    # the time, it is considered UTC.                       
+    # Time offset from UTC can be appended instead of 'Z' using plus or minus
+    # signs. Negative UTC offsets describe a time zone west of UTC�00:00, where
+    # the civil time is behind (or earlier) than UTC. Positive UTC offsets
+    # describe a time zone east of UTC�00:00, where the civil time is ahead (or
+    # later) than UTC
+    # @return [DateTime]
+    attr_accessor :valid_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['consumer_uuid'] = 'consumerUuid'
+      @_hash['offer_id'] = 'offerId'
+      @_hash['valid_from'] = 'validFrom'
+      @_hash['validity_period'] = 'validityPeriod'
+      @_hash['valid_to'] = 'validTo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        valid_from
+        validity_period
+        valid_to
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        valid_to
+      ]
+    end
+
+    def initialize(reference_id:, consumer_uuid:, offer_id:, valid_from: SKIP,
+                   validity_period: SKIP, valid_to: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reference_id = reference_id
+      @consumer_uuid = consumer_uuid
+      @offer_id = offer_id
+      @valid_from = valid_from unless valid_from == SKIP
+      @validity_period = validity_period unless validity_period == SKIP
+      @valid_to = valid_to unless valid_to == SKIP
+      @additional_properties = additional_properties
+    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_id = hash.key?('referenceId') ? hash['referenceId'] : nil
+      consumer_uuid = hash.key?('consumerUuid') ? hash['consumerUuid'] : nil
+      offer_id = hash.key?('offerId') ? hash['offerId'] : nil
+      valid_from = if hash.key?('validFrom')
+                     (DateTimeHelper.from_rfc3339(hash['validFrom']) if hash['validFrom'])
+                   else
+                     SKIP
+                   end
+      validity_period =
+        hash.key?('validityPeriod') ? hash['validityPeriod'] : SKIP
+      valid_to = if hash.key?('validTo')
+                   (DateTimeHelper.from_rfc3339(hash['validTo']) if hash['validTo'])
+                 else
+                   SKIP
+                 end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      OfferAssignment.new(reference_id: reference_id,
+                          consumer_uuid: consumer_uuid,
+                          offer_id: offer_id,
+                          valid_from: valid_from,
+                          validity_period: validity_period,
+                          valid_to: valid_to,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_valid_from
+      DateTimeHelper.to_rfc3339(valid_from)
+    end
+
+    def to_custom_valid_to
+      DateTimeHelper.to_rfc3339(valid_to)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_id: #{@reference_id}, consumer_uuid: #{@consumer_uuid}, offer_id:"\
+      " #{@offer_id}, valid_from: #{@valid_from}, validity_period: #{@validity_period}, valid_to:"\
+      " #{@valid_to}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_id: #{@reference_id.inspect}, consumer_uuid:"\
+      " #{@consumer_uuid.inspect}, offer_id: #{@offer_id.inspect}, valid_from:"\
+      " #{@valid_from.inspect}, validity_period: #{@validity_period.inspect}, valid_to:"\
+      " #{@valid_to.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end