talon_one 2.4.0 → 3.0.0

data/lib/talon_one/models/collection_without_payload.rb

@@ -0,0 +1,370 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class CollectionWithoutPayload
+    # Internal ID of this entity.
+    attr_accessor :id
+
+    # The time this entity was created.
+    attr_accessor :created
+
+    # The ID of the account that owns this entity.
+    attr_accessor :account_id
+
+    # The time this entity was last modified.
+    attr_accessor :modified
+
+    # A short description of the purpose of this collection.
+    attr_accessor :description
+
+    # A list of the IDs of the Applications where this collection is enabled.
+    attr_accessor :subscribed_applications_ids
+
+    # The name of this collection.
+    attr_accessor :name
+
+    # ID of the user who last updated this effect if available.
+    attr_accessor :modified_by
+
+    # ID of the user who created this effect.
+    attr_accessor :created_by
+
+    # The ID of the Application that owns this entity.
+    attr_accessor :application_id
+
+    # The ID of the campaign that owns this entity.
+    attr_accessor :campaign_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'account_id' => :'accountId',
+        :'modified' => :'modified',
+        :'description' => :'description',
+        :'subscribed_applications_ids' => :'subscribedApplicationsIds',
+        :'name' => :'name',
+        :'modified_by' => :'modifiedBy',
+        :'created_by' => :'createdBy',
+        :'application_id' => :'applicationId',
+        :'campaign_id' => :'campaignId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'account_id' => :'Integer',
+        :'modified' => :'DateTime',
+        :'description' => :'String',
+        :'subscribed_applications_ids' => :'Array<Integer>',
+        :'name' => :'String',
+        :'modified_by' => :'Integer',
+        :'created_by' => :'Integer',
+        :'application_id' => :'Integer',
+        :'campaign_id' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CollectionWithoutPayload` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CollectionWithoutPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'modified')
+        self.modified = attributes[:'modified']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'subscribed_applications_ids')
+        if (value = attributes[:'subscribed_applications_ids']).is_a?(Array)
+          self.subscribed_applications_ids = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'modified_by')
+        self.modified_by = attributes[:'modified_by']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @modified.nil?
+        invalid_properties.push('invalid value for "modified", modified cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[^[:cntrl:]\s][^[:cntrl:]]*$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @created_by.nil?
+        invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @created.nil?
+      return false if @account_id.nil?
+      return false if @modified.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @name !~ Regexp.new(/^[^[:cntrl:]\s][^[:cntrl:]]*$/)
+      return false if @created_by.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[^[:cntrl:]\s][^[:cntrl:]]*$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          created == o.created &&
+          account_id == o.account_id &&
+          modified == o.modified &&
+          description == o.description &&
+          subscribed_applications_ids == o.subscribed_applications_ids &&
+          name == o.name &&
+          modified_by == o.modified_by &&
+          created_by == o.created_by &&
+          application_id == o.application_id &&
+          campaign_id == o.campaign_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, created, account_id, modified, description, subscribed_applications_ids, name, modified_by, created_by, application_id, campaign_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        TalonOne.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/talon_one/models/coupon.rb

@@ -1,9 +1,9 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -15,31 +15,37 @@ require 'date'
 module TalonOne
   # 
   class Coupon
-    # Unique ID for this entity.
+    # Internal ID of this entity.
     attr_accessor :id
 
-    # The exact moment this entity was created.
+    # The time this entity was created.
     attr_accessor :created
 
     # The ID of the campaign that owns this entity.
     attr_accessor :campaign_id
 
-    # The actual coupon code.
+    # The coupon code.
     attr_accessor :value
 
-    # The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. 
+    # The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. 
     attr_accessor :usage_limit
 
-    # The amount of discounts that can be given with this coupon code. 
+    # The total discount value that the code can give. Typically used to represent a gift card value. 
     attr_accessor :discount_limit
 
+    # The number of reservations that can be made with this coupon code. 
+    attr_accessor :reservation_limit
+
     # Timestamp at which point the coupon becomes valid.
     attr_accessor :start_date
 
-    # Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
     attr_accessor :expiry_date
 
-    # The number of times this coupon has been successfully used.
+    # Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. 
+    attr_accessor :limits
+
+    # The number of times the coupon has been successfully redeemed.
     attr_accessor :usage_counter
 
     # The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon.
@@ -48,7 +54,10 @@ module TalonOne
     # The remaining discount this coupon can give.
     attr_accessor :discount_remainder
 
-    # Arbitrary properties associated with this item
+    # The number of times this coupon has been reserved.
+    attr_accessor :reservation_counter
+
+    # Custom attributes associated with this coupon.
     attr_accessor :attributes
 
     # The integration ID of the referring customer (if any) for whom this coupon was created as an effect.
@@ -60,12 +69,15 @@ module TalonOne
     # The ID of the Import which created this coupon.
     attr_accessor :import_id
 
-    # This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified.
+    # Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. 
     attr_accessor :reservation
 
     # The id of the batch the coupon belongs to.
     attr_accessor :batch_id
 
+    # Whether the reservation effect actually created a new reservation.
+    attr_accessor :is_reservation_mandatory
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -75,17 +87,21 @@ module TalonOne
         :'value' => :'value',
         :'usage_limit' => :'usageLimit',
         :'discount_limit' => :'discountLimit',
+        :'reservation_limit' => :'reservationLimit',
         :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
+        :'limits' => :'limits',
         :'usage_counter' => :'usageCounter',
         :'discount_counter' => :'discountCounter',
         :'discount_remainder' => :'discountRemainder',
+        :'reservation_counter' => :'reservationCounter',
         :'attributes' => :'attributes',
         :'referral_id' => :'referralId',
         :'recipient_integration_id' => :'recipientIntegrationId',
         :'import_id' => :'importId',
         :'reservation' => :'reservation',
-        :'batch_id' => :'batchId'
+        :'batch_id' => :'batchId',
+        :'is_reservation_mandatory' => :'isReservationMandatory'
       }
     end
 
@@ -98,17 +114,21 @@ module TalonOne
         :'value' => :'String',
         :'usage_limit' => :'Integer',
         :'discount_limit' => :'Float',
+        :'reservation_limit' => :'Integer',
         :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
+        :'limits' => :'Array<LimitConfig>',
         :'usage_counter' => :'Integer',
         :'discount_counter' => :'Float',
         :'discount_remainder' => :'Float',
+        :'reservation_counter' => :'Float',
         :'attributes' => :'Object',
         :'referral_id' => :'Integer',
         :'recipient_integration_id' => :'String',
         :'import_id' => :'Integer',
         :'reservation' => :'Boolean',
-        :'batch_id' => :'String'
+        :'batch_id' => :'String',
+        :'is_reservation_mandatory' => :'Boolean'
       }
     end
 
@@ -157,6 +177,10 @@ module TalonOne
         self.discount_limit = attributes[:'discount_limit']
       end
 
+      if attributes.key?(:'reservation_limit')
+        self.reservation_limit = attributes[:'reservation_limit']
+      end
+
       if attributes.key?(:'start_date')
         self.start_date = attributes[:'start_date']
       end
@@ -165,6 +189,12 @@ module TalonOne
         self.expiry_date = attributes[:'expiry_date']
       end
 
+      if attributes.key?(:'limits')
+        if (value = attributes[:'limits']).is_a?(Array)
+          self.limits = value
+        end
+      end
+
       if attributes.key?(:'usage_counter')
         self.usage_counter = attributes[:'usage_counter']
       end
@@ -177,6 +207,10 @@ module TalonOne
         self.discount_remainder = attributes[:'discount_remainder']
       end
 
+      if attributes.key?(:'reservation_counter')
+        self.reservation_counter = attributes[:'reservation_counter']
+      end
+
       if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
@@ -195,11 +229,19 @@ module TalonOne
 
       if attributes.key?(:'reservation')
         self.reservation = attributes[:'reservation']
+      else
+        self.reservation = true
       end
 
       if attributes.key?(:'batch_id')
         self.batch_id = attributes[:'batch_id']
       end
+
+      if attributes.key?(:'is_reservation_mandatory')
+        self.is_reservation_mandatory = attributes[:'is_reservation_mandatory']
+      else
+        self.is_reservation_mandatory = true
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -246,10 +288,22 @@ module TalonOne
         invalid_properties.push('invalid value for "discount_limit", must be greater than or equal to 0.')
       end
 
+      if !@reservation_limit.nil? && @reservation_limit > 999999
+        invalid_properties.push('invalid value for "reservation_limit", must be smaller than or equal to 999999.')
+      end
+
+      if !@reservation_limit.nil? && @reservation_limit < 0
+        invalid_properties.push('invalid value for "reservation_limit", must be greater than or equal to 0.')
+      end
+
       if @usage_counter.nil?
         invalid_properties.push('invalid value for "usage_counter", usage_counter cannot be nil.')
       end
 
+      if !@recipient_integration_id.nil? && @recipient_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       invalid_properties
     end
 
@@ -266,7 +320,10 @@ module TalonOne
       return false if @usage_limit < 0
       return false if !@discount_limit.nil? && @discount_limit > 999999
       return false if !@discount_limit.nil? && @discount_limit < 0
+      return false if !@reservation_limit.nil? && @reservation_limit > 999999
+      return false if !@reservation_limit.nil? && @reservation_limit < 0
       return false if @usage_counter.nil?
+      return false if !@recipient_integration_id.nil? && @recipient_integration_id.to_s.length > 1000
       true
     end
 
@@ -316,6 +373,30 @@ module TalonOne
       @discount_limit = discount_limit
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] reservation_limit Value to be assigned
+    def reservation_limit=(reservation_limit)
+      if !reservation_limit.nil? && reservation_limit > 999999
+        fail ArgumentError, 'invalid value for "reservation_limit", must be smaller than or equal to 999999.'
+      end
+
+      if !reservation_limit.nil? && reservation_limit < 0
+        fail ArgumentError, 'invalid value for "reservation_limit", must be greater than or equal to 0.'
+      end
+
+      @reservation_limit = reservation_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_integration_id Value to be assigned
+    def recipient_integration_id=(recipient_integration_id)
+      if !recipient_integration_id.nil? && recipient_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @recipient_integration_id = recipient_integration_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -327,17 +408,21 @@ module TalonOne
           value == o.value &&
           usage_limit == o.usage_limit &&
           discount_limit == o.discount_limit &&
+          reservation_limit == o.reservation_limit &&
           start_date == o.start_date &&
           expiry_date == o.expiry_date &&
+          limits == o.limits &&
           usage_counter == o.usage_counter &&
           discount_counter == o.discount_counter &&
           discount_remainder == o.discount_remainder &&
+          reservation_counter == o.reservation_counter &&
           attributes == o.attributes &&
           referral_id == o.referral_id &&
           recipient_integration_id == o.recipient_integration_id &&
           import_id == o.import_id &&
           reservation == o.reservation &&
-          batch_id == o.batch_id
+          batch_id == o.batch_id &&
+          is_reservation_mandatory == o.is_reservation_mandatory
     end
 
     # @see the `==` method
@@ -349,7 +434,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, campaign_id, value, usage_limit, discount_limit, start_date, expiry_date, usage_counter, discount_counter, discount_remainder, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id].hash
+      [id, created, campaign_id, value, usage_limit, discount_limit, reservation_limit, start_date, expiry_date, limits, usage_counter, discount_counter, discount_remainder, reservation_counter, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id, is_reservation_mandatory].hash
     end
 
     # Builds the object from hash