talon_one 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3f39c6a8fc2964f76caaa933c5e03ab0e8f033cd
-  data.tar.gz: a37e870cf423a03aa685077b2334005028f8bfd8
+SHA256:
+  metadata.gz: f8554b314e19813b57b268b4c5383c8f2b70f9b04700671811671e7d8af7ec05
+  data.tar.gz: 392acdebb7b7495971340c0d6cafa920c81ee55b6dfc2f14f29c2de37651eec3
 SHA512:
-  metadata.gz: 4d069d80d1cbe17ae87373a9d430f832c61b630dd33d7609a4fe0f8e990290d65c75cb1ecaf978a8caef4f293bc6f6c263f2ca7d0d460dcfecb0241d4017f39d
-  data.tar.gz: c78ba793510c2ad7b4d414077a74a1f950f5c7ebb1053d50dfc40c5935e878a5c5b5862d5fc6ec58ce042588baa0fae694c217225dbe0045723cea0a9d461aa0
+  metadata.gz: f3ba323ffc282b52fc6f450b1264e4782d2c582606cdd9ed1e8debae39878e0e49dd2b7160469f7f10767962f2f184a9707abe66475f3d65dfb86af6498ecc0f
+  data.tar.gz: 16e72f1c0d8a616e9aa7429ebf6abbd570f00440af3511ce26d158c88b30173be8aebc4dbf218eb2c0ac4a299c250dd05668c13a509617df54b547d47cba1c0a

data/README.md

@@ -7,7 +7,7 @@ The Talon.One API is used to manage applications and campaigns, as well as to in
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
-- Package version: 1.2.0
+- Package version: 1.3.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build talon_one.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./talon_one-1.2.0.gem
+gem install ./talon_one-1.3.0.gem
 ```
-(for development, run `gem install --dev ./talon_one-1.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./talon_one-1.3.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'talon_one', '~> 1.2.0'
+    gem 'talon_one', '~> 1.3.0'
 
 ### Install from Git
 
@@ -359,6 +359,7 @@ Class | Method | HTTP request | Description
  - [TalonOne::NewReferral](docs/NewReferral.md)
  - [TalonOne::NewRole](docs/NewRole.md)
  - [TalonOne::NewRuleset](docs/NewRuleset.md)
+ - [TalonOne::NewSamlConnection](docs/NewSamlConnection.md)
  - [TalonOne::NewTemplateDef](docs/NewTemplateDef.md)
  - [TalonOne::NewUser](docs/NewUser.md)
  - [TalonOne::NewWebhook](docs/NewWebhook.md)
@@ -371,11 +372,13 @@ Class | Method | HTTP request | Description
  - [TalonOne::RoleMembership](docs/RoleMembership.md)
  - [TalonOne::Rule](docs/Rule.md)
  - [TalonOne::Ruleset](docs/Ruleset.md)
