talon_one 1.4.0

data/lib/talon_one/models/webhook_log_entry.rb

@@ -0,0 +1,305 @@
+=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 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module TalonOne
+  # Log of webhook api calls
+  class WebhookLogEntry
+    # UUID reference of the webhook request
+    attr_accessor :id
+
+    # UUID reference of the integration request linked to this webhook request
+    attr_accessor :integration_request_uuid
+
+    # ID of the webhook that triggered the request
+    attr_accessor :webhook_id
+
+    # ID of the application that triggered the webhook
+    attr_accessor :application_id
+
+    # Target url of request
+    attr_accessor :url
+
+    # Request message
+    attr_accessor :request
+
+    # Response message
+    attr_accessor :response
+
+    # HTTP status code of response
+    attr_accessor :status
+
+    # Timestamp of request
+    attr_accessor :request_time
+
+    # Timestamp of response
+    attr_accessor :response_time
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'integration_request_uuid' => :'integrationRequestUuid',
+        :'webhook_id' => :'webhookId',
+        :'application_id' => :'applicationId',
+        :'url' => :'url',
+        :'request' => :'request',
+        :'response' => :'response',
+        :'status' => :'status',
+        :'request_time' => :'requestTime',
+        :'response_time' => :'responseTime'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'integration_request_uuid' => :'String',
+        :'webhook_id' => :'Integer',
+        :'application_id' => :'Integer',
+        :'url' => :'String',
+        :'request' => :'String',
+        :'response' => :'String',
+        :'status' => :'Integer',
+        :'request_time' => :'DateTime',
+        :'response_time' => :'DateTime'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'integrationRequestUuid')
+        self.integration_request_uuid = attributes[:'integrationRequestUuid']
+      end
+
+      if attributes.has_key?(:'webhookId')
+        self.webhook_id = attributes[:'webhookId']
+      end
+
+      if attributes.has_key?(:'applicationId')
+        self.application_id = attributes[:'applicationId']
+      end
+
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.has_key?(:'request')
+        self.request = attributes[:'request']
+      end
+
+      if attributes.has_key?(:'response')
+        self.response = attributes[:'response']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'requestTime')
+        self.request_time = attributes[:'requestTime']
+      end
+
+      if attributes.has_key?(:'responseTime')
+        self.response_time = attributes[:'responseTime']
+      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 @integration_request_uuid.nil?
+        invalid_properties.push('invalid value for "integration_request_uuid", integration_request_uuid cannot be nil.')
+      end
+
+      if @webhook_id.nil?
+        invalid_properties.push('invalid value for "webhook_id", webhook_id cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @request.nil?
+        invalid_properties.push('invalid value for "request", request cannot be nil.')
+      end
+
+      if @request_time.nil?
+        invalid_properties.push('invalid value for "request_time", request_time 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 @integration_request_uuid.nil?
+      return false if @webhook_id.nil?
+      return false if @url.nil?
+      return false if @request.nil?
+      return false if @request_time.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 &&
+          id == o.id &&
+          integration_request_uuid == o.integration_request_uuid &&
+          webhook_id == o.webhook_id &&
+          application_id == o.application_id &&
+          url == o.url &&
+          request == o.request &&
+          response == o.response &&
+          status == o.status &&
+          request_time == o.request_time &&
+          response_time == o.response_time
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, integration_request_uuid, webhook_id, application_id, url, request, response, status, request_time, response_time].hash
+    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.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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
+        temp_model = TalonOne.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/version.rb

@@ -0,0 +1,15 @@
+=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 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+module TalonOne
+  VERSION = '1.4.0'
+end

data/spec/api/integration_api_spec.rb

@@ -0,0 +1,161 @@
+=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 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TalonOne::IntegrationApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IntegrationApi' do
+  before do
+    # run before each test
+    @instance = TalonOne::IntegrationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IntegrationApi' do
+    it 'should create an instance of IntegrationApi' do
+      expect(@instance).to be_instance_of(TalonOne::IntegrationApi)
+    end
+  end
+
+  # unit tests for create_coupon_reservation
+  # Create a new coupon reservation
+  # Creates a coupon reservation for all passed customer profiles on this couponID 
+  # @param coupon_value The value of a coupon
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [Coupon]
+  describe 'create_coupon_reservation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_referral
+  # Create a referral code for an advocate
+  # Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [Referral]
+  describe 'create_referral test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_coupon_reservation
+  # Delete coupon reservations
+  # Removes all passed customer profiles reservation from this coupon 
+  # @param coupon_value The value of a coupon
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_coupon_reservation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_customer_data
+  # Delete the personal data of a customer.
+  # Delete all attributes on the customer profile and on entities that reference that customer profile. 
+  # @param integration_id The custom identifier for this profile, must be unique within the account.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_customer_data test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_customer_inventory
+  # Get an inventory of all data associated with a specific customer profile.
+  # Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and referral codes. In the future, this will be expanded with coupon codes and loyalty points.
+  # @param integration_id The custom identifier for this profile, must be unique within the account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Object] :profile optional flag to decide if you would like customer profile information in the response
+  # @option opts [Object] :referrals optional flag to decide if you would like referral information in the response
+  # @return [CustomerInventory]
+  describe 'get_customer_inventory test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_reserved_coupons
+  # Get all valid reserved coupons
+  # Returns all coupons this user is subscribed to that are valid and usable 
+  # @param integration_id The custom identifier for this profile, must be unique within the account.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2001]
+  describe 'get_reserved_coupons test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_reserved_customers
+  # Get the users that have this coupon reserved
+  # Returns all users that have this coupon marked as reserved 
+  # @param coupon_value The value of a coupon
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse200]
+  describe 'get_reserved_customers test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for track_event
+  # Track an Event
+  # Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information.  The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned.  As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [IntegrationState]
+  describe 'track_event test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_customer_profile
+  # Update a Customer Profile
+  # Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][].  The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons 
+  # @param integration_id The custom identifier for this profile, must be unique within the account.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [IntegrationState]
+  describe 'update_customer_profile test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_customer_session
+  # Update a Customer Session
+  # Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session.  The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's.  The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.  [Customer Session]: /Getting-Started/entities#customer-session 
+  # @param customer_session_id The custom identifier for this session, must be unique within the account.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [IntegrationState]
+  describe 'update_customer_session test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end