talon_one 8.0.0 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +42 -8
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/Achievement.md +2 -2
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/ApplicationCustomer.md +2 -2
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +4 -2
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CreateAchievement.md +1 -1
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/Effect.md +6 -0
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +25 -0
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20048.md +17 -0
- data/docs/InlineResponse20049.md +17 -0
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +6 -4
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +824 -220
- data/docs/MessageTest.md +27 -0
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewMessageTest.md +29 -0
- data/docs/NewPriceAdjustment.md +27 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewWebhook.md +2 -0
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +23 -0
- data/docs/PriceType.md +33 -0
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughLabelingNotification.md +2 -0
- data/docs/TemplateDef.md +1 -1
- data/docs/UpdateAchievement.md +1 -1
- data/docs/User.md +1 -1
- data/docs/Webhook.md +3 -1
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
- data/lib/talon_one/api/integration_api.rb +9 -6
- data/lib/talon_one/api/management_api.rb +1009 -304
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/achievement.rb +4 -4
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
- data/lib/talon_one/models/achievement_status_entry.rb +472 -0
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/analytics_sku.rb +246 -0
- data/lib/talon_one/models/application.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_cif_references.rb +219 -0
- data/lib/talon_one/models/application_customer.rb +2 -2
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +2 -2
- data/lib/talon_one/models/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.rb +1 -1
- data/lib/talon_one/models/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
- data/lib/talon_one/models/campaign_template.rb +17 -5
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- data/lib/talon_one/models/create_achievement.rb +3 -3
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +2 -2
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.rb +1 -1
- data/lib/talon_one/models/delete_user_request.rb +0 -1
- data/lib/talon_one/models/effect.rb +31 -1
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -1
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +270 -0
- data/lib/talon_one/models/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/inline_response20048.rb +208 -0
- data/lib/talon_one/models/inline_response20049.rb +208 -0
- data/lib/talon_one/models/inline_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/message_test.rb +227 -0
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- data/lib/talon_one/models/new_message_test.rb +322 -0
- data/lib/talon_one/models/new_price_adjustment.rb +268 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_webhook.rb +16 -1
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +237 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
- data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
- data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/update_achievement.rb +3 -3
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +17 -2
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +17 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +26 -1
- data/spec/api/integration_api_spec.rb +4 -3
- data/spec/api/management_api_spec.rb +227 -90
- data/spec/models/achievement_base_spec.rb +1 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +1 -1
- data/spec/models/achievement_spec.rb +1 -1
- data/spec/models/achievement_status_entry_spec.rb +1 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/create_achievement_spec.rb +1 -1
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +65 -0
- data/spec/models/inline_response20048_spec.rb +0 -6
- data/spec/models/inline_response20049_spec.rb +0 -6
- data/spec/models/inline_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +1 -1
- data/spec/models/new_price_adjustment_spec.rb +71 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/price_detail_spec.rb +59 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/revision_activation_request_spec.rb +47 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +1 -1
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +661 -527
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2d0ea9367c06e2095f80a11464c8778f6c92ef892aaf88282e4b91cb71084f9e
|
4
|
+
data.tar.gz: 94b26089c8d60de92e94464ad20a1ba4a91febd33efc97fa350794012e425595
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 39f0e15d0bd9f17815c68a7530f6e54dfb15fd4e11ba4f06ff012c52f4adeb637ba10a8e58d2ef0a600cccf594e7d313260d79d6e98f9fa59e28eed08a8e6ab2
|
7
|
+
data.tar.gz: d33ece1169cbb932ef53cbe7c6e70ccce85df72dbe962504fd271d7ed23c9086717c5c8118ff6010a8f6a2873b7952a642d23e48faff9c3a121ced2a1385f446
|
data/README.md
CHANGED
@@ -9,7 +9,7 @@ This SDK supports all of the operations of Talon.One's Integration API and Manag
|
|
9
9
|
Add this to the Gemfile:
|
10
10
|
|
11
11
|
```shell
|
12
|
-
gem 'talon_one', '~>
|
12
|
+
gem 'talon_one', '~> 10.0.0'
|
13
13
|
```
|
14
14
|
|
15
15
|
### Build a gem
|
@@ -25,10 +25,10 @@ gem build talon_one.gemspec
|
|
25
25
|
To install the gem locally:
|
26
26
|
|
27
27
|
```shell
|
28
|
-
gem install ./talon_one-
|
28
|
+
gem install ./talon_one-10.0.0.gem
|
29
29
|
```
|
30
30
|
|
31
|
-
For development, run `gem install --dev ./talon_one-
|
31
|
+
For development, run `gem install --dev ./talon_one-10.0.0.gem` to install the development dependencies.
|
32
32
|
|
33
33
|
### RubyGems
|
34
34
|
|
@@ -214,6 +214,7 @@ Class | Method | HTTP request | Description
|
|
214
214
|
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
215
215
|
*TalonOne::ManagementApi* | [**create_batch_loyalty_cards**](docs/ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
216
216
|
*TalonOne::ManagementApi* | [**create_campaign_from_template**](docs/ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
|
217
|
+
*TalonOne::ManagementApi* | [**create_campaign_store_budget**](docs/ManagementApi.md#create_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Create campaign store budget
|
217
218
|
*TalonOne::ManagementApi* | [**create_collection**](docs/ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
218
219
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
|
219
220
|
*TalonOne::ManagementApi* | [**create_coupons_async**](docs/ManagementApi.md#create_coupons_async) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
|
@@ -229,6 +230,7 @@ Class | Method | HTTP request | Description
|
|
229
230
|
*TalonOne::ManagementApi* | [**delete_account_collection**](docs/ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
230
231
|
*TalonOne::ManagementApi* | [**delete_achievement**](docs/ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
231
232
|
*TalonOne::ManagementApi* | [**delete_campaign**](docs/ManagementApi.md#delete_campaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign
|
233
|
+
*TalonOne::ManagementApi* | [**delete_campaign_store_budgets**](docs/ManagementApi.md#delete_campaign_store_budgets) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Delete campaign store budgets
|
232
234
|
*TalonOne::ManagementApi* | [**delete_collection**](docs/ManagementApi.md#delete_collection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection
|
233
235
|
*TalonOne::ManagementApi* | [**delete_coupon**](docs/ManagementApi.md#delete_coupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon
|
234
236
|
*TalonOne::ManagementApi* | [**delete_coupons**](docs/ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons
|
@@ -242,6 +244,7 @@ Class | Method | HTTP request | Description
|
|
242
244
|
*TalonOne::ManagementApi* | [**export_account_collection_items**](docs/ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
|
243
245
|
*TalonOne::ManagementApi* | [**export_achievements**](docs/ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
244
246
|
*TalonOne::ManagementApi* | [**export_audiences_memberships**](docs/ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
|
247
|
+
*TalonOne::ManagementApi* | [**export_campaign_store_budgets**](docs/ManagementApi.md#export_campaign_store_budgets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export | Export campaign store budgets
|
245
248
|
*TalonOne::ManagementApi* | [**export_campaign_stores**](docs/ManagementApi.md#export_campaign_stores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
|
246
249
|
*TalonOne::ManagementApi* | [**export_collection_items**](docs/ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
|
247
250
|
*TalonOne::ManagementApi* | [**export_coupons**](docs/ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
|
@@ -308,6 +311,7 @@ Class | Method | HTTP request | Description
|
|
308
311
|
*TalonOne::ManagementApi* | [**get_loyalty_program_transactions**](docs/ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
|
309
312
|
*TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
|
310
313
|
*TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
|
314
|
+
*TalonOne::ManagementApi* | [**get_message_logs**](docs/ManagementApi.md#get_message_logs) | **GET** /v1/message_logs | List message log entries
|
311
315
|
*TalonOne::ManagementApi* | [**get_referrals_without_total_count**](docs/ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
|
312
316
|
*TalonOne::ManagementApi* | [**get_role_v2**](docs/ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
|
313
317
|
*TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
|
@@ -322,6 +326,7 @@ Class | Method | HTTP request | Description
|
|
322
326
|
*TalonOne::ManagementApi* | [**import_account_collection**](docs/ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
323
327
|
*TalonOne::ManagementApi* | [**import_allowed_list**](docs/ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
324
328
|
*TalonOne::ManagementApi* | [**import_audiences_memberships**](docs/ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
|
329
|
+
*TalonOne::ManagementApi* | [**import_campaign_store_budget**](docs/ManagementApi.md#import_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import | Import campaign store budgets
|
325
330
|
*TalonOne::ManagementApi* | [**import_campaign_stores**](docs/ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
|
326
331
|
*TalonOne::ManagementApi* | [**import_collection**](docs/ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
|
327
332
|
*TalonOne::ManagementApi* | [**import_coupons**](docs/ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
|
@@ -334,28 +339,32 @@ Class | Method | HTTP request | Description
|
|
334
339
|
*TalonOne::ManagementApi* | [**list_account_collections**](docs/ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
335
340
|
*TalonOne::ManagementApi* | [**list_achievements**](docs/ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
336
341
|
*TalonOne::ManagementApi* | [**list_all_roles_v2**](docs/ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
342
|
+
*TalonOne::ManagementApi* | [**list_campaign_store_budget_limits**](docs/ManagementApi.md#list_campaign_store_budget_limits) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
|
337
343
|
*TalonOne::ManagementApi* | [**list_catalog_items**](docs/ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
|
338
344
|
*TalonOne::ManagementApi* | [**list_collections**](docs/ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
339
345
|
*TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
340
346
|
*TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
341
|
-
*TalonOne::ManagementApi* | [**notification_activation**](docs/ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
|
342
347
|
*TalonOne::ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
343
|
-
*TalonOne::ManagementApi* | [**post_added_deducted_points_notification**](docs/ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
|
344
|
-
*TalonOne::ManagementApi* | [**post_catalogs_strikethrough_notification**](docs/ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
345
|
-
*TalonOne::ManagementApi* | [**post_pending_points_notification**](docs/ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
|
346
348
|
*TalonOne::ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
347
349
|
*TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
350
|
+
*TalonOne::ManagementApi* | [**scim_create_group**](docs/ManagementApi.md#scim_create_group) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
|
348
351
|
*TalonOne::ManagementApi* | [**scim_create_user**](docs/ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
352
|
+
*TalonOne::ManagementApi* | [**scim_delete_group**](docs/ManagementApi.md#scim_delete_group) | **DELETE** /v1/provisioning/scim/Groups/{groupId} | Delete SCIM group
|
349
353
|
*TalonOne::ManagementApi* | [**scim_delete_user**](docs/ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
|
354
|
+
*TalonOne::ManagementApi* | [**scim_get_group**](docs/ManagementApi.md#scim_get_group) | **GET** /v1/provisioning/scim/Groups/{groupId} | Get SCIM group
|
355
|
+
*TalonOne::ManagementApi* | [**scim_get_groups**](docs/ManagementApi.md#scim_get_groups) | **GET** /v1/provisioning/scim/Groups | List SCIM groups
|
350
356
|
*TalonOne::ManagementApi* | [**scim_get_resource_types**](docs/ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
|
351
357
|
*TalonOne::ManagementApi* | [**scim_get_schemas**](docs/ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
|
352
358
|
*TalonOne::ManagementApi* | [**scim_get_service_provider_config**](docs/ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
|
353
359
|
*TalonOne::ManagementApi* | [**scim_get_user**](docs/ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
|
354
360
|
*TalonOne::ManagementApi* | [**scim_get_users**](docs/ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
|
361
|
+
*TalonOne::ManagementApi* | [**scim_patch_group**](docs/ManagementApi.md#scim_patch_group) | **PATCH** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group attributes
|
355
362
|
*TalonOne::ManagementApi* | [**scim_patch_user**](docs/ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
|
363
|
+
*TalonOne::ManagementApi* | [**scim_replace_group_attributes**](docs/ManagementApi.md#scim_replace_group_attributes) | **PUT** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group
|
356
364
|
*TalonOne::ManagementApi* | [**scim_replace_user_attributes**](docs/ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
|
357
365
|
*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 | List coupons that match the given attributes (without total count)
|
358
366
|
*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 | List coupons that match the given attributes in campaign (without total count)
|
367
|
+
*TalonOne::ManagementApi* | [**summarize_campaign_store_budget**](docs/ManagementApi.md#summarize_campaign_store_budget) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary | Get summary of campaign store budgets
|
359
368
|
*TalonOne::ManagementApi* | [**transfer_loyalty_card**](docs/ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
360
369
|
*TalonOne::ManagementApi* | [**update_account_collection**](docs/ManagementApi.md#update_account_collection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
|
361
370
|
*TalonOne::ManagementApi* | [**update_achievement**](docs/ManagementApi.md#update_achievement) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement
|
@@ -398,7 +407,9 @@ Class | Method | HTTP request | Description
|
|
398
407
|
- [TalonOne::AddItemCatalogAction](docs/AddItemCatalogAction.md)
|
399
408
|
- [TalonOne::AddLoyaltyPoints](docs/AddLoyaltyPoints.md)
|
400
409
|
- [TalonOne::AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md)
|
410
|
+
- [TalonOne::AddPriceAdjustmentCatalogAction](docs/AddPriceAdjustmentCatalogAction.md)
|
401
411
|
- [TalonOne::AddToAudienceEffectProps](docs/AddToAudienceEffectProps.md)
|
412
|
+
- [TalonOne::AddedDeductedPointsBalancesNotificationPolicy](docs/AddedDeductedPointsBalancesNotificationPolicy.md)
|
402
413
|
- [TalonOne::AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md)
|
403
414
|
- [TalonOne::AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md)
|
404
415
|
- [TalonOne::AdditionalCost](docs/AdditionalCost.md)
|
@@ -457,6 +468,7 @@ Class | Method | HTTP request | Description
|
|
457
468
|
- [TalonOne::CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md)
|
458
469
|
- [TalonOne::CampaignCopy](docs/CampaignCopy.md)
|
459
470
|
- [TalonOne::CampaignCreatedNotification](docs/CampaignCreatedNotification.md)
|
471
|
+
- [TalonOne::CampaignDeactivationRequest](docs/CampaignDeactivationRequest.md)
|
460
472
|
- [TalonOne::CampaignDeletedNotification](docs/CampaignDeletedNotification.md)
|
461
473
|
- [TalonOne::CampaignDetail](docs/CampaignDetail.md)
|
462
474
|
- [TalonOne::CampaignEditedNotification](docs/CampaignEditedNotification.md)
|
@@ -482,6 +494,7 @@ Class | Method | HTTP request | Description
|
|
482
494
|
- [TalonOne::CampaignTemplateCouponReservationSettings](docs/CampaignTemplateCouponReservationSettings.md)
|
483
495
|
- [TalonOne::CampaignTemplateParams](docs/CampaignTemplateParams.md)
|
484
496
|
- [TalonOne::CampaignVersions](docs/CampaignVersions.md)
|
497
|
+
- [TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy](docs/CardAddedDeductedPointsBalancesNotificationPolicy.md)
|
485
498
|
- [TalonOne::CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md)
|
486
499
|
- [TalonOne::CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md)
|
487
500
|
- [TalonOne::CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md)
|
@@ -508,6 +521,7 @@ Class | Method | HTTP request | Description
|
|
508
521
|
- [TalonOne::CouponCreationJob](docs/CouponCreationJob.md)
|
509
522
|
- [TalonOne::CouponDeletionFilters](docs/CouponDeletionFilters.md)
|
510
523
|
- [TalonOne::CouponDeletionJob](docs/CouponDeletionJob.md)
|
524
|
+
- [TalonOne::CouponEntity](docs/CouponEntity.md)
|
511
525
|
- [TalonOne::CouponLimitConfigs](docs/CouponLimitConfigs.md)
|
512
526
|
- [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md)
|
513
527
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
@@ -527,15 +541,16 @@ Class | Method | HTTP request | Description
|
|
527
541
|
- [TalonOne::CustomerProfile](docs/CustomerProfile.md)
|
528
542
|
- [TalonOne::CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md)
|
529
543
|
- [TalonOne::CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md)
|
544
|
+
- [TalonOne::CustomerProfileEntity](docs/CustomerProfileEntity.md)
|
530
545
|
- [TalonOne::CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md)
|
531
546
|
- [TalonOne::CustomerProfileIntegrationResponseV2](docs/CustomerProfileIntegrationResponseV2.md)
|
532
547
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
533
548
|
- [TalonOne::CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md)
|
534
549
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
535
550
|
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
536
|
-
- [TalonOne::DeactivateUserRequest](docs/DeactivateUserRequest.md)
|
537
551
|
- [TalonOne::DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md)
|
538
552
|
- [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
|
553
|
+
- [TalonOne::DeleteUserRequest](docs/DeleteUserRequest.md)
|
539
554
|
- [TalonOne::Effect](docs/Effect.md)
|
540
555
|
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
541
556
|
- [TalonOne::EmailEntity](docs/EmailEntity.md)
|
@@ -556,6 +571,7 @@ Class | Method | HTTP request | Description
|
|
556
571
|
- [TalonOne::ExpiringPointsNotificationPolicy](docs/ExpiringPointsNotificationPolicy.md)
|
557
572
|
- [TalonOne::ExpiringPointsNotificationTrigger](docs/ExpiringPointsNotificationTrigger.md)
|
558
573
|
- [TalonOne::Export](docs/Export.md)
|
574
|
+
- [TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps](docs/ExtendLoyaltyPointsExpiryDateEffectProps.md)
|
559
575
|
- [TalonOne::FeatureFlag](docs/FeatureFlag.md)
|
560
576
|
- [TalonOne::FeaturesFeed](docs/FeaturesFeed.md)
|
561
577
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
@@ -620,12 +636,16 @@ Class | Method | HTTP request | Description
|
|
620
636
|
- [TalonOne::InlineResponse20048](docs/InlineResponse20048.md)
|
621
637
|
- [TalonOne::InlineResponse20049](docs/InlineResponse20049.md)
|
622
638
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
639
|
+
- [TalonOne::InlineResponse20050](docs/InlineResponse20050.md)
|
640
|
+
- [TalonOne::InlineResponse20051](docs/InlineResponse20051.md)
|
623
641
|
- [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
|
624
642
|
- [TalonOne::InlineResponse2007](docs/InlineResponse2007.md)
|
625
643
|
- [TalonOne::InlineResponse2008](docs/InlineResponse2008.md)
|
626
644
|
- [TalonOne::InlineResponse2009](docs/InlineResponse2009.md)
|
627
645
|
- [TalonOne::InlineResponse201](docs/InlineResponse201.md)
|
628
646
|
- [TalonOne::IntegrationCoupon](docs/IntegrationCoupon.md)
|
647
|
+
- [TalonOne::IntegrationCustomerProfileAudienceRequest](docs/IntegrationCustomerProfileAudienceRequest.md)
|
648
|
+
- [TalonOne::IntegrationCustomerProfileAudienceRequestItem](docs/IntegrationCustomerProfileAudienceRequestItem.md)
|
629
649
|
- [TalonOne::IntegrationCustomerSessionResponse](docs/IntegrationCustomerSessionResponse.md)
|
630
650
|
- [TalonOne::IntegrationEntity](docs/IntegrationEntity.md)
|
631
651
|
- [TalonOne::IntegrationEvent](docs/IntegrationEvent.md)
|
@@ -738,6 +758,8 @@ Class | Method | HTTP request | Description
|
|
738
758
|
- [TalonOne::NewPassword](docs/NewPassword.md)
|
739
759
|
- [TalonOne::NewPasswordEmail](docs/NewPasswordEmail.md)
|
740
760
|
- [TalonOne::NewPicklist](docs/NewPicklist.md)
|
761
|
+
- [TalonOne::NewPriceAdjustment](docs/NewPriceAdjustment.md)
|
762
|
+
- [TalonOne::NewPriceType](docs/NewPriceType.md)
|
741
763
|
- [TalonOne::NewReferral](docs/NewReferral.md)
|
742
764
|
- [TalonOne::NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md)
|
743
765
|
- [TalonOne::NewReturn](docs/NewReturn.md)
|
@@ -772,6 +794,8 @@ Class | Method | HTTP request | Description
|
|
772
794
|
- [TalonOne::PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md)
|
773
795
|
- [TalonOne::PendingPointsNotificationPolicy](docs/PendingPointsNotificationPolicy.md)
|
774
796
|
- [TalonOne::Picklist](docs/Picklist.md)
|
797
|
+
- [TalonOne::PriceDetail](docs/PriceDetail.md)
|
798
|
+
- [TalonOne::PriceType](docs/PriceType.md)
|
775
799
|
- [TalonOne::Product](docs/Product.md)
|
776
800
|
- [TalonOne::ProductSearchMatch](docs/ProductSearchMatch.md)
|
777
801
|
- [TalonOne::ProductUnitAnalytics](docs/ProductUnitAnalytics.md)
|
@@ -795,6 +819,7 @@ Class | Method | HTTP request | Description
|
|
795
819
|
- [TalonOne::ReturnedCartItem](docs/ReturnedCartItem.md)
|
796
820
|
- [TalonOne::Revision](docs/Revision.md)
|
797
821
|
- [TalonOne::RevisionActivation](docs/RevisionActivation.md)
|
822
|
+
- [TalonOne::RevisionActivationRequest](docs/RevisionActivationRequest.md)
|
798
823
|
- [TalonOne::RevisionVersion](docs/RevisionVersion.md)
|
799
824
|
- [TalonOne::Role](docs/Role.md)
|
800
825
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
@@ -819,8 +844,12 @@ Class | Method | HTTP request | Description
|
|
819
844
|
- [TalonOne::SamlConnectionInternal](docs/SamlConnectionInternal.md)
|
820
845
|
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
821
846
|
- [TalonOne::SamlLoginEndpoint](docs/SamlLoginEndpoint.md)
|
847
|
+
- [TalonOne::ScimBaseGroup](docs/ScimBaseGroup.md)
|
822
848
|
- [TalonOne::ScimBaseUser](docs/ScimBaseUser.md)
|
823
849
|
- [TalonOne::ScimBaseUserName](docs/ScimBaseUserName.md)
|
850
|
+
- [TalonOne::ScimGroup](docs/ScimGroup.md)
|
851
|
+
- [TalonOne::ScimGroupMember](docs/ScimGroupMember.md)
|
852
|
+
- [TalonOne::ScimGroupsListResponse](docs/ScimGroupsListResponse.md)
|
824
853
|
- [TalonOne::ScimNewUser](docs/ScimNewUser.md)
|
825
854
|
- [TalonOne::ScimPatchOperation](docs/ScimPatchOperation.md)
|
826
855
|
- [TalonOne::ScimPatchRequest](docs/ScimPatchRequest.md)
|
@@ -900,6 +929,11 @@ Class | Method | HTTP request | Description
|
|
900
929
|
- [TalonOne::ValueMap](docs/ValueMap.md)
|
901
930
|
- [TalonOne::Webhook](docs/Webhook.md)
|
902
931
|
- [TalonOne::WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md)
|
932
|
+
- [TalonOne::WebhookAuthentication](docs/WebhookAuthentication.md)
|
933
|
+
- [TalonOne::WebhookAuthenticationBase](docs/WebhookAuthenticationBase.md)
|
934
|
+
- [TalonOne::WebhookAuthenticationDataBasic](docs/WebhookAuthenticationDataBasic.md)
|
935
|
+
- [TalonOne::WebhookAuthenticationDataCustom](docs/WebhookAuthenticationDataCustom.md)
|
936
|
+
- [TalonOne::WebhookAuthenticationWebhookRef](docs/WebhookAuthenticationWebhookRef.md)
|
903
937
|
- [TalonOne::WebhookLogEntry](docs/WebhookLogEntry.md)
|
904
938
|
- [TalonOne::WebhookWithOutgoingIntegrationDetails](docs/WebhookWithOutgoingIntegrationDetails.md)
|
905
939
|
- [TalonOne::WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md)
|
data/docs/Account.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
10
10
|
**company_name** | **String** | |
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**name** | **String** | The internal name used in API requests. |
|
data/docs/Achievement.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
|
10
10
|
**title** | **String** | The display name for the achievement in the Campaign Manager. |
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
|
13
13
|
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
14
14
|
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
15
|
-
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
|
15
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
16
16
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
17
17
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
18
18
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# TalonOne::AchievementBase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | [optional]
|
8
|
+
**title** | **String** | The display name for the achievement in the Campaign Manager. | [optional]
|
9
|
+
**description** | **String** | A description of the achievement. | [optional]
|
10
|
+
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
11
|
+
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
12
|
+
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
13
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
14
|
+
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
15
|
+
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
16
|
+
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'TalonOne'
|
22
|
+
|
23
|
+
instance = TalonOne::AchievementBase.new(name: Order50Discount,
|
24
|
+
title: 50% off on 50th purchase.,
|
25
|
+
description: 50% off for every 50th purchase in a year.,
|
26
|
+
target: 50.0,
|
27
|
+
period: 1Y,
|
28
|
+
period_end_override: null,
|
29
|
+
recurrence_policy: no_recurrence,
|
30
|
+
activation_policy: fixed_schedule,
|
31
|
+
fixed_start_date: null,
|
32
|
+
end_date: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# TalonOne::AchievementProgressWithDefinition
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | **String** | The status of the achievement. |
|
8
|
+
**progress** | **Float** | The current progress of the customer in the achievement. |
|
9
|
+
**start_date** | **DateTime** | Timestamp at which the customer started the achievement. | [optional]
|
10
|
+
**completion_date** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional]
|
11
|
+
**end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional]
|
12
|
+
**achievement_id** | **Integer** | The internal ID of the achievement. |
|
13
|
+
**name** | **String** | The internal name of the achievement used in API requests. |
|
14
|
+
**title** | **String** | The display name of the achievement in the Campaign Manager. |
|
15
|
+
**description** | **String** | The description of the achievement in the Campaign Manager. |
|
16
|
+
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
|
17
|
+
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
18
|
+
**achievement_recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
|
19
|
+
**achievement_activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
|
20
|
+
**achievement_fixed_start_date** | **DateTime** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
|
21
|
+
**achievement_end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
|
22
|
+
|
23
|
+
## Code Sample
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'TalonOne'
|
27
|
+
|
28
|
+
instance = TalonOne::AchievementProgressWithDefinition.new(status: completed,
|
29
|
+
progress: 10.0,
|
30
|
+
start_date: null,
|
31
|
+
completion_date: null,
|
32
|
+
end_date: null,
|
33
|
+
achievement_id: 3,
|
34
|
+
name: FreeCoffee10Orders,
|
35
|
+
title: 50% off on 50th purchase.,
|
36
|
+
description: 50% off for every 50th purchase in a year.,
|
37
|
+
campaign_id: 3,
|
38
|
+
target: 10.0,
|
39
|
+
achievement_recurrence_policy: no_recurrence,
|
40
|
+
achievement_activation_policy: fixed_schedule,
|
41
|
+
achievement_fixed_start_date: null,
|
42
|
+
achievement_end_date: null)
|
43
|
+
```
|
44
|
+
|
45
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# TalonOne::AchievementStatusEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
9
|
+
**name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
|
10
|
+
**title** | **String** | The display name for the achievement in the Campaign Manager. |
|
11
|
+
**description** | **String** | A description of the achievement. |
|
12
|
+
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
|
13
|
+
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
14
|
+
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
15
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
16
|
+
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
17
|
+
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
18
|
+
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
19
|
+
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | [optional]
|
20
|
+
**status** | **String** | The status of the achievement. | [optional]
|
21
|
+
**current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]
|
22
|
+
|
23
|
+
## Code Sample
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'TalonOne'
|
27
|
+
|
28
|
+
instance = TalonOne::AchievementStatusEntry.new(id: 6,
|
29
|
+
created: 2020-06-10T09:05:27.993483Z,
|
30
|
+
name: Order50Discount,
|
31
|
+
title: 50% off on 50th purchase.,
|
32
|
+
description: 50% off for every 50th purchase in a year.,
|
33
|
+
target: 50.0,
|
34
|
+
period: 1Y,
|
35
|
+
period_end_override: null,
|
36
|
+
recurrence_policy: no_recurrence,
|
37
|
+
activation_policy: fixed_schedule,
|
38
|
+
fixed_start_date: null,
|
39
|
+
end_date: null,
|
40
|
+
campaign_id: 1,
|
41
|
+
status: active,
|
42
|
+
current_progress: null)
|
43
|
+
```
|
44
|
+
|
45
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::AddPriceAdjustmentCatalogAction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**sku** | **String** | The SKU of the item for which the price is being adjusted. |
|
8
|
+
**adjustments** | [**Array<NewPriceAdjustment>**](NewPriceAdjustment.md) | A list of adjustments to apply to a given item. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::AddPriceAdjustmentCatalogAction.new(sku: SKU1241028,
|
16
|
+
adjustments: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::AddedDeductedPointsBalancesNotificationPolicy
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Notification name. |
|
8
|
+
**scopes** | **Array<String>** | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::AddedDeductedPointsBalancesNotificationPolicy.new(name: Christmas Sale,
|
16
|
+
scopes: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::AnalyticsSKU
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | The ID of the SKU linked to the application. |
|
8
|
+
**sku** | **String** | The SKU linked to the application. |
|
9
|
+
**last_updated** | **DateTime** | Values in UTC for the date the SKU linked to the product was last updated. | [optional]
|
10
|
+
**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::AnalyticsSKU.new(id: 1,
|
18
|
+
sku: SKU-123,
|
19
|
+
last_updated: 2024-02-01T00:00Z,
|
20
|
+
units_sold: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/Application.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
10
10
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
data/docs/ApplicationCIF.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**name** | **String** | The name of the Application cart item filter used in API requests. |
|
10
10
|
**description** | **String** | A short description of the Application cart item filter. | [optional]
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional]
|
10
10
|
**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::ApplicationCIFReferences
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**application_cart_item_filter_id** | **Integer** | The ID of the Application Cart Item Filter that is referenced by a campaign. | [optional]
|
8
|
+
**campaigns** | [**Array<CampaignDetail>**](CampaignDetail.md) | Campaigns that reference a speciifc Application Cart Item Filter. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::ApplicationCIFReferences.new(application_cart_item_filter_id: 322,
|
16
|
+
campaigns: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/ApplicationCustomer.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
10
10
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
11
11
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
12
|
-
**closed_sessions** | **Integer** | The total
|
12
|
+
**closed_sessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
|
13
13
|
**total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
|
14
14
|
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
|
15
15
|
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
|
data/docs/ApplicationEvent.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
10
10
|
**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
|
data/docs/ApplicationSession.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
10
10
|
**store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
|
data/docs/Attribute.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**entity** | **String** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. |
|
data/docs/Audience.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
8
|
-
**id** | **Integer** |
|
8
|
+
**id** | **Integer** | The internal ID of this entity. |
|
9
9
|
**created** | **DateTime** | The time this entity was created. |
|
10
10
|
**name** | **String** | The human-friendly display name for this audience. |
|
11
11
|
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
|
data/docs/AudienceCustomer.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
10
10
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
11
11
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
12
|
-
**closed_sessions** | **Integer** | The total
|
12
|
+
**closed_sessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
|
13
13
|
**total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
|
14
14
|
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
|
15
15
|
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
|