talon_one 2.4.0 → 2.5.1

data/lib/talon_one/models/application.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 
@@ -36,38 +36,44 @@ module TalonOne
     # A string containing an IANA timezone descriptor.
     attr_accessor :timezone
 
-    # A string describing a default currency for new customer sessions.
+    # The default currency for new customer sessions.
     attr_accessor :currency
 
-    # A string indicating how should campaigns in this application deal with case sensitivity on coupon codes.
+    # The case sensitivity behavior to check coupon codes in the campaigns of this Application.
     attr_accessor :case_sensitivity
 
-    # Arbitrary properties associated with this campaign
+    # Arbitrary properties associated with this campaign.
     attr_accessor :attributes
 
-    # Default limits for campaigns created in this application
+    # Default limits for campaigns created in this application.
     attr_accessor :limits
 
-    # Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\"
+    # Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. 
     attr_accessor :campaign_priority
 
-    # The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\"
+    # The strategy used when choosing exclusive campaigns for evaluation.
     attr_accessor :exclusive_campaigns_strategy
 
-    # The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect.
+    # The default scope to apply `setDiscount` effects on if no scope was provided with the effect. 
     attr_accessor :default_discount_scope
 
-    # Flag indicating if discounts should cascade for this application
+    # Indicates if discounts should cascade for this Application.
     attr_accessor :enable_cascading_discounts
 
-    # Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one
+    # Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). 
     attr_accessor :enable_flattened_cart_items
 
     attr_accessor :attributes_settings
 
-    # Flag indicating if this is a live or sandbox application
+    # Indicates if this is a live or sandbox Application.
     attr_accessor :sandbox
 
+    # Indicates if this Application supports partial discounts.
+    attr_accessor :enable_partial_discounts
+
+    # The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. 
+    attr_accessor :default_discount_additional_cost_per_item_scope
+
     # An array containing all the loyalty programs to which this application is subscribed
     attr_accessor :loyalty_programs
 
@@ -114,6 +120,8 @@ module TalonOne
         :'enable_flattened_cart_items' => :'enableFlattenedCartItems',
         :'attributes_settings' => :'attributesSettings',
         :'sandbox' => :'sandbox',
+        :'enable_partial_discounts' => :'enablePartialDiscounts',
+        :'default_discount_additional_cost_per_item_scope' => :'defaultDiscountAdditionalCostPerItemScope',
         :'loyalty_programs' => :'loyaltyPrograms'
       }
     end
@@ -139,6 +147,8 @@ module TalonOne
         :'enable_flattened_cart_items' => :'Boolean',
         :'attributes_settings' => :'AttributesSettings',
         :'sandbox' => :'Boolean',
+        :'enable_partial_discounts' => :'Boolean',
+        :'default_discount_additional_cost_per_item_scope' => :'String',
         :'loyalty_programs' => :'Array<LoyaltyProgram>'
       }
     end
@@ -212,10 +222,14 @@ module TalonOne
 
       if attributes.key?(:'campaign_priority')
         self.campaign_priority = attributes[:'campaign_priority']
+      else
+        self.campaign_priority = 'universal'
       end
 
       if attributes.key?(:'exclusive_campaigns_strategy')
         self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy']
+      else
+        self.exclusive_campaigns_strategy = 'listOrder'
       end
 
       if attributes.key?(:'default_discount_scope')
@@ -238,6 +252,14 @@ module TalonOne
         self.sandbox = attributes[:'sandbox']
       end
 
+      if attributes.key?(:'enable_partial_discounts')
+        self.enable_partial_discounts = attributes[:'enable_partial_discounts']
+      end
+
+      if attributes.key?(:'default_discount_additional_cost_per_item_scope')
+        self.default_discount_additional_cost_per_item_scope = attributes[:'default_discount_additional_cost_per_item_scope']
+      end
+
       if attributes.key?(:'loyalty_programs')
         if (value = attributes[:'loyalty_programs']).is_a?(Array)
           self.loyalty_programs = value
@@ -317,6 +339,8 @@ module TalonOne
       return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy)
       default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
       return false unless default_discount_scope_validator.valid?(@default_discount_scope)
+      default_discount_additional_cost_per_item_scope_validator = EnumAttributeValidator.new('String', ["price", "itemTotal", "additionalCosts"])
+      return false unless default_discount_additional_cost_per_item_scope_validator.valid?(@default_discount_additional_cost_per_item_scope)
       return false if @loyalty_programs.nil?
       true
     end
@@ -403,6 +427,16 @@ module TalonOne
       @default_discount_scope = default_discount_scope
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] default_discount_additional_cost_per_item_scope Object to be assigned
+    def default_discount_additional_cost_per_item_scope=(default_discount_additional_cost_per_item_scope)
+      validator = EnumAttributeValidator.new('String', ["price", "itemTotal", "additionalCosts"])
+      unless validator.valid?(default_discount_additional_cost_per_item_scope)
+        fail ArgumentError, "invalid value for \"default_discount_additional_cost_per_item_scope\", must be one of #{validator.allowable_values}."
+      end
+      @default_discount_additional_cost_per_item_scope = default_discount_additional_cost_per_item_scope
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -426,6 +460,8 @@ module TalonOne
           enable_flattened_cart_items == o.enable_flattened_cart_items &&
           attributes_settings == o.attributes_settings &&
           sandbox == o.sandbox &&
+          enable_partial_discounts == o.enable_partial_discounts &&
+          default_discount_additional_cost_per_item_scope == o.default_discount_additional_cost_per_item_scope &&
           loyalty_programs == o.loyalty_programs
     end
 