+ - [TalonOne::SamlConnection](docs/SamlConnection.md)
  - [TalonOne::Session](docs/Session.md)
  - [TalonOne::SlotDef](docs/SlotDef.md)
  - [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
  - [TalonOne::TemplateDef](docs/TemplateDef.md)
  - [TalonOne::UpdateAccount](docs/UpdateAccount.md)
+ - [TalonOne::UpdateApplication](docs/UpdateApplication.md)
  - [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
  - [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
  - [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)

data/docs/Application.md

@@ -9,12 +9,12 @@ Name | Type | Description | Notes
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **name** | **String** | The name of this application. | 
 **description** | **String** | A longer description of the application. | [optional] 
-**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
 **currency** | **String** | A string describing a default currency for new customer sessions. | 
 **case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] 
 **attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
 **loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
 
 

data/docs/Campaign.md

@@ -22,6 +22,8 @@ Name | Type | Description | Notes
 **coupon_redemption_count** | **Integer** | Number of coupons redeemed in the campaign. | [optional] 
 **referral_redemption_count** | **Integer** | Number of referral codes redeemed in the campaign. | [optional] 
 **discount_count** | **Integer** | Total amount of discounts redeemed in the campaign. | [optional] 
+**discount_effect_count** | **Integer** | Total number of times discounts were redeemed in this campaign. | [optional] 
+**coupon_creation_count** | **Integer** | Total number of coupons created by rules in this campaign. | [optional] 
 **last_activity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional] 
 **updated** | **DateTime** | Timestamp of the most recent update to the campaign or any of its elements. | [optional] 
 **created_by** | **String** | Name of the user who created this campaign if available. | [optional] 

data/docs/InlineResponse20025.md

@@ -3,7 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total_result_size** | **Integer** |  | 
+**total_result_size** | **Integer** |  | [optional] 
+**has_more** | **BOOLEAN** |  | [optional] 
 **data** | [**Array<Change>**](Change.md) |  | 
 
 

data/docs/IntegrationState.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **profile** | [**CustomerProfile**](CustomerProfile.md) |  | 
 **event** | [**Event**](Event.md) |  | 
 **loyalty** | [**Loyalty**](Loyalty.md) |  | [optional] 
+**coupon** | [**Coupon**](Coupon.md) |  | [optional] 
 
 

data/docs/ManagementApi.md

@@ -2318,7 +2318,12 @@ api_instance = TalonOne::ManagementApi.new
 opts = { 
   page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
   skip: 56, # Integer | Skips the given number of items when paging through large result sets.
-  sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+  sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+  application_id: 56, # Integer | 
+  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+  with_total_result_size: true, # BOOLEAN | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. 
+  include_old: true # BOOLEAN | When this flag is set to false, the state without the change will not be returned. The default value is true.
 }
 
 begin
@@ -2337,6 +2342,11 @@ Name | Type | Description  | Notes
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional] 
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional] 
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional] 
+ **application_id** | **Integer**|  | [optional] 
+ **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional] 
+ **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional] 
+ **with_total_result_size** | **BOOLEAN**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.  | [optional] 
+ **include_old** | **BOOLEAN**| When this flag is set to false, the state without the change will not be returned. The default value is true. | [optional] 
 
 ### Return type
 

data/docs/NewApplication.md

@@ -5,11 +5,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of this application. | 
 **description** | **String** | A longer description of the application. | [optional] 
-**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
 **currency** | **String** | A string describing a default currency for new customer sessions. | 
 **case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] 
 **attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional] 
 
 

data/docs/NewSamlConnection.md

@@ -0,0 +1,15 @@
+# TalonOne::NewSamlConnection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | ID of the SAML service. | 
+**enabled** | **BOOLEAN** | Determines if this SAML connection active. | 
+**issuer** | **String** | Identity Provider Entity ID. | 
+**sign_on_url** | **String** | Single Sign-On URL. | 
+**sign_out_url** | **String** | Single Sign-Out URL. | [optional] 
+**metadata_url** | **String** | Metadata URL. | [optional] 
+**x509certificate** | **String** | X.509 Certificate. | 
+**audience** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion.  This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.  | [optional] 
+
+

data/docs/SamlConnection.md

@@ -0,0 +1,19 @@
+# TalonOne::SamlConnection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**created** | **DateTime** | Unix timestamp indicating when the session was first created. | 
+**account_id** | **Integer** | The ID of the account that owns this SAML Service. | 
+**assertion_consumer_service_url** | **String** | The location where the SAML assertion is sent with a HTTP POST. | 
+**name** | **String** | ID of the SAML service. | 
+**enabled** | **BOOLEAN** | Determines if this SAML connection active. | 
+**issuer** | **String** | Identity Provider Entity ID. | 
+**sign_on_url** | **String** | Single Sign-On URL. | 
+**sign_out_url** | **String** | Single Sign-Out URL. | [optional] 
+**metadata_url** | **String** | Metadata URL. | [optional] 
+**x509certificate** | **String** | X.509 Certificate. | 
+**audience** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion.  This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.  | 
+
+

data/docs/UpdateApplication.md

@@ -0,0 +1,14 @@
+# TalonOne::UpdateApplication
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this application. | 
+**description** | **String** | A longer description of the application. | [optional] 
+**timezone** | **String** | A string containing an IANA timezone descriptor. | 
+**currency** | **String** | A string describing a default currency for new customer sessions. | 
+**case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] 
+**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+
+

data/docs/User.md

@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **latest_feature** | **String** | Latest feature the user has been notified. | [optional] 
 **roles** | **Array<Integer>** | Contains a list of all roles a user is a memeber of | [optional] 
 **application_notification_subscriptions** | **Object** |  | [optional] 
+**auth_method** | **String** | The Authentication method for this user | [optional] 
 
 

data/lib/talon_one.rb

