talon_one 9.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 +39 -3
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/Achievement.md +2 -2
- data/docs/AchievementBase.md +1 -1
- data/docs/AchievementProgressWithDefinition.md +1 -1
- data/docs/AchievementStatusEntry.md +2 -2
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- 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/CampaignGroup.md +1 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +1 -1
- 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/Import.md +1 -1
- data/docs/InlineResponse20048.md +2 -4
- data/docs/InlineResponse20049.md +2 -4
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +3 -3
- 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/LoyaltyCard.md +1 -1
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +792 -29
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- 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/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/Store.md +1 -1
- 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 +6 -6
- data/lib/talon_one/api/management_api.rb +879 -11
- 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 +3 -3
- data/lib/talon_one/models/achievement_progress_with_definition.rb +3 -3
- data/lib/talon_one/models/achievement_status_entry.rb +4 -4
- 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/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_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_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_template.rb +1 -1
- 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/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/import.rb +1 -1
- data/lib/talon_one/models/inline_response20048.rb +2 -16
- data/lib/talon_one/models/inline_response20049.rb +2 -21
- 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/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- 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 +2 -2
- 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/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/store.rb +1 -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 +24 -0
- data/spec/api/integration_api_spec.rb +3 -3
- data/spec/api/management_api_spec.rb +167 -3
- 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/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/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/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/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 +100 -2
data/docs/ManagementApi.md
CHANGED
@@ -14,6 +14,7 @@ Method | HTTP request | Description
|
|
14
14
|
[**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
15
15
|
[**create_batch_loyalty_cards**](ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
16
16
|
[**create_campaign_from_template**](ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
|
17
|
+
[**create_campaign_store_budget**](ManagementApi.md#create_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Create campaign store budget
|
17
18
|
[**create_collection**](ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
18
19
|
[**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
|
19
20
|
[**create_coupons_async**](ManagementApi.md#create_coupons_async) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
|
@@ -29,6 +30,7 @@ Method | HTTP request | Description
|
|
29
30
|
[**delete_account_collection**](ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
30
31
|
[**delete_achievement**](ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
31
32
|
[**delete_campaign**](ManagementApi.md#delete_campaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign
|
33
|
+
[**delete_campaign_store_budgets**](ManagementApi.md#delete_campaign_store_budgets) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Delete campaign store budgets
|
32
34
|
[**delete_collection**](ManagementApi.md#delete_collection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection
|
33
35
|
[**delete_coupon**](ManagementApi.md#delete_coupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon
|
34
36
|
[**delete_coupons**](ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons
|
@@ -42,6 +44,7 @@ Method | HTTP request | Description
|
|
42
44
|
[**export_account_collection_items**](ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
|
43
45
|
[**export_achievements**](ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
44
46
|
[**export_audiences_memberships**](ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
|
47
|
+
[**export_campaign_store_budgets**](ManagementApi.md#export_campaign_store_budgets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export | Export campaign store budgets
|
45
48
|
[**export_campaign_stores**](ManagementApi.md#export_campaign_stores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
|
46
49
|
[**export_collection_items**](ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
|
47
50
|
[**export_coupons**](ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
|
@@ -123,6 +126,7 @@ Method | HTTP request | Description
|
|
123
126
|
[**import_account_collection**](ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
124
127
|
[**import_allowed_list**](ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
125
128
|
[**import_audiences_memberships**](ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
|
129
|
+
[**import_campaign_store_budget**](ManagementApi.md#import_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import | Import campaign store budgets
|
126
130
|
[**import_campaign_stores**](ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
|
127
131
|
[**import_collection**](ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
|
128
132
|
[**import_coupons**](ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
|
@@ -135,6 +139,7 @@ Method | HTTP request | Description
|
|
135
139
|
[**list_account_collections**](ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
136
140
|
[**list_achievements**](ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
137
141
|
[**list_all_roles_v2**](ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
142
|
+
[**list_campaign_store_budget_limits**](ManagementApi.md#list_campaign_store_budget_limits) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
|
138
143
|
[**list_catalog_items**](ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
|
139
144
|
[**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
140
145
|
[**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
@@ -142,17 +147,24 @@ Method | HTTP request | Description
|
|
142
147
|
[**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
143
148
|
[**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
144
149
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
150
|
+
[**scim_create_group**](ManagementApi.md#scim_create_group) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
|
145
151
|
[**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
152
|
+
[**scim_delete_group**](ManagementApi.md#scim_delete_group) | **DELETE** /v1/provisioning/scim/Groups/{groupId} | Delete SCIM group
|
146
153
|
[**scim_delete_user**](ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
|
154
|
+
[**scim_get_group**](ManagementApi.md#scim_get_group) | **GET** /v1/provisioning/scim/Groups/{groupId} | Get SCIM group
|
155
|
+
[**scim_get_groups**](ManagementApi.md#scim_get_groups) | **GET** /v1/provisioning/scim/Groups | List SCIM groups
|
147
156
|
[**scim_get_resource_types**](ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
|
148
157
|
[**scim_get_schemas**](ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
|
149
158
|
[**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
|
150
159
|
[**scim_get_user**](ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
|
151
160
|
[**scim_get_users**](ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
|
161
|
+
[**scim_patch_group**](ManagementApi.md#scim_patch_group) | **PATCH** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group attributes
|
152
162
|
[**scim_patch_user**](ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
|
163
|
+
[**scim_replace_group_attributes**](ManagementApi.md#scim_replace_group_attributes) | **PUT** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group
|
153
164
|
[**scim_replace_user_attributes**](ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
|
154
165
|
[**search_coupons_advanced_application_wide_without_total_count**](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)
|
155
166
|
[**search_coupons_advanced_without_total_count**](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)
|
167
|
+
[**summarize_campaign_store_budget**](ManagementApi.md#summarize_campaign_store_budget) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary | Get summary of campaign store budgets
|
156
168
|
[**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
157
169
|
[**update_account_collection**](ManagementApi.md#update_account_collection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
|
158
170
|
[**update_achievement**](ManagementApi.md#update_achievement) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement
|
@@ -777,6 +789,68 @@ Name | Type | Description | Notes
|
|
777
789
|
- **Accept**: application/json
|
778
790
|
|
779
791
|
|
792
|
+
## create_campaign_store_budget
|
793
|
+
|
794
|
+
> create_campaign_store_budget(application_id, campaign_id, body)
|
795
|
+
|
796
|
+
Create campaign store budget
|
797
|
+
|
798
|
+
Create a new store budget for a given campaign.
|
799
|
+
|
800
|
+
### Example
|
801
|
+
|
802
|
+
```ruby
|
803
|
+
# load the gem
|
804
|
+
require 'talon_one'
|
805
|
+
# setup authorization
|
806
|
+
TalonOne.configure do |config|
|
807
|
+
# Configure API key authorization: management_key
|
808
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
809
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
810
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
811
|
+
|
812
|
+
# Configure API key authorization: manager_auth
|
813
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
814
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
815
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
816
|
+
end
|
817
|
+
|
818
|
+
api_instance = TalonOne::ManagementApi.new
|
819
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
820
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
821
|
+
body = TalonOne::NewCampaignStoreBudget.new # NewCampaignStoreBudget | body
|
822
|
+
|
823
|
+
begin
|
824
|
+
#Create campaign store budget
|
825
|
+
api_instance.create_campaign_store_budget(application_id, campaign_id, body)
|
826
|
+
rescue TalonOne::ApiError => e
|
827
|
+
puts "Exception when calling ManagementApi->create_campaign_store_budget: #{e}"
|
828
|
+
end
|
829
|
+
```
|
830
|
+
|
831
|
+
### Parameters
|
832
|
+
|
833
|
+
|
834
|
+
Name | Type | Description | Notes
|
835
|
+
------------- | ------------- | ------------- | -------------
|
836
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
837
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
838
|
+
**body** | [**NewCampaignStoreBudget**](NewCampaignStoreBudget.md)| body |
|
839
|
+
|
840
|
+
### Return type
|
841
|
+
|
842
|
+
nil (empty response body)
|
843
|
+
|
844
|
+
### Authorization
|
845
|
+
|
846
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
847
|
+
|
848
|
+
### HTTP request headers
|
849
|
+
|
850
|
+
- **Content-Type**: application/json
|
851
|
+
- **Accept**: application/json
|
852
|
+
|
853
|
+
|
780
854
|
## create_collection
|
781
855
|
|
782
856
|
> Collection create_collection(application_id, campaign_id, body)
|
@@ -1697,6 +1771,72 @@ nil (empty response body)
|
|
1697
1771
|
- **Accept**: Not defined
|
1698
1772
|
|
1699
1773
|
|
1774
|
+
## delete_campaign_store_budgets
|
1775
|
+
|
1776
|
+
> delete_campaign_store_budgets(application_id, campaign_id, opts)
|
1777
|
+
|
1778
|
+
Delete campaign store budgets
|
1779
|
+
|
1780
|
+
Delete the store budgets for a given campaign.
|
1781
|
+
|
1782
|
+
### Example
|
1783
|
+
|
1784
|
+
```ruby
|
1785
|
+
# load the gem
|
1786
|
+
require 'talon_one'
|
1787
|
+
# setup authorization
|
1788
|
+
TalonOne.configure do |config|
|
1789
|
+
# Configure API key authorization: management_key
|
1790
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1791
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1792
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1793
|
+
|
1794
|
+
# Configure API key authorization: manager_auth
|
1795
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1796
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1797
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
api_instance = TalonOne::ManagementApi.new
|
1801
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1802
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1803
|
+
opts = {
|
1804
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
1805
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
1806
|
+
}
|
1807
|
+
|
1808
|
+
begin
|
1809
|
+
#Delete campaign store budgets
|
1810
|
+
api_instance.delete_campaign_store_budgets(application_id, campaign_id, opts)
|
1811
|
+
rescue TalonOne::ApiError => e
|
1812
|
+
puts "Exception when calling ManagementApi->delete_campaign_store_budgets: #{e}"
|
1813
|
+
end
|
1814
|
+
```
|
1815
|
+
|
1816
|
+
### Parameters
|
1817
|
+
|
1818
|
+
|
1819
|
+
Name | Type | Description | Notes
|
1820
|
+
------------- | ------------- | ------------- | -------------
|
1821
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
1822
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
1823
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
1824
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
1825
|
+
|
1826
|
+
### Return type
|
1827
|
+
|
1828
|
+
nil (empty response body)
|
1829
|
+
|
1830
|
+
### Authorization
|
1831
|
+
|
1832
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
1833
|
+
|
1834
|
+
### HTTP request headers
|
1835
|
+
|
1836
|
+
- **Content-Type**: Not defined
|
1837
|
+
- **Accept**: application/json
|
1838
|
+
|
1839
|
+
|
1700
1840
|
## delete_collection
|
1701
1841
|
|
1702
1842
|
> delete_collection(application_id, campaign_id, collection_id)
|
@@ -2502,6 +2642,73 @@ Name | Type | Description | Notes
|
|
2502
2642
|
- **Accept**: application/csv
|
2503
2643
|
|
2504
2644
|
|
2645
|
+
## export_campaign_store_budgets
|
2646
|
+
|
2647
|
+
> String export_campaign_store_budgets(application_id, campaign_id, opts)
|
2648
|
+
|
2649
|
+
Export campaign store budgets
|
2650
|
+
|
2651
|
+
Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
|
2652
|
+
|
2653
|
+
### Example
|
2654
|
+
|
2655
|
+
```ruby
|
2656
|
+
# load the gem
|
2657
|
+
require 'talon_one'
|
2658
|
+
# setup authorization
|
2659
|
+
TalonOne.configure do |config|
|
2660
|
+
# Configure API key authorization: management_key
|
2661
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2662
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2663
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2664
|
+
|
2665
|
+
# Configure API key authorization: manager_auth
|
2666
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2667
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2668
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2669
|
+
end
|
2670
|
+
|
2671
|
+
api_instance = TalonOne::ManagementApi.new
|
2672
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2673
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2674
|
+
opts = {
|
2675
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
2676
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
2677
|
+
}
|
2678
|
+
|
2679
|
+
begin
|
2680
|
+
#Export campaign store budgets
|
2681
|
+
result = api_instance.export_campaign_store_budgets(application_id, campaign_id, opts)
|
2682
|
+
p result
|
2683
|
+
rescue TalonOne::ApiError => e
|
2684
|
+
puts "Exception when calling ManagementApi->export_campaign_store_budgets: #{e}"
|
2685
|
+
end
|
2686
|
+
```
|
2687
|
+
|
2688
|
+
### Parameters
|
2689
|
+
|
2690
|
+
|
2691
|
+
Name | Type | Description | Notes
|
2692
|
+
------------- | ------------- | ------------- | -------------
|
2693
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2694
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
2695
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
2696
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
2697
|
+
|
2698
|
+
### Return type
|
2699
|
+
|
2700
|
+
**String**
|
2701
|
+
|
2702
|
+
### Authorization
|
2703
|
+
|
2704
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
2705
|
+
|
2706
|
+
### HTTP request headers
|
2707
|
+
|
2708
|
+
- **Content-Type**: Not defined
|
2709
|
+
- **Accept**: application/csv
|
2710
|
+
|
2711
|
+
|
2505
2712
|
## export_campaign_stores
|
2506
2713
|
|
2507
2714
|
> String export_campaign_stores(application_id, campaign_id)
|
@@ -2721,7 +2928,7 @@ Name | Type | Description | Notes
|
|
2721
2928
|
|
2722
2929
|
Export customer sessions
|
2723
2930
|
|
2724
|
-
Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/
|
2931
|
+
Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
|
2725
2932
|
|
2726
2933
|
### Example
|
2727
2934
|
|
@@ -3208,6 +3415,8 @@ api_instance = TalonOne::ManagementApi.new
|
|
3208
3415
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
3209
3416
|
opts = {
|
3210
3417
|
batch_id: 'batch_id_example', # String | Filter results by loyalty card batch ID.
|
3418
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
3419
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
3211
3420
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
3212
3421
|
}
|
3213
3422
|
|
@@ -3227,6 +3436,8 @@ Name | Type | Description | Notes
|
|
3227
3436
|
------------- | ------------- | ------------- | -------------
|
3228
3437
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
3229
3438
|
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
3439
|
+
**created_before** | **DateTime**| Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional]
|
3440
|
+
**created_after** | **DateTime**| Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional]
|
3230
3441
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
3231
3442
|
|
3232
3443
|
### Return type
|
@@ -6040,7 +6251,7 @@ Name | Type | Description | Notes
|
|
6040
6251
|
|
6041
6252
|
## get_customer_profile_achievement_progress
|
6042
6253
|
|
6043
|
-
>
|
6254
|
+
> InlineResponse20051 get_customer_profile_achievement_progress(application_id, integration_id, opts)
|
6044
6255
|
|
6045
6256
|
List customer achievements
|
6046
6257
|
|
@@ -6097,7 +6308,7 @@ Name | Type | Description | Notes
|
|
6097
6308
|
|
6098
6309
|
### Return type
|
6099
6310
|
|
6100
|
-
[**
|
6311
|
+
[**InlineResponse20051**](InlineResponse20051.md)
|
6101
6312
|
|
6102
6313
|
### Authorization
|
6103
6314
|
|
@@ -7983,6 +8194,75 @@ Name | Type | Description | Notes
|
|
7983
8194
|
- **Accept**: application/json
|
7984
8195
|
|
7985
8196
|
|
8197
|
+
## import_campaign_store_budget
|
8198
|
+
|
8199
|
+
> Import import_campaign_store_budget(application_id, campaign_id, opts)
|
8200
|
+
|
8201
|
+
Import campaign store budgets
|
8202
|
+
|
8203
|
+
Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
|
8204
|
+
|
8205
|
+
### Example
|
8206
|
+
|
8207
|
+
```ruby
|
8208
|
+
# load the gem
|
8209
|
+
require 'talon_one'
|
8210
|
+
# setup authorization
|
8211
|
+
TalonOne.configure do |config|
|
8212
|
+
# Configure API key authorization: management_key
|
8213
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8215
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8216
|
+
|
8217
|
+
# Configure API key authorization: manager_auth
|
8218
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8219
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8220
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8221
|
+
end
|
8222
|
+
|
8223
|
+
api_instance = TalonOne::ManagementApi.new
|
8224
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
8225
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
8226
|
+
opts = {
|
8227
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
8228
|
+
period: 'period_example', # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
8229
|
+
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
8230
|
+
}
|
8231
|
+
|
8232
|
+
begin
|
8233
|
+
#Import campaign store budgets
|
8234
|
+
result = api_instance.import_campaign_store_budget(application_id, campaign_id, opts)
|
8235
|
+
p result
|
8236
|
+
rescue TalonOne::ApiError => e
|
8237
|
+
puts "Exception when calling ManagementApi->import_campaign_store_budget: #{e}"
|
8238
|
+
end
|
8239
|
+
```
|
8240
|
+
|
8241
|
+
### Parameters
|
8242
|
+
|
8243
|
+
|
8244
|
+
Name | Type | Description | Notes
|
8245
|
+
------------- | ------------- | ------------- | -------------
|
8246
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8247
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
8248
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
8249
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
8250
|
+
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
8251
|
+
|
8252
|
+
### Return type
|
8253
|
+
|
8254
|
+
[**Import**](Import.md)
|
8255
|
+
|
8256
|
+
### Authorization
|
8257
|
+
|
8258
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
8259
|
+
|
8260
|
+
### HTTP request headers
|
8261
|
+
|
8262
|
+
- **Content-Type**: multipart/form-data
|
8263
|
+
- **Accept**: application/json
|
8264
|
+
|
8265
|
+
|
7986
8266
|
## import_campaign_stores
|
7987
8267
|
|
7988
8268
|
> Import import_campaign_stores(application_id, campaign_id, opts)
|
@@ -8337,6 +8617,7 @@ end
|
|
8337
8617
|
api_instance = TalonOne::ManagementApi.new
|
8338
8618
|
loyalty_program_id = 56 # Integer | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
8339
8619
|
opts = {
|
8620
|
+
notifications_enabled: true, # Boolean | Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
|
8340
8621
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
8341
8622
|
}
|
8342
8623
|
|
@@ -8355,6 +8636,7 @@ end
|
|
8355
8636
|
Name | Type | Description | Notes
|
8356
8637
|
------------- | ------------- | ------------- | -------------
|
8357
8638
|
**loyalty_program_id** | **Integer**| Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
8639
|
+
**notifications_enabled** | **Boolean**| Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`. | [optional]
|
8358
8640
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
8359
8641
|
|
8360
8642
|
### Return type
|
@@ -8628,7 +8910,7 @@ Name | Type | Description | Notes
|
|
8628
8910
|
|
8629
8911
|
## list_achievements
|
8630
8912
|
|
8631
|
-
>
|
8913
|
+
> InlineResponse20050 list_achievements(application_id, campaign_id, opts)
|
8632
8914
|
|
8633
8915
|
List achievements
|
8634
8916
|
|
@@ -8683,7 +8965,7 @@ Name | Type | Description | Notes
|
|
8683
8965
|
|
8684
8966
|
### Return type
|
8685
8967
|
|
8686
|
-
[**
|
8968
|
+
[**InlineResponse20050**](InlineResponse20050.md)
|
8687
8969
|
|
8688
8970
|
### Authorization
|
8689
8971
|
|
@@ -8750,13 +9032,13 @@ This endpoint does not need any parameter.
|
|
8750
9032
|
- **Accept**: application/json
|
8751
9033
|
|
8752
9034
|
|
8753
|
-
##
|
9035
|
+
## list_campaign_store_budget_limits
|
8754
9036
|
|
8755
|
-
>
|
9037
|
+
> InlineResponse20048 list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
8756
9038
|
|
8757
|
-
List
|
9039
|
+
List campaign store budget limits
|
8758
9040
|
|
8759
|
-
Return
|
9041
|
+
Return the store budget limits for a given campaign.
|
8760
9042
|
|
8761
9043
|
### Example
|
8762
9044
|
|
@@ -8777,21 +9059,19 @@ TalonOne.configure do |config|
|
|
8777
9059
|
end
|
8778
9060
|
|
8779
9061
|
api_instance = TalonOne::ManagementApi.new
|
8780
|
-
|
9062
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
9063
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
8781
9064
|
opts = {
|
8782
|
-
|
8783
|
-
|
8784
|
-
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8785
|
-
sku: ['sku_example'], # Array<String> | Filter results by one or more SKUs. Must be exact match.
|
8786
|
-
product_names: ['product_names_example'] # Array<String> | Filter results by one or more product names. Must be exact match.
|
9065
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
9066
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
8787
9067
|
}
|
8788
9068
|
|
8789
9069
|
begin
|
8790
|
-
#List
|
8791
|
-
result = api_instance.
|
9070
|
+
#List campaign store budget limits
|
9071
|
+
result = api_instance.list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
8792
9072
|
p result
|
8793
9073
|
rescue TalonOne::ApiError => e
|
8794
|
-
puts "Exception when calling ManagementApi->
|
9074
|
+
puts "Exception when calling ManagementApi->list_campaign_store_budget_limits: #{e}"
|
8795
9075
|
end
|
8796
9076
|
```
|
8797
9077
|
|
@@ -8800,16 +9080,14 @@ end
|
|
8800
9080
|
|
8801
9081
|
Name | Type | Description | Notes
|
8802
9082
|
------------- | ------------- | ------------- | -------------
|
8803
|
-
**
|
8804
|
-
**
|
8805
|
-
**
|
8806
|
-
**
|
8807
|
-
**sku** | [**Array<String>**](String.md)| Filter results by one or more SKUs. Must be exact match. | [optional]
|
8808
|
-
**product_names** | [**Array<String>**](String.md)| Filter results by one or more product names. Must be exact match. | [optional]
|
9083
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
9084
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
9085
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
9086
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
8809
9087
|
|
8810
9088
|
### Return type
|
8811
9089
|
|
8812
|
-
[**
|
9090
|
+
[**InlineResponse20048**](InlineResponse20048.md)
|
8813
9091
|
|
8814
9092
|
### Authorization
|
8815
9093
|
|
@@ -8821,13 +9099,84 @@ Name | Type | Description | Notes
|
|
8821
9099
|
- **Accept**: application/json
|
8822
9100
|
|
8823
9101
|
|
8824
|
-
##
|
9102
|
+
## list_catalog_items
|
8825
9103
|
|
8826
|
-
>
|
9104
|
+
> InlineResponse20037 list_catalog_items(catalog_id, opts)
|
8827
9105
|
|
8828
|
-
List
|
9106
|
+
List items in a catalog
|
8829
9107
|
|
8830
|
-
|
9108
|
+
Return a paginated list of cart items in the given catalog.
|
9109
|
+
|
9110
|
+
### Example
|
9111
|
+
|
9112
|
+
```ruby
|
9113
|
+
# load the gem
|
9114
|
+
require 'talon_one'
|
9115
|
+
# setup authorization
|
9116
|
+
TalonOne.configure do |config|
|
9117
|
+
# Configure API key authorization: management_key
|
9118
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9119
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9120
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9121
|
+
|
9122
|
+
# Configure API key authorization: manager_auth
|
9123
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9124
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9125
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9126
|
+
end
|
9127
|
+
|
9128
|
+
api_instance = TalonOne::ManagementApi.new
|
9129
|
+
catalog_id = 56 # Integer | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
9130
|
+
opts = {
|
9131
|
+
page_size: 1000, # Integer | The number of items in the response.
|
9132
|
+
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
9133
|
+
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
9134
|
+
sku: ['sku_example'], # Array<String> | Filter results by one or more SKUs. Must be exact match.
|
9135
|
+
product_names: ['product_names_example'] # Array<String> | Filter results by one or more product names. Must be exact match.
|
9136
|
+
}
|
9137
|
+
|
9138
|
+
begin
|
9139
|
+
#List items in a catalog
|
9140
|
+
result = api_instance.list_catalog_items(catalog_id, opts)
|
9141
|
+
p result
|
9142
|
+
rescue TalonOne::ApiError => e
|
9143
|
+
puts "Exception when calling ManagementApi->list_catalog_items: #{e}"
|
9144
|
+
end
|
9145
|
+
```
|
9146
|
+
|
9147
|
+
### Parameters
|
9148
|
+
|
9149
|
+
|
9150
|
+
Name | Type | Description | Notes
|
9151
|
+
------------- | ------------- | ------------- | -------------
|
9152
|
+
**catalog_id** | **Integer**| The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. |
|
9153
|
+
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
9154
|
+
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
9155
|
+
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
9156
|
+
**sku** | [**Array<String>**](String.md)| Filter results by one or more SKUs. Must be exact match. | [optional]
|
9157
|
+
**product_names** | [**Array<String>**](String.md)| Filter results by one or more product names. Must be exact match. | [optional]
|
9158
|
+
|
9159
|
+
### Return type
|
9160
|
+
|
9161
|
+
[**InlineResponse20037**](InlineResponse20037.md)
|
9162
|
+
|
9163
|
+
### Authorization
|
9164
|
+
|
9165
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9166
|
+
|
9167
|
+
### HTTP request headers
|
9168
|
+
|
9169
|
+
- **Content-Type**: Not defined
|
9170
|
+
- **Accept**: application/json
|
9171
|
+
|
9172
|
+
|
9173
|
+
## list_collections
|
9174
|
+
|
9175
|
+
> InlineResponse20020 list_collections(application_id, campaign_id, opts)
|
9176
|
+
|
9177
|
+
List collections in campaign
|
9178
|
+
|
9179
|
+
List collections in a given campaign.
|
8831
9180
|
|
8832
9181
|
### Example
|
8833
9182
|
|
@@ -9217,6 +9566,65 @@ Name | Type | Description | Notes
|
|
9217
9566
|
- **Accept**: application/json
|
9218
9567
|
|
9219
9568
|
|
9569
|
+
## scim_create_group
|
9570
|
+
|
9571
|
+
> ScimGroup scim_create_group(body)
|
9572
|
+
|
9573
|
+
Create SCIM group
|
9574
|
+
|
9575
|
+
Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
9576
|
+
|
9577
|
+
### Example
|
9578
|
+
|
9579
|
+
```ruby
|
9580
|
+
# load the gem
|
9581
|
+
require 'talon_one'
|
9582
|
+
# setup authorization
|
9583
|
+
TalonOne.configure do |config|
|
9584
|
+
# Configure API key authorization: management_key
|
9585
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9586
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9587
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9588
|
+
|
9589
|
+
# Configure API key authorization: manager_auth
|
9590
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9591
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9592
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9593
|
+
end
|
9594
|
+
|
9595
|
+
api_instance = TalonOne::ManagementApi.new
|
9596
|
+
body = TalonOne::ScimBaseGroup.new # ScimBaseGroup | body
|
9597
|
+
|
9598
|
+
begin
|
9599
|
+
#Create SCIM group
|
9600
|
+
result = api_instance.scim_create_group(body)
|
9601
|
+
p result
|
9602
|
+
rescue TalonOne::ApiError => e
|
9603
|
+
puts "Exception when calling ManagementApi->scim_create_group: #{e}"
|
9604
|
+
end
|
9605
|
+
```
|
9606
|
+
|
9607
|
+
### Parameters
|
9608
|
+
|
9609
|
+
|
9610
|
+
Name | Type | Description | Notes
|
9611
|
+
------------- | ------------- | ------------- | -------------
|
9612
|
+
**body** | [**ScimBaseGroup**](ScimBaseGroup.md)| body |
|
9613
|
+
|
9614
|
+
### Return type
|
9615
|
+
|
9616
|
+
[**ScimGroup**](ScimGroup.md)
|
9617
|
+
|
9618
|
+
### Authorization
|
9619
|
+
|
9620
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9621
|
+
|
9622
|
+
### HTTP request headers
|
9623
|
+
|
9624
|
+
- **Content-Type**: application/json
|
9625
|
+
- **Accept**: application/json
|
9626
|
+
|
9627
|
+
|
9220
9628
|
## scim_create_user
|
9221
9629
|
|
9222
9630
|
> ScimUser scim_create_user(body)
|
@@ -9276,6 +9684,64 @@ Name | Type | Description | Notes
|
|
9276
9684
|
- **Accept**: application/json
|
9277
9685
|
|
9278
9686
|
|
9687
|
+
## scim_delete_group
|
9688
|
+
|
9689
|
+
> scim_delete_group(group_id)
|
9690
|
+
|
9691
|
+
Delete SCIM group
|
9692
|
+
|
9693
|
+
Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
9694
|
+
|
9695
|
+
### Example
|
9696
|
+
|
9697
|
+
```ruby
|
9698
|
+
# load the gem
|
9699
|
+
require 'talon_one'
|
9700
|
+
# setup authorization
|
9701
|
+
TalonOne.configure do |config|
|
9702
|
+
# Configure API key authorization: management_key
|
9703
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9704
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9705
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9706
|
+
|
9707
|
+
# Configure API key authorization: manager_auth
|
9708
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9709
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9710
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9711
|
+
end
|
9712
|
+
|
9713
|
+
api_instance = TalonOne::ManagementApi.new
|
9714
|
+
group_id = 56 # Integer | The ID of the group.
|
9715
|
+
|
9716
|
+
begin
|
9717
|
+
#Delete SCIM group
|
9718
|
+
api_instance.scim_delete_group(group_id)
|
9719
|
+
rescue TalonOne::ApiError => e
|
9720
|
+
puts "Exception when calling ManagementApi->scim_delete_group: #{e}"
|
9721
|
+
end
|
9722
|
+
```
|
9723
|
+
|
9724
|
+
### Parameters
|
9725
|
+
|
9726
|
+
|
9727
|
+
Name | Type | Description | Notes
|
9728
|
+
------------- | ------------- | ------------- | -------------
|
9729
|
+
**group_id** | **Integer**| The ID of the group. |
|
9730
|
+
|
9731
|
+
### Return type
|
9732
|
+
|
9733
|
+
nil (empty response body)
|
9734
|
+
|
9735
|
+
### Authorization
|
9736
|
+
|
9737
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9738
|
+
|
9739
|
+
### HTTP request headers
|
9740
|
+
|
9741
|
+
- **Content-Type**: Not defined
|
9742
|
+
- **Accept**: Not defined
|
9743
|
+
|
9744
|
+
|
9279
9745
|
## scim_delete_user
|
9280
9746
|
|
9281
9747
|
> scim_delete_user(user_id)
|
@@ -9334,6 +9800,120 @@ nil (empty response body)
|
|
9334
9800
|
- **Accept**: Not defined
|
9335
9801
|
|
9336
9802
|
|
9803
|
+
## scim_get_group
|
9804
|
+
|
9805
|
+
> ScimGroup scim_get_group(group_id)
|
9806
|
+
|
9807
|
+
Get SCIM group
|
9808
|
+
|
9809
|
+
Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
9810
|
+
|
9811
|
+
### Example
|
9812
|
+
|
9813
|
+
```ruby
|
9814
|
+
# load the gem
|
9815
|
+
require 'talon_one'
|
9816
|
+
# setup authorization
|
9817
|
+
TalonOne.configure do |config|
|
9818
|
+
# Configure API key authorization: management_key
|
9819
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9820
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9821
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9822
|
+
|
9823
|
+
# Configure API key authorization: manager_auth
|
9824
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9825
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9826
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9827
|
+
end
|
9828
|
+
|
9829
|
+
api_instance = TalonOne::ManagementApi.new
|
9830
|
+
group_id = 56 # Integer | The ID of the group.
|
9831
|
+
|
9832
|
+
begin
|
9833
|
+
#Get SCIM group
|
9834
|
+
result = api_instance.scim_get_group(group_id)
|
9835
|
+
p result
|
9836
|
+
rescue TalonOne::ApiError => e
|
9837
|
+
puts "Exception when calling ManagementApi->scim_get_group: #{e}"
|
9838
|
+
end
|
9839
|
+
```
|
9840
|
+
|
9841
|
+
### Parameters
|
9842
|
+
|
9843
|
+
|
9844
|
+
Name | Type | Description | Notes
|
9845
|
+
------------- | ------------- | ------------- | -------------
|
9846
|
+
**group_id** | **Integer**| The ID of the group. |
|
9847
|
+
|
9848
|
+
### Return type
|
9849
|
+
|
9850
|
+
[**ScimGroup**](ScimGroup.md)
|
9851
|
+
|
9852
|
+
### Authorization
|
9853
|
+
|
9854
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9855
|
+
|
9856
|
+
### HTTP request headers
|
9857
|
+
|
9858
|
+
- **Content-Type**: Not defined
|
9859
|
+
- **Accept**: application/json
|
9860
|
+
|
9861
|
+
|
9862
|
+
## scim_get_groups
|
9863
|
+
|
9864
|
+
> ScimGroupsListResponse scim_get_groups
|
9865
|
+
|
9866
|
+
List SCIM groups
|
9867
|
+
|
9868
|
+
Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
9869
|
+
|
9870
|
+
### Example
|
9871
|
+
|
9872
|
+
```ruby
|
9873
|
+
# load the gem
|
9874
|
+
require 'talon_one'
|
9875
|
+
# setup authorization
|
9876
|
+
TalonOne.configure do |config|
|
9877
|
+
# Configure API key authorization: management_key
|
9878
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9879
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9880
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9881
|
+
|
9882
|
+
# Configure API key authorization: manager_auth
|
9883
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9884
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9885
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9886
|
+
end
|
9887
|
+
|
9888
|
+
api_instance = TalonOne::ManagementApi.new
|
9889
|
+
|
9890
|
+
begin
|
9891
|
+
#List SCIM groups
|
9892
|
+
result = api_instance.scim_get_groups
|
9893
|
+
p result
|
9894
|
+
rescue TalonOne::ApiError => e
|
9895
|
+
puts "Exception when calling ManagementApi->scim_get_groups: #{e}"
|
9896
|
+
end
|
9897
|
+
```
|
9898
|
+
|
9899
|
+
### Parameters
|
9900
|
+
|
9901
|
+
This endpoint does not need any parameter.
|
9902
|
+
|
9903
|
+
### Return type
|
9904
|
+
|
9905
|
+
[**ScimGroupsListResponse**](ScimGroupsListResponse.md)
|
9906
|
+
|
9907
|
+
### Authorization
|
9908
|
+
|
9909
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9910
|
+
|
9911
|
+
### HTTP request headers
|
9912
|
+
|
9913
|
+
- **Content-Type**: Not defined
|
9914
|
+
- **Accept**: application/json
|
9915
|
+
|
9916
|
+
|
9337
9917
|
## scim_get_resource_types
|
9338
9918
|
|
9339
9919
|
> ScimResourceTypesListResponse scim_get_resource_types
|
@@ -9613,6 +10193,67 @@ This endpoint does not need any parameter.
|
|
9613
10193
|
- **Accept**: application/json
|
9614
10194
|
|
9615
10195
|
|
10196
|
+
## scim_patch_group
|
10197
|
+
|
10198
|
+
> ScimGroup scim_patch_group(group_id, body)
|
10199
|
+
|
10200
|
+
Update SCIM group attributes
|
10201
|
+
|
10202
|
+
Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
10203
|
+
|
10204
|
+
### Example
|
10205
|
+
|
10206
|
+
```ruby
|
10207
|
+
# load the gem
|
10208
|
+
require 'talon_one'
|
10209
|
+
# setup authorization
|
10210
|
+
TalonOne.configure do |config|
|
10211
|
+
# Configure API key authorization: management_key
|
10212
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10214
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10215
|
+
|
10216
|
+
# Configure API key authorization: manager_auth
|
10217
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10218
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10219
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10220
|
+
end
|
10221
|
+
|
10222
|
+
api_instance = TalonOne::ManagementApi.new
|
10223
|
+
group_id = 56 # Integer | The ID of the group.
|
10224
|
+
body = TalonOne::ScimPatchRequest.new # ScimPatchRequest | body
|
10225
|
+
|
10226
|
+
begin
|
10227
|
+
#Update SCIM group attributes
|
10228
|
+
result = api_instance.scim_patch_group(group_id, body)
|
10229
|
+
p result
|
10230
|
+
rescue TalonOne::ApiError => e
|
10231
|
+
puts "Exception when calling ManagementApi->scim_patch_group: #{e}"
|
10232
|
+
end
|
10233
|
+
```
|
10234
|
+
|
10235
|
+
### Parameters
|
10236
|
+
|
10237
|
+
|
10238
|
+
Name | Type | Description | Notes
|
10239
|
+
------------- | ------------- | ------------- | -------------
|
10240
|
+
**group_id** | **Integer**| The ID of the group. |
|
10241
|
+
**body** | [**ScimPatchRequest**](ScimPatchRequest.md)| body |
|
10242
|
+
|
10243
|
+
### Return type
|
10244
|
+
|
10245
|
+
[**ScimGroup**](ScimGroup.md)
|
10246
|
+
|
10247
|
+
### Authorization
|
10248
|
+
|
10249
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
10250
|
+
|
10251
|
+
### HTTP request headers
|
10252
|
+
|
10253
|
+
- **Content-Type**: application/json
|
10254
|
+
- **Accept**: application/json
|
10255
|
+
|
10256
|
+
|
9616
10257
|
## scim_patch_user
|
9617
10258
|
|
9618
10259
|
> ScimUser scim_patch_user(user_id, body)
|
@@ -9674,6 +10315,67 @@ Name | Type | Description | Notes
|
|
9674
10315
|
- **Accept**: application/json
|
9675
10316
|
|
9676
10317
|
|
10318
|
+
## scim_replace_group_attributes
|
10319
|
+
|
10320
|
+
> ScimGroup scim_replace_group_attributes(group_id, body)
|
10321
|
+
|
10322
|
+
Update SCIM group
|
10323
|
+
|
10324
|
+
Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
10325
|
+
|
10326
|
+
### Example
|
10327
|
+
|
10328
|
+
```ruby
|
10329
|
+
# load the gem
|
10330
|
+
require 'talon_one'
|
10331
|
+
# setup authorization
|
10332
|
+
TalonOne.configure do |config|
|
10333
|
+
# Configure API key authorization: management_key
|
10334
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10335
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10336
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10337
|
+
|
10338
|
+
# Configure API key authorization: manager_auth
|
10339
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10341
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10342
|
+
end
|
10343
|
+
|
10344
|
+
api_instance = TalonOne::ManagementApi.new
|
10345
|
+
group_id = 56 # Integer | The ID of the group.
|
10346
|
+
body = TalonOne::ScimBaseGroup.new # ScimBaseGroup | body
|
10347
|
+
|
10348
|
+
begin
|
10349
|
+
#Update SCIM group
|
10350
|
+
result = api_instance.scim_replace_group_attributes(group_id, body)
|
10351
|
+
p result
|
10352
|
+
rescue TalonOne::ApiError => e
|
10353
|
+
puts "Exception when calling ManagementApi->scim_replace_group_attributes: #{e}"
|
10354
|
+
end
|
10355
|
+
```
|
10356
|
+
|
10357
|
+
### Parameters
|
10358
|
+
|
10359
|
+
|
10360
|
+
Name | Type | Description | Notes
|
10361
|
+
------------- | ------------- | ------------- | -------------
|
10362
|
+
**group_id** | **Integer**| The ID of the group. |
|
10363
|
+
**body** | [**ScimBaseGroup**](ScimBaseGroup.md)| body |
|
10364
|
+
|
10365
|
+
### Return type
|
10366
|
+
|
10367
|
+
[**ScimGroup**](ScimGroup.md)
|
10368
|
+
|
10369
|
+
### Authorization
|
10370
|
+
|
10371
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
10372
|
+
|
10373
|
+
### HTTP request headers
|
10374
|
+
|
10375
|
+
- **Content-Type**: application/json
|
10376
|
+
- **Accept**: application/json
|
10377
|
+
|
10378
|
+
|
9677
10379
|
## scim_replace_user_attributes
|
9678
10380
|
|
9679
10381
|
> ScimUser scim_replace_user_attributes(user_id, body)
|
@@ -9913,6 +10615,67 @@ Name | Type | Description | Notes
|
|
9913
10615
|
- **Accept**: application/json
|
9914
10616
|
|
9915
10617
|
|
10618
|
+
## summarize_campaign_store_budget
|
10619
|
+
|
10620
|
+
> InlineResponse20049 summarize_campaign_store_budget(application_id, campaign_id)
|
10621
|
+
|
10622
|
+
Get summary of campaign store budgets
|
10623
|
+
|
10624
|
+
Fetch a summary of all store budget information for a given campaign.
|
10625
|
+
|
10626
|
+
### Example
|
10627
|
+
|
10628
|
+
```ruby
|
10629
|
+
# load the gem
|
10630
|
+
require 'talon_one'
|
10631
|
+
# setup authorization
|
10632
|
+
TalonOne.configure do |config|
|
10633
|
+
# Configure API key authorization: management_key
|
10634
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10635
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10636
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10637
|
+
|
10638
|
+
# Configure API key authorization: manager_auth
|
10639
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10640
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10641
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10642
|
+
end
|
10643
|
+
|
10644
|
+
api_instance = TalonOne::ManagementApi.new
|
10645
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10646
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
10647
|
+
|
10648
|
+
begin
|
10649
|
+
#Get summary of campaign store budgets
|
10650
|
+
result = api_instance.summarize_campaign_store_budget(application_id, campaign_id)
|
10651
|
+
p result
|
10652
|
+
rescue TalonOne::ApiError => e
|
10653
|
+
puts "Exception when calling ManagementApi->summarize_campaign_store_budget: #{e}"
|
10654
|
+
end
|
10655
|
+
```
|
10656
|
+
|
10657
|
+
### Parameters
|
10658
|
+
|
10659
|
+
|
10660
|
+
Name | Type | Description | Notes
|
10661
|
+
------------- | ------------- | ------------- | -------------
|
10662
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
10663
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
10664
|
+
|
10665
|
+
### Return type
|
10666
|
+
|
10667
|
+
[**InlineResponse20049**](InlineResponse20049.md)
|
10668
|
+
|
10669
|
+
### Authorization
|
10670
|
+
|
10671
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
10672
|
+
|
10673
|
+
### HTTP request headers
|
10674
|
+
|
10675
|
+
- **Content-Type**: Not defined
|
10676
|
+
- **Accept**: application/json
|
10677
|
+
|
10678
|
+
|
9916
10679
|
## transfer_loyalty_card
|
9917
10680
|
|
9918
10681
|
> transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|