@@ -438,7 +474,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, modified, account_id, name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, loyalty_programs].hash
+      [id, created, modified, account_id, name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, loyalty_programs].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application_api_health.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 

data/lib/talon_one/models/application_api_key.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 
@@ -21,7 +21,7 @@ module TalonOne
     # The date the API key expired
     attr_accessor :expires
 
-    # Platform the API key is valid for.
+    # The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. 
     attr_accessor :platform
 
     # ID of the API Key
@@ -183,7 +183,7 @@ module TalonOne
     def valid?
       return false if @title.nil?
       return false if @expires.nil?
-      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent"])
+      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data"])
       return false unless platform_validator.valid?(@platform)
       return false if @id.nil?
       return false if @created_by.nil?
@@ -196,7 +196,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] platform Object to be assigned
     def platform=(platform)
-      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent"])
+      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data"])
       unless validator.valid?(platform)
         fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/application_campaign_stats.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 

data/lib/talon_one/models/application_customer.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 
@@ -15,10 +15,10 @@ require 'date'
 module TalonOne
   # 
   class ApplicationCustomer
-    # Unique ID for this entity.
+    # Unique ID for this entity. Unique ID for this entity.
     attr_accessor :id
 
-    # The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created.
+    # The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created.
     attr_accessor :created
 
     # The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system.
@@ -36,15 +36,18 @@ module TalonOne
     # Sum of all purchases made by this customer
     attr_accessor :total_sales
 
-    # A list of loyalty programs joined by the customer
+    # **DEPRECATED** A list of loyalty programs joined by the customer. 
     attr_accessor :loyalty_memberships
 
     # A list of audiences the customer belongs to
     attr_accessor :audience_memberships
 
-    # Timestamp of the most recent event received from this customer
+    # Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. 
     attr_accessor :last_activity
 
+    # The Integration ID of the Customer Profile that referred this Customer in the Application.
+    attr_accessor :advocate_integration_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -57,7 +60,8 @@ module TalonOne
         :'total_sales' => :'totalSales',
         :'loyalty_memberships' => :'loyaltyMemberships',
         :'audience_memberships' => :'audienceMemberships',
-        :'last_activity' => :'lastActivity'
+        :'last_activity' => :'lastActivity',
+        :'advocate_integration_id' => :'advocateIntegrationId'
       }
     end
 
@@ -73,7 +77,8 @@ module TalonOne
         :'total_sales' => :'Float',
         :'loyalty_memberships' => :'Array<LoyaltyMembership>',
         :'audience_memberships' => :'Array<AudienceMembership>',
-        :'last_activity' => :'DateTime'
+        :'last_activity' => :'DateTime',
+        :'advocate_integration_id' => :'String'
       }
     end
 
@@ -141,6 +146,10 @@ module TalonOne
       if attributes.key?(:'last_activity')
         self.last_activity = attributes[:'last_activity']
       end
+
+      if attributes.key?(:'advocate_integration_id')
+        self.advocate_integration_id = attributes[:'advocate_integration_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -159,6 +168,10 @@ module TalonOne
         invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
       end
 
+      if @integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if @attributes.nil?
         invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
@@ -179,6 +192,10 @@ module TalonOne
         invalid_properties.push('invalid value for "last_activity", last_activity cannot be nil.')
       end
 
+      if !@advocate_integration_id.nil? && @advocate_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "advocate_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       invalid_properties
     end
 
@@ -188,14 +205,40 @@ module TalonOne
       return false if @id.nil?
       return false if @created.nil?
       return false if @integration_id.nil?
+      return false if @integration_id.to_s.length > 1000
       return false if @attributes.nil?
       return false if @account_id.nil?
       return false if @closed_sessions.nil?
       return false if @total_sales.nil?
       return false if @last_activity.nil?
+      return false if !@advocate_integration_id.nil? && @advocate_integration_id.to_s.length > 1000
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] integration_id Value to be assigned
+    def integration_id=(integration_id)
+      if integration_id.nil?
+        fail ArgumentError, 'integration_id cannot be nil'
+      end
+
+      if integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @integration_id = integration_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] advocate_integration_id Value to be assigned
+    def advocate_integration_id=(advocate_integration_id)
+      if !advocate_integration_id.nil? && advocate_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "advocate_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @advocate_integration_id = advocate_integration_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -210,7 +253,8 @@ module TalonOne
           total_sales == o.total_sales &&
           loyalty_memberships == o.loyalty_memberships &&
           audience_memberships == o.audience_memberships &&
-          last_activity == o.last_activity
+          last_activity == o.last_activity &&
+          advocate_integration_id == o.advocate_integration_id
     end
 
     # @see the `==` method
@@ -222,7 +266,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, integration_id, attributes, account_id, closed_sessions, total_sales, loyalty_memberships, audience_memberships, last_activity].hash
+      [id, created, integration_id, attributes, account_id, closed_sessions, total_sales, loyalty_memberships, audience_memberships, last_activity, advocate_integration_id].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application_customer_entity.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 

data/lib/talon_one/models/application_entity.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 

data/lib/talon_one/models/application_event.rb

@@ -1,7 +1,7 @@
 =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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 

data/lib/talon_one/models/application_notification.rb

@@ -0,0 +1,212 @@
+=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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class ApplicationNotification
+    # Event type. It can be one of the following: ['campaign_priorities_changed'] 
+    attr_accessor :event
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event' => :'event'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event' => :'String'
+      }
+    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::ApplicationNotification` 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::ApplicationNotification`. 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?(:'event')
+        self.event = attributes[:'event']
+      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 @event.nil?
+        invalid_properties.push('invalid value for "event", event 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 @event.nil?
+      true
+    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 &&
+          event == o.event
+    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
+      [event].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