talon_one 9.0.0 → 11.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/.github/workflows/autorelease.yml +123 -0
- data/README.md +89 -9
- data/docker-compose.yml +2 -2
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +4 -2
- data/docs/AchievementBase.md +4 -2
- data/docs/AchievementProgressWithDefinition.md +4 -2
- data/docs/AchievementStatusEntry.md +4 -2
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCustomer.md +3 -3
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +3 -3
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/BestPriorPrice.md +27 -0
- data/docs/BestPriorPriceMetadata.md +19 -0
- data/docs/BestPriorPriceRequest.md +25 -0
- data/docs/BestPriorPriceRequestTarget.md +19 -0
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDeletedNotification.md +6 -4
- data/docs/CampaignDeletedNotificationItem.md +21 -0
- data/docs/CampaignEditedNotification.md +6 -6
- data/docs/CampaignEditedNotificationItem.md +23 -0
- data/docs/CampaignEvaluationTreeChangedMessage.md +21 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignNotificationBase.md +19 -0
- data/docs/CampaignNotificationGeneric.md +21 -0
- data/docs/CampaignNotificationItemBase.md +17 -0
- data/docs/CampaignNotificationPolicy.md +1 -1
- data/docs/CampaignRulesetChangedNotification.md +6 -6
- data/docs/CampaignRulesetChangedNotificationItem.md +23 -0
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +1 -1
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CardAddedDeductedPointsNotification.md +45 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +1 -1
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/CardLedgerTransactionLogEntry.md +3 -1
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +4 -2
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +3 -3
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +7 -1
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/ExpiringCardPointsData.md +29 -0
- data/docs/ExpiringCardPointsNotification.md +21 -0
- data/docs/ExpiringCouponsData.md +35 -0
- data/docs/ExpiringCouponsNotification.md +21 -0
- data/docs/ExpiringCouponsNotificationPolicy.md +1 -1
- data/docs/ExpiringPointsData.md +25 -0
- data/docs/ExpiringPointsNotification.md +21 -0
- data/docs/ExpiringPointsNotificationPolicy.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/ExtendedCoupon.md +61 -0
- data/docs/GenerateAuditLogSummary.md +17 -0
- data/docs/GenerateCampaignDescription.md +3 -1
- data/docs/GenerateCouponFailureDetailedSummary.md +25 -0
- data/docs/GenerateCouponFailureSummary.md +19 -0
- data/docs/GenerateUserSessionSummary.md +19 -0
- data/docs/GetIntegrationCouponRequest.md +1 -1
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +1 -1
- data/docs/InlineResponse20042.md +4 -2
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +2 -4
- data/docs/InlineResponse20045.md +5 -3
- data/docs/InlineResponse20046.md +2 -4
- data/docs/InlineResponse20047.md +2 -6
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +91 -6
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +1819 -339
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +29 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +5 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +25 -0
- data/docs/PriceType.md +33 -0
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/RoleV2RolesGroup.md +3 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TemplateDef.md +1 -1
- data/docs/TierDowngradeData.md +31 -0
- data/docs/TierDowngradeNotification.md +21 -0
- data/docs/TierDowngradeNotificationPolicy.md +1 -1
- data/docs/TierUpgradeData.md +35 -0
- data/docs/TierUpgradeNotification.md +21 -0
- data/docs/TierUpgradeNotificationPolicy.md +1 -1
- data/docs/TierWillDowngradeData.md +31 -0
- data/docs/TierWillDowngradeNotification.md +21 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +1 -1
- data/docs/UpdateAchievement.md +4 -2
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/User.md +1 -1
- data/docs/Webhook.md +6 -2
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +5 -1
- data/lib/talon_one/api/integration_api.rb +110 -8
- data/lib/talon_one/api/management_api.rb +1123 -429
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +15 -5
- data/lib/talon_one/models/achievement_base.rb +17 -7
- data/lib/talon_one/models/achievement_progress_with_definition.rb +17 -7
- data/lib/talon_one/models/achievement_status_entry.rb +15 -5
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/added_deducted_points_notification.rb +478 -0
- data/lib/talon_one/models/analytics_sku.rb +23 -3
- data/lib/talon_one/models/application.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +3 -3
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/async_coupons_data.rb +272 -0
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +3 -3
- data/lib/talon_one/models/audience_reference.rb +256 -0
- data/lib/talon_one/models/base_loyalty_program.rb +1 -1
- data/lib/talon_one/models/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.rb +1 -1
- data/lib/talon_one/models/best_prior_price.rb +285 -0
- data/lib/talon_one/models/best_prior_price_metadata.rb +219 -0
- data/lib/talon_one/models/best_prior_price_request.rb +268 -0
- data/lib/talon_one/models/best_prior_price_request_target.rb +257 -0
- data/lib/talon_one/models/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_collection_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_created_notification.rb +30 -26
- data/lib/talon_one/models/campaign_created_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +33 -21
- data/lib/talon_one/models/campaign_deleted_notification_item.rb +242 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_message.rb +239 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_notification_base.rb +227 -0
- data/lib/talon_one/models/campaign_notification_generic.rb +244 -0
- data/lib/talon_one/models/campaign_notification_item_base.rb +212 -0
- data/lib/talon_one/models/campaign_notification_policy.rb +2 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +32 -23
- data/lib/talon_one/models/campaign_ruleset_changed_notification_item.rb +245 -0
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_state_changed_notification.rb +30 -42
- data/lib/talon_one/models/campaign_state_changed_notification_item.rb +266 -0
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_template.rb +1 -1
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/card_added_deducted_points_notification.rb +510 -0
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +16 -4
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- data/lib/talon_one/models/coupons_notification_data.rb +278 -0
- data/lib/talon_one/models/coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/create_achievement.rb +17 -7
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +3 -3
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.rb +1 -1
- data/lib/talon_one/models/deduct_loyalty_points.rb +0 -9
- data/lib/talon_one/models/delete_coupons_data.rb +310 -0
- data/lib/talon_one/models/effect.rb +31 -2
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -1
- data/lib/talon_one/models/expiring_card_points_data.rb +342 -0
- data/lib/talon_one/models/expiring_card_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_data.rb +369 -0
- data/lib/talon_one/models/expiring_coupons_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/expiring_points_data.rb +291 -0
- data/lib/talon_one/models/expiring_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/extended_coupon.rb +578 -0
- data/lib/talon_one/models/generate_audit_log_summary.rb +212 -0
- data/lib/talon_one/models/generate_campaign_description.rb +16 -1
- data/lib/talon_one/models/generate_coupon_failure_detailed_summary.rb +286 -0
- data/lib/talon_one/models/generate_coupon_failure_summary.rb +222 -0
- data/lib/talon_one/models/generate_user_session_summary.rb +227 -0
- data/lib/talon_one/models/get_integration_coupon_request.rb +2 -0
- data/lib/talon_one/models/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +1 -1
- data/lib/talon_one/models/inline_response20042.rb +11 -7
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +7 -11
- data/lib/talon_one/models/inline_response20045.rb +11 -7
- data/lib/talon_one/models/inline_response20046.rb +2 -21
- data/lib/talon_one/models/inline_response20047.rb +2 -25
- data/lib/talon_one/models/inline_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- data/lib/talon_one/models/jwt.rb +228 -0
- data/lib/talon_one/models/label_target_audience.rb +260 -0
- data/lib/talon_one/models/label_target_none.rb +246 -0
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- data/lib/talon_one/models/ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +17 -2
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_dashboard_data.rb +16 -1
- data/lib/talon_one/models/loyalty_ledger_entry_expiry_date_change.rb +238 -0
- data/lib/talon_one/models/loyalty_program.rb +1 -1
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- data/lib/talon_one/models/new_loyalty_program.rb +1 -1
- data/lib/talon_one/models/new_message_test.rb +28 -43
- data/lib/talon_one/models/new_price_adjustment.rb +297 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +29 -4
- data/lib/talon_one/models/pending_active_points_data.rb +308 -0
- data/lib/talon_one/models/pending_active_points_notification.rb +277 -0
- data/lib/talon_one/models/pending_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +247 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/price_type_reference_detail.rb +286 -0
- data/lib/talon_one/models/price_type_references.rb +224 -0
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/role_v2_roles_group.rb +14 -4
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- data/lib/talon_one/models/secondary_deployment.rb +367 -0
- data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_changed_item.rb +13 -1
- data/lib/talon_one/models/strikethrough_effect.rb +46 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +19 -4
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/tier_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_upgrade_data.rb +353 -0
- data/lib/talon_one/models/tier_upgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_will_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_will_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/update_achievement.rb +17 -7
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- data/lib/talon_one/models/update_coupons_data.rb +296 -0
- data/lib/talon_one/models/update_loyalty_program.rb +1 -1
- data/lib/talon_one/models/update_price_type.rb +239 -0
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +30 -5
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +27 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +73 -4
- data/spec/api/integration_api_spec.rb +26 -4
- data/spec/api/management_api_spec.rb +179 -51
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +7 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +7 -1
- data/spec/models/achievement_spec.rb +7 -1
- data/spec/models/achievement_status_entry_spec.rb +7 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/added_deducted_points_notification_spec.rb +125 -0
- data/spec/models/analytics_sku_spec.rb +12 -0
- data/spec/models/async_coupons_data_spec.rb +65 -0
- data/spec/models/audience_reference_spec.rb +53 -0
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/best_prior_price_metadata_spec.rb +47 -0
- data/spec/models/best_prior_price_request_spec.rb +65 -0
- data/spec/models/best_prior_price_request_target_spec.rb +51 -0
- data/spec/models/best_prior_price_spec.rb +71 -0
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_collection_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_collection_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_created_notification_item_spec.rb +59 -0
- data/spec/models/campaign_created_notification_spec.rb +3 -3
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_deleted_notification_item_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +53 -0
- data/spec/models/campaign_notification_base_spec.rb +47 -0
- data/spec/models/campaign_notification_generic_spec.rb +53 -0
- data/spec/models/campaign_notification_item_base_spec.rb +41 -0
- data/spec/models/campaign_ruleset_changed_notification_item_spec.rb +59 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_state_changed_notification_item_spec.rb +65 -0
- data/spec/models/campaign_state_changed_notification_spec.rb +3 -9
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/card_added_deducted_points_notification_spec.rb +137 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +6 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +7 -1
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/expiring_card_points_data_spec.rb +77 -0
- data/spec/models/expiring_card_points_notification_spec.rb +57 -0
- data/spec/models/expiring_coupons_data_spec.rb +95 -0
- data/spec/models/expiring_coupons_notification_spec.rb +57 -0
- data/spec/models/expiring_points_data_spec.rb +65 -0
- data/spec/models/expiring_points_notification_spec.rb +57 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/extended_coupon_spec.rb +173 -0
- data/spec/models/generate_audit_log_summary_spec.rb +41 -0
- data/spec/models/generate_campaign_description_spec.rb +6 -0
- data/spec/models/generate_coupon_failure_detailed_summary_spec.rb +65 -0
- data/spec/models/generate_coupon_failure_summary_spec.rb +47 -0
- data/spec/models/generate_user_session_summary_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +6 -0
- data/spec/models/inline_response20044_spec.rb +0 -6
- data/spec/models/inline_response20045_spec.rb +6 -0
- data/spec/models/inline_response20046_spec.rb +0 -6
- data/spec/models/inline_response20047_spec.rb +0 -12
- data/spec/models/inline_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/jwt_spec.rb +47 -0
- data/spec/models/label_target_audience_spec.rb +51 -0
- data/spec/models/label_target_none_spec.rb +45 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_expiry_date_change_spec.rb +53 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +10 -14
- data/spec/models/new_price_adjustment_spec.rb +77 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +12 -0
- data/spec/models/pending_active_points_data_spec.rb +77 -0
- data/spec/models/pending_active_points_notification_spec.rb +57 -0
- data/spec/models/price_detail_spec.rb +65 -0
- data/spec/models/price_type_reference_detail_spec.rb +63 -0
- data/spec/models/price_type_references_spec.rb +47 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -0
- data/spec/models/secondary_deployment_spec.rb +87 -0
- data/spec/models/set_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/strikethrough_changed_item_spec.rb +6 -0
- data/spec/models/strikethrough_effect_spec.rb +24 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/tier_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_downgrade_notification_spec.rb +57 -0
- data/spec/models/tier_upgrade_data_spec.rb +95 -0
- data/spec/models/tier_upgrade_notification_spec.rb +57 -0
- data/spec/models/tier_will_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_will_downgrade_notification_spec.rb +57 -0
- data/spec/models/update_achievement_spec.rb +7 -1
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +12 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +12 -0
- metadata +305 -3
- data/.github/dependabot.yml +0 -10
|
@@ -63,7 +63,7 @@ module TalonOne
|
|
|
63
63
|
return_type = opts[:return_type]
|
|
64
64
|
|
|
65
65
|
# auth_names
|
|
66
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
66
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
67
67
|
|
|
68
68
|
new_options = opts.merge(
|
|
69
69
|
:header_params => header_params,
|
|
@@ -143,7 +143,7 @@ module TalonOne
|
|
|
143
143
|
return_type = opts[:return_type]
|
|
144
144
|
|
|
145
145
|
# auth_names
|
|
146
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
146
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
147
147
|
|
|
148
148
|
new_options = opts.merge(
|
|
149
149
|
:header_params => header_params,
|
|
@@ -219,7 +219,7 @@ module TalonOne
|
|
|
219
219
|
return_type = opts[:return_type]
|
|
220
220
|
|
|
221
221
|
# auth_names
|
|
222
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
222
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
223
223
|
|
|
224
224
|
new_options = opts.merge(
|
|
225
225
|
:header_params => header_params,
|
|
@@ -295,7 +295,7 @@ module TalonOne
|
|
|
295
295
|
return_type = opts[:return_type] || 'InlineResponse2008'
|
|
296
296
|
|
|
297
297
|
# auth_names
|
|
298
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
298
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
299
299
|
|
|
300
300
|
new_options = opts.merge(
|
|
301
301
|
:header_params => header_params,
|
|
@@ -359,7 +359,7 @@ module TalonOne
|
|
|
359
359
|
return_type = opts[:return_type] || 'Collection'
|
|
360
360
|
|
|
361
361
|
# auth_names
|
|
362
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
362
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
363
363
|
|
|
364
364
|
new_options = opts.merge(
|
|
365
365
|
:header_params => header_params,
|
|
@@ -435,7 +435,7 @@ module TalonOne
|
|
|
435
435
|
return_type = opts[:return_type] || 'Achievement'
|
|
436
436
|
|
|
437
437
|
# auth_names
|
|
438
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
438
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
439
439
|
|
|
440
440
|
new_options = opts.merge(
|
|
441
441
|
:header_params => header_params,
|
|
@@ -499,7 +499,7 @@ module TalonOne
|
|
|
499
499
|
return_type = opts[:return_type] || 'AccountAdditionalCost'
|
|
500
500
|
|
|
501
501
|
# auth_names
|
|
502
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
502
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
503
503
|
|
|
504
504
|
new_options = opts.merge(
|
|
505
505
|
:header_params => header_params,
|
|
@@ -563,7 +563,7 @@ module TalonOne
|
|
|
563
563
|
return_type = opts[:return_type] || 'Attribute'
|
|
564
564
|
|
|
565
565
|
# auth_names
|
|
566
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
566
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
567
567
|
|
|
568
568
|
new_options = opts.merge(
|
|
569
569
|
:header_params => header_params,
|
|
@@ -633,7 +633,7 @@ module TalonOne
|
|
|
633
633
|
return_type = opts[:return_type] || 'LoyaltyCardBatchResponse'
|
|
634
634
|
|
|
635
635
|
# auth_names
|
|
636
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
636
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
637
637
|
|
|
638
638
|
new_options = opts.merge(
|
|
639
639
|
:header_params => header_params,
|
|
@@ -703,7 +703,7 @@ module TalonOne
|
|
|
703
703
|
return_type = opts[:return_type] || 'CreateTemplateCampaignResponse'
|
|
704
704
|
|
|
705
705
|
# auth_names
|
|
706
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
706
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
707
707
|
|
|
708
708
|
new_options = opts.merge(
|
|
709
709
|
:header_params => header_params,
|
|
@@ -721,6 +721,82 @@ module TalonOne
|
|
|
721
721
|
return data, status_code, headers
|
|
722
722
|
end
|
|
723
723
|
|
|
724
|
+
# Create campaign store budget
|
|
725
|
+
# Create a new store budget for a given campaign.
|
|
726
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
727
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
728
|
+
# @param body [NewCampaignStoreBudget] body
|
|
729
|
+
# @param [Hash] opts the optional parameters
|
|
730
|
+
# @return [nil]
|
|
731
|
+
def create_campaign_store_budget(application_id, campaign_id, body, opts = {})
|
|
732
|
+
create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts)
|
|
733
|
+
nil
|
|
734
|
+
end
|
|
735
|
+
|
|
736
|
+
# Create campaign store budget
|
|
737
|
+
# Create a new store budget for a given campaign.
|
|
738
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
739
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
740
|
+
# @param body [NewCampaignStoreBudget] body
|
|
741
|
+
# @param [Hash] opts the optional parameters
|
|
742
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
743
|
+
def create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts = {})
|
|
744
|
+
if @api_client.config.debugging
|
|
745
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.create_campaign_store_budget ...'
|
|
746
|
+
end
|
|
747
|
+
# verify the required parameter 'application_id' is set
|
|
748
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
|
749
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_campaign_store_budget"
|
|
750
|
+
end
|
|
751
|
+
# verify the required parameter 'campaign_id' is set
|
|
752
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
|
753
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_campaign_store_budget"
|
|
754
|
+
end
|
|
755
|
+
# verify the required parameter 'body' is set
|
|
756
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
757
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_campaign_store_budget"
|
|
758
|
+
end
|
|
759
|
+
# resource path
|
|
760
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
761
|
+
|
|
762
|
+
# query parameters
|
|
763
|
+
query_params = opts[:query_params] || {}
|
|
764
|
+
|
|
765
|
+
# header parameters
|
|
766
|
+
header_params = opts[:header_params] || {}
|
|
767
|
+
# HTTP header 'Accept' (if needed)
|
|
768
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
769
|
+
# HTTP header 'Content-Type'
|
|
770
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
771
|
+
|
|
772
|
+
# form parameters
|
|
773
|
+
form_params = opts[:form_params] || {}
|
|
774
|
+
|
|
775
|
+
# http body (model)
|
|
776
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
|
777
|
+
|
|
778
|
+
# return_type
|
|
779
|
+
return_type = opts[:return_type]
|
|
780
|
+
|
|
781
|
+
# auth_names
|
|
782
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
783
|
+
|
|
784
|
+
new_options = opts.merge(
|
|
785
|
+
:header_params => header_params,
|
|
786
|
+
:query_params => query_params,
|
|
787
|
+
:form_params => form_params,
|
|
788
|
+
:body => post_body,
|
|
789
|
+
:auth_names => auth_names,
|
|
790
|
+
:return_type => return_type
|
|
791
|
+
)
|
|
792
|
+
|
|
793
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
794
|
+
if @api_client.config.debugging
|
|
795
|
+
@api_client.config.logger.debug "API called: ManagementApi#create_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
796
|
+
end
|
|
797
|
+
return data, status_code, headers
|
|
798
|
+
end
|
|
799
|
+
|
|
724
800
|
# Create campaign-level collection
|
|
725
801
|
# Create a campaign-level collection in a given campaign.
|
|
726
802
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
@@ -779,7 +855,7 @@ module TalonOne
|
|
|
779
855
|
return_type = opts[:return_type] || 'Collection'
|
|
780
856
|
|
|
781
857
|
# auth_names
|
|
782
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
858
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
783
859
|
|
|
784
860
|
new_options = opts.merge(
|
|
785
861
|
:header_params => header_params,
|
|
@@ -858,7 +934,7 @@ module TalonOne
|
|
|
858
934
|
return_type = opts[:return_type] || 'InlineResponse20010'
|
|
859
935
|
|
|
860
936
|
# auth_names
|
|
861
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
937
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
862
938
|
|
|
863
939
|
new_options = opts.merge(
|
|
864
940
|
:header_params => header_params,
|
|
@@ -934,7 +1010,7 @@ module TalonOne
|
|
|
934
1010
|
return_type = opts[:return_type] || 'AsyncCouponCreationResponse'
|
|
935
1011
|
|
|
936
1012
|
# auth_names
|
|
937
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1013
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
938
1014
|
|
|
939
1015
|
new_options = opts.merge(
|
|
940
1016
|
:header_params => header_params,
|
|
@@ -1010,7 +1086,7 @@ module TalonOne
|
|
|
1010
1086
|
return_type = opts[:return_type] || 'AsyncCouponDeletionJobResponse'
|
|
1011
1087
|
|
|
1012
1088
|
# auth_names
|
|
1013
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1089
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1014
1090
|
|
|
1015
1091
|
new_options = opts.merge(
|
|
1016
1092
|
:header_params => header_params,
|
|
@@ -1089,7 +1165,7 @@ module TalonOne
|
|
|
1089
1165
|
return_type = opts[:return_type] || 'InlineResponse20010'
|
|
1090
1166
|
|
|
1091
1167
|
# auth_names
|
|
1092
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1168
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1093
1169
|
|
|
1094
1170
|
new_options = opts.merge(
|
|
1095
1171
|
:header_params => header_params,
|
|
@@ -1153,7 +1229,7 @@ module TalonOne
|
|
|
1153
1229
|
return_type = opts[:return_type] || 'NewInviteEmail'
|
|
1154
1230
|
|
|
1155
1231
|
# auth_names
|
|
1156
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1232
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1157
1233
|
|
|
1158
1234
|
new_options = opts.merge(
|
|
1159
1235
|
:header_params => header_params,
|
|
@@ -1217,7 +1293,7 @@ module TalonOne
|
|
|
1217
1293
|
return_type = opts[:return_type] || 'User'
|
|
1218
1294
|
|
|
1219
1295
|
# auth_names
|
|
1220
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1296
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1221
1297
|
|
|
1222
1298
|
new_options = opts.merge(
|
|
1223
1299
|
:header_params => header_params,
|
|
@@ -1281,7 +1357,7 @@ module TalonOne
|
|
|
1281
1357
|
return_type = opts[:return_type] || 'NewPasswordEmail'
|
|
1282
1358
|
|
|
1283
1359
|
# auth_names
|
|
1284
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1360
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1285
1361
|
|
|
1286
1362
|
new_options = opts.merge(
|
|
1287
1363
|
:header_params => header_params,
|
|
@@ -1345,7 +1421,7 @@ module TalonOne
|
|
|
1345
1421
|
return_type = opts[:return_type] || 'Session'
|
|
1346
1422
|
|
|
1347
1423
|
# auth_names
|
|
1348
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1424
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1349
1425
|
|
|
1350
1426
|
new_options = opts.merge(
|
|
1351
1427
|
:header_params => header_params,
|
|
@@ -1415,7 +1491,7 @@ module TalonOne
|
|
|
1415
1491
|
return_type = opts[:return_type] || 'Store'
|
|
1416
1492
|
|
|
1417
1493
|
# auth_names
|
|
1418
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1494
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1419
1495
|
|
|
1420
1496
|
new_options = opts.merge(
|
|
1421
1497
|
:header_params => header_params,
|
|
@@ -1477,7 +1553,7 @@ module TalonOne
|
|
|
1477
1553
|
return_type = opts[:return_type]
|
|
1478
1554
|
|
|
1479
1555
|
# auth_names
|
|
1480
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1556
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1481
1557
|
|
|
1482
1558
|
new_options = opts.merge(
|
|
1483
1559
|
:header_params => header_params,
|
|
@@ -1557,7 +1633,7 @@ module TalonOne
|
|
|
1557
1633
|
return_type = opts[:return_type]
|
|
1558
1634
|
|
|
1559
1635
|
# auth_names
|
|
1560
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1636
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1561
1637
|
|
|
1562
1638
|
new_options = opts.merge(
|
|
1563
1639
|
:header_params => header_params,
|
|
@@ -1619,7 +1695,7 @@ module TalonOne
|
|
|
1619
1695
|
return_type = opts[:return_type]
|
|
1620
1696
|
|
|
1621
1697
|
# auth_names
|
|
1622
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1698
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1623
1699
|
|
|
1624
1700
|
new_options = opts.merge(
|
|
1625
1701
|
:header_params => header_params,
|
|
@@ -1693,7 +1769,7 @@ module TalonOne
|
|
|
1693
1769
|
return_type = opts[:return_type]
|
|
1694
1770
|
|
|
1695
1771
|
# auth_names
|
|
1696
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1772
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1697
1773
|
|
|
1698
1774
|
new_options = opts.merge(
|
|
1699
1775
|
:header_params => header_params,
|
|
@@ -1759,7 +1835,7 @@ module TalonOne
|
|
|
1759
1835
|
return_type = opts[:return_type]
|
|
1760
1836
|
|
|
1761
1837
|
# auth_names
|
|
1762
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1838
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1763
1839
|
|
|
1764
1840
|
new_options = opts.merge(
|
|
1765
1841
|
:header_params => header_params,
|
|
@@ -1777,6 +1853,88 @@ module TalonOne
|
|
|
1777
1853
|
return data, status_code, headers
|
|
1778
1854
|
end
|
|
1779
1855
|
|
|
1856
|
+
# Delete campaign store budgets
|
|
1857
|
+
# Delete the store budgets for a given campaign.
|
|
1858
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1859
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1860
|
+
# @param [Hash] opts the optional parameters
|
|
1861
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
1862
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
1863
|
+
# @return [nil]
|
|
1864
|
+
def delete_campaign_store_budgets(application_id, campaign_id, opts = {})
|
|
1865
|
+
delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts)
|
|
1866
|
+
nil
|
|
1867
|
+
end
|
|
1868
|
+
|
|
1869
|
+
# Delete campaign store budgets
|
|
1870
|
+
# Delete the store budgets for a given campaign.
|
|
1871
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1872
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1873
|
+
# @param [Hash] opts the optional parameters
|
|
1874
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
1875
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
1876
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1877
|
+
def delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {})
|
|
1878
|
+
if @api_client.config.debugging
|
|
1879
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.delete_campaign_store_budgets ...'
|
|
1880
|
+
end
|
|
1881
|
+
# verify the required parameter 'application_id' is set
|
|
1882
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
|
1883
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_campaign_store_budgets"
|
|
1884
|
+
end
|
|
1885
|
+
# verify the required parameter 'campaign_id' is set
|
|
1886
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
|
1887
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_campaign_store_budgets"
|
|
1888
|
+
end
|
|
1889
|
+
allowable_values = ["setDiscount"]
|
|
1890
|
+
if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
|
|
1891
|
+
fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
|
|
1892
|
+
end
|
|
1893
|
+
allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
|
|
1894
|
+
if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
|
|
1895
|
+
fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
|
|
1896
|
+
end
|
|
1897
|
+
# resource path
|
|
1898
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
1899
|
+
|
|
1900
|
+
# query parameters
|
|
1901
|
+
query_params = opts[:query_params] || {}
|
|
1902
|
+
query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
|
|
1903
|
+
query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
|
|
1904
|
+
|
|
1905
|
+
# header parameters
|
|
1906
|
+
header_params = opts[:header_params] || {}
|
|
1907
|
+
# HTTP header 'Accept' (if needed)
|
|
1908
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1909
|
+
|
|
1910
|
+
# form parameters
|
|
1911
|
+
form_params = opts[:form_params] || {}
|
|
1912
|
+
|
|
1913
|
+
# http body (model)
|
|
1914
|
+
post_body = opts[:body]
|
|
1915
|
+
|
|
1916
|
+
# return_type
|
|
1917
|
+
return_type = opts[:return_type]
|
|
1918
|
+
|
|
1919
|
+
# auth_names
|
|
1920
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1921
|
+
|
|
1922
|
+
new_options = opts.merge(
|
|
1923
|
+
:header_params => header_params,
|
|
1924
|
+
:query_params => query_params,
|
|
1925
|
+
:form_params => form_params,
|
|
1926
|
+
:body => post_body,
|
|
1927
|
+
:auth_names => auth_names,
|
|
1928
|
+
:return_type => return_type
|
|
1929
|
+
)
|
|
1930
|
+
|
|
1931
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1932
|
+
if @api_client.config.debugging
|
|
1933
|
+
@api_client.config.logger.debug "API called: ManagementApi#delete_campaign_store_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1934
|
+
end
|
|
1935
|
+
return data, status_code, headers
|
|
1936
|
+
end
|
|
1937
|
+
|
|
1780
1938
|
# Delete campaign-level collection
|
|
1781
1939
|
# Delete a given campaign-level collection.
|
|
1782
1940
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
@@ -1833,7 +1991,7 @@ module TalonOne
|
|
|
1833
1991
|
return_type = opts[:return_type]
|
|
1834
1992
|
|
|
1835
1993
|
# auth_names
|
|
1836
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
1994
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1837
1995
|
|
|
1838
1996
|
new_options = opts.merge(
|
|
1839
1997
|
:header_params => header_params,
|
|
@@ -1905,7 +2063,7 @@ module TalonOne
|
|
|
1905
2063
|
return_type = opts[:return_type]
|
|
1906
2064
|
|
|
1907
2065
|
# auth_names
|
|
1908
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2066
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
1909
2067
|
|
|
1910
2068
|
new_options = opts.merge(
|
|
1911
2069
|
:header_params => header_params,
|
|
@@ -2018,7 +2176,7 @@ module TalonOne
|
|
|
2018
2176
|
return_type = opts[:return_type]
|
|
2019
2177
|
|
|
2020
2178
|
# auth_names
|
|
2021
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2179
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2022
2180
|
|
|
2023
2181
|
new_options = opts.merge(
|
|
2024
2182
|
:header_params => header_params,
|
|
@@ -2090,7 +2248,7 @@ module TalonOne
|
|
|
2090
2248
|
return_type = opts[:return_type]
|
|
2091
2249
|
|
|
2092
2250
|
# auth_names
|
|
2093
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2251
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2094
2252
|
|
|
2095
2253
|
new_options = opts.merge(
|
|
2096
2254
|
:header_params => header_params,
|
|
@@ -2162,7 +2320,7 @@ module TalonOne
|
|
|
2162
2320
|
return_type = opts[:return_type]
|
|
2163
2321
|
|
|
2164
2322
|
# auth_names
|
|
2165
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2323
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2166
2324
|
|
|
2167
2325
|
new_options = opts.merge(
|
|
2168
2326
|
:header_params => header_params,
|
|
@@ -2230,7 +2388,7 @@ module TalonOne
|
|
|
2230
2388
|
return_type = opts[:return_type]
|
|
2231
2389
|
|
|
2232
2390
|
# auth_names
|
|
2233
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2391
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2234
2392
|
|
|
2235
2393
|
new_options = opts.merge(
|
|
2236
2394
|
:header_params => header_params,
|
|
@@ -2290,7 +2448,7 @@ module TalonOne
|
|
|
2290
2448
|
return_type = opts[:return_type]
|
|
2291
2449
|
|
|
2292
2450
|
# auth_names
|
|
2293
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2451
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2294
2452
|
|
|
2295
2453
|
new_options = opts.merge(
|
|
2296
2454
|
:header_params => header_params,
|
|
@@ -2352,7 +2510,7 @@ module TalonOne
|
|
|
2352
2510
|
return_type = opts[:return_type]
|
|
2353
2511
|
|
|
2354
2512
|
# auth_names
|
|
2355
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2513
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2356
2514
|
|
|
2357
2515
|
new_options = opts.merge(
|
|
2358
2516
|
:header_params => header_params,
|
|
@@ -2406,7 +2564,7 @@ module TalonOne
|
|
|
2406
2564
|
return_type = opts[:return_type]
|
|
2407
2565
|
|
|
2408
2566
|
# auth_names
|
|
2409
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2567
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2410
2568
|
|
|
2411
2569
|
new_options = opts.merge(
|
|
2412
2570
|
:header_params => header_params,
|
|
@@ -2474,7 +2632,7 @@ module TalonOne
|
|
|
2474
2632
|
return_type = opts[:return_type]
|
|
2475
2633
|
|
|
2476
2634
|
# auth_names
|
|
2477
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2635
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2478
2636
|
|
|
2479
2637
|
new_options = opts.merge(
|
|
2480
2638
|
:header_params => header_params,
|
|
@@ -2536,7 +2694,7 @@ module TalonOne
|
|
|
2536
2694
|
return_type = opts[:return_type] || 'String'
|
|
2537
2695
|
|
|
2538
2696
|
# auth_names
|
|
2539
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2697
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2540
2698
|
|
|
2541
2699
|
new_options = opts.merge(
|
|
2542
2700
|
:header_params => header_params,
|
|
@@ -2610,7 +2768,7 @@ module TalonOne
|
|
|
2610
2768
|
return_type = opts[:return_type] || 'String'
|
|
2611
2769
|
|
|
2612
2770
|
# auth_names
|
|
2613
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2771
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2614
2772
|
|
|
2615
2773
|
new_options = opts.merge(
|
|
2616
2774
|
:header_params => header_params,
|
|
@@ -2672,7 +2830,7 @@ module TalonOne
|
|
|
2672
2830
|
return_type = opts[:return_type] || 'String'
|
|
2673
2831
|
|
|
2674
2832
|
# auth_names
|
|
2675
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2833
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2676
2834
|
|
|
2677
2835
|
new_options = opts.merge(
|
|
2678
2836
|
:header_params => header_params,
|
|
@@ -2690,6 +2848,88 @@ module TalonOne
|
|
|
2690
2848
|
return data, status_code, headers
|
|
2691
2849
|
end
|
|
2692
2850
|
|
|
2851
|
+
# Export campaign store budgets
|
|
2852
|
+
# Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
|
|
2853
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2854
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
2855
|
+
# @param [Hash] opts the optional parameters
|
|
2856
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
2857
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
2858
|
+
# @return [String]
|
|
2859
|
+
def export_campaign_store_budgets(application_id, campaign_id, opts = {})
|
|
2860
|
+
data, _status_code, _headers = export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts)
|
|
2861
|
+
data
|
|
2862
|
+
end
|
|
2863
|
+
|
|
2864
|
+
# Export campaign store budgets
|
|
2865
|
+
# Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
|
|
2866
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2867
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
2868
|
+
# @param [Hash] opts the optional parameters
|
|
2869
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
2870
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
2871
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
2872
|
+
def export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {})
|
|
2873
|
+
if @api_client.config.debugging
|
|
2874
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.export_campaign_store_budgets ...'
|
|
2875
|
+
end
|
|
2876
|
+
# verify the required parameter 'application_id' is set
|
|
2877
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
|
2878
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_campaign_store_budgets"
|
|
2879
|
+
end
|
|
2880
|
+
# verify the required parameter 'campaign_id' is set
|
|
2881
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
|
2882
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_campaign_store_budgets"
|
|
2883
|
+
end
|
|
2884
|
+
allowable_values = ["setDiscount"]
|
|
2885
|
+
if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
|
|
2886
|
+
fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
|
|
2887
|
+
end
|
|
2888
|
+
allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
|
|
2889
|
+
if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
|
|
2890
|
+
fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
|
|
2891
|
+
end
|
|
2892
|
+
# resource path
|
|
2893
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
2894
|
+
|
|
2895
|
+
# query parameters
|
|
2896
|
+
query_params = opts[:query_params] || {}
|
|
2897
|
+
query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
|
|
2898
|
+
query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
|
|
2899
|
+
|
|
2900
|
+
# header parameters
|
|
2901
|
+
header_params = opts[:header_params] || {}
|
|
2902
|
+
# HTTP header 'Accept' (if needed)
|
|
2903
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
|
|
2904
|
+
|
|
2905
|
+
# form parameters
|
|
2906
|
+
form_params = opts[:form_params] || {}
|
|
2907
|
+
|
|
2908
|
+
# http body (model)
|
|
2909
|
+
post_body = opts[:body]
|
|
2910
|
+
|
|
2911
|
+
# return_type
|
|
2912
|
+
return_type = opts[:return_type] || 'String'
|
|
2913
|
+
|
|
2914
|
+
# auth_names
|
|
2915
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2916
|
+
|
|
2917
|
+
new_options = opts.merge(
|
|
2918
|
+
:header_params => header_params,
|
|
2919
|
+
:query_params => query_params,
|
|
2920
|
+
:form_params => form_params,
|
|
2921
|
+
:body => post_body,
|
|
2922
|
+
:auth_names => auth_names,
|
|
2923
|
+
:return_type => return_type
|
|
2924
|
+
)
|
|
2925
|
+
|
|
2926
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2927
|
+
if @api_client.config.debugging
|
|
2928
|
+
@api_client.config.logger.debug "API called: ManagementApi#export_campaign_store_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2929
|
+
end
|
|
2930
|
+
return data, status_code, headers
|
|
2931
|
+
end
|
|
2932
|
+
|
|
2693
2933
|
# Export stores
|
|
2694
2934
|
# Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
|
|
2695
2935
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
@@ -2740,7 +2980,7 @@ module TalonOne
|
|
|
2740
2980
|
return_type = opts[:return_type] || 'String'
|
|
2741
2981
|
|
|
2742
2982
|
# auth_names
|
|
2743
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
2983
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2744
2984
|
|
|
2745
2985
|
new_options = opts.merge(
|
|
2746
2986
|
:header_params => header_params,
|
|
@@ -2814,7 +3054,7 @@ module TalonOne
|
|
|
2814
3054
|
return_type = opts[:return_type] || 'String'
|
|
2815
3055
|
|
|
2816
3056
|
# auth_names
|
|
2817
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3057
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2818
3058
|
|
|
2819
3059
|
new_options = opts.merge(
|
|
2820
3060
|
:header_params => header_params,
|
|
@@ -2934,7 +3174,7 @@ module TalonOne
|
|
|
2934
3174
|
return_type = opts[:return_type] || 'String'
|
|
2935
3175
|
|
|
2936
3176
|
# auth_names
|
|
2937
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3177
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
2938
3178
|
|
|
2939
3179
|
new_options = opts.merge(
|
|
2940
3180
|
:header_params => header_params,
|
|
@@ -2953,7 +3193,7 @@ module TalonOne
|
|
|
2953
3193
|
end
|
|
2954
3194
|
|
|
2955
3195
|
# Export customer sessions
|
|
2956
|
-
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/
|
|
3196
|
+
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
|
|
2957
3197
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2958
3198
|
# @param [Hash] opts the optional parameters
|
|
2959
3199
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
|
@@ -2968,7 +3208,7 @@ module TalonOne
|
|
|
2968
3208
|
end
|
|
2969
3209
|
|
|
2970
3210
|
# Export customer sessions
|
|
2971
|
-
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/
|
|
3211
|
+
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
|
|
2972
3212
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2973
3213
|
# @param [Hash] opts the optional parameters
|
|
2974
3214
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
|
@@ -3019,7 +3259,7 @@ module TalonOne
|
|
|
3019
3259
|
return_type = opts[:return_type] || 'String'
|
|
3020
3260
|
|
|
3021
3261
|
# auth_names
|
|
3022
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3262
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3023
3263
|
|
|
3024
3264
|
new_options = opts.merge(
|
|
3025
3265
|
:header_params => header_params,
|
|
@@ -3087,7 +3327,7 @@ module TalonOne
|
|
|
3087
3327
|
return_type = opts[:return_type] || 'String'
|
|
3088
3328
|
|
|
3089
3329
|
# auth_names
|
|
3090
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3330
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3091
3331
|
|
|
3092
3332
|
new_options = opts.merge(
|
|
3093
3333
|
:header_params => header_params,
|
|
@@ -3165,7 +3405,7 @@ module TalonOne
|
|
|
3165
3405
|
return_type = opts[:return_type] || 'String'
|
|
3166
3406
|
|
|
3167
3407
|
# auth_names
|
|
3168
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3408
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3169
3409
|
|
|
3170
3410
|
new_options = opts.merge(
|
|
3171
3411
|
:header_params => header_params,
|
|
@@ -3230,7 +3470,7 @@ module TalonOne
|
|
|
3230
3470
|
return_type = opts[:return_type] || 'String'
|
|
3231
3471
|
|
|
3232
3472
|
# auth_names
|
|
3233
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3473
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3234
3474
|
|
|
3235
3475
|
new_options = opts.merge(
|
|
3236
3476
|
:header_params => header_params,
|
|
@@ -3295,7 +3535,7 @@ module TalonOne
|
|
|
3295
3535
|
return_type = opts[:return_type] || 'String'
|
|
3296
3536
|
|
|
3297
3537
|
# auth_names
|
|
3298
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3538
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3299
3539
|
|
|
3300
3540
|
new_options = opts.merge(
|
|
3301
3541
|
:header_params => header_params,
|
|
@@ -3360,7 +3600,7 @@ module TalonOne
|
|
|
3360
3600
|
return_type = opts[:return_type] || 'String'
|
|
3361
3601
|
|
|
3362
3602
|
# auth_names
|
|
3363
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3603
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3364
3604
|
|
|
3365
3605
|
new_options = opts.merge(
|
|
3366
3606
|
:header_params => header_params,
|
|
@@ -3453,7 +3693,7 @@ module TalonOne
|
|
|
3453
3693
|
return_type = opts[:return_type] || 'String'
|
|
3454
3694
|
|
|
3455
3695
|
# auth_names
|
|
3456
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3696
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3457
3697
|
|
|
3458
3698
|
new_options = opts.merge(
|
|
3459
3699
|
:header_params => header_params,
|
|
@@ -3476,6 +3716,8 @@ module TalonOne
|
|
|
3476
3716
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
3477
3717
|
# @param [Hash] opts the optional parameters
|
|
3478
3718
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
|
3719
|
+
# @option opts [DateTime] :created_before Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
3720
|
+
# @option opts [DateTime] :created_after Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
3479
3721
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
|
3480
3722
|
# @return [String]
|
|
3481
3723
|
def export_loyalty_cards(loyalty_program_id, opts = {})
|
|
@@ -3488,6 +3730,8 @@ module TalonOne
|
|
|
3488
3730
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
3489
3731
|
# @param [Hash] opts the optional parameters
|
|
3490
3732
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
|
3733
|
+
# @option opts [DateTime] :created_before Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
3734
|
+
# @option opts [DateTime] :created_after Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
3491
3735
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
|
3492
3736
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
3493
3737
|
def export_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
|
@@ -3508,6 +3752,8 @@ module TalonOne
|
|
|
3508
3752
|
# query parameters
|
|
3509
3753
|
query_params = opts[:query_params] || {}
|
|
3510
3754
|
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
|
3755
|
+
query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
|
3756
|
+
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
|
3511
3757
|
query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
|
|
3512
3758
|
|
|
3513
3759
|
# header parameters
|
|
@@ -3525,7 +3771,7 @@ module TalonOne
|
|
|
3525
3771
|
return_type = opts[:return_type] || 'String'
|
|
3526
3772
|
|
|
3527
3773
|
# auth_names
|
|
3528
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3774
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3529
3775
|
|
|
3530
3776
|
new_options = opts.merge(
|
|
3531
3777
|
:header_params => header_params,
|
|
@@ -3544,7 +3790,7 @@ module TalonOne
|
|
|
3544
3790
|
end
|
|
3545
3791
|
|
|
3546
3792
|
# Export customer's transaction logs
|
|
3547
|
-
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
|
3793
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
|
|
3548
3794
|
# @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
3795
|
# @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
3796
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
|
@@ -3558,7 +3804,7 @@ module TalonOne
|
|
|
3558
3804
|
end
|
|
3559
3805
|
|
|
3560
3806
|
# Export customer's transaction logs
|
|
3561
|
-
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
|
3807
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
|
|
3562
3808
|
# @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
3809
|
# @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
3810
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
|
@@ -3614,7 +3860,7 @@ module TalonOne
|
|
|
3614
3860
|
return_type = opts[:return_type] || 'String'
|
|
3615
3861
|
|
|
3616
3862
|
# auth_names
|
|
3617
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3863
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3618
3864
|
|
|
3619
3865
|
new_options = opts.merge(
|
|
3620
3866
|
:header_params => header_params,
|
|
@@ -3682,7 +3928,7 @@ module TalonOne
|
|
|
3682
3928
|
return_type = opts[:return_type] || 'String'
|
|
3683
3929
|
|
|
3684
3930
|
# auth_names
|
|
3685
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
3931
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3686
3932
|
|
|
3687
3933
|
new_options = opts.merge(
|
|
3688
3934
|
:header_params => header_params,
|
|
@@ -3777,7 +4023,7 @@ module TalonOne
|
|
|
3777
4023
|
return_type = opts[:return_type] || 'String'
|
|
3778
4024
|
|
|
3779
4025
|
# auth_names
|
|
3780
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4026
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3781
4027
|
|
|
3782
4028
|
new_options = opts.merge(
|
|
3783
4029
|
:header_params => header_params,
|
|
@@ -3887,7 +4133,7 @@ module TalonOne
|
|
|
3887
4133
|
return_type = opts[:return_type] || 'InlineResponse20022'
|
|
3888
4134
|
|
|
3889
4135
|
# auth_names
|
|
3890
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4136
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3891
4137
|
|
|
3892
4138
|
new_options = opts.merge(
|
|
3893
4139
|
:header_params => header_params,
|
|
@@ -3949,7 +4195,7 @@ module TalonOne
|
|
|
3949
4195
|
return_type = opts[:return_type] || 'Account'
|
|
3950
4196
|
|
|
3951
4197
|
# auth_names
|
|
3952
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4198
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
3953
4199
|
|
|
3954
4200
|
new_options = opts.merge(
|
|
3955
4201
|
:header_params => header_params,
|
|
@@ -4011,7 +4257,7 @@ module TalonOne
|
|
|
4011
4257
|
return_type = opts[:return_type] || 'AccountAnalytics'
|
|
4012
4258
|
|
|
4013
4259
|
# auth_names
|
|
4014
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4260
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4015
4261
|
|
|
4016
4262
|
new_options = opts.merge(
|
|
4017
4263
|
:header_params => header_params,
|
|
@@ -4073,7 +4319,7 @@ module TalonOne
|
|
|
4073
4319
|
return_type = opts[:return_type] || 'Collection'
|
|
4074
4320
|
|
|
4075
4321
|
# auth_names
|
|
4076
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4322
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4077
4323
|
|
|
4078
4324
|
new_options = opts.merge(
|
|
4079
4325
|
:header_params => header_params,
|
|
@@ -4147,7 +4393,7 @@ module TalonOne
|
|
|
4147
4393
|
return_type = opts[:return_type] || 'Achievement'
|
|
4148
4394
|
|
|
4149
4395
|
# auth_names
|
|
4150
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4396
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4151
4397
|
|
|
4152
4398
|
new_options = opts.merge(
|
|
4153
4399
|
:header_params => header_params,
|
|
@@ -4209,7 +4455,7 @@ module TalonOne
|
|
|
4209
4455
|
return_type = opts[:return_type] || 'AccountAdditionalCost'
|
|
4210
4456
|
|
|
4211
4457
|
# auth_names
|
|
4212
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4458
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4213
4459
|
|
|
4214
4460
|
new_options = opts.merge(
|
|
4215
4461
|
:header_params => header_params,
|
|
@@ -4282,7 +4528,7 @@ module TalonOne
|
|
|
4282
4528
|
return_type = opts[:return_type] || 'InlineResponse20038'
|
|
4283
4529
|
|
|
4284
4530
|
# auth_names
|
|
4285
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4531
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4286
4532
|
|
|
4287
4533
|
new_options = opts.merge(
|
|
4288
4534
|
:header_params => header_params,
|
|
@@ -4344,7 +4590,7 @@ module TalonOne
|
|
|
4344
4590
|
return_type = opts[:return_type] || 'Application'
|
|
4345
4591
|
|
|
4346
4592
|
# auth_names
|
|
4347
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4593
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4348
4594
|
|
|
4349
4595
|
new_options = opts.merge(
|
|
4350
4596
|
:header_params => header_params,
|
|
@@ -4406,7 +4652,7 @@ module TalonOne
|
|
|
4406
4652
|
return_type = opts[:return_type] || 'ApplicationApiHealth'
|
|
4407
4653
|
|
|
4408
4654
|
# auth_names
|
|
4409
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4655
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4410
4656
|
|
|
4411
4657
|
new_options = opts.merge(
|
|
4412
4658
|
:header_params => header_params,
|
|
@@ -4474,7 +4720,7 @@ module TalonOne
|
|
|
4474
4720
|
return_type = opts[:return_type] || 'ApplicationCustomer'
|
|
4475
4721
|
|
|
4476
4722
|
# auth_names
|
|
4477
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4723
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4478
4724
|
|
|
4479
4725
|
new_options = opts.merge(
|
|
4480
4726
|
:header_params => header_params,
|
|
@@ -4562,7 +4808,7 @@ module TalonOne
|
|
|
4562
4808
|
return_type = opts[:return_type] || 'InlineResponse20035'
|
|
4563
4809
|
|
|
4564
4810
|
# auth_names
|
|
4565
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4811
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4566
4812
|
|
|
4567
4813
|
new_options = opts.merge(
|
|
4568
4814
|
:header_params => header_params,
|
|
@@ -4644,7 +4890,7 @@ module TalonOne
|
|
|
4644
4890
|
return_type = opts[:return_type] || 'InlineResponse20024'
|
|
4645
4891
|
|
|
4646
4892
|
# auth_names
|
|
4647
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4893
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4648
4894
|
|
|
4649
4895
|
new_options = opts.merge(
|
|
4650
4896
|
:header_params => header_params,
|
|
@@ -4731,7 +4977,7 @@ module TalonOne
|
|
|
4731
4977
|
return_type = opts[:return_type] || 'InlineResponse20025'
|
|
4732
4978
|
|
|
4733
4979
|
# auth_names
|
|
4734
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
4980
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4735
4981
|
|
|
4736
4982
|
new_options = opts.merge(
|
|
4737
4983
|
:header_params => header_params,
|
|
@@ -4810,7 +5056,7 @@ module TalonOne
|
|
|
4810
5056
|
return_type = opts[:return_type] || 'InlineResponse20031'
|
|
4811
5057
|
|
|
4812
5058
|
# auth_names
|
|
4813
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5059
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4814
5060
|
|
|
4815
5061
|
new_options = opts.merge(
|
|
4816
5062
|
:header_params => header_params,
|
|
@@ -4846,6 +5092,7 @@ module TalonOne
|
|
|
4846
5092
|
# @option opts [String] :referral_code Referral code
|
|
4847
5093
|
# @option opts [String] :rule_query Rule name filter for events
|
|
4848
5094
|
# @option opts [String] :campaign_query Campaign name filter for events
|
|
5095
|
+
# @option opts [String] :effect_type The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
|
|
4849
5096
|
# @return [InlineResponse20030]
|
|
4850
5097
|
def get_application_events_without_total_count(application_id, opts = {})
|
|
4851
5098
|
data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
|
|
@@ -4870,6 +5117,7 @@ module TalonOne
|
|
|
4870
5117
|
# @option opts [String] :referral_code Referral code
|
|
4871
5118
|
# @option opts [String] :rule_query Rule name filter for events
|
|
4872
5119
|
# @option opts [String] :campaign_query Campaign name filter for events
|
|
5120
|
+
# @option opts [String] :effect_type The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
|
|
4873
5121
|
# @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
|
|
4874
5122
|
def get_application_events_without_total_count_with_http_info(application_id, opts = {})
|
|
4875
5123
|
if @api_client.config.debugging
|
|
@@ -4914,6 +5162,7 @@ module TalonOne
|
|
|
4914
5162
|
query_params[:'referralCode'] = opts[:'referral_code'] if !opts[:'referral_code'].nil?
|
|
4915
5163
|
query_params[:'ruleQuery'] = opts[:'rule_query'] if !opts[:'rule_query'].nil?
|
|
4916
5164
|
query_params[:'campaignQuery'] = opts[:'campaign_query'] if !opts[:'campaign_query'].nil?
|
|
5165
|
+
query_params[:'effectType'] = opts[:'effect_type'] if !opts[:'effect_type'].nil?
|
|
4917
5166
|
|
|
4918
5167
|
# header parameters
|
|
4919
5168
|
header_params = opts[:header_params] || {}
|
|
@@ -4930,7 +5179,7 @@ module TalonOne
|
|
|
4930
5179
|
return_type = opts[:return_type] || 'InlineResponse20030'
|
|
4931
5180
|
|
|
4932
5181
|
# auth_names
|
|
4933
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5182
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
4934
5183
|
|
|
4935
5184
|
new_options = opts.merge(
|
|
4936
5185
|
:header_params => header_params,
|
|
@@ -4998,7 +5247,7 @@ module TalonOne
|
|
|
4998
5247
|
return_type = opts[:return_type] || 'ApplicationSession'
|
|
4999
5248
|
|
|
5000
5249
|
# auth_names
|
|
5001
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5250
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5002
5251
|
|
|
5003
5252
|
new_options = opts.merge(
|
|
5004
5253
|
:header_params => header_params,
|
|
@@ -5105,7 +5354,7 @@ module TalonOne
|
|
|
5105
5354
|
return_type = opts[:return_type] || 'InlineResponse20029'
|
|
5106
5355
|
|
|
5107
5356
|
# auth_names
|
|
5108
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5357
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5109
5358
|
|
|
5110
5359
|
new_options = opts.merge(
|
|
5111
5360
|
:header_params => header_params,
|
|
@@ -5178,7 +5427,7 @@ module TalonOne
|
|
|
5178
5427
|
return_type = opts[:return_type] || 'InlineResponse2007'
|
|
5179
5428
|
|
|
5180
5429
|
# auth_names
|
|
5181
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5430
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5182
5431
|
|
|
5183
5432
|
new_options = opts.merge(
|
|
5184
5433
|
:header_params => header_params,
|
|
@@ -5240,7 +5489,7 @@ module TalonOne
|
|
|
5240
5489
|
return_type = opts[:return_type] || 'Attribute'
|
|
5241
5490
|
|
|
5242
5491
|
# auth_names
|
|
5243
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5492
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5244
5493
|
|
|
5245
5494
|
new_options = opts.merge(
|
|
5246
5495
|
:header_params => header_params,
|
|
@@ -5316,7 +5565,7 @@ module TalonOne
|
|
|
5316
5565
|
return_type = opts[:return_type] || 'InlineResponse20036'
|
|
5317
5566
|
|
|
5318
5567
|
# auth_names
|
|
5319
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5568
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5320
5569
|
|
|
5321
5570
|
new_options = opts.merge(
|
|
5322
5571
|
:header_params => header_params,
|
|
@@ -5398,7 +5647,7 @@ module TalonOne
|
|
|
5398
5647
|
return_type = opts[:return_type] || 'InlineResponse20034'
|
|
5399
5648
|
|
|
5400
5649
|
# auth_names
|
|
5401
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5650
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5402
5651
|
|
|
5403
5652
|
new_options = opts.merge(
|
|
5404
5653
|
:header_params => header_params,
|
|
@@ -5474,7 +5723,7 @@ module TalonOne
|
|
|
5474
5723
|
return_type = opts[:return_type] || 'InlineResponse20032'
|
|
5475
5724
|
|
|
5476
5725
|
# auth_names
|
|
5477
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5726
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5478
5727
|
|
|
5479
5728
|
new_options = opts.merge(
|
|
5480
5729
|
:header_params => header_params,
|
|
@@ -5540,7 +5789,7 @@ module TalonOne
|
|
|
5540
5789
|
return_type = opts[:return_type] || 'InlineResponse20033'
|
|
5541
5790
|
|
|
5542
5791
|
# auth_names
|
|
5543
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5792
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5544
5793
|
|
|
5545
5794
|
new_options = opts.merge(
|
|
5546
5795
|
:header_params => header_params,
|
|
@@ -5608,7 +5857,7 @@ module TalonOne
|
|
|
5608
5857
|
return_type = opts[:return_type] || 'Campaign'
|
|
5609
5858
|
|
|
5610
5859
|
# auth_names
|
|
5611
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5860
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5612
5861
|
|
|
5613
5862
|
new_options = opts.merge(
|
|
5614
5863
|
:header_params => header_params,
|
|
@@ -5697,7 +5946,7 @@ module TalonOne
|
|
|
5697
5946
|
return_type = opts[:return_type] || 'InlineResponse20023'
|
|
5698
5947
|
|
|
5699
5948
|
# auth_names
|
|
5700
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
5949
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5701
5950
|
|
|
5702
5951
|
new_options = opts.merge(
|
|
5703
5952
|
:header_params => header_params,
|
|
@@ -5791,7 +6040,7 @@ module TalonOne
|
|
|
5791
6040
|
return_type = opts[:return_type] || 'InlineResponse2008'
|
|
5792
6041
|
|
|
5793
6042
|
# auth_names
|
|
5794
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6043
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5795
6044
|
|
|
5796
6045
|
new_options = opts.merge(
|
|
5797
6046
|
:header_params => header_params,
|
|
@@ -5853,7 +6102,7 @@ module TalonOne
|
|
|
5853
6102
|
return_type = opts[:return_type] || 'CampaignGroup'
|
|
5854
6103
|
|
|
5855
6104
|
# auth_names
|
|
5856
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6105
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5857
6106
|
|
|
5858
6107
|
new_options = opts.merge(
|
|
5859
6108
|
:header_params => header_params,
|
|
@@ -5926,7 +6175,7 @@ module TalonOne
|
|
|
5926
6175
|
return_type = opts[:return_type] || 'InlineResponse20013'
|
|
5927
6176
|
|
|
5928
6177
|
# auth_names
|
|
5929
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6178
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
5930
6179
|
|
|
5931
6180
|
new_options = opts.merge(
|
|
5932
6181
|
:header_params => header_params,
|
|
@@ -6015,7 +6264,7 @@ module TalonOne
|
|
|
6015
6264
|
return_type = opts[:return_type] || 'InlineResponse20014'
|
|
6016
6265
|
|
|
6017
6266
|
# auth_names
|
|
6018
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6267
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6019
6268
|
|
|
6020
6269
|
new_options = opts.merge(
|
|
6021
6270
|
:header_params => header_params,
|
|
@@ -6122,7 +6371,7 @@ module TalonOne
|
|
|
6122
6371
|
return_type = opts[:return_type] || 'InlineResponse2008'
|
|
6123
6372
|
|
|
6124
6373
|
# auth_names
|
|
6125
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6374
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6126
6375
|
|
|
6127
6376
|
new_options = opts.merge(
|
|
6128
6377
|
:header_params => header_params,
|
|
@@ -6154,7 +6403,7 @@ module TalonOne
|
|
|
6154
6403
|
# @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
6404
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
|
6156
6405
|
# @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 [
|
|
6406
|
+
# @return [InlineResponse20042]
|
|
6158
6407
|
def get_changes(opts = {})
|
|
6159
6408
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
|
6160
6409
|
data
|
|
@@ -6174,7 +6423,7 @@ module TalonOne
|
|
|
6174
6423
|
# @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
6424
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
|
6176
6425
|
# @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<(
|
|
6426
|
+
# @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
|
|
6178
6427
|
def get_changes_with_http_info(opts = {})
|
|
6179
6428
|
if @api_client.config.debugging
|
|
6180
6429
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
|
@@ -6216,10 +6465,10 @@ module TalonOne
|
|
|
6216
6465
|
post_body = opts[:body]
|
|
6217
6466
|
|
|
6218
6467
|
# return_type
|
|
6219
|
-
return_type = opts[:return_type] || '
|
|
6468
|
+
return_type = opts[:return_type] || 'InlineResponse20042'
|
|
6220
6469
|
|
|
6221
6470
|
# auth_names
|
|
6222
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6471
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6223
6472
|
|
|
6224
6473
|
new_options = opts.merge(
|
|
6225
6474
|
:header_params => header_params,
|
|
@@ -6293,7 +6542,7 @@ module TalonOne
|
|
|
6293
6542
|
return_type = opts[:return_type] || 'Collection'
|
|
6294
6543
|
|
|
6295
6544
|
# auth_names
|
|
6296
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6545
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6297
6546
|
|
|
6298
6547
|
new_options = opts.merge(
|
|
6299
6548
|
:header_params => header_params,
|
|
@@ -6369,7 +6618,7 @@ module TalonOne
|
|
|
6369
6618
|
return_type = opts[:return_type] || 'InlineResponse20021'
|
|
6370
6619
|
|
|
6371
6620
|
# auth_names
|
|
6372
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6621
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6373
6622
|
|
|
6374
6623
|
new_options = opts.merge(
|
|
6375
6624
|
:header_params => header_params,
|
|
@@ -6511,7 +6760,7 @@ module TalonOne
|
|
|
6511
6760
|
return_type = opts[:return_type] || 'InlineResponse20011'
|
|
6512
6761
|
|
|
6513
6762
|
# auth_names
|
|
6514
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6763
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6515
6764
|
|
|
6516
6765
|
new_options = opts.merge(
|
|
6517
6766
|
:header_params => header_params,
|
|
@@ -6607,7 +6856,7 @@ module TalonOne
|
|
|
6607
6856
|
return_type = opts[:return_type] || 'CustomerActivityReport'
|
|
6608
6857
|
|
|
6609
6858
|
# auth_names
|
|
6610
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6859
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6611
6860
|
|
|
6612
6861
|
new_options = opts.merge(
|
|
6613
6862
|
:header_params => header_params,
|
|
@@ -6712,7 +6961,7 @@ module TalonOne
|
|
|
6712
6961
|
return_type = opts[:return_type] || 'InlineResponse20028'
|
|
6713
6962
|
|
|
6714
6963
|
# auth_names
|
|
6715
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
6964
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6716
6965
|
|
|
6717
6966
|
new_options = opts.merge(
|
|
6718
6967
|
:header_params => header_params,
|
|
@@ -6797,7 +7046,7 @@ module TalonOne
|
|
|
6797
7046
|
return_type = opts[:return_type] || 'CustomerAnalytics'
|
|
6798
7047
|
|
|
6799
7048
|
# auth_names
|
|
6800
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7049
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6801
7050
|
|
|
6802
7051
|
new_options = opts.merge(
|
|
6803
7052
|
:header_params => header_params,
|
|
@@ -6859,7 +7108,7 @@ module TalonOne
|
|
|
6859
7108
|
return_type = opts[:return_type] || 'CustomerProfile'
|
|
6860
7109
|
|
|
6861
7110
|
# auth_names
|
|
6862
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7111
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6863
7112
|
|
|
6864
7113
|
new_options = opts.merge(
|
|
6865
7114
|
:header_params => header_params,
|
|
@@ -6947,7 +7196,7 @@ module TalonOne
|
|
|
6947
7196
|
return_type = opts[:return_type] || 'InlineResponse20049'
|
|
6948
7197
|
|
|
6949
7198
|
# auth_names
|
|
6950
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7199
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
6951
7200
|
|
|
6952
7201
|
new_options = opts.merge(
|
|
6953
7202
|
:header_params => header_params,
|
|
@@ -7020,7 +7269,7 @@ module TalonOne
|
|
|
7020
7269
|
return_type = opts[:return_type] || 'InlineResponse20027'
|
|
7021
7270
|
|
|
7022
7271
|
# auth_names
|
|
7023
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7272
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7024
7273
|
|
|
7025
7274
|
new_options = opts.merge(
|
|
7026
7275
|
:header_params => header_params,
|
|
@@ -7101,7 +7350,7 @@ module TalonOne
|
|
|
7101
7350
|
return_type = opts[:return_type] || 'InlineResponse20026'
|
|
7102
7351
|
|
|
7103
7352
|
# auth_names
|
|
7104
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7353
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7105
7354
|
|
|
7106
7355
|
new_options = opts.merge(
|
|
7107
7356
|
:header_params => header_params,
|
|
@@ -7180,7 +7429,7 @@ module TalonOne
|
|
|
7180
7429
|
return_type = opts[:return_type] || 'InlineResponse20016'
|
|
7181
7430
|
|
|
7182
7431
|
# auth_names
|
|
7183
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7432
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7184
7433
|
|
|
7185
7434
|
new_options = opts.merge(
|
|
7186
7435
|
:header_params => header_params,
|
|
@@ -7206,7 +7455,7 @@ module TalonOne
|
|
|
7206
7455
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
7207
7456
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
7208
7457
|
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
7209
|
-
# @return [
|
|
7458
|
+
# @return [InlineResponse20040]
|
|
7210
7459
|
def get_event_types(opts = {})
|
|
7211
7460
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
|
7212
7461
|
data
|
|
@@ -7220,7 +7469,7 @@ module TalonOne
|
|
|
7220
7469
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
7221
7470
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
7222
7471
|
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
7223
|
-
# @return [Array<(
|
|
7472
|
+
# @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
|
|
7224
7473
|
def get_event_types_with_http_info(opts = {})
|
|
7225
7474
|
if @api_client.config.debugging
|
|
7226
7475
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
|
@@ -7256,10 +7505,10 @@ module TalonOne
|
|
|
7256
7505
|
post_body = opts[:body]
|
|
7257
7506
|
|
|
7258
7507
|
# return_type
|
|
7259
|
-
return_type = opts[:return_type] || '
|
|
7508
|
+
return_type = opts[:return_type] || 'InlineResponse20040'
|
|
7260
7509
|
|
|
7261
7510
|
# auth_names
|
|
7262
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7511
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7263
7512
|
|
|
7264
7513
|
new_options = opts.merge(
|
|
7265
7514
|
:header_params => header_params,
|
|
@@ -7285,7 +7534,7 @@ module TalonOne
|
|
|
7285
7534
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
7286
7535
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
|
7287
7536
|
# @option opts [String] :entity The name of the entity type that was exported.
|
|
7288
|
-
# @return [
|
|
7537
|
+
# @return [InlineResponse20043]
|
|
7289
7538
|
def get_exports(opts = {})
|
|
7290
7539
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
|
7291
7540
|
data
|
|
@@ -7299,7 +7548,7 @@ module TalonOne
|
|
|
7299
7548
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
7300
7549
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
|
7301
7550
|
# @option opts [String] :entity The name of the entity type that was exported.
|
|
7302
|
-
# @return [Array<(
|
|
7551
|
+
# @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
|
|
7303
7552
|
def get_exports_with_http_info(opts = {})
|
|
7304
7553
|
if @api_client.config.debugging
|
|
7305
7554
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
|
@@ -7339,10 +7588,10 @@ module TalonOne
|
|
|
7339
7588
|
post_body = opts[:body]
|
|
7340
7589
|
|
|
7341
7590
|
# return_type
|
|
7342
|
-
return_type = opts[:return_type] || '
|
|
7591
|
+
return_type = opts[:return_type] || 'InlineResponse20043'
|
|
7343
7592
|
|
|
7344
7593
|
# auth_names
|
|
7345
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7594
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7346
7595
|
|
|
7347
7596
|
new_options = opts.merge(
|
|
7348
7597
|
:header_params => header_params,
|
|
@@ -7414,7 +7663,7 @@ module TalonOne
|
|
|
7414
7663
|
return_type = opts[:return_type] || 'LoyaltyCard'
|
|
7415
7664
|
|
|
7416
7665
|
# auth_names
|
|
7417
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7666
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7418
7667
|
|
|
7419
7668
|
new_options = opts.merge(
|
|
7420
7669
|
:header_params => header_params,
|
|
@@ -7442,6 +7691,8 @@ module TalonOne
|
|
|
7442
7691
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
7443
7692
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
7444
7693
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
7694
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
7695
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
7445
7696
|
# @return [InlineResponse20019]
|
|
7446
7697
|
def get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {})
|
|
7447
7698
|
data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
|
@@ -7458,6 +7709,8 @@ module TalonOne
|
|
|
7458
7709
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
7459
7710
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
7460
7711
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
7712
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
7713
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
7461
7714
|
# @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
|
|
7462
7715
|
def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
|
7463
7716
|
if @api_client.config.debugging
|
|
@@ -7493,6 +7746,8 @@ module TalonOne
|
|
|
7493
7746
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
7494
7747
|
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
7495
7748
|
query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?
|
|
7749
|
+
query_params[:'customerSessionIDs'] = @api_client.build_collection_param(opts[:'customer_session_i_ds'], :multi) if !opts[:'customer_session_i_ds'].nil?
|
|
7750
|
+
query_params[:'transactionUUIDs'] = @api_client.build_collection_param(opts[:'transaction_uui_ds'], :multi) if !opts[:'transaction_uui_ds'].nil?
|
|
7496
7751
|
|
|
7497
7752
|
# header parameters
|
|
7498
7753
|
header_params = opts[:header_params] || {}
|
|
@@ -7509,7 +7764,7 @@ module TalonOne
|
|
|
7509
7764
|
return_type = opts[:return_type] || 'InlineResponse20019'
|
|
7510
7765
|
|
|
7511
7766
|
# auth_names
|
|
7512
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7767
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7513
7768
|
|
|
7514
7769
|
new_options = opts.merge(
|
|
7515
7770
|
:header_params => header_params,
|
|
@@ -7605,7 +7860,7 @@ module TalonOne
|
|
|
7605
7860
|
return_type = opts[:return_type] || 'InlineResponse20018'
|
|
7606
7861
|
|
|
7607
7862
|
# auth_names
|
|
7608
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7863
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7609
7864
|
|
|
7610
7865
|
new_options = opts.merge(
|
|
7611
7866
|
:header_params => header_params,
|
|
@@ -7673,7 +7928,7 @@ module TalonOne
|
|
|
7673
7928
|
return_type = opts[:return_type] || 'LoyaltyLedger'
|
|
7674
7929
|
|
|
7675
7930
|
# auth_names
|
|
7676
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7931
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7677
7932
|
|
|
7678
7933
|
new_options = opts.merge(
|
|
7679
7934
|
:header_params => header_params,
|
|
@@ -7735,7 +7990,7 @@ module TalonOne
|
|
|
7735
7990
|
return_type = opts[:return_type] || 'LoyaltyProgram'
|
|
7736
7991
|
|
|
7737
7992
|
# auth_names
|
|
7738
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
7993
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7739
7994
|
|
|
7740
7995
|
new_options = opts.merge(
|
|
7741
7996
|
:header_params => header_params,
|
|
@@ -7759,6 +8014,8 @@ module TalonOne
|
|
|
7759
8014
|
# @param [Hash] opts the optional parameters
|
|
7760
8015
|
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
7761
8016
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
8017
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
8018
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
7762
8019
|
# @option opts [DateTime] :start_date Date and time from 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.
|
|
7763
8020
|
# @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.
|
|
7764
8021
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
|
@@ -7775,6 +8032,8 @@ module TalonOne
|
|
|
7775
8032
|
# @param [Hash] opts the optional parameters
|
|
7776
8033
|
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
7777
8034
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
8035
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
8036
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
7778
8037
|
# @option opts [DateTime] :start_date Date and time from 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.
|
|
7779
8038
|
# @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.
|
|
7780
8039
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
@@ -7792,8 +8051,8 @@ module TalonOne
|
|
|
7792
8051
|
if @api_client.config.client_side_validation && opts[:'loyalty_transaction_type'] && !allowable_values.include?(opts[:'loyalty_transaction_type'])
|
|
7793
8052
|
fail ArgumentError, "invalid value for \"loyalty_transaction_type\", must be one of #{allowable_values}"
|
|
7794
8053
|
end
|
|
7795
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
|
7796
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_program_transactions, must be smaller than or equal to
|
|
8054
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
|
8055
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_program_transactions, must be smaller than or equal to 1000.'
|
|
7797
8056
|
end
|
|
7798
8057
|
|
|
7799
8058
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
@@ -7807,6 +8066,8 @@ module TalonOne
|
|
|
7807
8066
|
query_params = opts[:query_params] || {}
|
|
7808
8067
|
query_params[:'loyaltyTransactionType'] = opts[:'loyalty_transaction_type'] if !opts[:'loyalty_transaction_type'].nil?
|
|
7809
8068
|
query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?
|
|
8069
|
+
query_params[:'customerSessionIDs'] = @api_client.build_collection_param(opts[:'customer_session_i_ds'], :multi) if !opts[:'customer_session_i_ds'].nil?
|
|
8070
|
+
query_params[:'transactionUUIDs'] = @api_client.build_collection_param(opts[:'transaction_uui_ds'], :multi) if !opts[:'transaction_uui_ds'].nil?
|
|
7810
8071
|
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
7811
8072
|
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
7812
8073
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
@@ -7827,7 +8088,7 @@ module TalonOne
|
|
|
7827
8088
|
return_type = opts[:return_type] || 'InlineResponse20017'
|
|
7828
8089
|
|
|
7829
8090
|
# auth_names
|
|
7830
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8091
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7831
8092
|
|
|
7832
8093
|
new_options = opts.merge(
|
|
7833
8094
|
:header_params => header_params,
|
|
@@ -7883,7 +8144,7 @@ module TalonOne
|
|
|
7883
8144
|
return_type = opts[:return_type] || 'InlineResponse20015'
|
|
7884
8145
|
|
|
7885
8146
|
# auth_names
|
|
7886
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8147
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7887
8148
|
|
|
7888
8149
|
new_options = opts.merge(
|
|
7889
8150
|
:header_params => header_params,
|
|
@@ -7945,7 +8206,7 @@ module TalonOne
|
|
|
7945
8206
|
return_type = opts[:return_type] || 'LoyaltyDashboardData'
|
|
7946
8207
|
|
|
7947
8208
|
# auth_names
|
|
7948
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8209
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
7949
8210
|
|
|
7950
8211
|
new_options = opts.merge(
|
|
7951
8212
|
:header_params => header_params,
|
|
@@ -7970,8 +8231,8 @@ module TalonOne
|
|
|
7970
8231
|
# @option opts [String] :message_id Filter results by message ID.
|
|
7971
8232
|
# @option opts [String] :change_type Filter results by change type.
|
|
7972
8233
|
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
|
7973
|
-
# @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.
|
|
7974
|
-
# @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.
|
|
8234
|
+
# @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. Use UTC time.
|
|
8235
|
+
# @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. Use UTC time.
|
|
7975
8236
|
# @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
|
7976
8237
|
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
|
7977
8238
|
# @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.
|
|
@@ -7993,8 +8254,8 @@ module TalonOne
|
|
|
7993
8254
|
# @option opts [String] :message_id Filter results by message ID.
|
|
7994
8255
|
# @option opts [String] :change_type Filter results by change type.
|
|
7995
8256
|
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
|
7996
|
-
# @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.
|
|
7997
|
-
# @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.
|
|
8257
|
+
# @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. Use UTC time.
|
|
8258
|
+
# @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. Use UTC time.
|
|
7998
8259
|
# @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
|
7999
8260
|
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
|
8000
8261
|
# @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.
|
|
@@ -8017,7 +8278,7 @@ module TalonOne
|
|
|
8017
8278
|
if @api_client.config.client_side_validation && !allowable_values.include?(entity_type)
|
|
8018
8279
|
fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
|
|
8019
8280
|
end
|
|
8020
|
-
allowable_values = ["CampaignEvaluationTreeChanged", "CampaignNotification", "CouponCreated", "CouponUpdated", "CouponDeleted", "AsyncCouponsCreated", "CouponsDeleted", "CouponsUpdated", "CouponCodeExpiring", "StrikethroughPrice", "LoyaltyPointsAdded", "LoyaltyPointsDeducted", "LoyaltyPointsExpiring", "LoyaltyPointsPendingToActive", "TierWillDowngrade", "TierUpgrade", "TierDowngrade", "LoyaltyCardPointsAdded", "LoyaltyCardPointsDeducted", "LoyaltyCardPointsExpiring"]
|
|
8281
|
+
allowable_values = ["CampaignEvaluationTreeChanged", "CampaignNotification", "CouponCreated", "CouponUpdated", "CouponDeleted", "AsyncCouponsCreated", "CouponsDeleted", "CouponsUpdated", "CouponCodeExpiring", "StrikethroughPrice", "LoyaltyPointsAdded", "LoyaltyPointsDeducted", "LoyaltyPointsExpiring", "LoyaltyPointsPendingToActive", "LoyaltyAddedDeductedPointsBalances", "LoyaltyCardAddedDeductedPointsBalances", "TierWillDowngrade", "TierUpgrade", "TierDowngrade", "LoyaltyCardPointsAdded", "LoyaltyCardPointsDeducted", "LoyaltyCardPointsExpiring"]
|
|
8021
8282
|
if @api_client.config.client_side_validation && opts[:'change_type'] && !allowable_values.include?(opts[:'change_type'])
|
|
8022
8283
|
fail ArgumentError, "invalid value for \"change_type\", must be one of #{allowable_values}"
|
|
8023
8284
|
end
|
|
@@ -8060,7 +8321,7 @@ module TalonOne
|
|
|
8060
8321
|
return_type = opts[:return_type] || 'MessageLogEntries'
|
|
8061
8322
|
|
|
8062
8323
|
# auth_names
|
|
8063
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8324
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8064
8325
|
|
|
8065
8326
|
new_options = opts.merge(
|
|
8066
8327
|
:header_params => header_params,
|
|
@@ -8171,7 +8432,7 @@ module TalonOne
|
|
|
8171
8432
|
return_type = opts[:return_type] || 'InlineResponse20012'
|
|
8172
8433
|
|
|
8173
8434
|
# auth_names
|
|
8174
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8435
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8175
8436
|
|
|
8176
8437
|
new_options = opts.merge(
|
|
8177
8438
|
:header_params => header_params,
|
|
@@ -8233,7 +8494,7 @@ module TalonOne
|
|
|
8233
8494
|
return_type = opts[:return_type] || 'RoleV2'
|
|
8234
8495
|
|
|
8235
8496
|
# auth_names
|
|
8236
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8497
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8237
8498
|
|
|
8238
8499
|
new_options = opts.merge(
|
|
8239
8500
|
:header_params => header_params,
|
|
@@ -8307,7 +8568,7 @@ module TalonOne
|
|
|
8307
8568
|
return_type = opts[:return_type] || 'Ruleset'
|
|
8308
8569
|
|
|
8309
8570
|
# auth_names
|
|
8310
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8571
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8311
8572
|
|
|
8312
8573
|
new_options = opts.merge(
|
|
8313
8574
|
:header_params => header_params,
|
|
@@ -8392,7 +8653,7 @@ module TalonOne
|
|
|
8392
8653
|
return_type = opts[:return_type] || 'InlineResponse2009'
|
|
8393
8654
|
|
|
8394
8655
|
# auth_names
|
|
8395
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8656
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8396
8657
|
|
|
8397
8658
|
new_options = opts.merge(
|
|
8398
8659
|
:header_params => header_params,
|
|
@@ -8460,7 +8721,7 @@ module TalonOne
|
|
|
8460
8721
|
return_type = opts[:return_type] || 'Store'
|
|
8461
8722
|
|
|
8462
8723
|
# auth_names
|
|
8463
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8724
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8464
8725
|
|
|
8465
8726
|
new_options = opts.merge(
|
|
8466
8727
|
:header_params => header_params,
|
|
@@ -8522,7 +8783,7 @@ module TalonOne
|
|
|
8522
8783
|
return_type = opts[:return_type] || 'User'
|
|
8523
8784
|
|
|
8524
8785
|
# auth_names
|
|
8525
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8786
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8526
8787
|
|
|
8527
8788
|
new_options = opts.merge(
|
|
8528
8789
|
:header_params => header_params,
|
|
@@ -8546,7 +8807,7 @@ module TalonOne
|
|
|
8546
8807
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
8547
8808
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8548
8809
|
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8549
|
-
# @return [
|
|
8810
|
+
# @return [InlineResponse20041]
|
|
8550
8811
|
def get_users(opts = {})
|
|
8551
8812
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
|
8552
8813
|
data
|
|
@@ -8558,7 +8819,7 @@ module TalonOne
|
|
|
8558
8819
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
8559
8820
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8560
8821
|
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8561
|
-
# @return [Array<(
|
|
8822
|
+
# @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
|
|
8562
8823
|
def get_users_with_http_info(opts = {})
|
|
8563
8824
|
if @api_client.config.debugging
|
|
8564
8825
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
|
@@ -8592,10 +8853,10 @@ module TalonOne
|
|
|
8592
8853
|
post_body = opts[:body]
|
|
8593
8854
|
|
|
8594
8855
|
# return_type
|
|
8595
|
-
return_type = opts[:return_type] || '
|
|
8856
|
+
return_type = opts[:return_type] || 'InlineResponse20041'
|
|
8596
8857
|
|
|
8597
8858
|
# auth_names
|
|
8598
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8859
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8599
8860
|
|
|
8600
8861
|
new_options = opts.merge(
|
|
8601
8862
|
:header_params => header_params,
|
|
@@ -8657,7 +8918,7 @@ module TalonOne
|
|
|
8657
8918
|
return_type = opts[:return_type] || 'Webhook'
|
|
8658
8919
|
|
|
8659
8920
|
# auth_names
|
|
8660
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8921
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8661
8922
|
|
|
8662
8923
|
new_options = opts.merge(
|
|
8663
8924
|
:header_params => header_params,
|
|
@@ -8675,251 +8936,62 @@ module TalonOne
|
|
|
8675
8936
|
return data, status_code, headers
|
|
8676
8937
|
end
|
|
8677
8938
|
|
|
8678
|
-
# List
|
|
8679
|
-
#
|
|
8939
|
+
# List webhooks
|
|
8940
|
+
# List all webhooks.
|
|
8680
8941
|
# @param [Hash] opts the optional parameters
|
|
8942
|
+
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
|
8943
|
+
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8681
8944
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
8682
8945
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8683
|
-
# @option opts [String] :
|
|
8684
|
-
# @option opts [String] :
|
|
8685
|
-
# @option opts [
|
|
8686
|
-
# @option opts [
|
|
8687
|
-
# @
|
|
8688
|
-
|
|
8689
|
-
|
|
8690
|
-
# @return [InlineResponse20040]
|
|
8691
|
-
def get_webhook_activation_logs(opts = {})
|
|
8692
|
-
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
|
8946
|
+
# @option opts [String] :creation_type Filter results by creation type.
|
|
8947
|
+
# @option opts [String] :visibility Filter results by visibility.
|
|
8948
|
+
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
|
8949
|
+
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
|
8950
|
+
# @return [InlineResponse20039]
|
|
8951
|
+
def get_webhooks(opts = {})
|
|
8952
|
+
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
|
8693
8953
|
data
|
|
8694
8954
|
end
|
|
8695
8955
|
|
|
8696
|
-
# List
|
|
8697
|
-
#
|
|
8956
|
+
# List webhooks
|
|
8957
|
+
# List all webhooks.
|
|
8698
8958
|
# @param [Hash] opts the optional parameters
|
|
8959
|
+
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
|
8960
|
+
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8699
8961
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
8700
8962
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8701
|
-
# @option opts [String] :
|
|
8702
|
-
# @option opts [String] :
|
|
8703
|
-
# @option opts [
|
|
8704
|
-
# @option opts [
|
|
8705
|
-
# @
|
|
8706
|
-
|
|
8707
|
-
# @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.
|
|
8708
|
-
# @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
|
|
8709
|
-
def get_webhook_activation_logs_with_http_info(opts = {})
|
|
8963
|
+
# @option opts [String] :creation_type Filter results by creation type.
|
|
8964
|
+
# @option opts [String] :visibility Filter results by visibility.
|
|
8965
|
+
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
|
8966
|
+
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
|
8967
|
+
# @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
|
|
8968
|
+
def get_webhooks_with_http_info(opts = {})
|
|
8710
8969
|
if @api_client.config.debugging
|
|
8711
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.
|
|
8970
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
|
8712
8971
|
end
|
|
8713
8972
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
|
8714
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.
|
|
8973
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhooks, must be smaller than or equal to 1000.'
|
|
8715
8974
|
end
|
|
8716
8975
|
|
|
8717
8976
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
8718
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.
|
|
8977
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhooks, must be greater than or equal to 1.'
|
|
8719
8978
|
end
|
|
8720
8979
|
|
|
8980
|
+
allowable_values = ["templateWebhooks", "webhooks"]
|
|
8981
|
+
if @api_client.config.client_side_validation && opts[:'creation_type'] && !allowable_values.include?(opts[:'creation_type'])
|
|
8982
|
+
fail ArgumentError, "invalid value for \"creation_type\", must be one of #{allowable_values}"
|
|
8983
|
+
end
|
|
8984
|
+
allowable_values = ["visible", "hidden"]
|
|
8985
|
+
if @api_client.config.client_side_validation && opts[:'visibility'] && !allowable_values.include?(opts[:'visibility'])
|
|
8986
|
+
fail ArgumentError, "invalid value for \"visibility\", must be one of #{allowable_values}"
|
|
8987
|
+
end
|
|
8721
8988
|
# resource path
|
|
8722
|
-
local_var_path = '/v1/
|
|
8989
|
+
local_var_path = '/v1/webhooks'
|
|
8723
8990
|
|
|
8724
8991
|
# query parameters
|
|
8725
8992
|
query_params = opts[:query_params] || {}
|
|
8726
|
-
query_params[:'
|
|
8727
|
-
query_params[:'
|
|
8728
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
8729
|
-
query_params[:'integrationRequestUuid'] = opts[:'integration_request_uuid'] if !opts[:'integration_request_uuid'].nil?
|
|
8730
|
-
query_params[:'webhookId'] = opts[:'webhook_id'] if !opts[:'webhook_id'].nil?
|
|
8731
|
-
query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
|
|
8732
|
-
query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
|
|
8733
|
-
query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
|
8734
|
-
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
|
8735
|
-
|
|
8736
|
-
# header parameters
|
|
8737
|
-
header_params = opts[:header_params] || {}
|
|
8738
|
-
# HTTP header 'Accept' (if needed)
|
|
8739
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
8740
|
-
|
|
8741
|
-
# form parameters
|
|
8742
|
-
form_params = opts[:form_params] || {}
|
|
8743
|
-
|
|
8744
|
-
# http body (model)
|
|
8745
|
-
post_body = opts[:body]
|
|
8746
|
-
|
|
8747
|
-
# return_type
|
|
8748
|
-
return_type = opts[:return_type] || 'InlineResponse20040'
|
|
8749
|
-
|
|
8750
|
-
# auth_names
|
|
8751
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8752
|
-
|
|
8753
|
-
new_options = opts.merge(
|
|
8754
|
-
:header_params => header_params,
|
|
8755
|
-
:query_params => query_params,
|
|
8756
|
-
:form_params => form_params,
|
|
8757
|
-
:body => post_body,
|
|
8758
|
-
:auth_names => auth_names,
|
|
8759
|
-
:return_type => return_type
|
|
8760
|
-
)
|
|
8761
|
-
|
|
8762
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
8763
|
-
if @api_client.config.debugging
|
|
8764
|
-
@api_client.config.logger.debug "API called: ManagementApi#get_webhook_activation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
8765
|
-
end
|
|
8766
|
-
return data, status_code, headers
|
|
8767
|
-
end
|
|
8768
|
-
|
|
8769
|
-
# List webhook log entries
|
|
8770
|
-
# Retrieve all webhook log entries.
|
|
8771
|
-
# @param [Hash] opts the optional parameters
|
|
8772
|
-
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
8773
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8774
|
-
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8775
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
|
8776
|
-
# @option opts [Float] :webhook_id Filter results by webhook id.
|
|
8777
|
-
# @option opts [Float] :application_id Filter results by Application ID.
|
|
8778
|
-
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
|
8779
|
-
# @option opts [String] :request_uuid Filter results by request UUID.
|
|
8780
|
-
# @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.
|
|
8781
|
-
# @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.
|
|
8782
|
-
# @return [InlineResponse20041]
|
|
8783
|
-
def get_webhook_logs(opts = {})
|
|
8784
|
-
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
|
8785
|
-
data
|
|
8786
|
-
end
|
|
8787
|
-
|
|
8788
|
-
# List webhook log entries
|
|
8789
|
-
# Retrieve all webhook log entries.
|
|
8790
|
-
# @param [Hash] opts the optional parameters
|
|
8791
|
-
# @option opts [Integer] :page_size The number of items in the response.
|
|
8792
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8793
|
-
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8794
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
|
8795
|
-
# @option opts [Float] :webhook_id Filter results by webhook id.
|
|
8796
|
-
# @option opts [Float] :application_id Filter results by Application ID.
|
|
8797
|
-
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
|
8798
|
-
# @option opts [String] :request_uuid Filter results by request UUID.
|
|
8799
|
-
# @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.
|
|
8800
|
-
# @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.
|
|
8801
|
-
# @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
|
|
8802
|
-
def get_webhook_logs_with_http_info(opts = {})
|
|
8803
|
-
if @api_client.config.debugging
|
|
8804
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
|
8805
|
-
end
|
|
8806
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
|
8807
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhook_logs, must be smaller than or equal to 1000.'
|
|
8808
|
-
end
|
|
8809
|
-
|
|
8810
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
8811
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhook_logs, must be greater than or equal to 1.'
|
|
8812
|
-
end
|
|
8813
|
-
|
|
8814
|
-
allowable_values = ["success", "error"]
|
|
8815
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
8816
|
-
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
8817
|
-
end
|
|
8818
|
-
# resource path
|
|
8819
|
-
local_var_path = '/v1/webhook_logs'
|
|
8820
|
-
|
|
8821
|
-
# query parameters
|
|
8822
|
-
query_params = opts[:query_params] || {}
|
|
8823
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
8824
|
-
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
8825
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
8826
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
8827
|
-
query_params[:'webhookId'] = opts[:'webhook_id'] if !opts[:'webhook_id'].nil?
|
|
8828
|
-
query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
|
|
8829
|
-
query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
|
|
8830
|
-
query_params[:'requestUuid'] = opts[:'request_uuid'] if !opts[:'request_uuid'].nil?
|
|
8831
|
-
query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
|
8832
|
-
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
|
8833
|
-
|
|
8834
|
-
# header parameters
|
|
8835
|
-
header_params = opts[:header_params] || {}
|
|
8836
|
-
# HTTP header 'Accept' (if needed)
|
|
8837
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
8838
|
-
|
|
8839
|
-
# form parameters
|
|
8840
|
-
form_params = opts[:form_params] || {}
|
|
8841
|
-
|
|
8842
|
-
# http body (model)
|
|
8843
|
-
post_body = opts[:body]
|
|
8844
|
-
|
|
8845
|
-
# return_type
|
|
8846
|
-
return_type = opts[:return_type] || 'InlineResponse20041'
|
|
8847
|
-
|
|
8848
|
-
# auth_names
|
|
8849
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
8850
|
-
|
|
8851
|
-
new_options = opts.merge(
|
|
8852
|
-
:header_params => header_params,
|
|
8853
|
-
:query_params => query_params,
|
|
8854
|
-
:form_params => form_params,
|
|
8855
|
-
:body => post_body,
|
|
8856
|
-
:auth_names => auth_names,
|
|
8857
|
-
:return_type => return_type
|
|
8858
|
-
)
|
|
8859
|
-
|
|
8860
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
8861
|
-
if @api_client.config.debugging
|
|
8862
|
-
@api_client.config.logger.debug "API called: ManagementApi#get_webhook_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
8863
|
-
end
|
|
8864
|
-
return data, status_code, headers
|
|
8865
|
-
end
|
|
8866
|
-
|
|
8867
|
-
# List webhooks
|
|
8868
|
-
# List all webhooks.
|
|
8869
|
-
# @param [Hash] opts the optional parameters
|
|
8870
|
-
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
|
8871
|
-
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8872
|
-
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
8873
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8874
|
-
# @option opts [String] :creation_type Filter results by creation type.
|
|
8875
|
-
# @option opts [String] :visibility Filter results by visibility.
|
|
8876
|
-
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
|
8877
|
-
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
|
8878
|
-
# @return [InlineResponse20039]
|
|
8879
|
-
def get_webhooks(opts = {})
|
|
8880
|
-
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
|
8881
|
-
data
|
|
8882
|
-
end
|
|
8883
|
-
|
|
8884
|
-
# List webhooks
|
|
8885
|
-
# List all webhooks.
|
|
8886
|
-
# @param [Hash] opts the optional parameters
|
|
8887
|
-
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
|
8888
|
-
# @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
8889
|
-
# @option opts [Integer] :page_size The number of items in the response.
|
|
8890
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
8891
|
-
# @option opts [String] :creation_type Filter results by creation type.
|
|
8892
|
-
# @option opts [String] :visibility Filter results by visibility.
|
|
8893
|
-
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
|
8894
|
-
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
|
8895
|
-
# @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
|
|
8896
|
-
def get_webhooks_with_http_info(opts = {})
|
|
8897
|
-
if @api_client.config.debugging
|
|
8898
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
|
8899
|
-
end
|
|
8900
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
|
8901
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhooks, must be smaller than or equal to 1000.'
|
|
8902
|
-
end
|
|
8903
|
-
|
|
8904
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
8905
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhooks, must be greater than or equal to 1.'
|
|
8906
|
-
end
|
|
8907
|
-
|
|
8908
|
-
allowable_values = ["templateWebhooks", "webhooks"]
|
|
8909
|
-
if @api_client.config.client_side_validation && opts[:'creation_type'] && !allowable_values.include?(opts[:'creation_type'])
|
|
8910
|
-
fail ArgumentError, "invalid value for \"creation_type\", must be one of #{allowable_values}"
|
|
8911
|
-
end
|
|
8912
|
-
allowable_values = ["visible", "hidden"]
|
|
8913
|
-
if @api_client.config.client_side_validation && opts[:'visibility'] && !allowable_values.include?(opts[:'visibility'])
|
|
8914
|
-
fail ArgumentError, "invalid value for \"visibility\", must be one of #{allowable_values}"
|
|
8915
|
-
end
|
|
8916
|
-
# resource path
|
|
8917
|
-
local_var_path = '/v1/webhooks'
|
|
8918
|
-
|
|
8919
|
-
# query parameters
|
|
8920
|
-
query_params = opts[:query_params] || {}
|
|
8921
|
-
query_params[:'applicationIds'] = opts[:'application_ids'] if !opts[:'application_ids'].nil?
|
|
8922
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
8993
|
+
query_params[:'applicationIds'] = opts[:'application_ids'] if !opts[:'application_ids'].nil?
|
|
8994
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
8923
8995
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
8924
8996
|
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
8925
8997
|
query_params[:'creationType'] = opts[:'creation_type'] if !opts[:'creation_type'].nil?
|
|
@@ -8942,7 +9014,7 @@ module TalonOne
|
|
|
8942
9014
|
return_type = opts[:return_type] || 'InlineResponse20039'
|
|
8943
9015
|
|
|
8944
9016
|
# auth_names
|
|
8945
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9017
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
8946
9018
|
|
|
8947
9019
|
new_options = opts.merge(
|
|
8948
9020
|
:header_params => header_params,
|
|
@@ -9009,7 +9081,7 @@ module TalonOne
|
|
|
9009
9081
|
return_type = opts[:return_type] || 'Import'
|
|
9010
9082
|
|
|
9011
9083
|
# auth_names
|
|
9012
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9084
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9013
9085
|
|
|
9014
9086
|
new_options = opts.merge(
|
|
9015
9087
|
:header_params => header_params,
|
|
@@ -9076,7 +9148,7 @@ module TalonOne
|
|
|
9076
9148
|
return_type = opts[:return_type] || 'Import'
|
|
9077
9149
|
|
|
9078
9150
|
# auth_names
|
|
9079
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9151
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9080
9152
|
|
|
9081
9153
|
new_options = opts.merge(
|
|
9082
9154
|
:header_params => header_params,
|
|
@@ -9143,7 +9215,7 @@ module TalonOne
|
|
|
9143
9215
|
return_type = opts[:return_type] || 'Import'
|
|
9144
9216
|
|
|
9145
9217
|
# auth_names
|
|
9146
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9218
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9147
9219
|
|
|
9148
9220
|
new_options = opts.merge(
|
|
9149
9221
|
:header_params => header_params,
|
|
@@ -9161,6 +9233,93 @@ module TalonOne
|
|
|
9161
9233
|
return data, status_code, headers
|
|
9162
9234
|
end
|
|
9163
9235
|
|
|
9236
|
+
# Import campaign store budgets
|
|
9237
|
+
# Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
|
|
9238
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
9239
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
9240
|
+
# @param [Hash] opts the optional parameters
|
|
9241
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
9242
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
9243
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
|
9244
|
+
# @return [Import]
|
|
9245
|
+
def import_campaign_store_budget(application_id, campaign_id, opts = {})
|
|
9246
|
+
data, _status_code, _headers = import_campaign_store_budget_with_http_info(application_id, campaign_id, opts)
|
|
9247
|
+
data
|
|
9248
|
+
end
|
|
9249
|
+
|
|
9250
|
+
# Import campaign store budgets
|
|
9251
|
+
# Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
|
|
9252
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
9253
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
9254
|
+
# @param [Hash] opts the optional parameters
|
|
9255
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
9256
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
9257
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
|
9258
|
+
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
|
9259
|
+
def import_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {})
|
|
9260
|
+
if @api_client.config.debugging
|
|
9261
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_store_budget ...'
|
|
9262
|
+
end
|
|
9263
|
+
# verify the required parameter 'application_id' is set
|
|
9264
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
|
9265
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_store_budget"
|
|
9266
|
+
end
|
|
9267
|
+
# verify the required parameter 'campaign_id' is set
|
|
9268
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
|
9269
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_store_budget"
|
|
9270
|
+
end
|
|
9271
|
+
allowable_values = ["setDiscount"]
|
|
9272
|
+
if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
|
|
9273
|
+
fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
|
|
9274
|
+
end
|
|
9275
|
+
allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
|
|
9276
|
+
if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
|
|
9277
|
+
fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
|
|
9278
|
+
end
|
|
9279
|
+
# resource path
|
|
9280
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
9281
|
+
|
|
9282
|
+
# query parameters
|
|
9283
|
+
query_params = opts[:query_params] || {}
|
|
9284
|
+
query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
|
|
9285
|
+
query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
|
|
9286
|
+
|
|
9287
|
+
# header parameters
|
|
9288
|
+
header_params = opts[:header_params] || {}
|
|
9289
|
+
# HTTP header 'Accept' (if needed)
|
|
9290
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9291
|
+
# HTTP header 'Content-Type'
|
|
9292
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
9293
|
+
|
|
9294
|
+
# form parameters
|
|
9295
|
+
form_params = opts[:form_params] || {}
|
|
9296
|
+
form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
|
|
9297
|
+
|
|
9298
|
+
# http body (model)
|
|
9299
|
+
post_body = opts[:body]
|
|
9300
|
+
|
|
9301
|
+
# return_type
|
|
9302
|
+
return_type = opts[:return_type] || 'Import'
|
|
9303
|
+
|
|
9304
|
+
# auth_names
|
|
9305
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9306
|
+
|
|
9307
|
+
new_options = opts.merge(
|
|
9308
|
+
:header_params => header_params,
|
|
9309
|
+
:query_params => query_params,
|
|
9310
|
+
:form_params => form_params,
|
|
9311
|
+
:body => post_body,
|
|
9312
|
+
:auth_names => auth_names,
|
|
9313
|
+
:return_type => return_type
|
|
9314
|
+
)
|
|
9315
|
+
|
|
9316
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9317
|
+
if @api_client.config.debugging
|
|
9318
|
+
@api_client.config.logger.debug "API called: ManagementApi#import_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9319
|
+
end
|
|
9320
|
+
return data, status_code, headers
|
|
9321
|
+
end
|
|
9322
|
+
|
|
9164
9323
|
# Import stores
|
|
9165
9324
|
# Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
|
9166
9325
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
@@ -9216,7 +9375,7 @@ module TalonOne
|
|
|
9216
9375
|
return_type = opts[:return_type] || 'Import'
|
|
9217
9376
|
|
|
9218
9377
|
# auth_names
|
|
9219
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9378
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9220
9379
|
|
|
9221
9380
|
new_options = opts.merge(
|
|
9222
9381
|
:header_params => header_params,
|
|
@@ -9295,7 +9454,7 @@ module TalonOne
|
|
|
9295
9454
|
return_type = opts[:return_type] || 'Import'
|
|
9296
9455
|
|
|
9297
9456
|
# auth_names
|
|
9298
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9457
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9299
9458
|
|
|
9300
9459
|
new_options = opts.merge(
|
|
9301
9460
|
:header_params => header_params,
|
|
@@ -9371,7 +9530,7 @@ module TalonOne
|
|
|
9371
9530
|
return_type = opts[:return_type] || 'Import'
|
|
9372
9531
|
|
|
9373
9532
|
# auth_names
|
|
9374
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9533
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9375
9534
|
|
|
9376
9535
|
new_options = opts.merge(
|
|
9377
9536
|
:header_params => header_params,
|
|
@@ -9438,7 +9597,7 @@ module TalonOne
|
|
|
9438
9597
|
return_type = opts[:return_type] || 'Import'
|
|
9439
9598
|
|
|
9440
9599
|
# auth_names
|
|
9441
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9600
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9442
9601
|
|
|
9443
9602
|
new_options = opts.merge(
|
|
9444
9603
|
:header_params => header_params,
|
|
@@ -9505,7 +9664,7 @@ module TalonOne
|
|
|
9505
9664
|
return_type = opts[:return_type] || 'Import'
|
|
9506
9665
|
|
|
9507
9666
|
# auth_names
|
|
9508
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9667
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9509
9668
|
|
|
9510
9669
|
new_options = opts.merge(
|
|
9511
9670
|
:header_params => header_params,
|
|
@@ -9527,6 +9686,7 @@ module TalonOne
|
|
|
9527
9686
|
# Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
|
9528
9687
|
# @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.
|
|
9529
9688
|
# @param [Hash] opts the optional parameters
|
|
9689
|
+
# @option opts [Boolean] :notifications_enabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
|
|
9530
9690
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
|
9531
9691
|
# @return [Import]
|
|
9532
9692
|
def import_loyalty_points(loyalty_program_id, opts = {})
|
|
@@ -9538,6 +9698,7 @@ module TalonOne
|
|
|
9538
9698
|
# Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
|
9539
9699
|
# @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.
|
|
9540
9700
|
# @param [Hash] opts the optional parameters
|
|
9701
|
+
# @option opts [Boolean] :notifications_enabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
|
|
9541
9702
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
|
9542
9703
|
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
|
9543
9704
|
def import_loyalty_points_with_http_info(loyalty_program_id, opts = {})
|
|
@@ -9553,6 +9714,7 @@ module TalonOne
|
|
|
9553
9714
|
|
|
9554
9715
|
# query parameters
|
|
9555
9716
|
query_params = opts[:query_params] || {}
|
|
9717
|
+
query_params[:'notificationsEnabled'] = opts[:'notifications_enabled'] if !opts[:'notifications_enabled'].nil?
|
|
9556
9718
|
|
|
9557
9719
|
# header parameters
|
|
9558
9720
|
header_params = opts[:header_params] || {}
|
|
@@ -9572,7 +9734,7 @@ module TalonOne
|
|
|
9572
9734
|
return_type = opts[:return_type] || 'Import'
|
|
9573
9735
|
|
|
9574
9736
|
# auth_names
|
|
9575
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9737
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9576
9738
|
|
|
9577
9739
|
new_options = opts.merge(
|
|
9578
9740
|
:header_params => header_params,
|
|
@@ -9639,7 +9801,7 @@ module TalonOne
|
|
|
9639
9801
|
return_type = opts[:return_type] || 'Import'
|
|
9640
9802
|
|
|
9641
9803
|
# auth_names
|
|
9642
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9804
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9643
9805
|
|
|
9644
9806
|
new_options = opts.merge(
|
|
9645
9807
|
:header_params => header_params,
|
|
@@ -9712,7 +9874,7 @@ module TalonOne
|
|
|
9712
9874
|
return_type = opts[:return_type] || 'Import'
|
|
9713
9875
|
|
|
9714
9876
|
# auth_names
|
|
9715
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9877
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9716
9878
|
|
|
9717
9879
|
new_options = opts.merge(
|
|
9718
9880
|
:header_params => header_params,
|
|
@@ -9774,7 +9936,7 @@ module TalonOne
|
|
|
9774
9936
|
return_type = opts[:return_type]
|
|
9775
9937
|
|
|
9776
9938
|
# auth_names
|
|
9777
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
9939
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9778
9940
|
|
|
9779
9941
|
new_options = opts.merge(
|
|
9780
9942
|
:header_params => header_params,
|
|
@@ -9853,7 +10015,7 @@ module TalonOne
|
|
|
9853
10015
|
return_type = opts[:return_type] || 'InlineResponse20020'
|
|
9854
10016
|
|
|
9855
10017
|
# auth_names
|
|
9856
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10018
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9857
10019
|
|
|
9858
10020
|
new_options = opts.merge(
|
|
9859
10021
|
:header_params => header_params,
|
|
@@ -9938,7 +10100,7 @@ module TalonOne
|
|
|
9938
10100
|
return_type = opts[:return_type] || 'InlineResponse20048'
|
|
9939
10101
|
|
|
9940
10102
|
# auth_names
|
|
9941
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10103
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9942
10104
|
|
|
9943
10105
|
new_options = opts.merge(
|
|
9944
10106
|
:header_params => header_params,
|
|
@@ -9959,7 +10121,7 @@ module TalonOne
|
|
|
9959
10121
|
# List roles
|
|
9960
10122
|
# List all roles.
|
|
9961
10123
|
# @param [Hash] opts the optional parameters
|
|
9962
|
-
# @return [
|
|
10124
|
+
# @return [InlineResponse20044]
|
|
9963
10125
|
def list_all_roles_v2(opts = {})
|
|
9964
10126
|
data, _status_code, _headers = list_all_roles_v2_with_http_info(opts)
|
|
9965
10127
|
data
|
|
@@ -9968,7 +10130,7 @@ module TalonOne
|
|
|
9968
10130
|
# List roles
|
|
9969
10131
|
# List all roles.
|
|
9970
10132
|
# @param [Hash] opts the optional parameters
|
|
9971
|
-
# @return [Array<(
|
|
10133
|
+
# @return [Array<(InlineResponse20044, Integer, Hash)>] InlineResponse20044 data, response status code and response headers
|
|
9972
10134
|
def list_all_roles_v2_with_http_info(opts = {})
|
|
9973
10135
|
if @api_client.config.debugging
|
|
9974
10136
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_all_roles_v2 ...'
|
|
@@ -9991,10 +10153,10 @@ module TalonOne
|
|
|
9991
10153
|
post_body = opts[:body]
|
|
9992
10154
|
|
|
9993
10155
|
# return_type
|
|
9994
|
-
return_type = opts[:return_type] || '
|
|
10156
|
+
return_type = opts[:return_type] || 'InlineResponse20044'
|
|
9995
10157
|
|
|
9996
10158
|
# auth_names
|
|
9997
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10159
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
9998
10160
|
|
|
9999
10161
|
new_options = opts.merge(
|
|
10000
10162
|
:header_params => header_params,
|
|
@@ -10012,23 +10174,105 @@ module TalonOne
|
|
|
10012
10174
|
return data, status_code, headers
|
|
10013
10175
|
end
|
|
10014
10176
|
|
|
10015
|
-
# List
|
|
10016
|
-
# Return
|
|
10017
|
-
# @param
|
|
10177
|
+
# List campaign store budget limits
|
|
10178
|
+
# Return the store budget limits for a given campaign.
|
|
10179
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
10180
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
10018
10181
|
# @param [Hash] opts the optional parameters
|
|
10019
|
-
# @option opts [
|
|
10020
|
-
# @option opts [
|
|
10021
|
-
# @
|
|
10022
|
-
|
|
10023
|
-
|
|
10024
|
-
# @return [InlineResponse20037]
|
|
10025
|
-
def list_catalog_items(catalog_id, opts = {})
|
|
10026
|
-
data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
|
|
10182
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
10183
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
10184
|
+
# @return [InlineResponse20046]
|
|
10185
|
+
def list_campaign_store_budget_limits(application_id, campaign_id, opts = {})
|
|
10186
|
+
data, _status_code, _headers = list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts)
|
|
10027
10187
|
data
|
|
10028
10188
|
end
|
|
10029
10189
|
|
|
10030
|
-
# List
|
|
10031
|
-
# Return
|
|
10190
|
+
# List campaign store budget limits
|
|
10191
|
+
# Return the store budget limits for a given campaign.
|
|
10192
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
10193
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
10194
|
+
# @param [Hash] opts the optional parameters
|
|
10195
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
10196
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
10197
|
+
# @return [Array<(InlineResponse20046, Integer, Hash)>] InlineResponse20046 data, response status code and response headers
|
|
10198
|
+
def list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts = {})
|
|
10199
|
+
if @api_client.config.debugging
|
|
10200
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.list_campaign_store_budget_limits ...'
|
|
10201
|
+
end
|
|
10202
|
+
# verify the required parameter 'application_id' is set
|
|
10203
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
|
10204
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_campaign_store_budget_limits"
|
|
10205
|
+
end
|
|
10206
|
+
# verify the required parameter 'campaign_id' is set
|
|
10207
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
|
10208
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.list_campaign_store_budget_limits"
|
|
10209
|
+
end
|
|
10210
|
+
allowable_values = ["setDiscount"]
|
|
10211
|
+
if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
|
|
10212
|
+
fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
|
|
10213
|
+
end
|
|
10214
|
+
allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
|
|
10215
|
+
if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
|
|
10216
|
+
fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
|
|
10217
|
+
end
|
|
10218
|
+
# resource path
|
|
10219
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
10220
|
+
|
|
10221
|
+
# query parameters
|
|
10222
|
+
query_params = opts[:query_params] || {}
|
|
10223
|
+
query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
|
|
10224
|
+
query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
|
|
10225
|
+
|
|
10226
|
+
# header parameters
|
|
10227
|
+
header_params = opts[:header_params] || {}
|
|
10228
|
+
# HTTP header 'Accept' (if needed)
|
|
10229
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10230
|
+
|
|
10231
|
+
# form parameters
|
|
10232
|
+
form_params = opts[:form_params] || {}
|
|
10233
|
+
|
|
10234
|
+
# http body (model)
|
|
10235
|
+
post_body = opts[:body]
|
|
10236
|
+
|
|
10237
|
+
# return_type
|
|
10238
|
+
return_type = opts[:return_type] || 'InlineResponse20046'
|
|
10239
|
+
|
|
10240
|
+
# auth_names
|
|
10241
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10242
|
+
|
|
10243
|
+
new_options = opts.merge(
|
|
10244
|
+
:header_params => header_params,
|
|
10245
|
+
:query_params => query_params,
|
|
10246
|
+
:form_params => form_params,
|
|
10247
|
+
:body => post_body,
|
|
10248
|
+
:auth_names => auth_names,
|
|
10249
|
+
:return_type => return_type
|
|
10250
|
+
)
|
|
10251
|
+
|
|
10252
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
10253
|
+
if @api_client.config.debugging
|
|
10254
|
+
@api_client.config.logger.debug "API called: ManagementApi#list_campaign_store_budget_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10255
|
+
end
|
|
10256
|
+
return data, status_code, headers
|
|
10257
|
+
end
|
|
10258
|
+
|
|
10259
|
+
# List items in a catalog
|
|
10260
|
+
# Return a paginated list of cart items in the given catalog.
|
|
10261
|
+
# @param catalog_id [Integer] The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
|
10262
|
+
# @param [Hash] opts the optional parameters
|
|
10263
|
+
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
|
10264
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
10265
|
+
# @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.
|
|
10266
|
+
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
|
10267
|
+
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
|
10268
|
+
# @return [InlineResponse20037]
|
|
10269
|
+
def list_catalog_items(catalog_id, opts = {})
|
|
10270
|
+
data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
|
|
10271
|
+
data
|
|
10272
|
+
end
|
|
10273
|
+
|
|
10274
|
+
# List items in a catalog
|
|
10275
|
+
# Return a paginated list of cart items in the given catalog.
|
|
10032
10276
|
# @param catalog_id [Integer] The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
|
10033
10277
|
# @param [Hash] opts the optional parameters
|
|
10034
10278
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
@@ -10061,8 +10305,8 @@ module TalonOne
|
|
|
10061
10305
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
10062
10306
|
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
|
10063
10307
|
query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
|
|
10064
|
-
query_params[:'sku'] = @api_client.build_collection_param(opts[:'sku'], :
|
|
10065
|
-
query_params[:'productNames'] = @api_client.build_collection_param(opts[:'product_names'], :
|
|
10308
|
+
query_params[:'sku'] = @api_client.build_collection_param(opts[:'sku'], :multi) if !opts[:'sku'].nil?
|
|
10309
|
+
query_params[:'productNames'] = @api_client.build_collection_param(opts[:'product_names'], :multi) if !opts[:'product_names'].nil?
|
|
10066
10310
|
|
|
10067
10311
|
# header parameters
|
|
10068
10312
|
header_params = opts[:header_params] || {}
|
|
@@ -10079,7 +10323,7 @@ module TalonOne
|
|
|
10079
10323
|
return_type = opts[:return_type] || 'InlineResponse20037'
|
|
10080
10324
|
|
|
10081
10325
|
# auth_names
|
|
10082
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10326
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10083
10327
|
|
|
10084
10328
|
new_options = opts.merge(
|
|
10085
10329
|
:header_params => header_params,
|
|
@@ -10170,7 +10414,7 @@ module TalonOne
|
|
|
10170
10414
|
return_type = opts[:return_type] || 'InlineResponse20020'
|
|
10171
10415
|
|
|
10172
10416
|
# auth_names
|
|
10173
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10417
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10174
10418
|
|
|
10175
10419
|
new_options = opts.merge(
|
|
10176
10420
|
:header_params => header_params,
|
|
@@ -10255,7 +10499,7 @@ module TalonOne
|
|
|
10255
10499
|
return_type = opts[:return_type] || 'InlineResponse20020'
|
|
10256
10500
|
|
|
10257
10501
|
# auth_names
|
|
10258
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10502
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10259
10503
|
|
|
10260
10504
|
new_options = opts.merge(
|
|
10261
10505
|
:header_params => header_params,
|
|
@@ -10285,7 +10529,7 @@ module TalonOne
|
|
|
10285
10529
|
# @option opts [String] :name The name of the store.
|
|
10286
10530
|
# @option opts [String] :integration_id The integration ID of the store.
|
|
10287
10531
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
|
10288
|
-
# @return [
|
|
10532
|
+
# @return [InlineResponse20045]
|
|
10289
10533
|
def list_stores(application_id, opts = {})
|
|
10290
10534
|
data, _status_code, _headers = list_stores_with_http_info(application_id, opts)
|
|
10291
10535
|
data
|
|
@@ -10303,7 +10547,7 @@ module TalonOne
|
|
|
10303
10547
|
# @option opts [String] :name The name of the store.
|
|
10304
10548
|
# @option opts [String] :integration_id The integration ID of the store.
|
|
10305
10549
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
|
10306
|
-
# @return [Array<(
|
|
10550
|
+
# @return [Array<(InlineResponse20045, Integer, Hash)>] InlineResponse20045 data, response status code and response headers
|
|
10307
10551
|
def list_stores_with_http_info(application_id, opts = {})
|
|
10308
10552
|
if @api_client.config.debugging
|
|
10309
10553
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_stores ...'
|
|
@@ -10346,10 +10590,10 @@ module TalonOne
|
|
|
10346
10590
|
post_body = opts[:body]
|
|
10347
10591
|
|
|
10348
10592
|
# return_type
|
|
10349
|
-
return_type = opts[:return_type] || '
|
|
10593
|
+
return_type = opts[:return_type] || 'InlineResponse20045'
|
|
10350
10594
|
|
|
10351
10595
|
# auth_names
|
|
10352
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10596
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10353
10597
|
|
|
10354
10598
|
new_options = opts.merge(
|
|
10355
10599
|
:header_params => header_params,
|
|
@@ -10403,7 +10647,7 @@ module TalonOne
|
|
|
10403
10647
|
return_type = opts[:return_type]
|
|
10404
10648
|
|
|
10405
10649
|
# auth_names
|
|
10406
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10650
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10407
10651
|
|
|
10408
10652
|
new_options = opts.merge(
|
|
10409
10653
|
:header_params => header_params,
|
|
@@ -10479,7 +10723,7 @@ module TalonOne
|
|
|
10479
10723
|
return_type = opts[:return_type]
|
|
10480
10724
|
|
|
10481
10725
|
# auth_names
|
|
10482
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10726
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10483
10727
|
|
|
10484
10728
|
new_options = opts.merge(
|
|
10485
10729
|
:header_params => header_params,
|
|
@@ -10543,7 +10787,7 @@ module TalonOne
|
|
|
10543
10787
|
return_type = opts[:return_type] || 'NewPassword'
|
|
10544
10788
|
|
|
10545
10789
|
# auth_names
|
|
10546
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10790
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10547
10791
|
|
|
10548
10792
|
new_options = opts.merge(
|
|
10549
10793
|
:header_params => header_params,
|
|
@@ -10561,6 +10805,70 @@ module TalonOne
|
|
|
10561
10805
|
return data, status_code, headers
|
|
10562
10806
|
end
|
|
10563
10807
|
|
|
10808
|
+
# Create SCIM group
|
|
10809
|
+
# Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10810
|
+
# @param body [ScimBaseGroup] body
|
|
10811
|
+
# @param [Hash] opts the optional parameters
|
|
10812
|
+
# @return [ScimGroup]
|
|
10813
|
+
def scim_create_group(body, opts = {})
|
|
10814
|
+
data, _status_code, _headers = scim_create_group_with_http_info(body, opts)
|
|
10815
|
+
data
|
|
10816
|
+
end
|
|
10817
|
+
|
|
10818
|
+
# Create SCIM group
|
|
10819
|
+
# Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10820
|
+
# @param body [ScimBaseGroup] body
|
|
10821
|
+
# @param [Hash] opts the optional parameters
|
|
10822
|
+
# @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
|
|
10823
|
+
def scim_create_group_with_http_info(body, opts = {})
|
|
10824
|
+
if @api_client.config.debugging
|
|
10825
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_group ...'
|
|
10826
|
+
end
|
|
10827
|
+
# verify the required parameter 'body' is set
|
|
10828
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
10829
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_group"
|
|
10830
|
+
end
|
|
10831
|
+
# resource path
|
|
10832
|
+
local_var_path = '/v1/provisioning/scim/Groups'
|
|
10833
|
+
|
|
10834
|
+
# query parameters
|
|
10835
|
+
query_params = opts[:query_params] || {}
|
|
10836
|
+
|
|
10837
|
+
# header parameters
|
|
10838
|
+
header_params = opts[:header_params] || {}
|
|
10839
|
+
# HTTP header 'Accept' (if needed)
|
|
10840
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10841
|
+
# HTTP header 'Content-Type'
|
|
10842
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
10843
|
+
|
|
10844
|
+
# form parameters
|
|
10845
|
+
form_params = opts[:form_params] || {}
|
|
10846
|
+
|
|
10847
|
+
# http body (model)
|
|
10848
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
|
10849
|
+
|
|
10850
|
+
# return_type
|
|
10851
|
+
return_type = opts[:return_type] || 'ScimGroup'
|
|
10852
|
+
|
|
10853
|
+
# auth_names
|
|
10854
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10855
|
+
|
|
10856
|
+
new_options = opts.merge(
|
|
10857
|
+
:header_params => header_params,
|
|
10858
|
+
:query_params => query_params,
|
|
10859
|
+
:form_params => form_params,
|
|
10860
|
+
:body => post_body,
|
|
10861
|
+
:auth_names => auth_names,
|
|
10862
|
+
:return_type => return_type
|
|
10863
|
+
)
|
|
10864
|
+
|
|
10865
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10866
|
+
if @api_client.config.debugging
|
|
10867
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10868
|
+
end
|
|
10869
|
+
return data, status_code, headers
|
|
10870
|
+
end
|
|
10871
|
+
|
|
10564
10872
|
# Create SCIM user
|
|
10565
10873
|
# Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
|
10566
10874
|
# @param body [ScimNewUser] body
|
|
@@ -10607,7 +10915,7 @@ module TalonOne
|
|
|
10607
10915
|
return_type = opts[:return_type] || 'ScimUser'
|
|
10608
10916
|
|
|
10609
10917
|
# auth_names
|
|
10610
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
10918
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10611
10919
|
|
|
10612
10920
|
new_options = opts.merge(
|
|
10613
10921
|
:header_params => header_params,
|
|
@@ -10625,6 +10933,66 @@ module TalonOne
|
|
|
10625
10933
|
return data, status_code, headers
|
|
10626
10934
|
end
|
|
10627
10935
|
|
|
10936
|
+
# Delete SCIM group
|
|
10937
|
+
# Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10938
|
+
# @param group_id [Integer] The ID of the group.
|
|
10939
|
+
# @param [Hash] opts the optional parameters
|
|
10940
|
+
# @return [nil]
|
|
10941
|
+
def scim_delete_group(group_id, opts = {})
|
|
10942
|
+
scim_delete_group_with_http_info(group_id, opts)
|
|
10943
|
+
nil
|
|
10944
|
+
end
|
|
10945
|
+
|
|
10946
|
+
# Delete SCIM group
|
|
10947
|
+
# Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10948
|
+
# @param group_id [Integer] The ID of the group.
|
|
10949
|
+
# @param [Hash] opts the optional parameters
|
|
10950
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
10951
|
+
def scim_delete_group_with_http_info(group_id, opts = {})
|
|
10952
|
+
if @api_client.config.debugging
|
|
10953
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_group ...'
|
|
10954
|
+
end
|
|
10955
|
+
# verify the required parameter 'group_id' is set
|
|
10956
|
+
if @api_client.config.client_side_validation && group_id.nil?
|
|
10957
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_delete_group"
|
|
10958
|
+
end
|
|
10959
|
+
# resource path
|
|
10960
|
+
local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
|
10961
|
+
|
|
10962
|
+
# query parameters
|
|
10963
|
+
query_params = opts[:query_params] || {}
|
|
10964
|
+
|
|
10965
|
+
# header parameters
|
|
10966
|
+
header_params = opts[:header_params] || {}
|
|
10967
|
+
|
|
10968
|
+
# form parameters
|
|
10969
|
+
form_params = opts[:form_params] || {}
|
|
10970
|
+
|
|
10971
|
+
# http body (model)
|
|
10972
|
+
post_body = opts[:body]
|
|
10973
|
+
|
|
10974
|
+
# return_type
|
|
10975
|
+
return_type = opts[:return_type]
|
|
10976
|
+
|
|
10977
|
+
# auth_names
|
|
10978
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10979
|
+
|
|
10980
|
+
new_options = opts.merge(
|
|
10981
|
+
:header_params => header_params,
|
|
10982
|
+
:query_params => query_params,
|
|
10983
|
+
:form_params => form_params,
|
|
10984
|
+
:body => post_body,
|
|
10985
|
+
:auth_names => auth_names,
|
|
10986
|
+
:return_type => return_type
|
|
10987
|
+
)
|
|
10988
|
+
|
|
10989
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
10990
|
+
if @api_client.config.debugging
|
|
10991
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_delete_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10992
|
+
end
|
|
10993
|
+
return data, status_code, headers
|
|
10994
|
+
end
|
|
10995
|
+
|
|
10628
10996
|
# Delete SCIM user
|
|
10629
10997
|
# Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
|
10630
10998
|
# @param user_id [Integer] The ID of the user.
|
|
@@ -10667,7 +11035,7 @@ module TalonOne
|
|
|
10667
11035
|
return_type = opts[:return_type]
|
|
10668
11036
|
|
|
10669
11037
|
# auth_names
|
|
10670
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11038
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10671
11039
|
|
|
10672
11040
|
new_options = opts.merge(
|
|
10673
11041
|
:header_params => header_params,
|
|
@@ -10685,6 +11053,124 @@ module TalonOne
|
|
|
10685
11053
|
return data, status_code, headers
|
|
10686
11054
|
end
|
|
10687
11055
|
|
|
11056
|
+
# Get SCIM group
|
|
11057
|
+
# Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11058
|
+
# @param group_id [Integer] The ID of the group.
|
|
11059
|
+
# @param [Hash] opts the optional parameters
|
|
11060
|
+
# @return [ScimGroup]
|
|
11061
|
+
def scim_get_group(group_id, opts = {})
|
|
11062
|
+
data, _status_code, _headers = scim_get_group_with_http_info(group_id, opts)
|
|
11063
|
+
data
|
|
11064
|
+
end
|
|
11065
|
+
|
|
11066
|
+
# Get SCIM group
|
|
11067
|
+
# Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11068
|
+
# @param group_id [Integer] The ID of the group.
|
|
11069
|
+
# @param [Hash] opts the optional parameters
|
|
11070
|
+
# @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
|
|
11071
|
+
def scim_get_group_with_http_info(group_id, opts = {})
|
|
11072
|
+
if @api_client.config.debugging
|
|
11073
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_group ...'
|
|
11074
|
+
end
|
|
11075
|
+
# verify the required parameter 'group_id' is set
|
|
11076
|
+
if @api_client.config.client_side_validation && group_id.nil?
|
|
11077
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_get_group"
|
|
11078
|
+
end
|
|
11079
|
+
# resource path
|
|
11080
|
+
local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
|
11081
|
+
|
|
11082
|
+
# query parameters
|
|
11083
|
+
query_params = opts[:query_params] || {}
|
|
11084
|
+
|
|
11085
|
+
# header parameters
|
|
11086
|
+
header_params = opts[:header_params] || {}
|
|
11087
|
+
# HTTP header 'Accept' (if needed)
|
|
11088
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
11089
|
+
|
|
11090
|
+
# form parameters
|
|
11091
|
+
form_params = opts[:form_params] || {}
|
|
11092
|
+
|
|
11093
|
+
# http body (model)
|
|
11094
|
+
post_body = opts[:body]
|
|
11095
|
+
|
|
11096
|
+
# return_type
|
|
11097
|
+
return_type = opts[:return_type] || 'ScimGroup'
|
|
11098
|
+
|
|
11099
|
+
# auth_names
|
|
11100
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11101
|
+
|
|
11102
|
+
new_options = opts.merge(
|
|
11103
|
+
:header_params => header_params,
|
|
11104
|
+
:query_params => query_params,
|
|
11105
|
+
:form_params => form_params,
|
|
11106
|
+
:body => post_body,
|
|
11107
|
+
:auth_names => auth_names,
|
|
11108
|
+
:return_type => return_type
|
|
11109
|
+
)
|
|
11110
|
+
|
|
11111
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
11112
|
+
if @api_client.config.debugging
|
|
11113
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
11114
|
+
end
|
|
11115
|
+
return data, status_code, headers
|
|
11116
|
+
end
|
|
11117
|
+
|
|
11118
|
+
# List SCIM groups
|
|
11119
|
+
# Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11120
|
+
# @param [Hash] opts the optional parameters
|
|
11121
|
+
# @return [ScimGroupsListResponse]
|
|
11122
|
+
def scim_get_groups(opts = {})
|
|
11123
|
+
data, _status_code, _headers = scim_get_groups_with_http_info(opts)
|
|
11124
|
+
data
|
|
11125
|
+
end
|
|
11126
|
+
|
|
11127
|
+
# List SCIM groups
|
|
11128
|
+
# Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11129
|
+
# @param [Hash] opts the optional parameters
|
|
11130
|
+
# @return [Array<(ScimGroupsListResponse, Integer, Hash)>] ScimGroupsListResponse data, response status code and response headers
|
|
11131
|
+
def scim_get_groups_with_http_info(opts = {})
|
|
11132
|
+
if @api_client.config.debugging
|
|
11133
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_groups ...'
|
|
11134
|
+
end
|
|
11135
|
+
# resource path
|
|
11136
|
+
local_var_path = '/v1/provisioning/scim/Groups'
|
|
11137
|
+
|
|
11138
|
+
# query parameters
|
|
11139
|
+
query_params = opts[:query_params] || {}
|
|
11140
|
+
|
|
11141
|
+
# header parameters
|
|
11142
|
+
header_params = opts[:header_params] || {}
|
|
11143
|
+
# HTTP header 'Accept' (if needed)
|
|
11144
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
11145
|
+
|
|
11146
|
+
# form parameters
|
|
11147
|
+
form_params = opts[:form_params] || {}
|
|
11148
|
+
|
|
11149
|
+
# http body (model)
|
|
11150
|
+
post_body = opts[:body]
|
|
11151
|
+
|
|
11152
|
+
# return_type
|
|
11153
|
+
return_type = opts[:return_type] || 'ScimGroupsListResponse'
|
|
11154
|
+
|
|
11155
|
+
# auth_names
|
|
11156
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11157
|
+
|
|
11158
|
+
new_options = opts.merge(
|
|
11159
|
+
:header_params => header_params,
|
|
11160
|
+
:query_params => query_params,
|
|
11161
|
+
:form_params => form_params,
|
|
11162
|
+
:body => post_body,
|
|
11163
|
+
:auth_names => auth_names,
|
|
11164
|
+
:return_type => return_type
|
|
11165
|
+
)
|
|
11166
|
+
|
|
11167
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
11168
|
+
if @api_client.config.debugging
|
|
11169
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
11170
|
+
end
|
|
11171
|
+
return data, status_code, headers
|
|
11172
|
+
end
|
|
11173
|
+
|
|
10688
11174
|
# List supported SCIM resource types
|
|
10689
11175
|
# Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
|
|
10690
11176
|
# @param [Hash] opts the optional parameters
|
|
@@ -10723,7 +11209,7 @@ module TalonOne
|
|
|
10723
11209
|
return_type = opts[:return_type] || 'ScimResourceTypesListResponse'
|
|
10724
11210
|
|
|
10725
11211
|
# auth_names
|
|
10726
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11212
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10727
11213
|
|
|
10728
11214
|
new_options = opts.merge(
|
|
10729
11215
|
:header_params => header_params,
|
|
@@ -10779,7 +11265,7 @@ module TalonOne
|
|
|
10779
11265
|
return_type = opts[:return_type] || 'ScimSchemasListResponse'
|
|
10780
11266
|
|
|
10781
11267
|
# auth_names
|
|
10782
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11268
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10783
11269
|
|
|
10784
11270
|
new_options = opts.merge(
|
|
10785
11271
|
:header_params => header_params,
|
|
@@ -10835,7 +11321,7 @@ module TalonOne
|
|
|
10835
11321
|
return_type = opts[:return_type] || 'ScimServiceProviderConfigResponse'
|
|
10836
11322
|
|
|
10837
11323
|
# auth_names
|
|
10838
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11324
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10839
11325
|
|
|
10840
11326
|
new_options = opts.merge(
|
|
10841
11327
|
:header_params => header_params,
|
|
@@ -10897,7 +11383,7 @@ module TalonOne
|
|
|
10897
11383
|
return_type = opts[:return_type] || 'ScimUser'
|
|
10898
11384
|
|
|
10899
11385
|
# auth_names
|
|
10900
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11386
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10901
11387
|
|
|
10902
11388
|
new_options = opts.merge(
|
|
10903
11389
|
:header_params => header_params,
|
|
@@ -10953,7 +11439,7 @@ module TalonOne
|
|
|
10953
11439
|
return_type = opts[:return_type] || 'ScimUsersListResponse'
|
|
10954
11440
|
|
|
10955
11441
|
# auth_names
|
|
10956
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11442
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
10957
11443
|
|
|
10958
11444
|
new_options = opts.merge(
|
|
10959
11445
|
:header_params => header_params,
|
|
@@ -10971,6 +11457,76 @@ module TalonOne
|
|
|
10971
11457
|
return data, status_code, headers
|
|
10972
11458
|
end
|
|
10973
11459
|
|
|
11460
|
+
# Update SCIM group attributes
|
|
11461
|
+
# Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11462
|
+
# @param group_id [Integer] The ID of the group.
|
|
11463
|
+
# @param body [ScimPatchRequest] body
|
|
11464
|
+
# @param [Hash] opts the optional parameters
|
|
11465
|
+
# @return [ScimGroup]
|
|
11466
|
+
def scim_patch_group(group_id, body, opts = {})
|
|
11467
|
+
data, _status_code, _headers = scim_patch_group_with_http_info(group_id, body, opts)
|
|
11468
|
+
data
|
|
11469
|
+
end
|
|
11470
|
+
|
|
11471
|
+
# Update SCIM group attributes
|
|
11472
|
+
# Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11473
|
+
# @param group_id [Integer] The ID of the group.
|
|
11474
|
+
# @param body [ScimPatchRequest] body
|
|
11475
|
+
# @param [Hash] opts the optional parameters
|
|
11476
|
+
# @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
|
|
11477
|
+
def scim_patch_group_with_http_info(group_id, body, opts = {})
|
|
11478
|
+
if @api_client.config.debugging
|
|
11479
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_patch_group ...'
|
|
11480
|
+
end
|
|
11481
|
+
# verify the required parameter 'group_id' is set
|
|
11482
|
+
if @api_client.config.client_side_validation && group_id.nil?
|
|
11483
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_patch_group"
|
|
11484
|
+
end
|
|
11485
|
+
# verify the required parameter 'body' is set
|
|
11486
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
11487
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_patch_group"
|
|
11488
|
+
end
|
|
11489
|
+
# resource path
|
|
11490
|
+
local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
|
11491
|
+
|
|
11492
|
+
# query parameters
|
|
11493
|
+
query_params = opts[:query_params] || {}
|
|
11494
|
+
|
|
11495
|
+
# header parameters
|
|
11496
|
+
header_params = opts[:header_params] || {}
|
|
11497
|
+
# HTTP header 'Accept' (if needed)
|
|
11498
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
11499
|
+
# HTTP header 'Content-Type'
|
|
11500
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
11501
|
+
|
|
11502
|
+
# form parameters
|
|
11503
|
+
form_params = opts[:form_params] || {}
|
|
11504
|
+
|
|
11505
|
+
# http body (model)
|
|
11506
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
|
11507
|
+
|
|
11508
|
+
# return_type
|
|
11509
|
+
return_type = opts[:return_type] || 'ScimGroup'
|
|
11510
|
+
|
|
11511
|
+
# auth_names
|
|
11512
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11513
|
+
|
|
11514
|
+
new_options = opts.merge(
|
|
11515
|
+
:header_params => header_params,
|
|
11516
|
+
:query_params => query_params,
|
|
11517
|
+
:form_params => form_params,
|
|
11518
|
+
:body => post_body,
|
|
11519
|
+
:auth_names => auth_names,
|
|
11520
|
+
:return_type => return_type
|
|
11521
|
+
)
|
|
11522
|
+
|
|
11523
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
11524
|
+
if @api_client.config.debugging
|
|
11525
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_patch_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
11526
|
+
end
|
|
11527
|
+
return data, status_code, headers
|
|
11528
|
+
end
|
|
11529
|
+
|
|
10974
11530
|
# Update SCIM user attributes
|
|
10975
11531
|
# Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
|
|
10976
11532
|
# @param user_id [Integer] The ID of the user.
|
|
@@ -11023,7 +11579,7 @@ module TalonOne
|
|
|
11023
11579
|
return_type = opts[:return_type] || 'ScimUser'
|
|
11024
11580
|
|
|
11025
11581
|
# auth_names
|
|
11026
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11582
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11027
11583
|
|
|
11028
11584
|
new_options = opts.merge(
|
|
11029
11585
|
:header_params => header_params,
|
|
@@ -11041,6 +11597,76 @@ module TalonOne
|
|
|
11041
11597
|
return data, status_code, headers
|
|
11042
11598
|
end
|
|
11043
11599
|
|
|
11600
|
+
# Update SCIM group
|
|
11601
|
+
# Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11602
|
+
# @param group_id [Integer] The ID of the group.
|
|
11603
|
+
# @param body [ScimBaseGroup] body
|
|
11604
|
+
# @param [Hash] opts the optional parameters
|
|
11605
|
+
# @return [ScimGroup]
|
|
11606
|
+
def scim_replace_group_attributes(group_id, body, opts = {})
|
|
11607
|
+
data, _status_code, _headers = scim_replace_group_attributes_with_http_info(group_id, body, opts)
|
|
11608
|
+
data
|
|
11609
|
+
end
|
|
11610
|
+
|
|
11611
|
+
# Update SCIM group
|
|
11612
|
+
# Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
11613
|
+
# @param group_id [Integer] The ID of the group.
|
|
11614
|
+
# @param body [ScimBaseGroup] body
|
|
11615
|
+
# @param [Hash] opts the optional parameters
|
|
11616
|
+
# @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
|
|
11617
|
+
def scim_replace_group_attributes_with_http_info(group_id, body, opts = {})
|
|
11618
|
+
if @api_client.config.debugging
|
|
11619
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_replace_group_attributes ...'
|
|
11620
|
+
end
|
|
11621
|
+
# verify the required parameter 'group_id' is set
|
|
11622
|
+
if @api_client.config.client_side_validation && group_id.nil?
|
|
11623
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_replace_group_attributes"
|
|
11624
|
+
end
|
|
11625
|
+
# verify the required parameter 'body' is set
|
|
11626
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
11627
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_replace_group_attributes"
|
|
11628
|
+
end
|
|
11629
|
+
# resource path
|
|
11630
|
+
local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
|
11631
|
+
|
|
11632
|
+
# query parameters
|
|
11633
|
+
query_params = opts[:query_params] || {}
|
|
11634
|
+
|
|
11635
|
+
# header parameters
|
|
11636
|
+
header_params = opts[:header_params] || {}
|
|
11637
|
+
# HTTP header 'Accept' (if needed)
|
|
11638
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
11639
|
+
# HTTP header 'Content-Type'
|
|
11640
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
11641
|
+
|
|
11642
|
+
# form parameters
|
|
11643
|
+
form_params = opts[:form_params] || {}
|
|
11644
|
+
|
|
11645
|
+
# http body (model)
|
|
11646
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
|
11647
|
+
|
|
11648
|
+
# return_type
|
|
11649
|
+
return_type = opts[:return_type] || 'ScimGroup'
|
|
11650
|
+
|
|
11651
|
+
# auth_names
|
|
11652
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11653
|
+
|
|
11654
|
+
new_options = opts.merge(
|
|
11655
|
+
:header_params => header_params,
|
|
11656
|
+
:query_params => query_params,
|
|
11657
|
+
:form_params => form_params,
|
|
11658
|
+
:body => post_body,
|
|
11659
|
+
:auth_names => auth_names,
|
|
11660
|
+
:return_type => return_type
|
|
11661
|
+
)
|
|
11662
|
+
|
|
11663
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
11664
|
+
if @api_client.config.debugging
|
|
11665
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_replace_group_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
11666
|
+
end
|
|
11667
|
+
return data, status_code, headers
|
|
11668
|
+
end
|
|
11669
|
+
|
|
11044
11670
|
# Update SCIM user
|
|
11045
11671
|
# Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
|
|
11046
11672
|
# @param user_id [Integer] The ID of the user.
|
|
@@ -11093,7 +11719,7 @@ module TalonOne
|
|
|
11093
11719
|
return_type = opts[:return_type] || 'ScimUser'
|
|
11094
11720
|
|
|
11095
11721
|
# auth_names
|
|
11096
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11722
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11097
11723
|
|
|
11098
11724
|
new_options = opts.merge(
|
|
11099
11725
|
:header_params => header_params,
|
|
@@ -11222,7 +11848,7 @@ module TalonOne
|
|
|
11222
11848
|
return_type = opts[:return_type] || 'InlineResponse20011'
|
|
11223
11849
|
|
|
11224
11850
|
# auth_names
|
|
11225
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11851
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11226
11852
|
|
|
11227
11853
|
new_options = opts.merge(
|
|
11228
11854
|
:header_params => header_params,
|
|
@@ -11350,7 +11976,7 @@ module TalonOne
|
|
|
11350
11976
|
return_type = opts[:return_type] || 'InlineResponse20011'
|
|
11351
11977
|
|
|
11352
11978
|
# auth_names
|
|
11353
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
11979
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11354
11980
|
|
|
11355
11981
|
new_options = opts.merge(
|
|
11356
11982
|
:header_params => header_params,
|
|
@@ -11368,6 +11994,74 @@ module TalonOne
|
|
|
11368
11994
|
return data, status_code, headers
|
|
11369
11995
|
end
|
|
11370
11996
|
|
|
11997
|
+
# Get summary of campaign store budgets
|
|
11998
|
+
# Fetch a summary of all store budget information for a given campaign.
|
|
11999
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
12000
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
12001
|
+
# @param [Hash] opts the optional parameters
|
|
12002
|
+
# @return [InlineResponse20047]
|
|
12003
|
+
def summarize_campaign_store_budget(application_id, campaign_id, opts = {})
|
|
12004
|
+
data, _status_code, _headers = summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts)
|
|
12005
|
+
data
|
|
12006
|
+
end
|
|
12007
|
+
|
|
12008
|
+
# Get summary of campaign store budgets
|
|
12009
|
+
# Fetch a summary of all store budget information for a given campaign.
|
|
12010
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
12011
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
12012
|
+
# @param [Hash] opts the optional parameters
|
|
12013
|
+
# @return [Array<(InlineResponse20047, Integer, Hash)>] InlineResponse20047 data, response status code and response headers
|
|
12014
|
+
def summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {})
|
|
12015
|
+
if @api_client.config.debugging
|
|
12016
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.summarize_campaign_store_budget ...'
|
|
12017
|
+
end
|
|
12018
|
+
# verify the required parameter 'application_id' is set
|
|
12019
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
|
12020
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.summarize_campaign_store_budget"
|
|
12021
|
+
end
|
|
12022
|
+
# verify the required parameter 'campaign_id' is set
|
|
12023
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
|
12024
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.summarize_campaign_store_budget"
|
|
12025
|
+
end
|
|
12026
|
+
# resource path
|
|
12027
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
12028
|
+
|
|
12029
|
+
# query parameters
|
|
12030
|
+
query_params = opts[:query_params] || {}
|
|
12031
|
+
|
|
12032
|
+
# header parameters
|
|
12033
|
+
header_params = opts[:header_params] || {}
|
|
12034
|
+
# HTTP header 'Accept' (if needed)
|
|
12035
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
12036
|
+
|
|
12037
|
+
# form parameters
|
|
12038
|
+
form_params = opts[:form_params] || {}
|
|
12039
|
+
|
|
12040
|
+
# http body (model)
|
|
12041
|
+
post_body = opts[:body]
|
|
12042
|
+
|
|
12043
|
+
# return_type
|
|
12044
|
+
return_type = opts[:return_type] || 'InlineResponse20047'
|
|
12045
|
+
|
|
12046
|
+
# auth_names
|
|
12047
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12048
|
+
|
|
12049
|
+
new_options = opts.merge(
|
|
12050
|
+
:header_params => header_params,
|
|
12051
|
+
:query_params => query_params,
|
|
12052
|
+
:form_params => form_params,
|
|
12053
|
+
:body => post_body,
|
|
12054
|
+
:auth_names => auth_names,
|
|
12055
|
+
:return_type => return_type
|
|
12056
|
+
)
|
|
12057
|
+
|
|
12058
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
12059
|
+
if @api_client.config.debugging
|
|
12060
|
+
@api_client.config.logger.debug "API called: ManagementApi#summarize_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
12061
|
+
end
|
|
12062
|
+
return data, status_code, headers
|
|
12063
|
+
end
|
|
12064
|
+
|
|
11371
12065
|
# Transfer card data
|
|
11372
12066
|
# Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
|
11373
12067
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
@@ -11430,7 +12124,7 @@ module TalonOne
|
|
|
11430
12124
|
return_type = opts[:return_type]
|
|
11431
12125
|
|
|
11432
12126
|
# auth_names
|
|
11433
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12127
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11434
12128
|
|
|
11435
12129
|
new_options = opts.merge(
|
|
11436
12130
|
:header_params => header_params,
|
|
@@ -11500,7 +12194,7 @@ module TalonOne
|
|
|
11500
12194
|
return_type = opts[:return_type] || 'Collection'
|
|
11501
12195
|
|
|
11502
12196
|
# auth_names
|
|
11503
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12197
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11504
12198
|
|
|
11505
12199
|
new_options = opts.merge(
|
|
11506
12200
|
:header_params => header_params,
|
|
@@ -11582,7 +12276,7 @@ module TalonOne
|
|
|
11582
12276
|
return_type = opts[:return_type] || 'Achievement'
|
|
11583
12277
|
|
|
11584
12278
|
# auth_names
|
|
11585
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12279
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11586
12280
|
|
|
11587
12281
|
new_options = opts.merge(
|
|
11588
12282
|
:header_params => header_params,
|
|
@@ -11652,7 +12346,7 @@ module TalonOne
|
|
|
11652
12346
|
return_type = opts[:return_type] || 'AccountAdditionalCost'
|
|
11653
12347
|
|
|
11654
12348
|
# auth_names
|
|
11655
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12349
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11656
12350
|
|
|
11657
12351
|
new_options = opts.merge(
|
|
11658
12352
|
:header_params => header_params,
|
|
@@ -11722,7 +12416,7 @@ module TalonOne
|
|
|
11722
12416
|
return_type = opts[:return_type] || 'Attribute'
|
|
11723
12417
|
|
|
11724
12418
|
# auth_names
|
|
11725
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12419
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11726
12420
|
|
|
11727
12421
|
new_options = opts.merge(
|
|
11728
12422
|
:header_params => header_params,
|
|
@@ -11798,7 +12492,7 @@ module TalonOne
|
|
|
11798
12492
|
return_type = opts[:return_type] || 'Campaign'
|
|
11799
12493
|
|
|
11800
12494
|
# auth_names
|
|
11801
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12495
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11802
12496
|
|
|
11803
12497
|
new_options = opts.merge(
|
|
11804
12498
|
:header_params => header_params,
|
|
@@ -11880,7 +12574,7 @@ module TalonOne
|
|
|
11880
12574
|
return_type = opts[:return_type] || 'Collection'
|
|
11881
12575
|
|
|
11882
12576
|
# auth_names
|
|
11883
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12577
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11884
12578
|
|
|
11885
12579
|
new_options = opts.merge(
|
|
11886
12580
|
:header_params => header_params,
|
|
@@ -11962,7 +12656,7 @@ module TalonOne
|
|
|
11962
12656
|
return_type = opts[:return_type] || 'Coupon'
|
|
11963
12657
|
|
|
11964
12658
|
# auth_names
|
|
11965
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12659
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
11966
12660
|
|
|
11967
12661
|
new_options = opts.merge(
|
|
11968
12662
|
:header_params => header_params,
|
|
@@ -12036,7 +12730,7 @@ module TalonOne
|
|
|
12036
12730
|
return_type = opts[:return_type]
|
|
12037
12731
|
|
|
12038
12732
|
# auth_names
|
|
12039
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12733
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12040
12734
|
|
|
12041
12735
|
new_options = opts.merge(
|
|
12042
12736
|
:header_params => header_params,
|
|
@@ -12116,7 +12810,7 @@ module TalonOne
|
|
|
12116
12810
|
return_type = opts[:return_type] || 'LoyaltyCard'
|
|
12117
12811
|
|
|
12118
12812
|
# auth_names
|
|
12119
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12813
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12120
12814
|
|
|
12121
12815
|
new_options = opts.merge(
|
|
12122
12816
|
:header_params => header_params,
|
|
@@ -12198,7 +12892,7 @@ module TalonOne
|
|
|
12198
12892
|
return_type = opts[:return_type] || 'Referral'
|
|
12199
12893
|
|
|
12200
12894
|
# auth_names
|
|
12201
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12895
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12202
12896
|
|
|
12203
12897
|
new_options = opts.merge(
|
|
12204
12898
|
:header_params => header_params,
|
|
@@ -12268,7 +12962,7 @@ module TalonOne
|
|
|
12268
12962
|
return_type = opts[:return_type] || 'RoleV2'
|
|
12269
12963
|
|
|
12270
12964
|
# auth_names
|
|
12271
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
12965
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12272
12966
|
|
|
12273
12967
|
new_options = opts.merge(
|
|
12274
12968
|
:header_params => header_params,
|
|
@@ -12344,7 +13038,7 @@ module TalonOne
|
|
|
12344
13038
|
return_type = opts[:return_type] || 'Store'
|
|
12345
13039
|
|
|
12346
13040
|
# auth_names
|
|
12347
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
13041
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12348
13042
|
|
|
12349
13043
|
new_options = opts.merge(
|
|
12350
13044
|
:header_params => header_params,
|
|
@@ -12414,7 +13108,7 @@ module TalonOne
|
|
|
12414
13108
|
return_type = opts[:return_type] || 'User'
|
|
12415
13109
|
|
|
12416
13110
|
# auth_names
|
|
12417
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
|
13111
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'management_key', 'manager_auth']
|
|
12418
13112
|
|
|
12419
13113
|
new_options = opts.merge(
|
|
12420
13114
|
:header_params => header_params,
|