talon_one 7.0.0 → 8.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 +24 -7
- data/docs/Achievement.md +6 -4
- data/docs/AchievementAdditionalProperties.md +5 -3
- data/docs/AchievementProgress.md +3 -15
- data/docs/AddFreeItemEffectProps.md +3 -1
- data/docs/AdditionalCampaignProperties.md +4 -2
- data/docs/AnalyticsProduct.md +6 -6
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationReferee.md +1 -1
- data/docs/ApplicationSession.md +2 -2
- data/docs/Audience.md +1 -1
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/Binding.md +1 -1
- data/docs/Campaign.md +4 -2
- data/docs/CampaignEvaluationGroup.md +1 -1
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CardExpiringPointsNotificationPolicy.md +3 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponsNotificationPolicy.md +5 -1
- data/docs/CreateAchievement.md +1 -1
- data/docs/CustomerInventory.md +1 -1
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +2 -4
- data/docs/Environment.md +1 -1
- data/docs/Event.md +1 -1
- data/docs/ExpiringCouponsNotificationPolicy.md +3 -1
- data/docs/ExpiringPointsNotificationPolicy.md +3 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +1 -1
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +3 -3
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +3 -5
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +3 -3
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +3 -5
- data/docs/InlineResponse20022.md +2 -4
- data/docs/InlineResponse20023.md +3 -5
- data/docs/InlineResponse20024.md +5 -3
- data/docs/InlineResponse20025.md +4 -2
- data/docs/InlineResponse20026.md +3 -1
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +3 -3
- data/docs/InlineResponse20029.md +1 -3
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse20030.md +2 -2
- data/docs/InlineResponse20031.md +3 -3
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +3 -3
- data/docs/InlineResponse20034.md +1 -3
- data/docs/InlineResponse20035.md +5 -3
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +5 -3
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +2 -4
- data/docs/InlineResponse20042.md +1 -1
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +4 -4
- data/docs/InlineResponse20045.md +3 -3
- data/docs/InlineResponse20046.md +3 -3
- data/docs/InlineResponse20047.md +5 -3
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +3 -3
- data/docs/IntegrationApi.md +156 -18
- data/docs/LedgerInfo.md +4 -0
- data/docs/LimitCounter.md +1 -1
- data/docs/LoyaltyBalance.md +3 -1
- data/docs/LoyaltyBalanceWithTier.md +2 -0
- data/docs/LoyaltyBalances.md +1 -1
- data/docs/LoyaltyBalancesWithTiers.md +1 -1
- data/docs/LoyaltyCardBalances.md +1 -1
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +5 -1
- data/docs/LoyaltySubLedger.md +2 -0
- data/docs/ManagementApi.md +184 -116
- data/docs/ManagementKey.md +3 -1
- data/docs/ModelReturn.md +1 -1
- data/docs/NewAudience.md +1 -1
- data/docs/NewCampaignSet.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewManagementKey.md +2 -0
- data/docs/PendingPointsNotificationPolicy.md +3 -1
- data/docs/ProductSearchMatch.md +2 -2
- data/docs/ProductUnitAnalytics.md +4 -10
- data/docs/Store.md +1 -1
- data/docs/StrikethroughEffect.md +5 -1
- data/docs/StrikethroughLabelingNotification.md +4 -2
- data/docs/SummaryCampaignStoreBudget.md +3 -1
- data/docs/TemplateDef.md +1 -1
- data/docs/TierDowngradeNotificationPolicy.md +3 -1
- data/docs/TierUpgradeNotificationPolicy.md +3 -1
- data/docs/TierWillDowngradeNotificationPolicy.md +2 -0
- data/docs/UpdateAchievement.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/lib/talon_one/api/integration_api.rb +220 -29
- data/lib/talon_one/api/management_api.rb +248 -169
- data/lib/talon_one/models/achievement.rb +27 -15
- data/lib/talon_one/models/achievement_additional_properties.rb +49 -10
- data/lib/talon_one/models/achievement_progress.rb +4 -137
- data/lib/talon_one/models/add_free_item_effect_props.rb +14 -4
- data/lib/talon_one/models/additional_campaign_properties.rb +16 -9
- data/lib/talon_one/models/analytics_product.rb +20 -21
- data/lib/talon_one/models/application_api_key.rb +2 -2
- 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_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_referee.rb +1 -1
- data/lib/talon_one/models/application_session.rb +2 -2
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/base_loyalty_program.rb +3 -3
- data/lib/talon_one/models/campaign.rb +14 -7
- data/lib/talon_one/models/campaign_evaluation_group.rb +1 -1
- data/lib/talon_one/models/campaign_notification_policy.rb +14 -4
- 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/card_expiring_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +38 -4
- data/lib/talon_one/models/coupon_creation_job.rb +1 -1
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupons_notification_policy.rb +24 -4
- data/lib/talon_one/models/create_achievement.rb +0 -5
- data/lib/talon_one/models/create_application_api_key.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +1 -1
- data/lib/talon_one/models/customer_session.rb +1 -1
- data/lib/talon_one/models/customer_session_v2.rb +5 -15
- data/lib/talon_one/models/environment.rb +1 -1
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +14 -4
- data/lib/talon_one/models/expiring_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/inline_response2001.rb +11 -11
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -11
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +1 -1
- data/lib/talon_one/models/inline_response20014.rb +1 -1
- data/lib/talon_one/models/inline_response20015.rb +11 -11
- data/lib/talon_one/models/inline_response20016.rb +11 -13
- data/lib/talon_one/models/inline_response20017.rb +7 -11
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +3 -1
- data/lib/talon_one/models/inline_response2002.rb +11 -11
- data/lib/talon_one/models/inline_response20020.rb +11 -7
- data/lib/talon_one/models/inline_response20021.rb +7 -11
- data/lib/talon_one/models/inline_response20022.rb +7 -11
- data/lib/talon_one/models/inline_response20023.rb +7 -11
- data/lib/talon_one/models/inline_response20024.rb +11 -7
- data/lib/talon_one/models/inline_response20025.rb +11 -7
- data/lib/talon_one/models/inline_response20026.rb +11 -2
- data/lib/talon_one/models/inline_response20027.rb +1 -1
- data/lib/talon_one/models/inline_response20028.rb +11 -11
- data/lib/talon_one/models/inline_response20029.rb +2 -11
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +6 -1
- data/lib/talon_one/models/inline_response20031.rb +13 -8
- data/lib/talon_one/models/inline_response20032.rb +1 -1
- data/lib/talon_one/models/inline_response20033.rb +8 -13
- data/lib/talon_one/models/inline_response20034.rb +2 -11
- data/lib/talon_one/models/inline_response20035.rb +11 -7
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +11 -7
- data/lib/talon_one/models/inline_response20038.rb +1 -1
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +7 -11
- data/lib/talon_one/models/inline_response20042.rb +1 -1
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +11 -11
- data/lib/talon_one/models/inline_response20045.rb +13 -8
- data/lib/talon_one/models/inline_response20046.rb +11 -11
- data/lib/talon_one/models/inline_response20047.rb +11 -7
- data/lib/talon_one/models/inline_response2005.rb +11 -11
- data/lib/talon_one/models/inline_response2006.rb +11 -11
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +11 -11
- data/lib/talon_one/models/ledger_info.rb +31 -1
- data/lib/talon_one/models/limit_counter.rb +1 -1
- data/lib/talon_one/models/loyalty_balance.rb +14 -4
- data/lib/talon_one/models/loyalty_balance_with_tier.rb +11 -1
- data/lib/talon_one/models/loyalty_ledger_entry.rb +13 -4
- data/lib/talon_one/models/loyalty_program.rb +3 -3
- data/lib/talon_one/models/loyalty_program_balance.rb +34 -4
- data/lib/talon_one/models/loyalty_sub_ledger.rb +16 -1
- data/lib/talon_one/models/management_key.rb +14 -4
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/new_application_api_key.rb +2 -2
- data/lib/talon_one/models/new_audience.rb +1 -1
- data/lib/talon_one/models/new_campaign_set.rb +1 -1
- data/lib/talon_one/models/new_loyalty_program.rb +3 -3
- data/lib/talon_one/models/new_management_key.rb +11 -1
- data/lib/talon_one/models/pending_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/product.rb +0 -19
- data/lib/talon_one/models/product_search_match.rb +1 -6
- data/lib/talon_one/models/product_unit_analytics.rb +21 -65
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_effect.rb +24 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +46 -2
- data/lib/talon_one/models/summary_campaign_store_budget.rb +18 -4
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +14 -4
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +14 -4
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +11 -1
- data/lib/talon_one/models/update_achievement.rb +2 -2
- data/lib/talon_one/models/update_loyalty_program.rb +3 -3
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +18 -4
- data/spec/api/integration_api_spec.rb +45 -9
- data/spec/api/management_api_spec.rb +75 -60
- data/spec/models/achievement_additional_properties_spec.rb +10 -0
- data/spec/models/achievement_base_spec.rb +103 -0
- data/spec/models/achievement_progress_spec.rb +1 -37
- data/spec/models/achievement_progress_with_definition_spec.rb +137 -0
- data/spec/models/achievement_spec.rb +10 -0
- data/spec/models/achievement_status_entry_spec.rb +137 -0
- data/spec/models/add_free_item_effect_props_spec.rb +6 -0
- data/spec/models/additional_campaign_properties_spec.rb +6 -0
- data/spec/models/analytics_product_spec.rb +3 -3
- data/spec/models/analytics_sku_spec.rb +59 -0
- data/spec/models/application_api_key_spec.rb +1 -1
- data/spec/models/application_cif_references_spec.rb +47 -0
- data/spec/models/base_loyalty_program_spec.rb +1 -1
- data/spec/models/campaign_detail_spec.rb +47 -0
- data/spec/models/campaign_notification_policy_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +6 -0
- data/spec/models/campaign_store_budget_limit_config_spec.rb +73 -0
- data/spec/models/card_expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupons_notification_policy_spec.rb +12 -0
- data/spec/models/create_application_api_key_spec.rb +1 -1
- data/spec/models/customer_session_v2_spec.rb +0 -6
- data/spec/models/expiring_coupons_notification_policy_spec.rb +6 -0
- data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/hidden_conditions_effects_spec.rb +59 -0
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +0 -6
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +6 -0
- data/spec/models/inline_response20021_spec.rb +0 -6
- data/spec/models/inline_response20022_spec.rb +0 -6
- data/spec/models/inline_response20023_spec.rb +0 -6
- data/spec/models/inline_response20024_spec.rb +6 -0
- data/spec/models/inline_response20025_spec.rb +6 -0
- data/spec/models/inline_response20026_spec.rb +6 -0
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +0 -6
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20031_spec.rb +1 -1
- data/spec/models/inline_response20033_spec.rb +1 -1
- data/spec/models/inline_response20034_spec.rb +0 -6
- data/spec/models/inline_response20035_spec.rb +6 -0
- data/spec/models/inline_response20037_spec.rb +6 -0
- data/spec/models/inline_response20041_spec.rb +0 -6
- data/spec/models/inline_response20044_spec.rb +2 -2
- data/spec/models/inline_response20045_spec.rb +1 -1
- data/spec/models/inline_response20046_spec.rb +1 -1
- data/spec/models/inline_response20047_spec.rb +6 -0
- data/spec/models/inline_response20048_spec.rb +47 -0
- data/spec/models/inline_response20049_spec.rb +47 -0
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/ledger_info_spec.rb +12 -0
- data/spec/models/loyalty_balance_spec.rb +6 -0
- data/spec/models/loyalty_balance_with_tier_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_flags_spec.rb +41 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +6 -0
- data/spec/models/loyalty_program_balance_spec.rb +12 -0
- data/spec/models/loyalty_program_spec.rb +1 -1
- data/spec/models/loyalty_sub_ledger_spec.rb +6 -0
- data/spec/models/management_key_spec.rb +6 -0
- data/spec/models/message_test_spec.rb +47 -0
- data/spec/models/new_application_api_key_spec.rb +1 -1
- data/spec/models/new_loyalty_program_spec.rb +1 -1
- data/spec/models/new_management_key_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +79 -0
- data/spec/models/pending_points_notification_policy_spec.rb +6 -0
- data/spec/models/product_unit_analytics_data_point_spec.rb +65 -0
- data/spec/models/product_unit_analytics_spec.rb +2 -20
- data/spec/models/product_unit_analytics_totals_spec.rb +41 -0
- data/spec/models/sku_unit_analytics_data_point_spec.rb +59 -0
- data/spec/models/sku_unit_analytics_spec.rb +47 -0
- data/spec/models/strikethrough_effect_spec.rb +12 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +10 -0
- data/spec/models/summary_campaign_store_budget_spec.rb +6 -0
- data/spec/models/tier_downgrade_notification_policy_spec.rb +6 -0
- data/spec/models/tier_upgrade_notification_policy_spec.rb +6 -0
- data/spec/models/tier_will_downgrade_notification_policy_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +1 -1
- metadata +37 -3
@@ -164,7 +164,7 @@ module TalonOne
|
|
164
164
|
# Add points to customer profile
|
165
165
|
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
166
166
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
167
|
-
# @param integration_id [String] The identifier
|
167
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
168
168
|
# @param body [AddLoyaltyPoints] body
|
169
169
|
# @param [Hash] opts the optional parameters
|
170
170
|
# @return [nil]
|
@@ -176,7 +176,7 @@ module TalonOne
|
|
176
176
|
# Add points to customer profile
|
177
177
|
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
178
178
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
179
|
-
# @param integration_id [String] The identifier
|
179
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
180
180
|
# @param body [AddLoyaltyPoints] body
|
181
181
|
# @param [Hash] opts the optional parameters
|
182
182
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -243,7 +243,7 @@ module TalonOne
|
|
243
243
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
244
244
|
# @param body [CampaignCopy] body
|
245
245
|
# @param [Hash] opts the optional parameters
|
246
|
-
# @return [
|
246
|
+
# @return [InlineResponse2008]
|
247
247
|
def copy_campaign_to_applications(application_id, campaign_id, body, opts = {})
|
248
248
|
data, _status_code, _headers = copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts)
|
249
249
|
data
|
@@ -255,7 +255,7 @@ module TalonOne
|
|
255
255
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
256
256
|
# @param body [CampaignCopy] body
|
257
257
|
# @param [Hash] opts the optional parameters
|
258
|
-
# @return [Array<(
|
258
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
259
259
|
def copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {})
|
260
260
|
if @api_client.config.debugging
|
261
261
|
@api_client.config.logger.debug 'Calling API: ManagementApi.copy_campaign_to_applications ...'
|
@@ -292,7 +292,7 @@ module TalonOne
|
|
292
292
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
293
293
|
|
294
294
|
# return_type
|
295
|
-
return_type = opts[:return_type] || '
|
295
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
296
296
|
|
297
297
|
# auth_names
|
298
298
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -803,8 +803,8 @@ module TalonOne
|
|
803
803
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
804
804
|
# @param body [NewCoupons] body
|
805
805
|
# @param [Hash] opts the optional parameters
|
806
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
807
|
-
# @return [
|
806
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (default to 'yes')
|
807
|
+
# @return [InlineResponse20010]
|
808
808
|
def create_coupons(application_id, campaign_id, body, opts = {})
|
809
809
|
data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts)
|
810
810
|
data
|
@@ -816,8 +816,8 @@ module TalonOne
|
|
816
816
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
817
817
|
# @param body [NewCoupons] body
|
818
818
|
# @param [Hash] opts the optional parameters
|
819
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
820
|
-
# @return [Array<(
|
819
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
820
|
+
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
821
821
|
def create_coupons_with_http_info(application_id, campaign_id, body, opts = {})
|
822
822
|
if @api_client.config.debugging
|
823
823
|
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons ...'
|
@@ -855,7 +855,7 @@ module TalonOne
|
|
855
855
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
856
856
|
|
857
857
|
# return_type
|
858
|
-
return_type = opts[:return_type] || '
|
858
|
+
return_type = opts[:return_type] || 'InlineResponse20010'
|
859
859
|
|
860
860
|
# auth_names
|
861
861
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -1034,8 +1034,8 @@ module TalonOne
|
|
1034
1034
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1035
1035
|
# @param body [NewCouponsForMultipleRecipients] body
|
1036
1036
|
# @param [Hash] opts the optional parameters
|
1037
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
1038
|
-
# @return [
|
1037
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (default to 'yes')
|
1038
|
+
# @return [InlineResponse20010]
|
1039
1039
|
def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
|
1040
1040
|
data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
|
1041
1041
|
data
|
@@ -1047,8 +1047,8 @@ module TalonOne
|
|
1047
1047
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1048
1048
|
# @param body [NewCouponsForMultipleRecipients] body
|
1049
1049
|
# @param [Hash] opts the optional parameters
|
1050
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
1051
|
-
# @return [Array<(
|
1050
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
1051
|
+
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
1052
1052
|
def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
|
1053
1053
|
if @api_client.config.debugging
|
1054
1054
|
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_for_multiple_recipients ...'
|
@@ -1086,7 +1086,7 @@ module TalonOne
|
|
1086
1086
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
1087
1087
|
|
1088
1088
|
# return_type
|
1089
|
-
return_type = opts[:return_type] || '
|
1089
|
+
return_type = opts[:return_type] || 'InlineResponse20010'
|
1090
1090
|
|
1091
1091
|
# auth_names
|
1092
1092
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3548,7 +3548,7 @@ module TalonOne
|
|
3548
3548
|
# @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3549
3549
|
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3550
3550
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3551
|
-
# @param integration_id [String] The identifier
|
3551
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
3552
3552
|
# @param [Hash] opts the optional parameters
|
3553
3553
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3554
3554
|
# @return [String]
|
@@ -3562,7 +3562,7 @@ module TalonOne
|
|
3562
3562
|
# @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3563
3563
|
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3564
3564
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3565
|
-
# @param integration_id [String] The identifier
|
3565
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
3566
3566
|
# @param [Hash] opts the optional parameters
|
3567
3567
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3568
3568
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
@@ -3807,7 +3807,7 @@ module TalonOne
|
|
3807
3807
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
3808
3808
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3809
3809
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3810
|
-
# @return [
|
3810
|
+
# @return [InlineResponse20022]
|
3811
3811
|
def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
|
3812
3812
|
data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
|
3813
3813
|
data
|
@@ -3825,7 +3825,7 @@ module TalonOne
|
|
3825
3825
|
# @option opts [Integer] :page_size The number of items in the response.
|
3826
3826
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3827
3827
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3828
|
-
# @return [Array<(
|
3828
|
+
# @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
|
3829
3829
|
def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
|
3830
3830
|
if @api_client.config.debugging
|
3831
3831
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...'
|
@@ -3884,7 +3884,7 @@ module TalonOne
|
|
3884
3884
|
post_body = opts[:body]
|
3885
3885
|
|
3886
3886
|
# return_type
|
3887
|
-
return_type = opts[:return_type] || '
|
3887
|
+
return_type = opts[:return_type] || 'InlineResponse20022'
|
3888
3888
|
|
3889
3889
|
# auth_names
|
3890
3890
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4233,7 +4233,7 @@ module TalonOne
|
|
4233
4233
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4234
4234
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4235
4235
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4236
|
-
# @return [
|
4236
|
+
# @return [InlineResponse20038]
|
4237
4237
|
def get_additional_costs(opts = {})
|
4238
4238
|
data, _status_code, _headers = get_additional_costs_with_http_info(opts)
|
4239
4239
|
data
|
@@ -4245,7 +4245,7 @@ module TalonOne
|
|
4245
4245
|
# @option opts [Integer] :page_size The number of items in the response.
|
4246
4246
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4247
4247
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4248
|
-
# @return [Array<(
|
4248
|
+
# @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
|
4249
4249
|
def get_additional_costs_with_http_info(opts = {})
|
4250
4250
|
if @api_client.config.debugging
|
4251
4251
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
|
@@ -4279,7 +4279,7 @@ module TalonOne
|
|
4279
4279
|
post_body = opts[:body]
|
4280
4280
|
|
4281
4281
|
# return_type
|
4282
|
-
return_type = opts[:return_type] || '
|
4282
|
+
return_type = opts[:return_type] || 'InlineResponse20038'
|
4283
4283
|
|
4284
4284
|
# auth_names
|
4285
4285
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4501,7 +4501,7 @@ module TalonOne
|
|
4501
4501
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4502
4502
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4503
4503
|
# @option opts [Boolean] :with_total_result_size 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.
|
4504
|
-
# @return [
|
4504
|
+
# @return [InlineResponse20035]
|
4505
4505
|
def get_application_customer_friends(application_id, integration_id, opts = {})
|
4506
4506
|
data, _status_code, _headers = get_application_customer_friends_with_http_info(application_id, integration_id, opts)
|
4507
4507
|
data
|
@@ -4516,7 +4516,7 @@ module TalonOne
|
|
4516
4516
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4517
4517
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4518
4518
|
# @option opts [Boolean] :with_total_result_size 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.
|
4519
|
-
# @return [Array<(
|
4519
|
+
# @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
|
4520
4520
|
def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
|
4521
4521
|
if @api_client.config.debugging
|
4522
4522
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer_friends ...'
|
@@ -4559,7 +4559,7 @@ module TalonOne
|
|
4559
4559
|
post_body = opts[:body]
|
4560
4560
|
|
4561
4561
|
# return_type
|
4562
|
-
return_type = opts[:return_type] || '
|
4562
|
+
return_type = opts[:return_type] || 'InlineResponse20035'
|
4563
4563
|
|
4564
4564
|
# auth_names
|
4565
4565
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4588,7 +4588,7 @@ module TalonOne
|
|
4588
4588
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4589
4589
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4590
4590
|
# @option opts [Boolean] :with_total_result_size 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.
|
4591
|
-
# @return [
|
4591
|
+
# @return [InlineResponse20024]
|
4592
4592
|
def get_application_customers(application_id, opts = {})
|
4593
4593
|
data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
|
4594
4594
|
data
|
@@ -4602,7 +4602,7 @@ module TalonOne
|
|
4602
4602
|
# @option opts [Integer] :page_size The number of items in the response.
|
4603
4603
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4604
4604
|
# @option opts [Boolean] :with_total_result_size 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.
|
4605
|
-
# @return [Array<(
|
4605
|
+
# @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
|
4606
4606
|
def get_application_customers_with_http_info(application_id, opts = {})
|
4607
4607
|
if @api_client.config.debugging
|
4608
4608
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
|
@@ -4641,7 +4641,7 @@ module TalonOne
|
|
4641
4641
|
post_body = opts[:body]
|
4642
4642
|
|
4643
4643
|
# return_type
|
4644
|
-
return_type = opts[:return_type] || '
|
4644
|
+
return_type = opts[:return_type] || 'InlineResponse20024'
|
4645
4645
|
|
4646
4646
|
# auth_names
|
4647
4647
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4670,7 +4670,7 @@ module TalonOne
|
|
4670
4670
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4671
4671
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4672
4672
|
# @option opts [Boolean] :with_total_result_size 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.
|
4673
|
-
# @return [
|
4673
|
+
# @return [InlineResponse20025]
|
4674
4674
|
def get_application_customers_by_attributes(application_id, body, opts = {})
|
4675
4675
|
data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(application_id, body, opts)
|
4676
4676
|
data
|
@@ -4684,7 +4684,7 @@ module TalonOne
|
|
4684
4684
|
# @option opts [Integer] :page_size The number of items in the response.
|
4685
4685
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4686
4686
|
# @option opts [Boolean] :with_total_result_size 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.
|
4687
|
-
# @return [Array<(
|
4687
|
+
# @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
|
4688
4688
|
def get_application_customers_by_attributes_with_http_info(application_id, body, opts = {})
|
4689
4689
|
if @api_client.config.debugging
|
4690
4690
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
|
@@ -4728,7 +4728,7 @@ module TalonOne
|
|
4728
4728
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
4729
4729
|
|
4730
4730
|
# return_type
|
4731
|
-
return_type = opts[:return_type] || '
|
4731
|
+
return_type = opts[:return_type] || 'InlineResponse20025'
|
4732
4732
|
|
4733
4733
|
# auth_names
|
4734
4734
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4756,7 +4756,7 @@ module TalonOne
|
|
4756
4756
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4757
4757
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4758
4758
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4759
|
-
# @return [
|
4759
|
+
# @return [InlineResponse20031]
|
4760
4760
|
def get_application_event_types(application_id, opts = {})
|
4761
4761
|
data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
|
4762
4762
|
data
|
@@ -4769,7 +4769,7 @@ module TalonOne
|
|
4769
4769
|
# @option opts [Integer] :page_size The number of items in the response.
|
4770
4770
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4771
4771
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4772
|
-
# @return [Array<(
|
4772
|
+
# @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
|
4773
4773
|
def get_application_event_types_with_http_info(application_id, opts = {})
|
4774
4774
|
if @api_client.config.debugging
|
4775
4775
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
|
@@ -4807,7 +4807,7 @@ module TalonOne
|
|
4807
4807
|
post_body = opts[:body]
|
4808
4808
|
|
4809
4809
|
# return_type
|
4810
|
-
return_type = opts[:return_type] || '
|
4810
|
+
return_type = opts[:return_type] || 'InlineResponse20031'
|
4811
4811
|
|
4812
4812
|
# auth_names
|
4813
4813
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4846,7 +4846,7 @@ module TalonOne
|
|
4846
4846
|
# @option opts [String] :referral_code Referral code
|
4847
4847
|
# @option opts [String] :rule_query Rule name filter for events
|
4848
4848
|
# @option opts [String] :campaign_query Campaign name filter for events
|
4849
|
-
# @return [
|
4849
|
+
# @return [InlineResponse20030]
|
4850
4850
|
def get_application_events_without_total_count(application_id, opts = {})
|
4851
4851
|
data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
|
4852
4852
|
data
|
@@ -4870,7 +4870,7 @@ module TalonOne
|
|
4870
4870
|
# @option opts [String] :referral_code Referral code
|
4871
4871
|
# @option opts [String] :rule_query Rule name filter for events
|
4872
4872
|
# @option opts [String] :campaign_query Campaign name filter for events
|
4873
|
-
# @return [Array<(
|
4873
|
+
# @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
|
4874
4874
|
def get_application_events_without_total_count_with_http_info(application_id, opts = {})
|
4875
4875
|
if @api_client.config.debugging
|
4876
4876
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
|
@@ -4927,7 +4927,7 @@ module TalonOne
|
|
4927
4927
|
post_body = opts[:body]
|
4928
4928
|
|
4929
4929
|
# return_type
|
4930
|
-
return_type = opts[:return_type] || '
|
4930
|
+
return_type = opts[:return_type] || 'InlineResponse20030'
|
4931
4931
|
|
4932
4932
|
# auth_names
|
4933
4933
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5031,7 +5031,7 @@ module TalonOne
|
|
5031
5031
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
5032
5032
|
# @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
|
5033
5033
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
5034
|
-
# @return [
|
5034
|
+
# @return [InlineResponse20029]
|
5035
5035
|
def get_application_sessions(application_id, opts = {})
|
5036
5036
|
data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
|
5037
5037
|
data
|
@@ -5052,7 +5052,7 @@ module TalonOne
|
|
5052
5052
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
5053
5053
|
# @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
|
5054
5054
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
5055
|
-
# @return [Array<(
|
5055
|
+
# @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
|
5056
5056
|
def get_application_sessions_with_http_info(application_id, opts = {})
|
5057
5057
|
if @api_client.config.debugging
|
5058
5058
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
|
@@ -5102,7 +5102,7 @@ module TalonOne
|
|
5102
5102
|
post_body = opts[:body]
|
5103
5103
|
|
5104
5104
|
# return_type
|
5105
|
-
return_type = opts[:return_type] || '
|
5105
|
+
return_type = opts[:return_type] || 'InlineResponse20029'
|
5106
5106
|
|
5107
5107
|
# auth_names
|
5108
5108
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5129,7 +5129,7 @@ module TalonOne
|
|
5129
5129
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5130
5130
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5131
5131
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5132
|
-
# @return [
|
5132
|
+
# @return [InlineResponse2007]
|
5133
5133
|
def get_applications(opts = {})
|
5134
5134
|
data, _status_code, _headers = get_applications_with_http_info(opts)
|
5135
5135
|
data
|
@@ -5141,7 +5141,7 @@ module TalonOne
|
|
5141
5141
|
# @option opts [Integer] :page_size The number of items in the response.
|
5142
5142
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5143
5143
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5144
|
-
# @return [Array<(
|
5144
|
+
# @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
|
5145
5145
|
def get_applications_with_http_info(opts = {})
|
5146
5146
|
if @api_client.config.debugging
|
5147
5147
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_applications ...'
|
@@ -5175,7 +5175,7 @@ module TalonOne
|
|
5175
5175
|
post_body = opts[:body]
|
5176
5176
|
|
5177
5177
|
# return_type
|
5178
|
-
return_type = opts[:return_type] || '
|
5178
|
+
return_type = opts[:return_type] || 'InlineResponse2007'
|
5179
5179
|
|
5180
5180
|
# auth_names
|
5181
5181
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5265,7 +5265,7 @@ module TalonOne
|
|
5265
5265
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5266
5266
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5267
5267
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5268
|
-
# @return [
|
5268
|
+
# @return [InlineResponse20036]
|
5269
5269
|
def get_attributes(opts = {})
|
5270
5270
|
data, _status_code, _headers = get_attributes_with_http_info(opts)
|
5271
5271
|
data
|
@@ -5278,7 +5278,7 @@ module TalonOne
|
|
5278
5278
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5279
5279
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5280
5280
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5281
|
-
# @return [Array<(
|
5281
|
+
# @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
|
5282
5282
|
def get_attributes_with_http_info(opts = {})
|
5283
5283
|
if @api_client.config.debugging
|
5284
5284
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
|
@@ -5313,7 +5313,7 @@ module TalonOne
|
|
5313
5313
|
post_body = opts[:body]
|
5314
5314
|
|
5315
5315
|
# return_type
|
5316
|
-
return_type = opts[:return_type] || '
|
5316
|
+
return_type = opts[:return_type] || 'InlineResponse20036'
|
5317
5317
|
|
5318
5318
|
# auth_names
|
5319
5319
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5342,7 +5342,7 @@ module TalonOne
|
|
5342
5342
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5343
5343
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5344
5344
|
# @option opts [String] :profile_query The filter to select a profile.
|
5345
|
-
# @return [
|
5345
|
+
# @return [InlineResponse20034]
|
5346
5346
|
def get_audience_memberships(audience_id, opts = {})
|
5347
5347
|
data, _status_code, _headers = get_audience_memberships_with_http_info(audience_id, opts)
|
5348
5348
|
data
|
@@ -5356,7 +5356,7 @@ module TalonOne
|
|
5356
5356
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5357
5357
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5358
5358
|
# @option opts [String] :profile_query The filter to select a profile.
|
5359
|
-
# @return [Array<(
|
5359
|
+
# @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
|
5360
5360
|
def get_audience_memberships_with_http_info(audience_id, opts = {})
|
5361
5361
|
if @api_client.config.debugging
|
5362
5362
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audience_memberships ...'
|
@@ -5395,7 +5395,7 @@ module TalonOne
|
|
5395
5395
|
post_body = opts[:body]
|
5396
5396
|
|
5397
5397
|
# return_type
|
5398
|
-
return_type = opts[:return_type] || '
|
5398
|
+
return_type = opts[:return_type] || 'InlineResponse20034'
|
5399
5399
|
|
5400
5400
|
# auth_names
|
5401
5401
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5423,7 +5423,7 @@ module TalonOne
|
|
5423
5423
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5424
5424
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5425
5425
|
# @option opts [Boolean] :with_total_result_size 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.
|
5426
|
-
# @return [
|
5426
|
+
# @return [InlineResponse20032]
|
5427
5427
|
def get_audiences(opts = {})
|
5428
5428
|
data, _status_code, _headers = get_audiences_with_http_info(opts)
|
5429
5429
|
data
|
@@ -5436,7 +5436,7 @@ module TalonOne
|
|
5436
5436
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5437
5437
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5438
5438
|
# @option opts [Boolean] :with_total_result_size 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.
|
5439
|
-
# @return [Array<(
|
5439
|
+
# @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
|
5440
5440
|
def get_audiences_with_http_info(opts = {})
|
5441
5441
|
if @api_client.config.debugging
|
5442
5442
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
|
@@ -5471,7 +5471,7 @@ module TalonOne
|
|
5471
5471
|
post_body = opts[:body]
|
5472
5472
|
|
5473
5473
|
# return_type
|
5474
|
-
return_type = opts[:return_type] || '
|
5474
|
+
return_type = opts[:return_type] || 'InlineResponse20032'
|
5475
5475
|
|
5476
5476
|
# auth_names
|
5477
5477
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5497,7 +5497,7 @@ module TalonOne
|
|
5497
5497
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5498
5498
|
# @param [Hash] opts the optional parameters
|
5499
5499
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5500
|
-
# @return [
|
5500
|
+
# @return [InlineResponse20033]
|
5501
5501
|
def get_audiences_analytics(audience_ids, opts = {})
|
5502
5502
|
data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
|
5503
5503
|
data
|
@@ -5508,7 +5508,7 @@ module TalonOne
|
|
5508
5508
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5509
5509
|
# @param [Hash] opts the optional parameters
|
5510
5510
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5511
|
-
# @return [Array<(
|
5511
|
+
# @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
|
5512
5512
|
def get_audiences_analytics_with_http_info(audience_ids, opts = {})
|
5513
5513
|
if @api_client.config.debugging
|
5514
5514
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences_analytics ...'
|
@@ -5537,7 +5537,7 @@ module TalonOne
|
|
5537
5537
|
post_body = opts[:body]
|
5538
5538
|
|
5539
5539
|
# return_type
|
5540
|
-
return_type = opts[:return_type] || '
|
5540
|
+
return_type = opts[:return_type] || 'InlineResponse20033'
|
5541
5541
|
|
5542
5542
|
# auth_names
|
5543
5543
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5634,7 +5634,7 @@ module TalonOne
|
|
5634
5634
|
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
5635
5635
|
# @param [Hash] opts the optional parameters
|
5636
5636
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
5637
|
-
# @return [
|
5637
|
+
# @return [InlineResponse20023]
|
5638
5638
|
def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
|
5639
5639
|
data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
|
5640
5640
|
data
|
@@ -5648,7 +5648,7 @@ module TalonOne
|
|
5648
5648
|
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
5649
5649
|
# @param [Hash] opts the optional parameters
|
5650
5650
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
5651
|
-
# @return [Array<(
|
5651
|
+
# @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
|
5652
5652
|
def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
|
5653
5653
|
if @api_client.config.debugging
|
5654
5654
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
|
@@ -5694,7 +5694,7 @@ module TalonOne
|
|
5694
5694
|
post_body = opts[:body]
|
5695
5695
|
|
5696
5696
|
# return_type
|
5697
|
-
return_type = opts[:return_type] || '
|
5697
|
+
return_type = opts[:return_type] || 'InlineResponse20023'
|
5698
5698
|
|
5699
5699
|
# auth_names
|
5700
5700
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5724,7 +5724,7 @@ module TalonOne
|
|
5724
5724
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5725
5725
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5726
5726
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5727
|
-
# @return [
|
5727
|
+
# @return [InlineResponse2008]
|
5728
5728
|
def get_campaign_by_attributes(application_id, body, opts = {})
|
5729
5729
|
data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
|
5730
5730
|
data
|
@@ -5739,7 +5739,7 @@ module TalonOne
|
|
5739
5739
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5740
5740
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5741
5741
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5742
|
-
# @return [Array<(
|
5742
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
5743
5743
|
def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
|
5744
5744
|
if @api_client.config.debugging
|
5745
5745
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_by_attributes ...'
|
@@ -5788,7 +5788,7 @@ module TalonOne
|
|
5788
5788
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
5789
5789
|
|
5790
5790
|
# return_type
|
5791
|
-
return_type = opts[:return_type] || '
|
5791
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
5792
5792
|
|
5793
5793
|
# auth_names
|
5794
5794
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5877,7 +5877,7 @@ module TalonOne
|
|
5877
5877
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5878
5878
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5879
5879
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5880
|
-
# @return [
|
5880
|
+
# @return [InlineResponse20013]
|
5881
5881
|
def get_campaign_groups(opts = {})
|
5882
5882
|
data, _status_code, _headers = get_campaign_groups_with_http_info(opts)
|
5883
5883
|
data
|
@@ -5889,7 +5889,7 @@ module TalonOne
|
|
5889
5889
|
# @option opts [Integer] :page_size The number of items in the response.
|
5890
5890
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5891
5891
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5892
|
-
# @return [Array<(
|
5892
|
+
# @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
|
5893
5893
|
def get_campaign_groups_with_http_info(opts = {})
|
5894
5894
|
if @api_client.config.debugging
|
5895
5895
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_groups ...'
|
@@ -5923,7 +5923,7 @@ module TalonOne
|
|
5923
5923
|
post_body = opts[:body]
|
5924
5924
|
|
5925
5925
|
# return_type
|
5926
|
-
return_type = opts[:return_type] || '
|
5926
|
+
return_type = opts[:return_type] || 'InlineResponse20013'
|
5927
5927
|
|
5928
5928
|
# auth_names
|
5929
5929
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5954,7 +5954,7 @@ module TalonOne
|
|
5954
5954
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
5955
5955
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
5956
5956
|
# @option opts [Integer] :user_id Filter results by user ID.
|
5957
|
-
# @return [
|
5957
|
+
# @return [InlineResponse20014]
|
5958
5958
|
def get_campaign_templates(opts = {})
|
5959
5959
|
data, _status_code, _headers = get_campaign_templates_with_http_info(opts)
|
5960
5960
|
data
|
@@ -5970,7 +5970,7 @@ module TalonOne
|
|
5970
5970
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
5971
5971
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
5972
5972
|
# @option opts [Integer] :user_id Filter results by user ID.
|
5973
|
-
# @return [Array<(
|
5973
|
+
# @return [Array<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers
|
5974
5974
|
def get_campaign_templates_with_http_info(opts = {})
|
5975
5975
|
if @api_client.config.debugging
|
5976
5976
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_templates ...'
|
@@ -6012,7 +6012,7 @@ module TalonOne
|
|
6012
6012
|
post_body = opts[:body]
|
6013
6013
|
|
6014
6014
|
# return_type
|
6015
|
-
return_type = opts[:return_type] || '
|
6015
|
+
return_type = opts[:return_type] || 'InlineResponse20014'
|
6016
6016
|
|
6017
6017
|
# auth_names
|
6018
6018
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6048,7 +6048,7 @@ module TalonOne
|
|
6048
6048
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
6049
6049
|
# @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
|
6050
6050
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
6051
|
-
# @return [
|
6051
|
+
# @return [InlineResponse2008]
|
6052
6052
|
def get_campaigns(application_id, opts = {})
|
6053
6053
|
data, _status_code, _headers = get_campaigns_with_http_info(application_id, opts)
|
6054
6054
|
data
|
@@ -6069,7 +6069,7 @@ module TalonOne
|
|
6069
6069
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
6070
6070
|
# @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
|
6071
6071
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
6072
|
-
# @return [Array<(
|
6072
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
6073
6073
|
def get_campaigns_with_http_info(application_id, opts = {})
|
6074
6074
|
if @api_client.config.debugging
|
6075
6075
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaigns ...'
|
@@ -6119,7 +6119,7 @@ module TalonOne
|
|
6119
6119
|
post_body = opts[:body]
|
6120
6120
|
|
6121
6121
|
# return_type
|
6122
|
-
return_type = opts[:return_type] || '
|
6122
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
6123
6123
|
|
6124
6124
|
# auth_names
|
6125
6125
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6154,7 +6154,7 @@ module TalonOne
|
|
6154
6154
|
# @option opts [Boolean] :with_total_result_size 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.
|
6155
6155
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
6156
6156
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
6157
|
-
# @return [
|
6157
|
+
# @return [InlineResponse20044]
|
6158
6158
|
def get_changes(opts = {})
|
6159
6159
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
6160
6160
|
data
|
@@ -6174,7 +6174,7 @@ module TalonOne
|
|
6174
6174
|
# @option opts [Boolean] :with_total_result_size 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.
|
6175
6175
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
6176
6176
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
6177
|
-
# @return [Array<(
|
6177
|
+
# @return [Array<(InlineResponse20044, Integer, Hash)>] InlineResponse20044 data, response status code and response headers
|
6178
6178
|
def get_changes_with_http_info(opts = {})
|
6179
6179
|
if @api_client.config.debugging
|
6180
6180
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
@@ -6216,7 +6216,7 @@ module TalonOne
|
|
6216
6216
|
post_body = opts[:body]
|
6217
6217
|
|
6218
6218
|
# return_type
|
6219
|
-
return_type = opts[:return_type] || '
|
6219
|
+
return_type = opts[:return_type] || 'InlineResponse20044'
|
6220
6220
|
|
6221
6221
|
# auth_names
|
6222
6222
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6317,7 +6317,7 @@ module TalonOne
|
|
6317
6317
|
# @param [Hash] opts the optional parameters
|
6318
6318
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6319
6319
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6320
|
-
# @return [
|
6320
|
+
# @return [InlineResponse20021]
|
6321
6321
|
def get_collection_items(collection_id, opts = {})
|
6322
6322
|
data, _status_code, _headers = get_collection_items_with_http_info(collection_id, opts)
|
6323
6323
|
data
|
@@ -6329,7 +6329,7 @@ module TalonOne
|
|
6329
6329
|
# @param [Hash] opts the optional parameters
|
6330
6330
|
# @option opts [Integer] :page_size The number of items in the response.
|
6331
6331
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6332
|
-
# @return [Array<(
|
6332
|
+
# @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
|
6333
6333
|
def get_collection_items_with_http_info(collection_id, opts = {})
|
6334
6334
|
if @api_client.config.debugging
|
6335
6335
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_collection_items ...'
|
@@ -6366,7 +6366,7 @@ module TalonOne
|
|
6366
6366
|
post_body = opts[:body]
|
6367
6367
|
|
6368
6368
|
# return_type
|
6369
|
-
return_type = opts[:return_type] || '
|
6369
|
+
return_type = opts[:return_type] || 'InlineResponse20021'
|
6370
6370
|
|
6371
6371
|
# auth_names
|
6372
6372
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6410,7 +6410,7 @@ module TalonOne
|
|
6410
6410
|
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6411
6411
|
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6412
6412
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false)
|
6413
|
-
# @return [
|
6413
|
+
# @return [InlineResponse20011]
|
6414
6414
|
def get_coupons_without_total_count(application_id, campaign_id, opts = {})
|
6415
6415
|
data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
|
6416
6416
|
data
|
@@ -6439,7 +6439,7 @@ module TalonOne
|
|
6439
6439
|
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6440
6440
|
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6441
6441
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
6442
|
-
# @return [Array<(
|
6442
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
6443
6443
|
def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
6444
6444
|
if @api_client.config.debugging
|
6445
6445
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_without_total_count ...'
|
@@ -6508,7 +6508,7 @@ module TalonOne
|
|
6508
6508
|
post_body = opts[:body]
|
6509
6509
|
|
6510
6510
|
# return_type
|
6511
|
-
return_type = opts[:return_type] || '
|
6511
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
6512
6512
|
|
6513
6513
|
# auth_names
|
6514
6514
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6638,7 +6638,7 @@ module TalonOne
|
|
6638
6638
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6639
6639
|
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
6640
6640
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
|
6641
|
-
# @return [
|
6641
|
+
# @return [InlineResponse20028]
|
6642
6642
|
def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
|
6643
6643
|
data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
|
6644
6644
|
data
|
@@ -6657,7 +6657,7 @@ module TalonOne
|
|
6657
6657
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6658
6658
|
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
6659
6659
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
|
6660
|
-
# @return [Array<(
|
6660
|
+
# @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
|
6661
6661
|
def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
|
6662
6662
|
if @api_client.config.debugging
|
6663
6663
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
|
@@ -6709,7 +6709,7 @@ module TalonOne
|
|
6709
6709
|
post_body = opts[:body]
|
6710
6710
|
|
6711
6711
|
# return_type
|
6712
|
-
return_type = opts[:return_type] || '
|
6712
|
+
return_type = opts[:return_type] || 'InlineResponse20028'
|
6713
6713
|
|
6714
6714
|
# auth_names
|
6715
6715
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6880,13 +6880,13 @@ module TalonOne
|
|
6880
6880
|
# List customer achievements
|
6881
6881
|
# For the given customer profile, list all the achievements that match your filter criteria.
|
6882
6882
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6883
|
-
# @param integration_id [String] The identifier
|
6883
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
6884
6884
|
# @param [Hash] opts the optional parameters
|
6885
6885
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
6886
6886
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6887
6887
|
# @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
6888
6888
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
6889
|
-
# @return [
|
6889
|
+
# @return [InlineResponse20049]
|
6890
6890
|
def get_customer_profile_achievement_progress(application_id, integration_id, opts = {})
|
6891
6891
|
data, _status_code, _headers = get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts)
|
6892
6892
|
data
|
@@ -6895,13 +6895,13 @@ module TalonOne
|
|
6895
6895
|
# List customer achievements
|
6896
6896
|
# For the given customer profile, list all the achievements that match your filter criteria.
|
6897
6897
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6898
|
-
# @param integration_id [String] The identifier
|
6898
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
6899
6899
|
# @param [Hash] opts the optional parameters
|
6900
6900
|
# @option opts [Integer] :page_size The number of items in the response.
|
6901
6901
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6902
6902
|
# @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
6903
6903
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
6904
|
-
# @return [Array<(
|
6904
|
+
# @return [Array<(InlineResponse20049, Integer, Hash)>] InlineResponse20049 data, response status code and response headers
|
6905
6905
|
def get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {})
|
6906
6906
|
if @api_client.config.debugging
|
6907
6907
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile_achievement_progress ...'
|
@@ -6944,7 +6944,7 @@ module TalonOne
|
|
6944
6944
|
post_body = opts[:body]
|
6945
6945
|
|
6946
6946
|
# return_type
|
6947
|
-
return_type = opts[:return_type] || '
|
6947
|
+
return_type = opts[:return_type] || 'InlineResponse20049'
|
6948
6948
|
|
6949
6949
|
# auth_names
|
6950
6950
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6971,7 +6971,7 @@ module TalonOne
|
|
6971
6971
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6972
6972
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6973
6973
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
|
6974
|
-
# @return [
|
6974
|
+
# @return [InlineResponse20027]
|
6975
6975
|
def get_customer_profiles(opts = {})
|
6976
6976
|
data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
|
6977
6977
|
data
|
@@ -6983,7 +6983,7 @@ module TalonOne
|
|
6983
6983
|
# @option opts [Integer] :page_size The number of items in the response.
|
6984
6984
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6985
6985
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
6986
|
-
# @return [Array<(
|
6986
|
+
# @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
|
6987
6987
|
def get_customer_profiles_with_http_info(opts = {})
|
6988
6988
|
if @api_client.config.debugging
|
6989
6989
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
|
@@ -7017,7 +7017,7 @@ module TalonOne
|
|
7017
7017
|
post_body = opts[:body]
|
7018
7018
|
|
7019
7019
|
# return_type
|
7020
|
-
return_type = opts[:return_type] || '
|
7020
|
+
return_type = opts[:return_type] || 'InlineResponse20027'
|
7021
7021
|
|
7022
7022
|
# auth_names
|
7023
7023
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7045,7 +7045,7 @@ module TalonOne
|
|
7045
7045
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7046
7046
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7047
7047
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
|
7048
|
-
# @return [
|
7048
|
+
# @return [InlineResponse20026]
|
7049
7049
|
def get_customers_by_attributes(body, opts = {})
|
7050
7050
|
data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
|
7051
7051
|
data
|
@@ -7058,7 +7058,7 @@ module TalonOne
|
|
7058
7058
|
# @option opts [Integer] :page_size The number of items in the response.
|
7059
7059
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7060
7060
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
7061
|
-
# @return [Array<(
|
7061
|
+
# @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
|
7062
7062
|
def get_customers_by_attributes_with_http_info(body, opts = {})
|
7063
7063
|
if @api_client.config.debugging
|
7064
7064
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
|
@@ -7098,7 +7098,7 @@ module TalonOne
|
|
7098
7098
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
7099
7099
|
|
7100
7100
|
# return_type
|
7101
|
-
return_type = opts[:return_type] || '
|
7101
|
+
return_type = opts[:return_type] || 'InlineResponse20026'
|
7102
7102
|
|
7103
7103
|
# auth_names
|
7104
7104
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7119,6 +7119,85 @@ module TalonOne
|
|
7119
7119
|
return data, status_code, headers
|
7120
7120
|
end
|
7121
7121
|
|
7122
|
+
# Get statistics for loyalty dashboard
|
7123
|
+
# Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
7124
|
+
# @param 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.
|
7125
|
+
# @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
7126
|
+
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
7127
|
+
# @param [Hash] opts the optional parameters
|
7128
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7129
|
+
# @return [InlineResponse20016]
|
7130
|
+
def get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts = {})
|
7131
|
+
data, _status_code, _headers = get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts)
|
7132
|
+
data
|
7133
|
+
end
|
7134
|
+
|
7135
|
+
# Get statistics for loyalty dashboard
|
7136
|
+
# Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
7137
|
+
# @param 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.
|
7138
|
+
# @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
7139
|
+
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
7140
|
+
# @param [Hash] opts the optional parameters
|
7141
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7142
|
+
# @return [Array<(InlineResponse20016, Integer, Hash)>] InlineResponse20016 data, response status code and response headers
|
7143
|
+
def get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts = {})
|
7144
|
+
if @api_client.config.debugging
|
7145
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.get_dashboard_statistics ...'
|
7146
|
+
end
|
7147
|
+
# verify the required parameter 'loyalty_program_id' is set
|
7148
|
+
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
7149
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_dashboard_statistics"
|
7150
|
+
end
|
7151
|
+
# verify the required parameter 'range_start' is set
|
7152
|
+
if @api_client.config.client_side_validation && range_start.nil?
|
7153
|
+
fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_dashboard_statistics"
|
7154
|
+
end
|
7155
|
+
# verify the required parameter 'range_end' is set
|
7156
|
+
if @api_client.config.client_side_validation && range_end.nil?
|
7157
|
+
fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_dashboard_statistics"
|
7158
|
+
end
|
7159
|
+
# resource path
|
7160
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/dashboard'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
7161
|
+
|
7162
|
+
# query parameters
|
7163
|
+
query_params = opts[:query_params] || {}
|
7164
|
+
query_params[:'rangeStart'] = range_start
|
7165
|
+
query_params[:'rangeEnd'] = range_end
|
7166
|
+
query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?
|
7167
|
+
|
7168
|
+
# header parameters
|
7169
|
+
header_params = opts[:header_params] || {}
|
7170
|
+
# HTTP header 'Accept' (if needed)
|
7171
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7172
|
+
|
7173
|
+
# form parameters
|
7174
|
+
form_params = opts[:form_params] || {}
|
7175
|
+
|
7176
|
+
# http body (model)
|
7177
|
+
post_body = opts[:body]
|
7178
|
+
|
7179
|
+
# return_type
|
7180
|
+
return_type = opts[:return_type] || 'InlineResponse20016'
|
7181
|
+
|
7182
|
+
# auth_names
|
7183
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
7184
|
+
|
7185
|
+
new_options = opts.merge(
|
7186
|
+
:header_params => header_params,
|
7187
|
+
:query_params => query_params,
|
7188
|
+
:form_params => form_params,
|
7189
|
+
:body => post_body,
|
7190
|
+
:auth_names => auth_names,
|
7191
|
+
:return_type => return_type
|
7192
|
+
)
|
7193
|
+
|
7194
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
7195
|
+
if @api_client.config.debugging
|
7196
|
+
@api_client.config.logger.debug "API called: ManagementApi#get_dashboard_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7197
|
+
end
|
7198
|
+
return data, status_code, headers
|
7199
|
+
end
|
7200
|
+
|
7122
7201
|
# List event types
|
7123
7202
|
# Fetch all event type definitions for your account.
|
7124
7203
|
# @param [Hash] opts the optional parameters
|
@@ -7127,7 +7206,7 @@ module TalonOne
|
|
7127
7206
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7128
7207
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7129
7208
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7130
|
-
# @return [
|
7209
|
+
# @return [InlineResponse20042]
|
7131
7210
|
def get_event_types(opts = {})
|
7132
7211
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
7133
7212
|
data
|
@@ -7141,7 +7220,7 @@ module TalonOne
|
|
7141
7220
|
# @option opts [Integer] :page_size The number of items in the response.
|
7142
7221
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7143
7222
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7144
|
-
# @return [Array<(
|
7223
|
+
# @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
|
7145
7224
|
def get_event_types_with_http_info(opts = {})
|
7146
7225
|
if @api_client.config.debugging
|
7147
7226
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
@@ -7177,7 +7256,7 @@ module TalonOne
|
|
7177
7256
|
post_body = opts[:body]
|
7178
7257
|
|
7179
7258
|
# return_type
|
7180
|
-
return_type = opts[:return_type] || '
|
7259
|
+
return_type = opts[:return_type] || 'InlineResponse20042'
|
7181
7260
|
|
7182
7261
|
# auth_names
|
7183
7262
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7206,7 +7285,7 @@ module TalonOne
|
|
7206
7285
|
# @option opts [Float] :application_id Filter results by Application ID.
|
7207
7286
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
7208
7287
|
# @option opts [String] :entity The name of the entity type that was exported.
|
7209
|
-
# @return [
|
7288
|
+
# @return [InlineResponse20045]
|
7210
7289
|
def get_exports(opts = {})
|
7211
7290
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
7212
7291
|
data
|
@@ -7220,7 +7299,7 @@ module TalonOne
|
|
7220
7299
|
# @option opts [Float] :application_id Filter results by Application ID.
|
7221
7300
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
7222
7301
|
# @option opts [String] :entity The name of the entity type that was exported.
|
7223
|
-
# @return [Array<(
|
7302
|
+
# @return [Array<(InlineResponse20045, Integer, Hash)>] InlineResponse20045 data, response status code and response headers
|
7224
7303
|
def get_exports_with_http_info(opts = {})
|
7225
7304
|
if @api_client.config.debugging
|
7226
7305
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
@@ -7260,7 +7339,7 @@ module TalonOne
|
|
7260
7339
|
post_body = opts[:body]
|
7261
7340
|
|
7262
7341
|
# return_type
|
7263
|
-
return_type = opts[:return_type] || '
|
7342
|
+
return_type = opts[:return_type] || 'InlineResponse20045'
|
7264
7343
|
|
7265
7344
|
# auth_names
|
7266
7345
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7363,7 +7442,7 @@ module TalonOne
|
|
7363
7442
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7364
7443
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7365
7444
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7366
|
-
# @return [
|
7445
|
+
# @return [InlineResponse20019]
|
7367
7446
|
def get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {})
|
7368
7447
|
data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
7369
7448
|
data
|
@@ -7379,7 +7458,7 @@ module TalonOne
|
|
7379
7458
|
# @option opts [Integer] :page_size The number of items in the response.
|
7380
7459
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7381
7460
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7382
|
-
# @return [Array<(
|
7461
|
+
# @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
|
7383
7462
|
def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
7384
7463
|
if @api_client.config.debugging
|
7385
7464
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card_transaction_logs ...'
|
@@ -7427,7 +7506,7 @@ module TalonOne
|
|
7427
7506
|
post_body = opts[:body]
|
7428
7507
|
|
7429
7508
|
# return_type
|
7430
|
-
return_type = opts[:return_type] || '
|
7509
|
+
return_type = opts[:return_type] || 'InlineResponse20019'
|
7431
7510
|
|
7432
7511
|
# auth_names
|
7433
7512
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7458,7 +7537,7 @@ module TalonOne
|
|
7458
7537
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7459
7538
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7460
7539
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
7461
|
-
# @return [
|
7540
|
+
# @return [InlineResponse20018]
|
7462
7541
|
def get_loyalty_cards(loyalty_program_id, opts = {})
|
7463
7542
|
data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
|
7464
7543
|
data
|
@@ -7474,7 +7553,7 @@ module TalonOne
|
|
7474
7553
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7475
7554
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7476
7555
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
7477
|
-
# @return [Array<(
|
7556
|
+
# @return [Array<(InlineResponse20018, Integer, Hash)>] InlineResponse20018 data, response status code and response headers
|
7478
7557
|
def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
7479
7558
|
if @api_client.config.debugging
|
7480
7559
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_cards ...'
|
@@ -7523,7 +7602,7 @@ module TalonOne
|
|
7523
7602
|
post_body = opts[:body]
|
7524
7603
|
|
7525
7604
|
# return_type
|
7526
|
-
return_type = opts[:return_type] || '
|
7605
|
+
return_type = opts[:return_type] || 'InlineResponse20018'
|
7527
7606
|
|
7528
7607
|
# auth_names
|
7529
7608
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7547,7 +7626,7 @@ module TalonOne
|
|
7547
7626
|
# Get customer's full loyalty ledger
|
7548
7627
|
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
7549
7628
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
7550
|
-
# @param integration_id [String] The identifier
|
7629
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
7551
7630
|
# @param [Hash] opts the optional parameters
|
7552
7631
|
# @return [LoyaltyLedger]
|
7553
7632
|
def get_loyalty_points(loyalty_program_id, integration_id, opts = {})
|
@@ -7558,7 +7637,7 @@ module TalonOne
|
|
7558
7637
|
# Get customer's full loyalty ledger
|
7559
7638
|
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
7560
7639
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
7561
|
-
# @param integration_id [String] The identifier
|
7640
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
7562
7641
|
# @param [Hash] opts the optional parameters
|
7563
7642
|
# @return [Array<(LoyaltyLedger, Integer, Hash)>] LoyaltyLedger data, response status code and response headers
|
7564
7643
|
def get_loyalty_points_with_http_info(loyalty_program_id, integration_id, opts = {})
|
@@ -7684,7 +7763,7 @@ module TalonOne
|
|
7684
7763
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
7685
7764
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
7686
7765
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7687
|
-
# @return [
|
7766
|
+
# @return [InlineResponse20017]
|
7688
7767
|
def get_loyalty_program_transactions(loyalty_program_id, opts = {})
|
7689
7768
|
data, _status_code, _headers = get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts)
|
7690
7769
|
data
|
@@ -7700,7 +7779,7 @@ module TalonOne
|
|
7700
7779
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
7701
7780
|
# @option opts [Integer] :page_size The number of items in the response.
|
7702
7781
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7703
|
-
# @return [Array<(
|
7782
|
+
# @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
|
7704
7783
|
def get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts = {})
|
7705
7784
|
if @api_client.config.debugging
|
7706
7785
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program_transactions ...'
|
@@ -7745,7 +7824,7 @@ module TalonOne
|
|
7745
7824
|
post_body = opts[:body]
|
7746
7825
|
|
7747
7826
|
# return_type
|
7748
|
-
return_type = opts[:return_type] || '
|
7827
|
+
return_type = opts[:return_type] || 'InlineResponse20017'
|
7749
7828
|
|
7750
7829
|
# auth_names
|
7751
7830
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7769,7 +7848,7 @@ module TalonOne
|
|
7769
7848
|
# List loyalty programs
|
7770
7849
|
# List the loyalty programs of the account.
|
7771
7850
|
# @param [Hash] opts the optional parameters
|
7772
|
-
# @return [
|
7851
|
+
# @return [InlineResponse20015]
|
7773
7852
|
def get_loyalty_programs(opts = {})
|
7774
7853
|
data, _status_code, _headers = get_loyalty_programs_with_http_info(opts)
|
7775
7854
|
data
|
@@ -7778,7 +7857,7 @@ module TalonOne
|
|
7778
7857
|
# List loyalty programs
|
7779
7858
|
# List the loyalty programs of the account.
|
7780
7859
|
# @param [Hash] opts the optional parameters
|
7781
|
-
# @return [Array<(
|
7860
|
+
# @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
|
7782
7861
|
def get_loyalty_programs_with_http_info(opts = {})
|
7783
7862
|
if @api_client.config.debugging
|
7784
7863
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...'
|
@@ -7801,7 +7880,7 @@ module TalonOne
|
|
7801
7880
|
post_body = opts[:body]
|
7802
7881
|
|
7803
7882
|
# return_type
|
7804
|
-
return_type = opts[:return_type] || '
|
7883
|
+
return_type = opts[:return_type] || 'InlineResponse20015'
|
7805
7884
|
|
7806
7885
|
# auth_names
|
7807
7886
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7823,7 +7902,7 @@ module TalonOne
|
|
7823
7902
|
end
|
7824
7903
|
|
7825
7904
|
# Get loyalty program statistics
|
7826
|
-
#
|
7905
|
+
# ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
|
7827
7906
|
# @param 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.
|
7828
7907
|
# @param [Hash] opts the optional parameters
|
7829
7908
|
# @return [LoyaltyDashboardData]
|
@@ -7833,7 +7912,7 @@ module TalonOne
|
|
7833
7912
|
end
|
7834
7913
|
|
7835
7914
|
# Get loyalty program statistics
|
7836
|
-
#
|
7915
|
+
# ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
|
7837
7916
|
# @param 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.
|
7838
7917
|
# @param [Hash] opts the optional parameters
|
7839
7918
|
# @return [Array<(LoyaltyDashboardData, Integer, Hash)>] LoyaltyDashboardData data, response status code and response headers
|
@@ -7898,7 +7977,7 @@ module TalonOne
|
|
7898
7977
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
7899
7978
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
7900
7979
|
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
7901
|
-
# @return [
|
7980
|
+
# @return [InlineResponse20012]
|
7902
7981
|
def get_referrals_without_total_count(application_id, campaign_id, opts = {})
|
7903
7982
|
data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
|
7904
7983
|
data
|
@@ -7918,7 +7997,7 @@ module TalonOne
|
|
7918
7997
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
7919
7998
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
7920
7999
|
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
7921
|
-
# @return [Array<(
|
8000
|
+
# @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
|
7922
8001
|
def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
7923
8002
|
if @api_client.config.debugging
|
7924
8003
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...'
|
@@ -7974,7 +8053,7 @@ module TalonOne
|
|
7974
8053
|
post_body = opts[:body]
|
7975
8054
|
|
7976
8055
|
# return_type
|
7977
|
-
return_type = opts[:return_type] || '
|
8056
|
+
return_type = opts[:return_type] || 'InlineResponse20012'
|
7978
8057
|
|
7979
8058
|
# auth_names
|
7980
8059
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8139,7 +8218,7 @@ module TalonOne
|
|
8139
8218
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8140
8219
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8141
8220
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8142
|
-
# @return [
|
8221
|
+
# @return [InlineResponse2009]
|
8143
8222
|
def get_rulesets(application_id, campaign_id, opts = {})
|
8144
8223
|
data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
|
8145
8224
|
data
|
@@ -8153,7 +8232,7 @@ module TalonOne
|
|
8153
8232
|
# @option opts [Integer] :page_size The number of items in the response.
|
8154
8233
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8155
8234
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8156
|
-
# @return [Array<(
|
8235
|
+
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
8157
8236
|
def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
|
8158
8237
|
if @api_client.config.debugging
|
8159
8238
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_rulesets ...'
|
@@ -8195,7 +8274,7 @@ module TalonOne
|
|
8195
8274
|
post_body = opts[:body]
|
8196
8275
|
|
8197
8276
|
# return_type
|
8198
|
-
return_type = opts[:return_type] || '
|
8277
|
+
return_type = opts[:return_type] || 'InlineResponse2009'
|
8199
8278
|
|
8200
8279
|
# auth_names
|
8201
8280
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8352,7 +8431,7 @@ module TalonOne
|
|
8352
8431
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8353
8432
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8354
8433
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8355
|
-
# @return [
|
8434
|
+
# @return [InlineResponse20043]
|
8356
8435
|
def get_users(opts = {})
|
8357
8436
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
8358
8437
|
data
|
@@ -8364,7 +8443,7 @@ module TalonOne
|
|
8364
8443
|
# @option opts [Integer] :page_size The number of items in the response.
|
8365
8444
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8366
8445
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8367
|
-
# @return [Array<(
|
8446
|
+
# @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
|
8368
8447
|
def get_users_with_http_info(opts = {})
|
8369
8448
|
if @api_client.config.debugging
|
8370
8449
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
@@ -8398,7 +8477,7 @@ module TalonOne
|
|
8398
8477
|
post_body = opts[:body]
|
8399
8478
|
|
8400
8479
|
# return_type
|
8401
|
-
return_type = opts[:return_type] || '
|
8480
|
+
return_type = opts[:return_type] || 'InlineResponse20043'
|
8402
8481
|
|
8403
8482
|
# auth_names
|
8404
8483
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8493,7 +8572,7 @@ module TalonOne
|
|
8493
8572
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8494
8573
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8495
8574
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8496
|
-
# @return [
|
8575
|
+
# @return [InlineResponse20040]
|
8497
8576
|
def get_webhook_activation_logs(opts = {})
|
8498
8577
|
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
8499
8578
|
data
|
@@ -8511,7 +8590,7 @@ module TalonOne
|
|
8511
8590
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8512
8591
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8513
8592
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8514
|
-
# @return [Array<(
|
8593
|
+
# @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
|
8515
8594
|
def get_webhook_activation_logs_with_http_info(opts = {})
|
8516
8595
|
if @api_client.config.debugging
|
8517
8596
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
|
@@ -8551,7 +8630,7 @@ module TalonOne
|
|
8551
8630
|
post_body = opts[:body]
|
8552
8631
|
|
8553
8632
|
# return_type
|
8554
|
-
return_type = opts[:return_type] || '
|
8633
|
+
return_type = opts[:return_type] || 'InlineResponse20040'
|
8555
8634
|
|
8556
8635
|
# auth_names
|
8557
8636
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8585,7 +8664,7 @@ module TalonOne
|
|
8585
8664
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
8586
8665
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8587
8666
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8588
|
-
# @return [
|
8667
|
+
# @return [InlineResponse20041]
|
8589
8668
|
def get_webhook_logs(opts = {})
|
8590
8669
|
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
8591
8670
|
data
|
@@ -8604,7 +8683,7 @@ module TalonOne
|
|
8604
8683
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
8605
8684
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8606
8685
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8607
|
-
# @return [Array<(
|
8686
|
+
# @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
|
8608
8687
|
def get_webhook_logs_with_http_info(opts = {})
|
8609
8688
|
if @api_client.config.debugging
|
8610
8689
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
@@ -8649,7 +8728,7 @@ module TalonOne
|
|
8649
8728
|
post_body = opts[:body]
|
8650
8729
|
|
8651
8730
|
# return_type
|
8652
|
-
return_type = opts[:return_type] || '
|
8731
|
+
return_type = opts[:return_type] || 'InlineResponse20041'
|
8653
8732
|
|
8654
8733
|
# auth_names
|
8655
8734
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8681,7 +8760,7 @@ module TalonOne
|
|
8681
8760
|
# @option opts [String] :visibility Filter results by visibility.
|
8682
8761
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
8683
8762
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
8684
|
-
# @return [
|
8763
|
+
# @return [InlineResponse20039]
|
8685
8764
|
def get_webhooks(opts = {})
|
8686
8765
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
8687
8766
|
data
|
@@ -8698,7 +8777,7 @@ module TalonOne
|
|
8698
8777
|
# @option opts [String] :visibility Filter results by visibility.
|
8699
8778
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
8700
8779
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
8701
|
-
# @return [Array<(
|
8780
|
+
# @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
|
8702
8781
|
def get_webhooks_with_http_info(opts = {})
|
8703
8782
|
if @api_client.config.debugging
|
8704
8783
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
@@ -8745,7 +8824,7 @@ module TalonOne
|
|
8745
8824
|
post_body = opts[:body]
|
8746
8825
|
|
8747
8826
|
# return_type
|
8748
|
-
return_type = opts[:return_type] || '
|
8827
|
+
return_type = opts[:return_type] || 'InlineResponse20039'
|
8749
8828
|
|
8750
8829
|
# auth_names
|
8751
8830
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9606,7 +9685,7 @@ module TalonOne
|
|
9606
9685
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
9607
9686
|
# @option opts [Boolean] :with_total_result_size 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.
|
9608
9687
|
# @option opts [String] :name Filter by collection name.
|
9609
|
-
# @return [
|
9688
|
+
# @return [InlineResponse20020]
|
9610
9689
|
def list_account_collections(opts = {})
|
9611
9690
|
data, _status_code, _headers = list_account_collections_with_http_info(opts)
|
9612
9691
|
data
|
@@ -9620,7 +9699,7 @@ module TalonOne
|
|
9620
9699
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
9621
9700
|
# @option opts [Boolean] :with_total_result_size 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.
|
9622
9701
|
# @option opts [String] :name Filter by collection name.
|
9623
|
-
# @return [Array<(
|
9702
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
9624
9703
|
def list_account_collections_with_http_info(opts = {})
|
9625
9704
|
if @api_client.config.debugging
|
9626
9705
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_account_collections ...'
|
@@ -9656,7 +9735,7 @@ module TalonOne
|
|
9656
9735
|
post_body = opts[:body]
|
9657
9736
|
|
9658
9737
|
# return_type
|
9659
|
-
return_type = opts[:return_type] || '
|
9738
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
9660
9739
|
|
9661
9740
|
# auth_names
|
9662
9741
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9685,7 +9764,7 @@ module TalonOne
|
|
9685
9764
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
9686
9765
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9687
9766
|
# @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
|
9688
|
-
# @return [
|
9767
|
+
# @return [InlineResponse20048]
|
9689
9768
|
def list_achievements(application_id, campaign_id, opts = {})
|
9690
9769
|
data, _status_code, _headers = list_achievements_with_http_info(application_id, campaign_id, opts)
|
9691
9770
|
data
|
@@ -9699,7 +9778,7 @@ module TalonOne
|
|
9699
9778
|
# @option opts [Integer] :page_size The number of items in the response.
|
9700
9779
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9701
9780
|
# @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
|
9702
|
-
# @return [Array<(
|
9781
|
+
# @return [Array<(InlineResponse20048, Integer, Hash)>] InlineResponse20048 data, response status code and response headers
|
9703
9782
|
def list_achievements_with_http_info(application_id, campaign_id, opts = {})
|
9704
9783
|
if @api_client.config.debugging
|
9705
9784
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_achievements ...'
|
@@ -9741,7 +9820,7 @@ module TalonOne
|
|
9741
9820
|
post_body = opts[:body]
|
9742
9821
|
|
9743
9822
|
# return_type
|
9744
|
-
return_type = opts[:return_type] || '
|
9823
|
+
return_type = opts[:return_type] || 'InlineResponse20048'
|
9745
9824
|
|
9746
9825
|
# auth_names
|
9747
9826
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9765,7 +9844,7 @@ module TalonOne
|
|
9765
9844
|
# List roles
|
9766
9845
|
# List all roles.
|
9767
9846
|
# @param [Hash] opts the optional parameters
|
9768
|
-
# @return [
|
9847
|
+
# @return [InlineResponse20046]
|
9769
9848
|
def list_all_roles_v2(opts = {})
|
9770
9849
|
data, _status_code, _headers = list_all_roles_v2_with_http_info(opts)
|
9771
9850
|
data
|
@@ -9774,7 +9853,7 @@ module TalonOne
|
|
9774
9853
|
# List roles
|
9775
9854
|
# List all roles.
|
9776
9855
|
# @param [Hash] opts the optional parameters
|
9777
|
-
# @return [Array<(
|
9856
|
+
# @return [Array<(InlineResponse20046, Integer, Hash)>] InlineResponse20046 data, response status code and response headers
|
9778
9857
|
def list_all_roles_v2_with_http_info(opts = {})
|
9779
9858
|
if @api_client.config.debugging
|
9780
9859
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_all_roles_v2 ...'
|
@@ -9797,7 +9876,7 @@ module TalonOne
|
|
9797
9876
|
post_body = opts[:body]
|
9798
9877
|
|
9799
9878
|
# return_type
|
9800
|
-
return_type = opts[:return_type] || '
|
9879
|
+
return_type = opts[:return_type] || 'InlineResponse20046'
|
9801
9880
|
|
9802
9881
|
# auth_names
|
9803
9882
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9827,7 +9906,7 @@ module TalonOne
|
|
9827
9906
|
# @option opts [Boolean] :with_total_result_size 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.
|
9828
9907
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
9829
9908
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
9830
|
-
# @return [
|
9909
|
+
# @return [InlineResponse20037]
|
9831
9910
|
def list_catalog_items(catalog_id, opts = {})
|
9832
9911
|
data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
|
9833
9912
|
data
|
@@ -9842,7 +9921,7 @@ module TalonOne
|
|
9842
9921
|
# @option opts [Boolean] :with_total_result_size 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.
|
9843
9922
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
9844
9923
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
9845
|
-
# @return [Array<(
|
9924
|
+
# @return [Array<(InlineResponse20037, Integer, Hash)>] InlineResponse20037 data, response status code and response headers
|
9846
9925
|
def list_catalog_items_with_http_info(catalog_id, opts = {})
|
9847
9926
|
if @api_client.config.debugging
|
9848
9927
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_catalog_items ...'
|
@@ -9882,7 +9961,7 @@ module TalonOne
|
|
9882
9961
|
post_body = opts[:body]
|
9883
9962
|
|
9884
9963
|
# return_type
|
9885
|
-
return_type = opts[:return_type] || '
|
9964
|
+
return_type = opts[:return_type] || 'InlineResponse20037'
|
9886
9965
|
|
9887
9966
|
# auth_names
|
9888
9967
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9913,7 +9992,7 @@ module TalonOne
|
|
9913
9992
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
9914
9993
|
# @option opts [Boolean] :with_total_result_size 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.
|
9915
9994
|
# @option opts [String] :name Filter by collection name.
|
9916
|
-
# @return [
|
9995
|
+
# @return [InlineResponse20020]
|
9917
9996
|
def list_collections(application_id, campaign_id, opts = {})
|
9918
9997
|
data, _status_code, _headers = list_collections_with_http_info(application_id, campaign_id, opts)
|
9919
9998
|
data
|
@@ -9929,7 +10008,7 @@ module TalonOne
|
|
9929
10008
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
9930
10009
|
# @option opts [Boolean] :with_total_result_size 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.
|
9931
10010
|
# @option opts [String] :name Filter by collection name.
|
9932
|
-
# @return [Array<(
|
10011
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
9933
10012
|
def list_collections_with_http_info(application_id, campaign_id, opts = {})
|
9934
10013
|
if @api_client.config.debugging
|
9935
10014
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_collections ...'
|
@@ -9973,7 +10052,7 @@ module TalonOne
|
|
9973
10052
|
post_body = opts[:body]
|
9974
10053
|
|
9975
10054
|
# return_type
|
9976
|
-
return_type = opts[:return_type] || '
|
10055
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
9977
10056
|
|
9978
10057
|
# auth_names
|
9979
10058
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10003,7 +10082,7 @@ module TalonOne
|
|
10003
10082
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
10004
10083
|
# @option opts [Boolean] :with_total_result_size 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.
|
10005
10084
|
# @option opts [String] :name Filter by collection name.
|
10006
|
-
# @return [
|
10085
|
+
# @return [InlineResponse20020]
|
10007
10086
|
def list_collections_in_application(application_id, opts = {})
|
10008
10087
|
data, _status_code, _headers = list_collections_in_application_with_http_info(application_id, opts)
|
10009
10088
|
data
|
@@ -10018,7 +10097,7 @@ module TalonOne
|
|
10018
10097
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
10019
10098
|
# @option opts [Boolean] :with_total_result_size 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.
|
10020
10099
|
# @option opts [String] :name Filter by collection name.
|
10021
|
-
# @return [Array<(
|
10100
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
10022
10101
|
def list_collections_in_application_with_http_info(application_id, opts = {})
|
10023
10102
|
if @api_client.config.debugging
|
10024
10103
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_collections_in_application ...'
|
@@ -10058,7 +10137,7 @@ module TalonOne
|
|
10058
10137
|
post_body = opts[:body]
|
10059
10138
|
|
10060
10139
|
# return_type
|
10061
|
-
return_type = opts[:return_type] || '
|
10140
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
10062
10141
|
|
10063
10142
|
# auth_names
|
10064
10143
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10091,7 +10170,7 @@ module TalonOne
|
|
10091
10170
|
# @option opts [String] :name The name of the store.
|
10092
10171
|
# @option opts [String] :integration_id The integration ID of the store.
|
10093
10172
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
10094
|
-
# @return [
|
10173
|
+
# @return [InlineResponse20047]
|
10095
10174
|
def list_stores(application_id, opts = {})
|
10096
10175
|
data, _status_code, _headers = list_stores_with_http_info(application_id, opts)
|
10097
10176
|
data
|
@@ -10109,7 +10188,7 @@ module TalonOne
|
|
10109
10188
|
# @option opts [String] :name The name of the store.
|
10110
10189
|
# @option opts [String] :integration_id The integration ID of the store.
|
10111
10190
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
10112
|
-
# @return [Array<(
|
10191
|
+
# @return [Array<(InlineResponse20047, Integer, Hash)>] InlineResponse20047 data, response status code and response headers
|
10113
10192
|
def list_stores_with_http_info(application_id, opts = {})
|
10114
10193
|
if @api_client.config.debugging
|
10115
10194
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_stores ...'
|
@@ -10152,7 +10231,7 @@ module TalonOne
|
|
10152
10231
|
post_body = opts[:body]
|
10153
10232
|
|
10154
10233
|
# return_type
|
10155
|
-
return_type = opts[:return_type] || '
|
10234
|
+
return_type = opts[:return_type] || 'InlineResponse20047'
|
10156
10235
|
|
10157
10236
|
# auth_names
|
10158
10237
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10296,7 +10375,7 @@ module TalonOne
|
|
10296
10375
|
end
|
10297
10376
|
|
10298
10377
|
# Create notification about added or deducted loyalty points
|
10299
|
-
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [
|
10378
|
+
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10300
10379
|
# @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
10301
10380
|
# @param body [NewBaseNotification] body
|
10302
10381
|
# @param [Hash] opts the optional parameters
|
@@ -10307,7 +10386,7 @@ module TalonOne
|
|
10307
10386
|
end
|
10308
10387
|
|
10309
10388
|
# Create notification about added or deducted loyalty points
|
10310
|
-
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [
|
10389
|
+
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10311
10390
|
# @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
10312
10391
|
# @param body [NewBaseNotification] body
|
10313
10392
|
# @param [Hash] opts the optional parameters
|
@@ -10366,7 +10445,7 @@ module TalonOne
|
|
10366
10445
|
end
|
10367
10446
|
|
10368
10447
|
# Create strikethrough notification
|
10369
|
-
# Create a notification for the in the given Application. For more information, see [
|
10448
|
+
# Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
10370
10449
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10371
10450
|
# @param body [NewBaseNotification] body
|
10372
10451
|
# @param [Hash] opts the optional parameters
|
@@ -10377,7 +10456,7 @@ module TalonOne
|
|
10377
10456
|
end
|
10378
10457
|
|
10379
10458
|
# Create strikethrough notification
|
10380
|
-
# Create a notification for the in the given Application. For more information, see [
|
10459
|
+
# Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
10381
10460
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10382
10461
|
# @param body [NewBaseNotification] body
|
10383
10462
|
# @param [Hash] opts the optional parameters
|
@@ -10436,7 +10515,7 @@ module TalonOne
|
|
10436
10515
|
end
|
10437
10516
|
|
10438
10517
|
# Create notification about pending loyalty points
|
10439
|
-
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [
|
10518
|
+
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10440
10519
|
# @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
10441
10520
|
# @param body [NewBaseNotification] body
|
10442
10521
|
# @param [Hash] opts the optional parameters
|
@@ -10447,7 +10526,7 @@ module TalonOne
|
|
10447
10526
|
end
|
10448
10527
|
|
10449
10528
|
# Create notification about pending loyalty points
|
10450
|
-
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [
|
10529
|
+
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10451
10530
|
# @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
10452
10531
|
# @param body [NewBaseNotification] body
|
10453
10532
|
# @param [Hash] opts the optional parameters
|
@@ -10508,7 +10587,7 @@ module TalonOne
|
|
10508
10587
|
# Deduct points from customer profile
|
10509
10588
|
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
10510
10589
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
10511
|
-
# @param integration_id [String] The identifier
|
10590
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
10512
10591
|
# @param body [DeductLoyaltyPoints] body
|
10513
10592
|
# @param [Hash] opts the optional parameters
|
10514
10593
|
# @return [nil]
|
@@ -10520,7 +10599,7 @@ module TalonOne
|
|
10520
10599
|
# Deduct points from customer profile
|
10521
10600
|
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
10522
10601
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
10523
|
-
# @param integration_id [String] The identifier
|
10602
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
10524
10603
|
# @param body [DeductLoyaltyPoints] body
|
10525
10604
|
# @param [Hash] opts the optional parameters
|
10526
10605
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -11213,7 +11292,7 @@ module TalonOne
|
|
11213
11292
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11214
11293
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
11215
11294
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
11216
|
-
# @return [
|
11295
|
+
# @return [InlineResponse20011]
|
11217
11296
|
def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
|
11218
11297
|
data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
|
11219
11298
|
data
|
@@ -11237,7 +11316,7 @@ module TalonOne
|
|
11237
11316
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11238
11317
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
11239
11318
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
11240
|
-
# @return [Array<(
|
11319
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
11241
11320
|
def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
|
11242
11321
|
if @api_client.config.debugging
|
11243
11322
|
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...'
|
@@ -11303,7 +11382,7 @@ module TalonOne
|
|
11303
11382
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11304
11383
|
|
11305
11384
|
# return_type
|
11306
|
-
return_type = opts[:return_type] || '
|
11385
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
11307
11386
|
|
11308
11387
|
# auth_names
|
11309
11388
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -11342,7 +11421,7 @@ module TalonOne
|
|
11342
11421
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11343
11422
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
11344
11423
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11345
|
-
# @return [
|
11424
|
+
# @return [InlineResponse20011]
|
11346
11425
|
def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {})
|
11347
11426
|
data, _status_code, _headers = search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts)
|
11348
11427
|
data
|
@@ -11366,7 +11445,7 @@ module TalonOne
|
|
11366
11445
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11367
11446
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
11368
11447
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11369
|
-
# @return [Array<(
|
11448
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
11370
11449
|
def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {})
|
11371
11450
|
if @api_client.config.debugging
|
11372
11451
|
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_without_total_count ...'
|
@@ -11431,7 +11510,7 @@ module TalonOne
|
|
11431
11510
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11432
11511
|
|
11433
11512
|
# return_type
|
11434
|
-
return_type = opts[:return_type] || '
|
11513
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
11435
11514
|
|
11436
11515
|
# auth_names
|
11437
11516
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|