talon_one 1.1.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +21 -12
- data/docs/AccountAnalytics.md +1 -0
- data/docs/AccountLimits.md +1 -0
- data/docs/Application.md +2 -1
- data/docs/ApplicationCustomer.md +1 -1
- data/docs/ApplicationSession.md +2 -1
- data/docs/Attribute.md +0 -2
- data/docs/AttributesMandatory.md +9 -0
- data/docs/AttributesSettings.md +8 -0
- data/docs/BaseSamlConnection.md +15 -0
- data/docs/Campaign.md +2 -0
- data/docs/CampaignAnalytics.md +9 -3
- data/docs/CampaignCopy.md +4 -0
- data/docs/Change.md +2 -2
- data/docs/CustomerInventory.md +9 -0
- data/docs/CustomerProfile.md +1 -1
- data/docs/ErrorSource.md +1 -0
- data/docs/Event.md +1 -1
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +3 -2
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +9 -0
- data/docs/IntegrationApi.md +66 -0
- data/docs/IntegrationEvent.md +10 -0
- data/docs/IntegrationState.md +1 -0
- data/docs/ManagementApi.md +175 -104
- data/docs/Meta.md +1 -0
- data/docs/NewApplication.md +2 -1
- data/docs/NewEvent.md +1 -1
- data/docs/NewSamlConnection.md +16 -0
- data/docs/Notification.md +10 -0
- data/docs/{ApplicationStorageData.md → Notifications.md} +1 -1
- data/docs/ReferralRejectionReason.md +10 -0
- data/docs/SamlConnection.md +18 -0
- data/docs/SamlConnectionMetadata.md +11 -0
- data/docs/UpdateApplication.md +15 -0
- data/docs/UpdateUser.md +1 -0
- data/docs/User.md +2 -0
- data/docs/Webhook.md +0 -1
- data/lib/talon_one.rb +13 -6
- data/lib/talon_one/api/integration_api.rb +60 -0
- data/lib/talon_one/api/management_api.rb +194 -121
- data/lib/talon_one/models/account_analytics.rb +19 -4
- data/lib/talon_one/models/account_limits.rb +11 -1
- data/lib/talon_one/models/application.rb +62 -53
- data/lib/talon_one/models/application_customer.rb +0 -5
- data/lib/talon_one/models/application_session.rb +12 -2
- data/lib/talon_one/models/attribute.rb +4 -38
- data/lib/talon_one/models/attributes_mandatory.rb +199 -0
- data/lib/talon_one/models/{new_application_storage_data.rb → attributes_settings.rb} +13 -4
- data/lib/talon_one/models/{application_storage.rb → base_saml_connection.rb} +122 -78
- data/lib/talon_one/models/campaign.rb +21 -1
- data/lib/talon_one/models/campaign_analytics.rb +94 -4
- data/lib/talon_one/models/campaign_copy.rb +46 -4
- data/lib/talon_one/models/change.rb +2 -2
- data/lib/talon_one/models/coupon_rejection_reason.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +194 -0
- data/lib/talon_one/models/customer_profile.rb +0 -5
- data/lib/talon_one/models/error_source.rb +14 -4
- data/lib/talon_one/models/event.rb +11 -35
- data/lib/talon_one/models/inline_response_200_20.rb +1 -1
- data/lib/talon_one/models/inline_response_200_21.rb +1 -1
- data/lib/talon_one/models/inline_response_200_22.rb +1 -1
- data/lib/talon_one/models/inline_response_200_23.rb +1 -1
- data/lib/talon_one/models/inline_response_200_24.rb +1 -1
- data/lib/talon_one/models/inline_response_200_25.rb +1 -1
- data/lib/talon_one/models/inline_response_200_26.rb +11 -7
- data/lib/talon_one/models/inline_response_200_27.rb +1 -1
- data/lib/talon_one/models/inline_response_200_28.rb +1 -1
- data/lib/talon_one/models/{new_application_storage_tuple.rb → inline_response_200_29.rb} +22 -40
- data/lib/talon_one/models/integration_event.rb +234 -0
- data/lib/talon_one/models/integration_state.rb +13 -4
- data/lib/talon_one/models/limit_config.rb +2 -2
- data/lib/talon_one/models/meta.rb +10 -1
- data/lib/talon_one/models/new_application.rb +57 -56
- data/lib/talon_one/models/new_event.rb +38 -38
- data/lib/talon_one/models/new_saml_connection.rb +371 -0
- data/lib/talon_one/models/{new_application_storage.rb → notification.rb} +22 -17
- data/lib/talon_one/models/{application_storage_data.rb → notifications.rb} +1 -2
- data/lib/talon_one/models/referral_rejection_reason.rb +251 -0
- data/lib/talon_one/models/saml_connection.rb +387 -0
- data/lib/talon_one/models/{application_storage_tuple.rb → saml_connection_metadata.rb} +68 -80
- data/lib/talon_one/models/update_application.rb +361 -0
- data/lib/talon_one/models/update_user.rb +13 -4
- data/lib/talon_one/models/user.rb +23 -4
- data/lib/talon_one/models/webhook.rb +4 -21
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +14 -0
- data/spec/api/management_api_spec.rb +56 -37
- data/spec/models/account_analytics_spec.rb +6 -0
- data/spec/models/account_limits_spec.rb +6 -0
- data/spec/models/application_session_spec.rb +6 -0
- data/spec/models/application_spec.rb +12 -6
- data/spec/models/attribute_spec.rb +0 -12
- data/spec/models/{new_application_storage_tuple_spec.rb → attributes_mandatory_spec.rb} +8 -8
- data/spec/models/{new_application_storage_data_spec.rb → attributes_settings_spec.rb} +12 -6
- data/spec/models/{application_storage_spec.rb → base_saml_connection_spec.rb} +14 -14
- data/spec/models/campaign_analytics_spec.rb +36 -0
- data/spec/models/campaign_copy_spec.rb +24 -0
- data/spec/models/campaign_spec.rb +12 -0
- data/spec/models/coupon_rejection_reason_spec.rb +1 -1
- data/spec/models/customer_inventory_spec.rb +47 -0
- data/spec/models/error_source_spec.rb +6 -0
- data/spec/models/event_spec.rb +3 -3
- data/spec/models/inline_response_200_26_spec.rb +6 -0
- data/spec/models/inline_response_200_29_spec.rb +47 -0
- data/spec/models/integration_event_spec.rb +53 -0
- data/spec/models/integration_state_spec.rb +6 -0
- data/spec/models/limit_config_spec.rb +1 -1
- data/spec/models/meta_spec.rb +6 -0
- data/spec/models/new_application_spec.rb +12 -6
- data/spec/models/new_event_spec.rb +3 -3
- data/spec/models/new_saml_connection_spec.rb +89 -0
- data/spec/models/{new_application_storage_spec.rb → notification_spec.rb} +8 -8
- data/spec/models/{application_storage_data_spec.rb → notifications_spec.rb} +6 -6
- data/spec/models/referral_rejection_reason_spec.rb +57 -0
- data/spec/models/{application_storage_tuple_spec.rb → saml_connection_metadata_spec.rb} +10 -22
- data/spec/models/saml_connection_spec.rb +101 -0
- data/spec/models/update_application_spec.rb +87 -0
- data/spec/models/update_user_spec.rb +6 -0
- data/spec/models/user_spec.rb +12 -0
- data/spec/models/webhook_spec.rb +0 -6
- data/talon_one-1.0.0.gem +0 -0
- data/talon_one-1.1.0.gem +0 -0
- data/talon_one-1.1.1.gem +0 -0
- data/talon_one-1.1.2.gem +0 -0
- data/talon_one-1.2.0.gem +0 -0
- data/talon_one-1.3.0.gem +0 -0
- data/talon_one.gemspec +1 -1
- metadata +74 -42
- data/docs/ApplicationStorage.md +0 -15
- data/docs/ApplicationStorageTuple.md +0 -13
- data/docs/NewApplicationStorage.md +0 -10
- data/docs/NewApplicationStorageData.md +0 -7
- data/docs/NewApplicationStorageTuple.md +0 -9
- data/fck.rb +0 -64
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 45665e29a6992992ab245da3fc617f49ddf0468e4a192384c0872c3209f9cded
|
4
|
+
data.tar.gz: dfcf3b660ad5f8d19a17ca8914c2dfa94f5393f47fc6df5b2788d2687ece4481
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e49c926f6e86618f668f117f58a67382d09fa89297f0d1640baed8ef7476438e256eb8d401dce43c98e2f28def15ab2e7288f4b54ad8237ef3cfab38258edf8a
|
7
|
+
data.tar.gz: 7abe931e1870c161cac4935482976593cb3fca881c9fc75a912d0d537f300daefbaf4712c4a7f94432a6678e3b3045353d7c573aa451869bcfbbd85bf4954683
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The Talon.One API is used to manage applications and campaigns, as well as to in
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.4.0
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build talon_one.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./talon_one-1.
|
26
|
+
gem install ./talon_one-1.4.0.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./talon_one-1.
|
28
|
+
(for development, run `gem install --dev ./talon_one-1.4.0.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'talon_one', '~> 1.
|
34
|
+
gem 'talon_one', '~> 1.4.0'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
|
|
140
140
|
*TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
141
141
|
*TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
142
142
|
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
|
143
|
+
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
|
143
144
|
*TalonOne::IntegrationApi* | [**get_reserved_coupons**](docs/IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
|
144
145
|
*TalonOne::IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
145
146
|
*TalonOne::IntegrationApi* | [**track_event**](docs/IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
@@ -147,6 +148,7 @@ Class | Method | HTTP request | Description
|
|
147
148
|
*TalonOne::IntegrationApi* | [**update_customer_session**](docs/IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
|
148
149
|
*TalonOne::ManagementApi* | [**add_loyalty_points**](docs/ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
|
149
150
|
*TalonOne::ManagementApi* | [**copy_campaign_to_applications**](docs/ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
|
151
|
+
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
150
152
|
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
151
153
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
152
154
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
@@ -161,7 +163,6 @@ Class | Method | HTTP request | Description
|
|
161
163
|
*TalonOne::ManagementApi* | [**get_access_logs_without_total_count**](docs/ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
|
162
164
|
*TalonOne::ManagementApi* | [**get_account**](docs/ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
163
165
|
*TalonOne::ManagementApi* | [**get_account_analytics**](docs/ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
|
164
|
-
*TalonOne::ManagementApi* | [**get_account_limits**](docs/ManagementApi.md#get_account_limits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
|
165
166
|
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
166
167
|
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
|
167
168
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
@@ -176,6 +177,7 @@ Class | Method | HTTP request | Description
|
|
176
177
|
*TalonOne::ManagementApi* | [**get_application_sessions**](docs/ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
|
177
178
|
*TalonOne::ManagementApi* | [**get_applications**](docs/ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
178
179
|
*TalonOne::ManagementApi* | [**get_attribute**](docs/ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
180
|
+
*TalonOne::ManagementApi* | [**get_attributes**](docs/ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
179
181
|
*TalonOne::ManagementApi* | [**get_campaign**](docs/ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
180
182
|
*TalonOne::ManagementApi* | [**get_campaign_analytics**](docs/ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
181
183
|
*TalonOne::ManagementApi* | [**get_campaign_by_attributes**](docs/ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
|
@@ -217,7 +219,7 @@ Class | Method | HTTP request | Description
|
|
217
219
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide**](docs/ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
218
220
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
219
221
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
|
220
|
-
*TalonOne::ManagementApi* | [**
|
222
|
+
*TalonOne::ManagementApi* | [**update_attribute**](docs/ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
221
223
|
*TalonOne::ManagementApi* | [**update_campaign**](docs/ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
|
222
224
|
*TalonOne::ManagementApi* | [**update_campaign_set**](docs/ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
|
223
225
|
*TalonOne::ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
@@ -243,11 +245,11 @@ Class | Method | HTTP request | Description
|
|
243
245
|
- [TalonOne::ApplicationEvent](docs/ApplicationEvent.md)
|
244
246
|
- [TalonOne::ApplicationSession](docs/ApplicationSession.md)
|
245
247
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
246
|
-
- [TalonOne::ApplicationStorage](docs/ApplicationStorage.md)
|
247
|
-
- [TalonOne::ApplicationStorageData](docs/ApplicationStorageData.md)
|
248
|
-
- [TalonOne::ApplicationStorageTuple](docs/ApplicationStorageTuple.md)
|
249
248
|
- [TalonOne::Attribute](docs/Attribute.md)
|
250
249
|
- [TalonOne::AttributeQuery](docs/AttributeQuery.md)
|
250
|
+
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
251
|
+
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
252
|
+
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
|
251
253
|
- [TalonOne::Binding](docs/Binding.md)
|
252
254
|
- [TalonOne::Campaign](docs/Campaign.md)
|
253
255
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
@@ -271,6 +273,7 @@ Class | Method | HTTP request | Description
|
|
271
273
|
- [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
|
272
274
|
- [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
|
273
275
|
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
|
276
|
+
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
|
274
277
|
- [TalonOne::CustomerProfile](docs/CustomerProfile.md)
|
275
278
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
276
279
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
@@ -311,6 +314,7 @@ Class | Method | HTTP request | Description
|
|
311
314
|
- [TalonOne::InlineResponse20026](docs/InlineResponse20026.md)
|
312
315
|
- [TalonOne::InlineResponse20027](docs/InlineResponse20027.md)
|
313
316
|
- [TalonOne::InlineResponse20028](docs/InlineResponse20028.md)
|
317
|
+
- [TalonOne::InlineResponse20029](docs/InlineResponse20029.md)
|
314
318
|
- [TalonOne::InlineResponse2003](docs/InlineResponse2003.md)
|
315
319
|
- [TalonOne::InlineResponse2004](docs/InlineResponse2004.md)
|
316
320
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
@@ -319,6 +323,7 @@ Class | Method | HTTP request | Description
|
|
319
323
|
- [TalonOne::InlineResponse2008](docs/InlineResponse2008.md)
|
320
324
|
- [TalonOne::InlineResponse2009](docs/InlineResponse2009.md)
|
321
325
|
- [TalonOne::IntegrationEntity](docs/IntegrationEntity.md)
|
326
|
+
- [TalonOne::IntegrationEvent](docs/IntegrationEvent.md)
|
322
327
|
- [TalonOne::IntegrationProfileEntity](docs/IntegrationProfileEntity.md)
|
323
328
|
- [TalonOne::IntegrationState](docs/IntegrationState.md)
|
324
329
|
- [TalonOne::LedgerEntry](docs/LedgerEntry.md)
|
@@ -343,9 +348,6 @@ Class | Method | HTTP request | Description
|
|
343
348
|
- [TalonOne::NewAccountSignUp](docs/NewAccountSignUp.md)
|
344
349
|
- [TalonOne::NewApplication](docs/NewApplication.md)
|
345
350
|
- [TalonOne::NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
|
346
|
-
- [TalonOne::NewApplicationStorage](docs/NewApplicationStorage.md)
|
347
|
-
- [TalonOne::NewApplicationStorageData](docs/NewApplicationStorageData.md)
|
348
|
-
- [TalonOne::NewApplicationStorageTuple](docs/NewApplicationStorageTuple.md)
|
349
351
|
- [TalonOne::NewAttribute](docs/NewAttribute.md)
|
350
352
|
- [TalonOne::NewCampaign](docs/NewCampaign.md)
|
351
353
|
- [TalonOne::NewCampaignSet](docs/NewCampaignSet.md)
|
@@ -364,20 +366,27 @@ Class | Method | HTTP request | Description
|
|
364
366
|
- [TalonOne::NewReferral](docs/NewReferral.md)
|
365
367
|
- [TalonOne::NewRole](docs/NewRole.md)
|
366
368
|
- [TalonOne::NewRuleset](docs/NewRuleset.md)
|
369
|
+
- [TalonOne::NewSamlConnection](docs/NewSamlConnection.md)
|
367
370
|
- [TalonOne::NewTemplateDef](docs/NewTemplateDef.md)
|
368
371
|
- [TalonOne::NewUser](docs/NewUser.md)
|
369
372
|
- [TalonOne::NewWebhook](docs/NewWebhook.md)
|
373
|
+
- [TalonOne::Notification](docs/Notification.md)
|
374
|
+
- [TalonOne::Notifications](docs/Notifications.md)
|
370
375
|
- [TalonOne::Referral](docs/Referral.md)
|
376
|
+
- [TalonOne::ReferralRejectionReason](docs/ReferralRejectionReason.md)
|
371
377
|
- [TalonOne::Role](docs/Role.md)
|
372
378
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
373
379
|
- [TalonOne::RoleMembership](docs/RoleMembership.md)
|
374
380
|
- [TalonOne::Rule](docs/Rule.md)
|
375
381
|
- [TalonOne::Ruleset](docs/Ruleset.md)
|
382
|
+
- [TalonOne::SamlConnection](docs/SamlConnection.md)
|
383
|
+
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
376
384
|
- [TalonOne::Session](docs/Session.md)
|
377
385
|
- [TalonOne::SlotDef](docs/SlotDef.md)
|
378
386
|
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
|
379
387
|
- [TalonOne::TemplateDef](docs/TemplateDef.md)
|
380
388
|
- [TalonOne::UpdateAccount](docs/UpdateAccount.md)
|
389
|
+
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
|
381
390
|
- [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
|
382
391
|
- [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
|
383
392
|
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
|
data/docs/AccountAnalytics.md
CHANGED
@@ -17,5 +17,6 @@ Name | Type | Description | Notes
|
|
17
17
|
**roles** | **Integer** | Total Number of roles inside the account |
|
18
18
|
**webhooks** | **Integer** | Total Number of webhooks inside the account |
|
19
19
|
**loyalty_programs** | **Integer** | Total Number of loyalty programs inside the account |
|
20
|
+
**active_rules** | **Integer** | Total Number of active rules in the account |
|
20
21
|
|
21
22
|
|
data/docs/AccountLimits.md
CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**webhooks** | **Integer** | Total Number of allowed webhooks in the account |
|
14
14
|
**users** | **Integer** | Total Number of allowed users in the account |
|
15
15
|
**api_volume** | **Integer** | Total allowed api volume |
|
16
|
+
**active_rules** | **Integer** | Total allowed active rulesets | [optional]
|
16
17
|
**promotion_types** | **Array<String>** | array of rulesets where webhook is used |
|
17
18
|
|
18
19
|
|
data/docs/Application.md
CHANGED
@@ -9,12 +9,13 @@ Name | Type | Description | Notes
|
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**name** | **String** | The name of this application. |
|
11
11
|
**description** | **String** | A longer description of the application. | [optional]
|
12
|
-
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) |
|
13
12
|
**timezone** | **String** | A string containing an IANA timezone descriptor. |
|
14
13
|
**currency** | **String** | A string describing a default currency for new customer sessions. |
|
15
14
|
**case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional]
|
16
15
|
**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional]
|
17
16
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
|
17
|
+
**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
|
18
|
+
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) |
|
18
19
|
**loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |
|
19
20
|
|
20
21
|
|
data/docs/ApplicationCustomer.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. |
|
11
11
|
**closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
|
12
12
|
**total_sales** | **Float** | Sum of all purchases made by this customer |
|
13
|
-
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer |
|
13
|
+
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional]
|
14
14
|
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer |
|
15
15
|
|
16
16
|
|
data/docs/ApplicationSession.md
CHANGED
@@ -9,10 +9,11 @@ Name | Type | Description | Notes
|
|
9
9
|
**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
|
10
10
|
**integration_id** | **String** | The ID used for this entity in the application system. |
|
11
11
|
**coupon** | **String** | Any coupon code entered. |
|
12
|
-
**referral** | **String** | Any
|
12
|
+
**referral** | **String** | Any referral code entered. |
|
13
13
|
**state** | **String** | Indicating if the customer session is in progress (\"open\"), \"closed\", or \"cancelled\". |
|
14
14
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. |
|
15
15
|
**discounts** | **Hash<String, Float>** | A map of labelled discount values, in the same currency as the session. |
|
16
|
+
**total** | **Float** | The total sum of the session before any discounts applied. | [optional]
|
16
17
|
**attributes** | **Object** | Arbitrary properties associated with this item | [optional]
|
17
18
|
|
18
19
|
|
data/docs/Attribute.md
CHANGED
@@ -14,7 +14,5 @@ Name | Type | Description | Notes
|
|
14
14
|
**description** | **String** | A description of this attribute. |
|
15
15
|
**suggestions** | **Array<String>** | A list of suggestions for the attribute. |
|
16
16
|
**editable** | **BOOLEAN** | Whether or not this attribute can be edited. |
|
17
|
-
**locked** | **BOOLEAN** | Indicates whether this attribute is in use. If in use only title can be changed and other operations are prohibited. | [default to false]
|
18
|
-
**used_at** | **Array<String>** | array of rulesets where the attribute is used |
|
19
17
|
|
20
18
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# TalonOne::AttributesMandatory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**campaigns** | **Array<String>** | List of mandatory attributes for campaigns. | [optional]
|
7
|
+
**coupons** | **Array<String>** | List of mandatory attributes for campaigns. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# TalonOne::BaseSamlConnection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
7
|
+
**name** | **String** | ID of the SAML service. |
|
8
|
+
**enabled** | **BOOLEAN** | Determines if this SAML connection active. |
|
9
|
+
**issuer** | **String** | Identity Provider Entity ID. |
|
10
|
+
**sign_on_url** | **String** | Single Sign-On URL. |
|
11
|
+
**sign_out_url** | **String** | Single Sign-Out URL. | [optional]
|
12
|
+
**metadata_url** | **String** | Metadata URL. | [optional]
|
13
|
+
**audience_uri** | **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]
|
14
|
+
|
15
|
+
|
data/docs/Campaign.md
CHANGED
@@ -22,6 +22,8 @@ Name | Type | Description | Notes
|
|
22
22
|
**coupon_redemption_count** | **Integer** | Number of coupons redeemed in the campaign. | [optional]
|
23
23
|
**referral_redemption_count** | **Integer** | Number of referral codes redeemed in the campaign. | [optional]
|
24
24
|
**discount_count** | **Integer** | Total amount of discounts redeemed in the campaign. | [optional]
|
25
|
+
**discount_effect_count** | **Integer** | Total number of times discounts were redeemed in this campaign. | [optional]
|
26
|
+
**coupon_creation_count** | **Integer** | Total number of coupons created by rules in this campaign. | [optional]
|
25
27
|
**last_activity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional]
|
26
28
|
**updated** | **DateTime** | Timestamp of the most recent update to the campaign or any of its elements. | [optional]
|
27
29
|
**created_by** | **String** | Name of the user who created this campaign if available. | [optional]
|
data/docs/CampaignAnalytics.md
CHANGED
@@ -4,14 +4,20 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**date** | **DateTime** | |
|
7
|
-
**campaign_revenue** | **Float** | Amount of revenue in this campaign. |
|
8
|
-
**total_campaign_revenue** | **Float** | Amount of revenue in this campaign since it began. |
|
7
|
+
**campaign_revenue** | **Float** | Amount of revenue in this campaign (for coupon or discount sessions). |
|
8
|
+
**total_campaign_revenue** | **Float** | Amount of revenue in this campaign since it began (for coupon or discount sessions). |
|
9
|
+
**campaign_refund** | **Float** | Amount of refunds in this campaign (for coupon or discount sessions). |
|
10
|
+
**total_campaign_refund** | **Float** | Amount of refunds in this campaign since it began (for coupon or discount sessions). |
|
9
11
|
**campaign_discount_costs** | **Float** | Amount of cost caused by discounts given in the campaign. |
|
10
12
|
**total_campaign_discount_costs** | **Float** | Amount of cost caused by discounts given in the campaign since it began. |
|
13
|
+
**campaign_refunded_discounts** | **Float** | Amount of discounts rolledback due to refund in the campaign. |
|
14
|
+
**total_campaign_refunded_discounts** | **Float** | Amount of discounts rolledback due to refund in the campaign since it began. |
|
11
15
|
**campaign_free_items** | **Integer** | Amount of free items given in the campaign. |
|
12
16
|
**total_campaign_free_items** | **Integer** | Amount of free items given in the campaign since it began. |
|
13
|
-
**coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign
|
17
|
+
**coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign. |
|
14
18
|
**total_coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign since it began. |
|
19
|
+
**coupon_rolledback_redemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
|
20
|
+
**total_coupon_rolledback_redemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
|
15
21
|
**referral_redemptions** | **Integer** | Number of referral redemptions in the campaign. |
|
16
22
|
**total_referral_redemptions** | **Integer** | Number of referral redemptions in the campaign since it began. |
|
17
23
|
**coupons_created** | **Integer** | Number of coupons created in the campaign by the rule engine. |
|
data/docs/CampaignCopy.md
CHANGED
@@ -5,5 +5,9 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the copied campaign (Defaults to \"Copy of original campaign name\") | [optional]
|
7
7
|
**application_ids** | **Array<String>** | Application IDs of the applications to which a campaign should be copied to |
|
8
|
+
**description** | **String** | A detailed description of the campaign. | [optional]
|
9
|
+
**start_time** | **DateTime** | Datetime when the campaign will become active. | [optional]
|
10
|
+
**end_time** | **DateTime** | Datetime when the campaign will become in-active. | [optional]
|
11
|
+
**tags** | **Array<String>** | A list of tags for the campaign. | [optional]
|
8
12
|
|
9
13
|
|
data/docs/Change.md
CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**created** | **DateTime** | The exact moment this entity was created. |
|
8
8
|
**user_id** | **Integer** | The ID of the account that owns this entity. |
|
9
9
|
**entity** | **String** | API endpoint on which the change was initiated. |
|
10
|
-
**old** | **Object** | Resource before the change
|
11
|
-
**new** | **Object** | Resource after the change
|
10
|
+
**old** | **Object** | Resource before the change occurred. | [optional]
|
11
|
+
**new** | **Object** | Resource after the change occurred. | [optional]
|
12
12
|
|
13
13
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# TalonOne::CustomerInventory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
|
7
|
+
**referrals** | [**Array<Referral>**](Referral.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/CustomerProfile.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
10
10
|
**closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
|
11
11
|
**total_sales** | **Float** | Sum of all purchases made by this customer |
|
12
|
-
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer |
|
12
|
+
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional]
|
13
13
|
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer |
|
14
14
|
|
15
15
|
|
data/docs/ErrorSource.md
CHANGED
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**pointer** | **String** | Pointer to the path in the payload that caused this error. | [optional]
|
7
7
|
**parameter** | **String** | Query parameter that caused this error. | [optional]
|
8
8
|
**line** | **String** | Line number in uploaded multipart file that caused this error. 'N/A' if unknown. | [optional]
|
9
|
+
**resource** | **String** | Pointer to the resource that caused this error | [optional]
|
9
10
|
|
10
11
|
|
data/docs/Event.md
CHANGED
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
7
7
|
**created** | **DateTime** | The exact moment this entity was created. |
|
8
8
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
9
9
|
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional]
|
10
|
-
**session_id** | **String** | The ID of the session that this event occurred in. |
|
11
10
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
12
11
|
**attributes** | **Object** | Arbitrary additional JSON data associated with the event. |
|
12
|
+
**session_id** | **String** | The ID of the session that this event occurred in. | [optional]
|
13
13
|
**effects** | **Array<Object>** | An array of \"effects\" that must be applied in response to this event. Example effects include `addItemToCart` or `setDiscount`. |
|
14
14
|
**ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. |
|
15
15
|
**meta** | [**Meta**](Meta.md) | | [optional]
|
data/docs/InlineResponse20020.md
CHANGED
data/docs/InlineResponse20021.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
7
|
+
**data** | [**Array<Webhook>**](Webhook.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20022.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
7
|
+
**data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20023.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
7
|
+
**data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20024.md
CHANGED
data/docs/InlineResponse20025.md
CHANGED
data/docs/InlineResponse20026.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**total_result_size** | **Integer** | |
|
7
|
-
**
|
6
|
+
**total_result_size** | **Integer** | | [optional]
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
8
|
+
**data** | [**Array<Change>**](Change.md) | |
|
8
9
|
|
9
10
|
|
data/docs/InlineResponse20027.md
CHANGED
data/docs/InlineResponse20028.md
CHANGED