@@ -149,6 +149,7 @@ require 'talon_one/models/new_password_email'
 require 'talon_one/models/new_referral'
 require 'talon_one/models/new_role'
 require 'talon_one/models/new_ruleset'
+require 'talon_one/models/new_saml_connection'
 require 'talon_one/models/new_template_def'
 require 'talon_one/models/new_user'
 require 'talon_one/models/new_webhook'
@@ -161,11 +162,13 @@ require 'talon_one/models/role_assign'
 require 'talon_one/models/role_membership'
 require 'talon_one/models/rule'
 require 'talon_one/models/ruleset'
+require 'talon_one/models/saml_connection'
 require 'talon_one/models/session'
 require 'talon_one/models/slot_def'
 require 'talon_one/models/template_arg_def'
 require 'talon_one/models/template_def'
 require 'talon_one/models/update_account'
+require 'talon_one/models/update_application'
 require 'talon_one/models/update_campaign'
 require 'talon_one/models/update_coupon'
 require 'talon_one/models/update_coupon_batch'

data/lib/talon_one/api/management_api.rb

@@ -2438,6 +2438,11 @@ module TalonOne
     # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
     # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
     # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+    # @option opts [Integer] :application_id 
+    # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+    # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+    # @option opts [BOOLEAN] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. 
+    # @option opts [BOOLEAN] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
     # @return [InlineResponse20025]
     def get_changes(opts = {})
       data, _status_code, _headers = get_changes_with_http_info(opts)
@@ -2450,6 +2455,11 @@ module TalonOne
     # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
     # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
     # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+    # @option opts [Integer] :application_id 
+    # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+    # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+    # @option opts [BOOLEAN] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. 
+    # @option opts [BOOLEAN] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
     # @return [Array<(InlineResponse20025, Fixnum, Hash)>] InlineResponse20025 data, response status code and response headers
     def get_changes_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -2463,6 +2473,11 @@ module TalonOne
       query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
+      query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
+      query_params[:'includeOld'] = opts[:'include_old'] if !opts[:'include_old'].nil?
 
       # header parameters
       header_params = {}

data/lib/talon_one/models/application.rb

@@ -33,9 +33,6 @@ module TalonOne
     # A longer description of the application.
     attr_accessor :description
 
-    # Hex key for HMAC-signing API calls as coming from this application (16 hex digits)
-    attr_accessor :key
-
     # A string containing an IANA timezone descriptor.
     attr_accessor :timezone
 
@@ -51,6 +48,9 @@ module TalonOne
     # Default limits for campaigns created in this application
     attr_accessor :limits
 
+    # Hex key for HMAC-signing API calls as coming from this application (16 hex digits)
+    attr_accessor :key
+
     # An array containing all the loyalty programs to which this application is subscribed
     attr_accessor :loyalty_programs
 
@@ -85,12 +85,12 @@ module TalonOne
         :'account_id' => :'accountId',
         :'name' => :'name',
         :'description' => :'description',
-        :'key' => :'key',
         :'timezone' => :'timezone',
         :'currency' => :'currency',
         :'case_sensitivity' => :'caseSensitivity',
         :'attributes' => :'attributes',
         :'limits' => :'limits',
+        :'key' => :'key',
         :'loyalty_programs' => :'loyaltyPrograms'
       }
     end
@@ -104,12 +104,12 @@ module TalonOne
         :'account_id' => :'Integer',
         :'name' => :'String',
         :'description' => :'String',
-        :'key' => :'String',
         :'timezone' => :'String',
         :'currency' => :'String',
         :'case_sensitivity' => :'String',
         :'attributes' => :'Object',
         :'limits' => :'Array<LimitConfig>',
+        :'key' => :'String',
         :'loyalty_programs' => :'Array<LoyaltyProgram>'
       }
     end
@@ -146,10 +146,6 @@ module TalonOne
         self.description = attributes[:'description']
       end
 
-      if attributes.has_key?(:'key')
-        self.key = attributes[:'key']
-      end
-
       if attributes.has_key?(:'timezone')
         self.timezone = attributes[:'timezone']
       end
@@ -172,6 +168,10 @@ module TalonOne
         end
       end
 
+      if attributes.has_key?(:'key')
+        self.key = attributes[:'key']
+      end
+
       if attributes.has_key?(:'loyaltyPrograms')
         if (value = attributes[:'loyaltyPrograms']).is_a?(Array)
           self.loyalty_programs = value
@@ -207,22 +207,6 @@ module TalonOne
         invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
       end
 
-      if @key.nil?
-        invalid_properties.push('invalid value for "key", key cannot be nil.')
-      end
-
-      if @key.to_s.length > 16
-        invalid_properties.push('invalid value for "key", the character length must be smaller than or equal to 16.')
-      end
-
-      if @key.to_s.length < 16
-        invalid_properties.push('invalid value for "key", the character length must be great than or equal to 16.')
-      end
-
-      if @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
-        invalid_properties.push('invalid value for "key", must conform to the pattern /^[a-fA-F0-9]{16}$/.')
-      end
-
       if @timezone.nil?
         invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
       end
@@ -239,6 +223,22 @@ module TalonOne
         invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 1.')
       end
 
+      if @key.nil?
+        invalid_properties.push('invalid value for "key", key cannot be nil.')
+      end
+
+      if @key.to_s.length > 16
+        invalid_properties.push('invalid value for "key", the character length must be smaller than or equal to 16.')
+      end
+
+      if @key.to_s.length < 16
+        invalid_properties.push('invalid value for "key", the character length must be great than or equal to 16.')
+      end
+
+      if @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
+        invalid_properties.push('invalid value for "key", must conform to the pattern /^[a-fA-F0-9]{16}$/.')
+      end
+
       if @loyalty_programs.nil?
         invalid_properties.push('invalid value for "loyalty_programs", loyalty_programs cannot be nil.')
       end
@@ -255,16 +255,16 @@ module TalonOne
       return false if @account_id.nil?
       return false if @name.nil?
       return false if @name.to_s.length < 1
-      return false if @key.nil?
-      return false if @key.to_s.length > 16
-      return false if @key.to_s.length < 16
-      return false if @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
       return false if @timezone.nil?
       return false if @timezone.to_s.length < 1
       return false if @currency.nil?
       return false if @currency.to_s.length < 1
       case_sensitivity_validator = EnumAttributeValidator.new('String', ['sensitive', 'insensitive-uppercase', 'insensitive-lowercase'])
       return false unless case_sensitivity_validator.valid?(@case_sensitivity)
+      return false if @key.nil?
+      return false if @key.to_s.length > 16
+      return false if @key.to_s.length < 16
+      return false if @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
       return false if @loyalty_programs.nil?
       true
     end
@@ -283,28 +283,6 @@ module TalonOne
       @name = name
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] key Value to be assigned
-    def key=(key)
-      if key.nil?
-        fail ArgumentError, 'key cannot be nil'
-      end
-
-      if key.to_s.length > 16
-        fail ArgumentError, 'invalid value for "key", the character length must be smaller than or equal to 16.'
-      end
-
-      if key.to_s.length < 16
-        fail ArgumentError, 'invalid value for "key", the character length must be great than or equal to 16.'
-      end
-
-      if key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
-        fail ArgumentError, 'invalid value for "key", must conform to the pattern /^[a-fA-F0-9]{16}$/.'
-      end
-
-      @key = key
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] timezone Value to be assigned
     def timezone=(timezone)
@@ -343,6 +321,28 @@ module TalonOne
       @case_sensitivity = case_sensitivity
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if key.nil?
+        fail ArgumentError, 'key cannot be nil'
+      end
+
+      if key.to_s.length > 16
+        fail ArgumentError, 'invalid value for "key", the character length must be smaller than or equal to 16.'
+      end
+
+      if key.to_s.length < 16
+        fail ArgumentError, 'invalid value for "key", the character length must be great than or equal to 16.'
+      end
+
+      if key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
+        fail ArgumentError, 'invalid value for "key", must conform to the pattern /^[a-fA-F0-9]{16}$/.'
+      end
+
+      @key = key
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -354,12 +354,12 @@ module TalonOne
           account_id == o.account_id &&
           name == o.name &&
           description == o.description &&
-          key == o.key &&
           timezone == o.timezone &&
           currency == o.currency &&
           case_sensitivity == o.case_sensitivity &&
           attributes == o.attributes &&
           limits == o.limits &&
+          key == o.key &&
           loyalty_programs == o.loyalty_programs
     end
 
@@ -372,7 +372,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, created, modified, account_id, name, description, key, timezone, currency, case_sensitivity, attributes, limits, loyalty_programs].hash
+      [id, created, modified, account_id, name, description, timezone, currency, case_sensitivity, attributes, limits, key, loyalty_programs].hash
     end
 
     # Builds the object from hash