From e589abedcf014d6ba392f5bfb20b189c3692253f Mon Sep 17 00:00:00 2001 From: "Jakob (Koby) Shimony" Date: Sun, 14 Aug 2022 17:04:22 +0200 Subject: [PATCH] v2.6.0: Partial Returns, Collections & Improved customer inventory (#19) ## v2.6.0 closes #18 ## Commit Summary * Initial Commit * minor fixes in readme --- README.md | 198 +- api/openapi.yaml | 18436 +++++++++++----- api_integration.go | 1769 +- api_management.go | 9812 +++++--- client.go | 2 +- configuration.go | 6 +- docs/AcceptCouponEffectProps.md | 2 +- docs/AcceptReferralEffectProps.md | 2 +- docs/AccessLogEntry.md | 6 +- docs/Account.md | 8 +- docs/AccountAdditionalCost.md | 30 +- docs/AccountAnalytics.md | 62 +- docs/AccountLimits.md | 24 +- docs/AddFreeItemEffectProps.md | 4 +- docs/AddItemCatalogAction.md | 117 + docs/AddLoyaltyPointsEffectProps.md | 120 +- docs/Application.md | 76 +- docs/ApplicationApiHealth.md | 4 +- docs/ApplicationApiKey.md | 16 +- docs/ApplicationCampaignStats.md | 12 +- docs/ApplicationCustomer.md | 14 +- docs/ApplicationCustomerSearch.md | 91 - docs/ApplicationEvent.md | 2 +- docs/ApplicationNotification.md | 39 + docs/ApplicationReferee.md | 8 +- docs/ApplicationSession.md | 36 +- docs/AsyncCouponCreationResponse.md | 39 + docs/Attribute.md | 134 +- docs/Audience.md | 86 +- docs/AudienceAnalytics.md | 65 + docs/AudienceIntegrationId.md | 39 + docs/BaseLoyaltyProgram.md | 28 +- docs/Binding.md | 28 +- docs/BulkApplicationNotification.md | 65 + docs/BulkCampaignNotification.md | 65 + docs/Campaign.md | 90 +- docs/CampaignActivationRequest.md | 39 + docs/CampaignCollection.md | 299 + docs/CampaignCollectionWithoutPayload.md | 273 + docs/CampaignCopy.md | 4 +- docs/CampaignCreatedNotification.md | 39 + docs/CampaignDeletedNotification.md | 39 + docs/CampaignEditedNotification.md | 65 + docs/CampaignGroup.md | 6 +- docs/CampaignNotification.md | 39 + docs/CampaignPrioritiesChangedNotification.md | 91 + docs/CampaignPrioritiesV2.md | 91 + docs/CampaignRulesetChangedNotification.md | 91 + docs/CampaignSearch.md | 2 +- docs/CampaignSet.md | 4 +- docs/CampaignSetBranchNode.md | 6 +- docs/CampaignSetIDs.md | 39 + docs/CampaignSetLeafNode.md | 2 +- docs/CampaignSetV2.md | 143 + docs/CampaignStateChangedNotification.md | 91 + docs/CampaignTemplate.md | 58 +- docs/CampaignTemplateCollection.md | 65 + docs/CampaignTemplateParams.md | 28 +- docs/CardLedgerTransactionLogEntry.md | 351 + ...LedgerTransactionLogEntryIntegrationApi.md | 351 + docs/CartItem.md | 126 +- docs/Catalog.md | 247 + docs/CatalogAction.md | 65 + docs/CatalogActionFilter.md | 91 + docs/CatalogItem.md | 195 + docs/CatalogSyncRequest.md | 65 + docs/Change.md | 4 +- docs/CodeGeneratorSettings.md | 4 +- docs/Collection.md | 204 +- docs/CollectionItem.md | 39 + docs/CollectionWithoutPayload.md | 299 + docs/Coupon.md | 36 +- docs/CouponConstraints.md | 2 +- docs/CouponCreatedEffectProps.md | 4 +- docs/CouponCreationJob.md | 68 +- docs/CouponLimitConfigs.md | 39 + docs/CouponReservations.md | 2 +- docs/CouponSearch.md | 2 +- docs/CouponValue.md | 2 +- docs/CreateApplicationApiKey.md | 6 +- docs/CreateManagementKey.md | 91 + docs/CreateTemplateCampaign.md | 54 +- docs/CreateTemplateCampaignResponse.md | 26 + docs/CustomEffect.md | 4 +- docs/CustomEffectProps.md | 2 +- docs/CustomerActivityReport.md | 2 +- docs/CustomerAnalytics.md | 14 +- docs/CustomerInventory.md | 12 +- docs/CustomerProfile.md | 14 +- docs/CustomerProfileAudienceRequestItem.md | 4 +- docs/CustomerProfileIntegrationRequestV2.md | 4 +- docs/CustomerProfileSearchQuery.md | 2 +- docs/CustomerSession.md | 10 +- docs/CustomerSessionV2.md | 104 +- docs/DeductLoyaltyPointsEffectProps.md | 36 +- docs/Effect.md | 38 +- docs/EffectEntity.md | 38 +- docs/Endpoint.md | 39 + docs/Entity.md | 2 +- docs/Environment.md | 30 +- docs/ErrorResponseWithStatus.md | 91 + docs/ErrorSource.md | 2 +- docs/Event.md | 6 +- docs/EventType.md | 186 +- docs/EventV2.md | 91 + docs/Export.md | 4 +- docs/FeatureFlag.md | 4 +- docs/FeatureFlags.md | 117 - docs/FeedNotification.md | 12 +- docs/Giveaway.md | 2 +- docs/GiveawaysPool.md | 4 +- docs/Import.md | 6 +- docs/InlineResponse20010.md | 36 +- docs/InlineResponse20011.md | 60 +- docs/InlineResponse20012.md | 10 +- docs/InlineResponse20013.md | 36 +- docs/InlineResponse20014.md | 36 +- docs/InlineResponse20015.md | 36 +- docs/InlineResponse20016.md | 10 +- docs/InlineResponse20017.md | 36 +- docs/InlineResponse20018.md | 38 +- docs/InlineResponse20019.md | 38 +- docs/InlineResponse20020.md | 36 +- docs/InlineResponse20021.md | 10 +- docs/InlineResponse20022.md | 38 +- docs/InlineResponse20023.md | 36 +- docs/InlineResponse20024.md | 10 +- docs/InlineResponse20025.md | 10 +- docs/InlineResponse20026.md | 10 +- docs/InlineResponse20027.md | 38 +- docs/InlineResponse20028.md | 10 +- docs/InlineResponse20029.md | 10 +- docs/InlineResponse2003.md | 10 +- docs/InlineResponse20030.md | 65 + docs/InlineResponse20031.md | 91 + docs/InlineResponse20032.md | 65 + docs/InlineResponse20033.md | 65 + docs/InlineResponse2004.md | 10 +- docs/InlineResponse2005.md | 26 +- docs/InlineResponse2006.md | 10 +- docs/InlineResponse2007.md | 36 +- docs/InlineResponse2008.md | 36 +- docs/InlineResponse2009.md | 38 +- docs/IntegrationApi.md | 282 +- docs/IntegrationCustomerSessionResponse.md | 65 + docs/IntegrationEntity.md | 2 +- docs/IntegrationEvent.md | 2 +- docs/IntegrationEventV2Request.md | 117 + docs/IntegrationProfileEntity.md | 2 +- docs/IntegrationRequest.md | 2 +- docs/IntegrationStateV2.md | 62 +- docs/InventoryCoupon.md | 38 +- docs/InventoryReferral.md | 377 + docs/ItemAttribute.md | 91 + docs/LedgerEntry.md | 16 +- docs/LedgerInfo.md | 36 +- ...LedgerTransactionLogEntryIntegrationApi.md | 325 + docs/LimitConfig.md | 8 +- docs/Loyalty.md | 28 +- docs/LoyaltyBalance.md | 117 + docs/LoyaltyBalances.md | 65 + docs/LoyaltyCard.md | 273 + docs/LoyaltyCardProfileRegistration.md | 65 + docs/LoyaltyCardRegistration.md | 39 + docs/LoyaltyLedgerEntry.md | 30 +- docs/LoyaltyLedgerTransactions.md | 65 + docs/LoyaltyPoints.md | 6 +- docs/LoyaltyProgram.md | 84 +- docs/LoyaltyProgramBalance.md | 10 +- docs/LoyaltyProgramLedgers.md | 8 +- docs/LoyaltyProjection.md | 91 + docs/LoyaltyProjectionData.md | 117 + docs/LoyaltySubLedger.md | 2 +- docs/LoyaltyTier.md | 4 +- docs/ManagementApi.md | 2576 ++- docs/ManagementKey.md | 195 + docs/MultipleAttribute.md | 39 + docs/MultipleAudiences.md | 65 + docs/MultipleAudiencesItem.md | 143 + ...leCustomerProfileIntegrationRequestItem.md | 4 +- docs/MultipleNewAttribute.md | 39 + docs/MultipleNewAudiences.md | 39 + docs/NewAdditionalCost.md | 28 +- docs/NewApplication.md | 74 +- docs/NewApplicationApiKey.md | 18 +- docs/NewAttribute.md | 106 +- docs/NewAudience.md | 84 +- docs/NewCampaign.md | 10 +- docs/NewCampaignCollection.md | 65 + docs/NewCampaignGroup.md | 4 +- docs/NewCampaignSet.md | 2 +- docs/NewCampaignSetV2.md | 91 + docs/NewCampaignTemplate.md | 54 +- docs/NewCatalog.md | 91 + docs/NewCollection.md | 76 +- docs/NewCouponCreationJob.md | 4 +- docs/NewCoupons.md | 38 +- docs/NewCouponsForMultipleRecipients.md | 10 +- docs/NewCustomEffect.md | 2 +- docs/NewCustomerProfile.md | 2 +- docs/NewCustomerSession.md | 6 +- docs/NewCustomerSessionV2.md | 42 +- docs/NewEvent.md | 2 +- docs/NewEventType.md | 184 +- docs/NewFeatureFlags.md | 91 - docs/NewGiveawaysPool.md | 2 +- docs/NewInternalAudience.md | 91 + docs/NewInvitation.md | 4 +- docs/NewLoyaltyProgram.md | 82 +- docs/NewLoyaltyTier.md | 2 +- docs/NewManagementKey.md | 221 + docs/NewMultipleAudiencesItem.md | 65 + docs/NewNotificationWebhook.md | 65 + docs/NewReferral.md | 4 +- docs/NewReferralsForMultipleAdvocates.md | 6 +- docs/NewReturn.md | 39 + docs/NewRole.md | 8 +- docs/NewRuleset.md | 4 +- docs/NewWebhook.md | 14 +- docs/Notification.md | 6 +- docs/NotificationWebhook.md | 169 + docs/PatchItemCatalogAction.md | 117 + docs/PatchManyItemsCatalogAction.md | 91 + docs/RedeemReferralEffectProps.md | 4 +- docs/Referral.md | 8 +- docs/ReferralConstraints.md | 2 +- docs/ReferralCreatedEffectProps.md | 2 +- docs/RejectCouponEffectProps.md | 10 +- docs/RejectReferralEffectProps.md | 10 +- docs/RemoveItemCatalogAction.md | 39 + docs/RemoveManyItemsCatalogAction.md | 39 + docs/Return.md | 299 + docs/ReturnIntegrationRequest.md | 65 + docs/ReturnedCartItem.md | 65 + docs/Role.md | 12 +- docs/RoleAssign.md | 4 +- docs/RoleMembership.md | 4 +- docs/RollbackAddedLoyaltyPointsEffectProps.md | 86 +- docs/RollbackCouponEffectProps.md | 2 +- ...ollbackDeductedLoyaltyPointsEffectProps.md | 40 +- docs/RollbackDiscountEffectProps.md | 134 +- docs/RollbackReferralEffectProps.md | 2 +- docs/RuleFailureReason.md | 24 +- docs/Ruleset.md | 6 +- docs/SamlConnection.md | 2 +- docs/Session.md | 2 +- docs/SetDiscountEffectProps.md | 32 +- ...SetDiscountPerAdditionalCostEffectProps.md | 34 +- ...ountPerAdditionalCostPerItemEffectProps.md | 195 + docs/SetDiscountPerItemEffectProps.md | 164 +- docs/ShowBundleMetadataEffectProps.md | 6 +- docs/ShowNotificationEffectProps.md | 6 +- docs/TemplateDef.md | 2 +- docs/TemplateLimitConfig.md | 34 +- docs/Tier.md | 4 +- docs/TriggerWebhookEffectProps.md | 4 +- docs/UpdateAccount.md | 4 +- docs/UpdateApplication.md | 72 +- docs/UpdateAttributeEffectProps.md | 4 +- docs/UpdateAudience.md | 2 +- docs/UpdateCampaign.md | 4 +- docs/UpdateCampaignCollection.md | 39 + docs/UpdateCampaignGroup.md | 4 +- docs/UpdateCampaignTemplate.md | 56 +- docs/UpdateCatalog.md | 91 + docs/UpdateCollection.md | 50 +- docs/UpdateCoupon.md | 32 +- docs/UpdateCouponBatch.md | 6 +- docs/UpdateCustomEffect.md | 2 +- docs/UpdateLoyaltyCard.md | 39 + docs/UpdateLoyaltyProgram.md | 30 +- docs/UpdateLoyaltyTier.md | 65 - docs/UpdateReferral.md | 4 +- docs/UpdateReferralBatch.md | 2 +- docs/UpdateRole.md | 8 +- docs/UpdateUser.md | 6 +- docs/UpdateUserLatestFeedTimestamp.md | 2 +- docs/User.md | 6 +- docs/UserFeedNotifications.md | 4 +- docs/Webhook.md | 16 +- docs/WebhookActivationLogEntry.md | 8 +- docs/WebhookLogEntry.md | 10 +- model_accept_coupon_effect_props.go | 4 +- model_accept_referral_effect_props.go | 4 +- model_access_log_entry.go | 10 +- model_account.go | 10 +- model_account_additional_cost.go | 41 +- model_account_analytics.go | 55 +- model_account_entity.go | 2 +- model_account_limits.go | 26 +- model_add_free_item_effect_props.go | 6 +- model_add_item_catalog_action.go | 164 + model_add_loyalty_points_effect_props.go | 158 +- model_additional_cost.go | 2 +- model_api_error.go | 2 +- model_application.go | 96 +- model_application_api_health.go | 8 +- model_application_api_key.go | 18 +- model_application_campaign_stats.go | 16 +- model_application_customer.go | 16 +- model_application_customer_entity.go | 2 +- model_application_customer_search.go | 145 - model_application_entity.go | 2 +- model_application_event.go | 4 +- model_application_notification.go | 59 + model_application_referee.go | 10 +- model_application_session.go | 29 +- model_application_session_entity.go | 2 +- model_async_coupon_creation_response.go | 59 + model_attribute.go | 180 +- model_attributes_mandatory.go | 2 +- model_attributes_settings.go | 2 +- model_audience.go | 175 +- model_audience_analytics.go | 112 + model_audience_integration_id.go | 77 + model_audience_membership.go | 2 +- model_award_giveaway_effect_props.go | 2 +- model_base_loyalty_program.go | 40 +- model_base_saml_connection.go | 2 +- model_binding.go | 39 +- model_bulk_application_notification.go | 74 + model_bulk_campaign_notification.go | 74 + model_campaign.go | 119 +- model_campaign_activation_request.go | 59 + model_campaign_analytics.go | 2 +- model_campaign_collection.go | 320 + model_campaign_collection_without_payload.go | 285 + model_campaign_copy.go | 6 +- model_campaign_created_notification.go | 58 + model_campaign_deleted_notification.go | 58 + model_campaign_edited_notification.go | 74 + model_campaign_entity.go | 2 +- model_campaign_group.go | 8 +- model_campaign_group_entity.go | 2 +- model_campaign_notification.go | 59 + ...ampaign_priorities_changed_notification.go | 110 + model_campaign_priorities_v2.go | 144 + ...l_campaign_ruleset_changed_notification.go | 108 + model_campaign_search.go | 4 +- model_campaign_set.go | 6 +- model_campaign_set_branch_node.go | 8 +- model_campaign_set_i_ds.go | 77 + model_campaign_set_leaf_node.go | 4 +- model_campaign_set_node.go | 2 +- model_campaign_set_v2.go | 127 + model_campaign_state_changed_notification.go | 92 + model_campaign_template.go | 78 +- model_campaign_template_collection.go | 94 + model_campaign_template_params.go | 39 +- model_card_ledger_transaction_log_entry.go | 300 + ...r_transaction_log_entry_integration_api.go | 300 + model_cart_item.go | 164 +- model_catalog.go | 214 + model_catalog_action.go | 75 + model_catalog_action_filter.go | 93 + model_catalog_item.go | 197 + model_catalog_sync_request.go | 93 + model_change.go | 6 +- model_change_profile_password.go | 2 +- model_code_generator_settings.go | 6 +- model_collection.go | 213 +- model_collection_item.go | 58 + model_collection_without_payload.go | 320 + model_coupon.go | 47 +- model_coupon_constraints.go | 4 +- model_coupon_created_effect_props.go | 6 +- model_coupon_creation_job.go | 69 +- model_coupon_limit_configs.go | 77 + model_coupon_rejection_reason.go | 2 +- model_coupon_reservations.go | 4 +- model_coupon_search.go | 4 +- model_coupon_value.go | 4 +- model_create_application_api_key.go | 8 +- model_create_management_key.go | 94 + model_create_template_campaign.go | 74 +- model_create_template_campaign_response.go | 40 +- model_custom_effect.go | 6 +- model_custom_effect_props.go | 4 +- model_customer_activity_report.go | 6 +- model_customer_analytics.go | 18 +- model_customer_inventory.go | 21 +- model_customer_profile.go | 16 +- model_customer_profile_audience_request.go | 2 +- ..._customer_profile_audience_request_item.go | 5 +- ...customer_profile_integration_request_v2.go | 6 +- model_customer_profile_search_query.go | 4 +- model_customer_session.go | 12 +- model_customer_session_v2.go | 98 +- model_deduct_loyalty_points_effect_props.go | 47 +- model_effect.go | 53 +- model_effect_entity.go | 51 +- model_email_entity.go | 2 +- model_endpoint.go | 59 + model_entity.go | 4 +- model_entity_with_talang_visible_id.go | 2 +- model_environment.go | 41 +- model_error_effect_props.go | 2 +- model_error_response.go | 2 +- model_error_response_with_status.go | 146 + model_error_source.go | 4 +- model_event.go | 8 +- model_event_type.go | 187 +- model_event_v2.go | 129 + model_export.go | 6 +- model_feature_flag.go | 6 +- model_feature_flags.go | 164 - model_features_feed.go | 2 +- model_feed_notification.go | 16 +- model_func_arg_def.go | 2 +- model_function_def.go | 2 +- model_giveaway.go | 4 +- model_giveaways_pool.go | 8 +- model_import.go | 8 +- model_import_entity.go | 2 +- model_inline_response_200.go | 2 +- model_inline_response_200_1.go | 2 +- model_inline_response_200_10.go | 26 +- model_inline_response_200_11.go | 78 +- model_inline_response_200_12.go | 12 +- model_inline_response_200_13.go | 26 +- model_inline_response_200_14.go | 26 +- model_inline_response_200_15.go | 46 +- model_inline_response_200_16.go | 12 +- model_inline_response_200_17.go | 26 +- model_inline_response_200_18.go | 74 +- model_inline_response_200_19.go | 48 +- model_inline_response_200_2.go | 2 +- model_inline_response_200_20.go | 26 +- model_inline_response_200_21.go | 12 +- model_inline_response_200_22.go | 74 +- model_inline_response_200_23.go | 28 +- model_inline_response_200_24.go | 12 +- model_inline_response_200_25.go | 12 +- model_inline_response_200_26.go | 12 +- model_inline_response_200_27.go | 74 +- model_inline_response_200_28.go | 12 +- model_inline_response_200_29.go | 12 +- model_inline_response_200_3.go | 12 +- model_inline_response_200_30.go | 74 + model_inline_response_200_31.go | 126 + model_inline_response_200_32.go | 74 + model_inline_response_200_33.go | 74 + model_inline_response_200_4.go | 12 +- model_inline_response_200_5.go | 20 +- model_inline_response_200_6.go | 12 +- model_inline_response_200_7.go | 26 +- model_inline_response_200_8.go | 26 +- model_inline_response_200_9.go | 74 +- model_inline_response_201.go | 2 +- ...l_integration_customer_session_response.go | 110 + model_integration_entity.go | 4 +- model_integration_event.go | 4 +- model_integration_event_v2_request.go | 164 + model_integration_profile_entity.go | 4 +- model_integration_request.go | 4 +- model_integration_state.go | 2 +- model_integration_state_v2.go | 84 +- model_inventory_coupon.go | 49 +- model_inventory_referral.go | 389 + model_item_attribute.go | 93 + model_ledger_entry.go | 18 +- model_ledger_info.go | 48 +- ...r_transaction_log_entry_integration_api.go | 283 + model_library_attribute.go | 2 +- model_limit_config.go | 10 +- model_limit_counter.go | 2 +- model_login_params.go | 2 +- model_loyalty.go | 39 +- model_loyalty_balance.go | 182 + model_loyalty_balances.go | 111 + model_loyalty_card.go | 284 + model_loyalty_card_profile_registration.go | 77 + model_loyalty_card_registration.go | 59 + model_loyalty_dashboard_data.go | 2 +- model_loyalty_dashboard_points_breakdown.go | 2 +- model_loyalty_ledger.go | 2 +- model_loyalty_ledger_entry.go | 68 +- model_loyalty_ledger_transactions.go | 112 + model_loyalty_membership.go | 2 +- model_loyalty_points.go | 10 +- model_loyalty_program.go | 78 +- model_loyalty_program_balance.go | 12 +- model_loyalty_program_entity.go | 2 +- model_loyalty_program_ledgers.go | 10 +- model_loyalty_projection.go | 110 + model_loyalty_projection_data.go | 111 + model_loyalty_statistics.go | 2 +- model_loyalty_sub_ledger.go | 4 +- model_loyalty_tier.go | 6 +- model_management_key.go | 162 + model_manager_config.go | 2 +- model_meta.go | 2 +- model_multi_application_entity.go | 2 +- model_multiple_attribute.go | 76 + model_multiple_audiences.go | 75 + model_multiple_audiences_item.go | 128 + ...le_customer_profile_integration_request.go | 2 +- ...stomer_profile_integration_request_item.go | 6 +- ...ustomer_profile_integration_response_v2.go | 2 +- model_multiple_new_attribute.go | 76 + model_multiple_new_audiences.go | 58 + model_mutable_entity.go | 2 +- model_new_account.go | 2 +- model_new_account_sign_up.go | 2 +- model_new_additional_cost.go | 39 +- model_new_application.go | 94 +- model_new_application_api_key.go | 20 +- model_new_attribute.go | 144 +- model_new_audience.go | 175 +- model_new_campaign.go | 12 +- model_new_campaign_collection.go | 94 + model_new_campaign_group.go | 6 +- model_new_campaign_set.go | 4 +- model_new_campaign_set_v2.go | 92 + model_new_campaign_template.go | 74 +- model_new_catalog.go | 111 + model_new_collection.go | 73 +- model_new_coupon_creation_job.go | 6 +- model_new_coupons.go | 49 +- model_new_coupons_for_multiple_recipients.go | 12 +- model_new_custom_effect.go | 4 +- model_new_customer_profile.go | 4 +- model_new_customer_session.go | 8 +- model_new_customer_session_v2.go | 53 +- model_new_event.go | 4 +- model_new_event_type.go | 185 +- model_new_feature_flags.go | 147 - model_new_giveaways_pool.go | 4 +- model_new_internal_audience.go | 129 + model_new_invitation.go | 8 +- model_new_invite_email.go | 2 +- model_new_loyalty_program.go | 76 +- model_new_loyalty_tier.go | 6 +- model_new_management_key.go | 179 + model_new_multiple_audiences_item.go | 94 + model_new_notification_webhook.go | 76 + model_new_password.go | 2 +- model_new_password_email.go | 2 +- model_new_referral.go | 6 +- model_new_referrals_for_multiple_advocates.go | 8 +- model_new_return.go | 59 + model_new_role.go | 10 +- model_new_ruleset.go | 6 +- model_new_saml_connection.go | 2 +- model_new_template_def.go | 2 +- model_new_user.go | 2 +- model_new_webhook.go | 16 +- model_notification.go | 8 +- model_notification_webhook.go | 145 + model_patch_item_catalog_action.go | 164 + model_patch_many_items_catalog_action.go | 147 + model_profile_audiences_changes.go | 2 +- model_redeem_referral_effect_props.go | 8 +- model_referral.go | 10 +- model_referral_constraints.go | 4 +- model_referral_created_effect_props.go | 4 +- model_referral_rejection_reason.go | 2 +- model_reject_coupon_effect_props.go | 12 +- model_reject_referral_effect_props.go | 12 +- model_remove_item_catalog_action.go | 59 + model_remove_many_items_catalog_action.go | 77 + model_return.go | 284 + model_return_integration_request.go | 93 + model_returned_cart_item.go | 94 + model_role.go | 14 +- model_role_assign.go | 6 +- model_role_membership.go | 6 +- ...lback_added_loyalty_points_effect_props.go | 115 +- model_rollback_coupon_effect_props.go | 4 +- ...ck_deducted_loyalty_points_effect_props.go | 51 +- model_rollback_discount_effect_props.go | 183 +- model_rollback_referral_effect_props.go | 4 +- model_rule.go | 2 +- model_rule_failure_reason.go | 26 +- model_ruleset.go | 8 +- model_saml_connection.go | 4 +- model_saml_connection_metadata.go | 2 +- model_saml_login_endpoint.go | 2 +- model_session.go | 4 +- model_set_discount_effect_props.go | 43 +- ...scount_per_additional_cost_effect_props.go | 45 +- ...r_additional_cost_per_item_effect_props.go | 197 + model_set_discount_per_item_effect_props.go | 222 +- model_show_bundle_metadata_effect_props.go | 10 +- model_show_notification_effect_props.go | 8 +- model_slot_def.go | 2 +- model_template_arg_def.go | 2 +- model_template_def.go | 4 +- model_template_limit_config.go | 27 +- model_tier.go | 6 +- model_trigger_webhook_effect_props.go | 6 +- model_update_account.go | 6 +- model_update_application.go | 92 +- model_update_attribute_effect_props.go | 6 +- model_update_audience.go | 4 +- model_update_campaign.go | 6 +- model_update_campaign_collection.go | 77 + model_update_campaign_group.go | 6 +- model_update_campaign_template.go | 76 +- model_update_catalog.go | 147 + model_update_collection.go | 56 +- model_update_coupon.go | 43 +- model_update_coupon_batch.go | 36 +- model_update_custom_effect.go | 4 +- model_update_loyalty_card.go | 59 + model_update_loyalty_program.go | 42 +- model_update_loyalty_tier.go | 76 - model_update_referral.go | 6 +- model_update_referral_batch.go | 4 +- model_update_role.go | 10 +- model_update_user.go | 8 +- model_update_user_latest_feed_timestamp.go | 6 +- model_user.go | 8 +- model_user_entity.go | 2 +- model_user_feed_notifications.go | 8 +- model_webhook.go | 18 +- model_webhook_activation_log_entry.go | 12 +- model_webhook_log_entry.go | 14 +- model_will_award_giveaway_effect_props.go | 2 +- response.go | 2 +- utils.go | 2 +- 621 files changed, 49505 insertions(+), 14014 deletions(-) create mode 100644 docs/AddItemCatalogAction.md delete mode 100644 docs/ApplicationCustomerSearch.md create mode 100644 docs/ApplicationNotification.md create mode 100644 docs/AsyncCouponCreationResponse.md create mode 100644 docs/AudienceAnalytics.md create mode 100644 docs/AudienceIntegrationId.md create mode 100644 docs/BulkApplicationNotification.md create mode 100644 docs/BulkCampaignNotification.md create mode 100644 docs/CampaignActivationRequest.md create mode 100644 docs/CampaignCollection.md create mode 100644 docs/CampaignCollectionWithoutPayload.md create mode 100644 docs/CampaignCreatedNotification.md create mode 100644 docs/CampaignDeletedNotification.md create mode 100644 docs/CampaignEditedNotification.md create mode 100644 docs/CampaignNotification.md create mode 100644 docs/CampaignPrioritiesChangedNotification.md create mode 100644 docs/CampaignPrioritiesV2.md create mode 100644 docs/CampaignRulesetChangedNotification.md create mode 100644 docs/CampaignSetIDs.md create mode 100644 docs/CampaignSetV2.md create mode 100644 docs/CampaignStateChangedNotification.md create mode 100644 docs/CampaignTemplateCollection.md create mode 100644 docs/CardLedgerTransactionLogEntry.md create mode 100644 docs/CardLedgerTransactionLogEntryIntegrationApi.md create mode 100644 docs/Catalog.md create mode 100644 docs/CatalogAction.md create mode 100644 docs/CatalogActionFilter.md create mode 100644 docs/CatalogItem.md create mode 100644 docs/CatalogSyncRequest.md create mode 100644 docs/CollectionItem.md create mode 100644 docs/CollectionWithoutPayload.md create mode 100644 docs/CouponLimitConfigs.md create mode 100644 docs/CreateManagementKey.md create mode 100644 docs/Endpoint.md create mode 100644 docs/ErrorResponseWithStatus.md create mode 100644 docs/EventV2.md delete mode 100644 docs/FeatureFlags.md create mode 100644 docs/InlineResponse20030.md create mode 100644 docs/InlineResponse20031.md create mode 100644 docs/InlineResponse20032.md create mode 100644 docs/InlineResponse20033.md create mode 100644 docs/IntegrationCustomerSessionResponse.md create mode 100644 docs/IntegrationEventV2Request.md create mode 100644 docs/InventoryReferral.md create mode 100644 docs/ItemAttribute.md create mode 100644 docs/LedgerTransactionLogEntryIntegrationApi.md create mode 100644 docs/LoyaltyBalance.md create mode 100644 docs/LoyaltyBalances.md create mode 100644 docs/LoyaltyCard.md create mode 100644 docs/LoyaltyCardProfileRegistration.md create mode 100644 docs/LoyaltyCardRegistration.md create mode 100644 docs/LoyaltyLedgerTransactions.md create mode 100644 docs/LoyaltyProjection.md create mode 100644 docs/LoyaltyProjectionData.md create mode 100644 docs/ManagementKey.md create mode 100644 docs/MultipleAttribute.md create mode 100644 docs/MultipleAudiences.md create mode 100644 docs/MultipleAudiencesItem.md create mode 100644 docs/MultipleNewAttribute.md create mode 100644 docs/MultipleNewAudiences.md create mode 100644 docs/NewCampaignCollection.md create mode 100644 docs/NewCampaignSetV2.md create mode 100644 docs/NewCatalog.md delete mode 100644 docs/NewFeatureFlags.md create mode 100644 docs/NewInternalAudience.md create mode 100644 docs/NewManagementKey.md create mode 100644 docs/NewMultipleAudiencesItem.md create mode 100644 docs/NewNotificationWebhook.md create mode 100644 docs/NewReturn.md create mode 100644 docs/NotificationWebhook.md create mode 100644 docs/PatchItemCatalogAction.md create mode 100644 docs/PatchManyItemsCatalogAction.md create mode 100644 docs/RemoveItemCatalogAction.md create mode 100644 docs/RemoveManyItemsCatalogAction.md create mode 100644 docs/Return.md create mode 100644 docs/ReturnIntegrationRequest.md create mode 100644 docs/ReturnedCartItem.md create mode 100644 docs/SetDiscountPerAdditionalCostPerItemEffectProps.md create mode 100644 docs/UpdateCampaignCollection.md create mode 100644 docs/UpdateCatalog.md create mode 100644 docs/UpdateLoyaltyCard.md delete mode 100644 docs/UpdateLoyaltyTier.md create mode 100644 model_add_item_catalog_action.go delete mode 100644 model_application_customer_search.go create mode 100644 model_application_notification.go create mode 100644 model_async_coupon_creation_response.go create mode 100644 model_audience_analytics.go create mode 100644 model_audience_integration_id.go create mode 100644 model_bulk_application_notification.go create mode 100644 model_bulk_campaign_notification.go create mode 100644 model_campaign_activation_request.go create mode 100644 model_campaign_collection.go create mode 100644 model_campaign_collection_without_payload.go create mode 100644 model_campaign_created_notification.go create mode 100644 model_campaign_deleted_notification.go create mode 100644 model_campaign_edited_notification.go create mode 100644 model_campaign_notification.go create mode 100644 model_campaign_priorities_changed_notification.go create mode 100644 model_campaign_priorities_v2.go create mode 100644 model_campaign_ruleset_changed_notification.go create mode 100644 model_campaign_set_i_ds.go create mode 100644 model_campaign_set_v2.go create mode 100644 model_campaign_state_changed_notification.go create mode 100644 model_campaign_template_collection.go create mode 100644 model_card_ledger_transaction_log_entry.go create mode 100644 model_card_ledger_transaction_log_entry_integration_api.go create mode 100644 model_catalog.go create mode 100644 model_catalog_action.go create mode 100644 model_catalog_action_filter.go create mode 100644 model_catalog_item.go create mode 100644 model_catalog_sync_request.go create mode 100644 model_collection_item.go create mode 100644 model_collection_without_payload.go create mode 100644 model_coupon_limit_configs.go create mode 100644 model_create_management_key.go create mode 100644 model_endpoint.go create mode 100644 model_error_response_with_status.go create mode 100644 model_event_v2.go delete mode 100644 model_feature_flags.go create mode 100644 model_inline_response_200_30.go create mode 100644 model_inline_response_200_31.go create mode 100644 model_inline_response_200_32.go create mode 100644 model_inline_response_200_33.go create mode 100644 model_integration_customer_session_response.go create mode 100644 model_integration_event_v2_request.go create mode 100644 model_inventory_referral.go create mode 100644 model_item_attribute.go create mode 100644 model_ledger_transaction_log_entry_integration_api.go create mode 100644 model_loyalty_balance.go create mode 100644 model_loyalty_balances.go create mode 100644 model_loyalty_card.go create mode 100644 model_loyalty_card_profile_registration.go create mode 100644 model_loyalty_card_registration.go create mode 100644 model_loyalty_ledger_transactions.go create mode 100644 model_loyalty_projection.go create mode 100644 model_loyalty_projection_data.go create mode 100644 model_management_key.go create mode 100644 model_multiple_attribute.go create mode 100644 model_multiple_audiences.go create mode 100644 model_multiple_audiences_item.go create mode 100644 model_multiple_new_attribute.go create mode 100644 model_multiple_new_audiences.go create mode 100644 model_new_campaign_collection.go create mode 100644 model_new_campaign_set_v2.go create mode 100644 model_new_catalog.go delete mode 100644 model_new_feature_flags.go create mode 100644 model_new_internal_audience.go create mode 100644 model_new_management_key.go create mode 100644 model_new_multiple_audiences_item.go create mode 100644 model_new_notification_webhook.go create mode 100644 model_new_return.go create mode 100644 model_notification_webhook.go create mode 100644 model_patch_item_catalog_action.go create mode 100644 model_patch_many_items_catalog_action.go create mode 100644 model_remove_item_catalog_action.go create mode 100644 model_remove_many_items_catalog_action.go create mode 100644 model_return.go create mode 100644 model_return_integration_request.go create mode 100644 model_returned_cart_item.go create mode 100644 model_set_discount_per_additional_cost_per_item_effect_props.go create mode 100644 model_update_campaign_collection.go create mode 100644 model_update_catalog.go create mode 100644 model_update_loyalty_card.go delete mode 100644 model_update_loyalty_tier.go diff --git a/README.md b/README.md index 84b2bc5c..f96884c5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Go API client for talon -se the Talon.One API to integrate with your application and to +Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) @@ -17,11 +17,10 @@ is `https://mycompany.talon.one/v2/customer_sessions/{Id}` ## Overview - This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. - API version: 1.0.0 -- Package version: 2.5.0 +- Package version: 2.6.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen ## Installation @@ -80,7 +79,6 @@ ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables }, }) ``` - ## Getting Started ### Integration API @@ -122,22 +120,22 @@ func main() { }) // Instantiating a NewCustomerSessionV2 struct - customerSession := talon.NewCustomerSession{ - // You can use both struct literals + newCustomerSession := talon.NewCustomerSessionV2{ + // You can use either struct literals ProfileId: talon.PtrString("DEADBEEF"), CouponCodes: &[]string{"Cool-Stuff!"}, } // Or alternatively, using the relevant setter in a later stage in the code newCustomerSession.SetCartItems([]talon.CartItem{ - talon.CartItem{ + { Name: "Pad Thai - Veggie", Sku: "pad-332", Quantity: 1, Price: 5.5, Category: talon.PtrString("Noodles"), }, - talon.CartItem{ + { Name: "Chang", Sku: "chang-br-42", Quantity: 1, @@ -277,7 +275,7 @@ func main() { ## Documentation for API Endpoints -All URIs are relative to *http://localhost* +All URIs are relative to *https://yourbaseurl.talon.one* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -288,45 +286,59 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**DeleteAudienceMembershipsV2**](docs/IntegrationApi.md#deleteaudiencemembershipsv2) | **Delete** /v2/audiences/{audienceId}/memberships | Delete audience memberships *IntegrationApi* | [**DeleteAudienceV2**](docs/IntegrationApi.md#deleteaudiencev2) | **Delete** /v2/audiences/{audienceId} | Delete audience *IntegrationApi* | [**DeleteCouponReservation**](docs/IntegrationApi.md#deletecouponreservation) | **Delete** /v1/coupon_reservations/{couponValue} | Delete coupon reservations -*IntegrationApi* | [**DeleteCustomerData**](docs/IntegrationApi.md#deletecustomerdata) | **Delete** /v1/customer_data/{integrationId} | Delete the personal data of a customer -*IntegrationApi* | [**GetCustomerInventory**](docs/IntegrationApi.md#getcustomerinventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | List data associated with a specific customer profile -*IntegrationApi* | [**GetReservedCustomers**](docs/IntegrationApi.md#getreservedcustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | List users that have this coupon reserved -*IntegrationApi* | [**TrackEvent**](docs/IntegrationApi.md#trackevent) | **Post** /v1/events | Track an Event +*IntegrationApi* | [**DeleteCustomerData**](docs/IntegrationApi.md#deletecustomerdata) | **Delete** /v1/customer_data/{integrationId} | Delete customer's personal data +*IntegrationApi* | [**GetCustomerInventory**](docs/IntegrationApi.md#getcustomerinventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | List customer data +*IntegrationApi* | [**GetCustomerSession**](docs/IntegrationApi.md#getcustomersession) | **Get** /v2/customer_sessions/{customerSessionId} | Get customer session +*IntegrationApi* | [**GetLoyaltyTransactions**](docs/IntegrationApi.md#getloyaltytransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | Get loyalty ledger transaction logs +*IntegrationApi* | [**GetReservedCustomers**](docs/IntegrationApi.md#getreservedcustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved +*IntegrationApi* | [**ReturnCartItems**](docs/IntegrationApi.md#returncartitems) | **Post** /v2/customer_sessions/{customerSessionId}/returns | Return cart items +*IntegrationApi* | [**SyncCatalog**](docs/IntegrationApi.md#synccatalog) | **Put** /v1/catalogs/{catalogId}/sync | Sync cart item catalog +*IntegrationApi* | [**TrackEvent**](docs/IntegrationApi.md#trackevent) | **Post** /v1/events | Track event +*IntegrationApi* | [**TrackEventV2**](docs/IntegrationApi.md#trackeventv2) | **Post** /v2/events | Track event V2 *IntegrationApi* | [**UpdateAudienceCustomersAttributes**](docs/IntegrationApi.md#updateaudiencecustomersattributes) | **Put** /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience -*IntegrationApi* | [**UpdateAudienceV2**](docs/IntegrationApi.md#updateaudiencev2) | **Put** /v2/audiences/{audienceId} | Update audience +*IntegrationApi* | [**UpdateAudienceV2**](docs/IntegrationApi.md#updateaudiencev2) | **Put** /v2/audiences/{audienceId} | Update audience name *IntegrationApi* | [**UpdateCustomerProfileAudiences**](docs/IntegrationApi.md#updatecustomerprofileaudiences) | **Post** /v2/customer_audiences | Update multiple customer profiles' audiences *IntegrationApi* | [**UpdateCustomerProfileV2**](docs/IntegrationApi.md#updatecustomerprofilev2) | **Put** /v2/customer_profiles/{integrationId} | Update customer profile *IntegrationApi* | [**UpdateCustomerProfilesV2**](docs/IntegrationApi.md#updatecustomerprofilesv2) | **Put** /v2/customer_profiles | Update multiple customer profiles *IntegrationApi* | [**UpdateCustomerSessionV2**](docs/IntegrationApi.md#updatecustomersessionv2) | **Put** /v2/customer_sessions/{customerSessionId} | Update customer session -*ManagementApi* | [**AddLoyaltyPoints**](docs/ManagementApi.md#addloyaltypoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in loyalty program for given customer -*ManagementApi* | [**CopyCampaignToApplications**](docs/ManagementApi.md#copycampaigntoapplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application -*ManagementApi* | [**CreateAdditionalCost**](docs/ManagementApi.md#createadditionalcost) | **Post** /v1/additional_costs | Define a new additional cost +*ManagementApi* | [**AddLoyaltyPoints**](docs/ManagementApi.md#addloyaltypoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points in loyalty program for given customer +*ManagementApi* | [**CopyCampaignToApplications**](docs/ManagementApi.md#copycampaigntoapplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified application +*ManagementApi* | [**CreateAccountCollection**](docs/ManagementApi.md#createaccountcollection) | **Post** /v1/collections | Create account-level collection +*ManagementApi* | [**CreateAdditionalCost**](docs/ManagementApi.md#createadditionalcost) | **Post** /v1/additional_costs | Create additional cost *ManagementApi* | [**CreateAttribute**](docs/ManagementApi.md#createattribute) | **Post** /v1/attributes | Create custom attribute -*ManagementApi* | [**CreateCampaign**](docs/ManagementApi.md#createcampaign) | **Post** /v1/applications/{applicationId}/campaigns | Create campaign +*ManagementApi* | [**CreateCampaignFromTemplate**](docs/ManagementApi.md#createcampaignfromtemplate) | **Post** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template +*ManagementApi* | [**CreateCollection**](docs/ManagementApi.md#createcollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create collection *ManagementApi* | [**CreateCoupons**](docs/ManagementApi.md#createcoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons +*ManagementApi* | [**CreateCouponsAsync**](docs/ManagementApi.md#createcouponsasync) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously *ManagementApi* | [**CreateCouponsForMultipleRecipients**](docs/ManagementApi.md#createcouponsformultiplerecipients) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients +*ManagementApi* | [**CreateNotificationWebhook**](docs/ManagementApi.md#createnotificationwebhook) | **Post** /v1/applications/{applicationId}/notification_webhooks | Create notification webhook *ManagementApi* | [**CreatePasswordRecoveryEmail**](docs/ManagementApi.md#createpasswordrecoveryemail) | **Post** /v1/password_recovery_emails | Request a password reset -*ManagementApi* | [**CreateRuleset**](docs/ManagementApi.md#createruleset) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create ruleset *ManagementApi* | [**CreateSession**](docs/ManagementApi.md#createsession) | **Post** /v1/sessions | Create session +*ManagementApi* | [**DeleteAccountCollection**](docs/ManagementApi.md#deleteaccountcollection) | **Delete** /v1/collections/{collectionId} | Delete account-level collection *ManagementApi* | [**DeleteCampaign**](docs/ManagementApi.md#deletecampaign) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign +*ManagementApi* | [**DeleteCollection**](docs/ManagementApi.md#deletecollection) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete collection *ManagementApi* | [**DeleteCoupon**](docs/ManagementApi.md#deletecoupon) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon *ManagementApi* | [**DeleteCoupons**](docs/ManagementApi.md#deletecoupons) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons +*ManagementApi* | [**DeleteNotificationWebhook**](docs/ManagementApi.md#deletenotificationwebhook) | **Delete** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification webhook *ManagementApi* | [**DeleteReferral**](docs/ManagementApi.md#deletereferral) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral *ManagementApi* | [**DestroySession**](docs/ManagementApi.md#destroysession) | **Delete** /v1/sessions | Destroy session -*ManagementApi* | [**ExportCoupons**](docs/ManagementApi.md#exportcoupons) | **Get** /v1/applications/{applicationId}/export_coupons | Export coupons to CSV file -*ManagementApi* | [**ExportCustomerSessions**](docs/ManagementApi.md#exportcustomersessions) | **Get** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions to CSV file -*ManagementApi* | [**ExportEffects**](docs/ManagementApi.md#exporteffects) | **Get** /v1/applications/{applicationId}/export_effects | Export triggered effects to CSV file -*ManagementApi* | [**ExportLoyaltyBalance**](docs/ManagementApi.md#exportloyaltybalance) | **Get** /v1/loyalty_programs/{programID}/export_customer_balance | Export customer loyalty balance to a CSV file -*ManagementApi* | [**ExportLoyaltyLedger**](docs/ManagementApi.md#exportloyaltyledger) | **Get** /v1/loyalty_programs/{programID}/profile/{integrationID}/export_log | Export a customer's loyalty ledger log to CSV file -*ManagementApi* | [**ExportReferrals**](docs/ManagementApi.md#exportreferrals) | **Get** /v1/applications/{applicationId}/export_referrals | Export referrals to CSV file +*ManagementApi* | [**ExportAccountCollectionItems**](docs/ManagementApi.md#exportaccountcollectionitems) | **Get** /v1/collections/{collectionId}/export | Export account-level collection's items +*ManagementApi* | [**ExportCollectionItems**](docs/ManagementApi.md#exportcollectionitems) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export a collection's items +*ManagementApi* | [**ExportCoupons**](docs/ManagementApi.md#exportcoupons) | **Get** /v1/applications/{applicationId}/export_coupons | Export coupons +*ManagementApi* | [**ExportCustomerSessions**](docs/ManagementApi.md#exportcustomersessions) | **Get** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions +*ManagementApi* | [**ExportEffects**](docs/ManagementApi.md#exporteffects) | **Get** /v1/applications/{applicationId}/export_effects | Export triggered effects +*ManagementApi* | [**ExportLoyaltyBalance**](docs/ManagementApi.md#exportloyaltybalance) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to a CSV file +*ManagementApi* | [**ExportLoyaltyLedger**](docs/ManagementApi.md#exportloyaltyledger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export a customer's loyalty ledger log +*ManagementApi* | [**ExportReferrals**](docs/ManagementApi.md#exportreferrals) | **Get** /v1/applications/{applicationId}/export_referrals | Export referrals *ManagementApi* | [**GetAccessLogsWithoutTotalCount**](docs/ManagementApi.md#getaccesslogswithouttotalcount) | **Get** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for Application *ManagementApi* | [**GetAccount**](docs/ManagementApi.md#getaccount) | **Get** /v1/accounts/{accountId} | Get account details *ManagementApi* | [**GetAccountAnalytics**](docs/ManagementApi.md#getaccountanalytics) | **Get** /v1/accounts/{accountId}/analytics | Get account analytics -*ManagementApi* | [**GetAdditionalCost**](docs/ManagementApi.md#getadditionalcost) | **Get** /v1/additional_costs/{additionalCostId} | Get an additional cost +*ManagementApi* | [**GetAccountCollection**](docs/ManagementApi.md#getaccountcollection) | **Get** /v1/collections/{collectionId} | Get account-level collection +*ManagementApi* | [**GetAdditionalCost**](docs/ManagementApi.md#getadditionalcost) | **Get** /v1/additional_costs/{additionalCostId} | Get additional cost *ManagementApi* | [**GetAdditionalCosts**](docs/ManagementApi.md#getadditionalcosts) | **Get** /v1/additional_costs | List additional costs *ManagementApi* | [**GetAllAccessLogs**](docs/ManagementApi.md#getallaccesslogs) | **Get** /v1/access_logs | List access logs *ManagementApi* | [**GetAllRoles**](docs/ManagementApi.md#getallroles) | **Get** /v1/roles | List roles -*ManagementApi* | [**GetApplication**](docs/ManagementApi.md#getapplication) | **Get** /v1/applications/{applicationId} | Get Application +*ManagementApi* | [**GetApplication**](docs/ManagementApi.md#getapplication) | **Get** /v1/applications/{applicationId} | Get application *ManagementApi* | [**GetApplicationApiHealth**](docs/ManagementApi.md#getapplicationapihealth) | **Get** /v1/applications/{applicationId}/health_report | Get report of health of application API *ManagementApi* | [**GetApplicationCustomer**](docs/ManagementApi.md#getapplicationcustomer) | **Get** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer *ManagementApi* | [**GetApplicationCustomerFriends**](docs/ManagementApi.md#getapplicationcustomerfriends) | **Get** /v1/applications/{applicationId}/profile/{integrationId}/friends | List friends referred by customer profile @@ -336,16 +348,17 @@ Class | Method | HTTP request | Description *ManagementApi* | [**GetApplicationEventsWithoutTotalCount**](docs/ManagementApi.md#getapplicationeventswithouttotalcount) | **Get** /v1/applications/{applicationId}/events/no_total | List Applications events *ManagementApi* | [**GetApplicationSession**](docs/ManagementApi.md#getapplicationsession) | **Get** /v1/applications/{applicationId}/sessions/{sessionId} | Get Application session *ManagementApi* | [**GetApplicationSessions**](docs/ManagementApi.md#getapplicationsessions) | **Get** /v1/applications/{applicationId}/sessions | List Application sessions -*ManagementApi* | [**GetApplications**](docs/ManagementApi.md#getapplications) | **Get** /v1/applications | List Applications -*ManagementApi* | [**GetAttribute**](docs/ManagementApi.md#getattribute) | **Get** /v1/attributes/{attributeId} | Get a custom attribute +*ManagementApi* | [**GetApplications**](docs/ManagementApi.md#getapplications) | **Get** /v1/applications | List applications +*ManagementApi* | [**GetAttribute**](docs/ManagementApi.md#getattribute) | **Get** /v1/attributes/{attributeId} | Get custom attribute *ManagementApi* | [**GetAttributes**](docs/ManagementApi.md#getattributes) | **Get** /v1/attributes | List custom attributes *ManagementApi* | [**GetAudiences**](docs/ManagementApi.md#getaudiences) | **Get** /v1/audiences | List audiences *ManagementApi* | [**GetCampaign**](docs/ManagementApi.md#getcampaign) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId} | Get campaign *ManagementApi* | [**GetCampaignAnalytics**](docs/ManagementApi.md#getcampaignanalytics) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns *ManagementApi* | [**GetCampaignByAttributes**](docs/ManagementApi.md#getcampaignbyattributes) | **Post** /v1/applications/{applicationId}/campaigns_search | List campaigns that match the given attributes *ManagementApi* | [**GetCampaigns**](docs/ManagementApi.md#getcampaigns) | **Get** /v1/applications/{applicationId}/campaigns | List campaigns -*ManagementApi* | [**GetChanges**](docs/ManagementApi.md#getchanges) | **Get** /v1/changes | Get audit log for an account -*ManagementApi* | [**GetCouponsByAttributes**](docs/ManagementApi.md#getcouponsbyattributes) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search | List coupons that match the given attributes +*ManagementApi* | [**GetChanges**](docs/ManagementApi.md#getchanges) | **Get** /v1/changes | Get audit logs for an account +*ManagementApi* | [**GetCollection**](docs/ManagementApi.md#getcollection) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get collection +*ManagementApi* | [**GetCollectionItems**](docs/ManagementApi.md#getcollectionitems) | **Get** /v1/collections/{collectionId}/items | Get collection items *ManagementApi* | [**GetCouponsWithoutTotalCount**](docs/ManagementApi.md#getcouponswithouttotalcount) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons *ManagementApi* | [**GetCustomerActivityReport**](docs/ManagementApi.md#getcustomeractivityreport) | **Get** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report *ManagementApi* | [**GetCustomerActivityReportsWithoutTotalCount**](docs/ManagementApi.md#getcustomeractivityreportswithouttotalcount) | **Get** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers @@ -353,38 +366,47 @@ Class | Method | HTTP request | Description *ManagementApi* | [**GetCustomerProfile**](docs/ManagementApi.md#getcustomerprofile) | **Get** /v1/customers/{customerId} | Get customer profile *ManagementApi* | [**GetCustomerProfiles**](docs/ManagementApi.md#getcustomerprofiles) | **Get** /v1/customers/no_total | List customer profiles *ManagementApi* | [**GetCustomersByAttributes**](docs/ManagementApi.md#getcustomersbyattributes) | **Post** /v1/customer_search/no_total | List customer profiles matching the given attributes -*ManagementApi* | [**GetEventTypes**](docs/ManagementApi.md#geteventtypes) | **Get** /v1/event_types | List Event Types -*ManagementApi* | [**GetExports**](docs/ManagementApi.md#getexports) | **Get** /v1/exports | Get Exports -*ManagementApi* | [**GetLoyaltyPoints**](docs/ManagementApi.md#getloyaltypoints) | **Get** /v1/loyalty_programs/{programID}/profile/{integrationID} | Get the Loyalty Ledger for this integrationID -*ManagementApi* | [**GetLoyaltyProgram**](docs/ManagementApi.md#getloyaltyprogram) | **Get** /v1/loyalty_programs/{programID} | Get loyalty program +*ManagementApi* | [**GetEventTypes**](docs/ManagementApi.md#geteventtypes) | **Get** /v1/event_types | List event types +*ManagementApi* | [**GetExports**](docs/ManagementApi.md#getexports) | **Get** /v1/exports | Get exports +*ManagementApi* | [**GetLoyaltyPoints**](docs/ManagementApi.md#getloyaltypoints) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get the Loyalty Ledger for this integrationID +*ManagementApi* | [**GetLoyaltyProgram**](docs/ManagementApi.md#getloyaltyprogram) | **Get** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program *ManagementApi* | [**GetLoyaltyPrograms**](docs/ManagementApi.md#getloyaltyprograms) | **Get** /v1/loyalty_programs | List loyalty programs -*ManagementApi* | [**GetLoyaltyStatistics**](docs/ManagementApi.md#getloyaltystatistics) | **Get** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID +*ManagementApi* | [**GetLoyaltyStatistics**](docs/ManagementApi.md#getloyaltystatistics) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics by loyalty program ID +*ManagementApi* | [**GetNotificationWebhook**](docs/ManagementApi.md#getnotificationwebhook) | **Get** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Get notification webhook +*ManagementApi* | [**GetNotificationWebhooks**](docs/ManagementApi.md#getnotificationwebhooks) | **Get** /v1/applications/{applicationId}/notification_webhooks | List notification webhooks *ManagementApi* | [**GetReferralsWithoutTotalCount**](docs/ManagementApi.md#getreferralswithouttotalcount) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals *ManagementApi* | [**GetRole**](docs/ManagementApi.md#getrole) | **Get** /v1/roles/{roleId} | Get role *ManagementApi* | [**GetRuleset**](docs/ManagementApi.md#getruleset) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset *ManagementApi* | [**GetRulesets**](docs/ManagementApi.md#getrulesets) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets -*ManagementApi* | [**GetUser**](docs/ManagementApi.md#getuser) | **Get** /v1/users/{userId} | Get a single user +*ManagementApi* | [**GetUser**](docs/ManagementApi.md#getuser) | **Get** /v1/users/{userId} | Get user *ManagementApi* | [**GetUsers**](docs/ManagementApi.md#getusers) | **Get** /v1/users | List users in account -*ManagementApi* | [**GetWebhook**](docs/ManagementApi.md#getwebhook) | **Get** /v1/webhooks/{webhookId} | Get Webhook +*ManagementApi* | [**GetWebhook**](docs/ManagementApi.md#getwebhook) | **Get** /v1/webhooks/{webhookId} | Get webhook *ManagementApi* | [**GetWebhookActivationLogs**](docs/ManagementApi.md#getwebhookactivationlogs) | **Get** /v1/webhook_activation_logs | List webhook activation log entries *ManagementApi* | [**GetWebhookLogs**](docs/ManagementApi.md#getwebhooklogs) | **Get** /v1/webhook_logs | List webhook log entries *ManagementApi* | [**GetWebhooks**](docs/ManagementApi.md#getwebhooks) | **Get** /v1/webhooks | List webhooks -*ManagementApi* | [**ImportCollection**](docs/ManagementApi.md#importcollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import collection via CSV file -*ManagementApi* | [**ImportCoupons**](docs/ManagementApi.md#importcoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file -*ManagementApi* | [**ImportLoyaltyPoints**](docs/ManagementApi.md#importloyaltypoints) | **Post** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file +*ManagementApi* | [**ImportAccountCollection**](docs/ManagementApi.md#importaccountcollection) | **Post** /v1/collections/{collectionId}/import | Import data in existing account-level collection +*ManagementApi* | [**ImportAllowedList**](docs/ManagementApi.md#importallowedlist) | **Post** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute +*ManagementApi* | [**ImportCollection**](docs/ManagementApi.md#importcollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data in existing collection +*ManagementApi* | [**ImportCoupons**](docs/ManagementApi.md#importcoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons +*ManagementApi* | [**ImportLoyaltyPoints**](docs/ManagementApi.md#importloyaltypoints) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points *ManagementApi* | [**ImportPoolGiveaways**](docs/ManagementApi.md#importpoolgiveaways) | **Post** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool -*ManagementApi* | [**ImportReferrals**](docs/ManagementApi.md#importreferrals) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file -*ManagementApi* | [**RemoveLoyaltyPoints**](docs/ManagementApi.md#removeloyaltypoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in loyalty program for given customer +*ManagementApi* | [**ImportReferrals**](docs/ManagementApi.md#importreferrals) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals +*ManagementApi* | [**ListAccountCollections**](docs/ManagementApi.md#listaccountcollections) | **Get** /v1/collections | List collections in account +*ManagementApi* | [**ListCollections**](docs/ManagementApi.md#listcollections) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections +*ManagementApi* | [**ListCollectionsInApplication**](docs/ManagementApi.md#listcollectionsinapplication) | **Get** /v1/applications/{applicationId}/collections | List collections in application +*ManagementApi* | [**RemoveLoyaltyPoints**](docs/ManagementApi.md#removeloyaltypoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points in loyalty program for given customer *ManagementApi* | [**ResetPassword**](docs/ManagementApi.md#resetpassword) | **Post** /v1/reset_password | Reset password -*ManagementApi* | [**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedapplicationwidewithouttotalcount) | **Post** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes in all active campaigns of an application -*ManagementApi* | [**SearchCouponsAdvancedWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedwithouttotalcount) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes -*ManagementApi* | [**UpdateAdditionalCost**](docs/ManagementApi.md#updateadditionalcost) | **Put** /v1/additional_costs/{additionalCostId} | Update an additional cost -*ManagementApi* | [**UpdateAttribute**](docs/ManagementApi.md#updateattribute) | **Put** /v1/attributes/{attributeId} | Update a custom attribute +*ManagementApi* | [**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedapplicationwidewithouttotalcount) | **Post** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count) +*ManagementApi* | [**SearchCouponsAdvancedWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedwithouttotalcount) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count) +*ManagementApi* | [**UpdateAccountCollection**](docs/ManagementApi.md#updateaccountcollection) | **Put** /v1/collections/{collectionId} | Update account-level collection +*ManagementApi* | [**UpdateAdditionalCost**](docs/ManagementApi.md#updateadditionalcost) | **Put** /v1/additional_costs/{additionalCostId} | Update additional cost +*ManagementApi* | [**UpdateAttribute**](docs/ManagementApi.md#updateattribute) | **Put** /v1/attributes/{attributeId} | Update custom attribute *ManagementApi* | [**UpdateCampaign**](docs/ManagementApi.md#updatecampaign) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign +*ManagementApi* | [**UpdateCollection**](docs/ManagementApi.md#updatecollection) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update collection description *ManagementApi* | [**UpdateCoupon**](docs/ManagementApi.md#updatecoupon) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon -*ManagementApi* | [**UpdateCouponBatch**](docs/ManagementApi.md#updatecouponbatch) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a batch of coupons +*ManagementApi* | [**UpdateCouponBatch**](docs/ManagementApi.md#updatecouponbatch) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons +*ManagementApi* | [**UpdateNotificationWebhook**](docs/ManagementApi.md#updatenotificationwebhook) | **Put** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification webhook *ManagementApi* | [**UpdateReferral**](docs/ManagementApi.md#updatereferral) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral -*ManagementApi* | [**UpdateRuleset**](docs/ManagementApi.md#updateruleset) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update ruleset ## Documentation For Models @@ -398,6 +420,7 @@ Class | Method | HTTP request | Description - [AccountEntity](docs/AccountEntity.md) - [AccountLimits](docs/AccountLimits.md) - [AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md) + - [AddItemCatalogAction](docs/AddItemCatalogAction.md) - [AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md) - [AdditionalCost](docs/AdditionalCost.md) - [ApiError](docs/ApiError.md) @@ -409,45 +432,76 @@ Class | Method | HTTP request | Description - [ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md) - [ApplicationEntity](docs/ApplicationEntity.md) - [ApplicationEvent](docs/ApplicationEvent.md) + - [ApplicationNotification](docs/ApplicationNotification.md) - [ApplicationReferee](docs/ApplicationReferee.md) - [ApplicationSession](docs/ApplicationSession.md) - [ApplicationSessionEntity](docs/ApplicationSessionEntity.md) + - [AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md) - [Attribute](docs/Attribute.md) - [AttributesMandatory](docs/AttributesMandatory.md) - [AttributesSettings](docs/AttributesSettings.md) - [Audience](docs/Audience.md) + - [AudienceAnalytics](docs/AudienceAnalytics.md) + - [AudienceIntegrationId](docs/AudienceIntegrationId.md) - [AudienceMembership](docs/AudienceMembership.md) - [AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md) - [BaseLoyaltyProgram](docs/BaseLoyaltyProgram.md) - [BaseSamlConnection](docs/BaseSamlConnection.md) - [Binding](docs/Binding.md) + - [BulkApplicationNotification](docs/BulkApplicationNotification.md) + - [BulkCampaignNotification](docs/BulkCampaignNotification.md) - [Campaign](docs/Campaign.md) + - [CampaignActivationRequest](docs/CampaignActivationRequest.md) - [CampaignAnalytics](docs/CampaignAnalytics.md) + - [CampaignCollection](docs/CampaignCollection.md) + - [CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md) - [CampaignCopy](docs/CampaignCopy.md) + - [CampaignCreatedNotification](docs/CampaignCreatedNotification.md) + - [CampaignDeletedNotification](docs/CampaignDeletedNotification.md) + - [CampaignEditedNotification](docs/CampaignEditedNotification.md) - [CampaignEntity](docs/CampaignEntity.md) - [CampaignGroup](docs/CampaignGroup.md) - [CampaignGroupEntity](docs/CampaignGroupEntity.md) + - [CampaignNotification](docs/CampaignNotification.md) + - [CampaignPrioritiesChangedNotification](docs/CampaignPrioritiesChangedNotification.md) + - [CampaignPrioritiesV2](docs/CampaignPrioritiesV2.md) + - [CampaignRulesetChangedNotification](docs/CampaignRulesetChangedNotification.md) - [CampaignSearch](docs/CampaignSearch.md) - [CampaignSet](docs/CampaignSet.md) - [CampaignSetBranchNode](docs/CampaignSetBranchNode.md) + - [CampaignSetIDs](docs/CampaignSetIDs.md) - [CampaignSetLeafNode](docs/CampaignSetLeafNode.md) - [CampaignSetNode](docs/CampaignSetNode.md) + - [CampaignSetV2](docs/CampaignSetV2.md) + - [CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md) - [CampaignTemplate](docs/CampaignTemplate.md) + - [CampaignTemplateCollection](docs/CampaignTemplateCollection.md) - [CampaignTemplateParams](docs/CampaignTemplateParams.md) + - [CardLedgerTransactionLogEntry](docs/CardLedgerTransactionLogEntry.md) + - [CardLedgerTransactionLogEntryIntegrationApi](docs/CardLedgerTransactionLogEntryIntegrationApi.md) - [CartItem](docs/CartItem.md) + - [Catalog](docs/Catalog.md) + - [CatalogAction](docs/CatalogAction.md) + - [CatalogActionFilter](docs/CatalogActionFilter.md) + - [CatalogItem](docs/CatalogItem.md) + - [CatalogSyncRequest](docs/CatalogSyncRequest.md) - [Change](docs/Change.md) - [ChangeProfilePassword](docs/ChangeProfilePassword.md) - [CodeGeneratorSettings](docs/CodeGeneratorSettings.md) - [Collection](docs/Collection.md) + - [CollectionItem](docs/CollectionItem.md) + - [CollectionWithoutPayload](docs/CollectionWithoutPayload.md) - [Coupon](docs/Coupon.md) - [CouponConstraints](docs/CouponConstraints.md) - [CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md) - [CouponCreationJob](docs/CouponCreationJob.md) + - [CouponLimitConfigs](docs/CouponLimitConfigs.md) - [CouponRejectionReason](docs/CouponRejectionReason.md) - [CouponReservations](docs/CouponReservations.md) - [CouponSearch](docs/CouponSearch.md) - [CouponValue](docs/CouponValue.md) - [CreateApplicationApiKey](docs/CreateApplicationApiKey.md) + - [CreateManagementKey](docs/CreateManagementKey.md) - [CreateTemplateCampaign](docs/CreateTemplateCampaign.md) - [CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md) - [CustomEffect](docs/CustomEffect.md) @@ -466,14 +520,17 @@ Class | Method | HTTP request | Description - [Effect](docs/Effect.md) - [EffectEntity](docs/EffectEntity.md) - [EmailEntity](docs/EmailEntity.md) + - [Endpoint](docs/Endpoint.md) - [Entity](docs/Entity.md) - [EntityWithTalangVisibleId](docs/EntityWithTalangVisibleId.md) - [Environment](docs/Environment.md) - [ErrorEffectProps](docs/ErrorEffectProps.md) - [ErrorResponse](docs/ErrorResponse.md) + - [ErrorResponseWithStatus](docs/ErrorResponseWithStatus.md) - [ErrorSource](docs/ErrorSource.md) - [Event](docs/Event.md) - [EventType](docs/EventType.md) + - [EventV2](docs/EventV2.md) - [Export](docs/Export.md) - [FeatureFlag](docs/FeatureFlag.md) - [FeaturesFeed](docs/FeaturesFeed.md) @@ -508,6 +565,10 @@ Class | Method | HTTP request | Description - [InlineResponse20028](docs/InlineResponse20028.md) - [InlineResponse20029](docs/InlineResponse20029.md) - [InlineResponse2003](docs/InlineResponse2003.md) + - [InlineResponse20030](docs/InlineResponse20030.md) + - [InlineResponse20031](docs/InlineResponse20031.md) + - [InlineResponse20032](docs/InlineResponse20032.md) + - [InlineResponse20033](docs/InlineResponse20033.md) - [InlineResponse2004](docs/InlineResponse2004.md) - [InlineResponse2005](docs/InlineResponse2005.md) - [InlineResponse2006](docs/InlineResponse2006.md) @@ -515,39 +576,58 @@ Class | Method | HTTP request | Description - [InlineResponse2008](docs/InlineResponse2008.md) - [InlineResponse2009](docs/InlineResponse2009.md) - [InlineResponse201](docs/InlineResponse201.md) + - [IntegrationCustomerSessionResponse](docs/IntegrationCustomerSessionResponse.md) - [IntegrationEntity](docs/IntegrationEntity.md) - [IntegrationEvent](docs/IntegrationEvent.md) + - [IntegrationEventV2Request](docs/IntegrationEventV2Request.md) - [IntegrationProfileEntity](docs/IntegrationProfileEntity.md) - [IntegrationRequest](docs/IntegrationRequest.md) - [IntegrationState](docs/IntegrationState.md) - [IntegrationStateV2](docs/IntegrationStateV2.md) - [InventoryCoupon](docs/InventoryCoupon.md) + - [InventoryReferral](docs/InventoryReferral.md) + - [ItemAttribute](docs/ItemAttribute.md) - [LedgerEntry](docs/LedgerEntry.md) - [LedgerInfo](docs/LedgerInfo.md) + - [LedgerTransactionLogEntryIntegrationApi](docs/LedgerTransactionLogEntryIntegrationApi.md) - [LibraryAttribute](docs/LibraryAttribute.md) - [LimitConfig](docs/LimitConfig.md) - [LimitCounter](docs/LimitCounter.md) - [LoginParams](docs/LoginParams.md) - [Loyalty](docs/Loyalty.md) + - [LoyaltyBalance](docs/LoyaltyBalance.md) + - [LoyaltyBalances](docs/LoyaltyBalances.md) + - [LoyaltyCard](docs/LoyaltyCard.md) + - [LoyaltyCardProfileRegistration](docs/LoyaltyCardProfileRegistration.md) + - [LoyaltyCardRegistration](docs/LoyaltyCardRegistration.md) - [LoyaltyDashboardData](docs/LoyaltyDashboardData.md) - [LoyaltyDashboardPointsBreakdown](docs/LoyaltyDashboardPointsBreakdown.md) - [LoyaltyLedger](docs/LoyaltyLedger.md) - [LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md) + - [LoyaltyLedgerTransactions](docs/LoyaltyLedgerTransactions.md) - [LoyaltyMembership](docs/LoyaltyMembership.md) - [LoyaltyPoints](docs/LoyaltyPoints.md) - [LoyaltyProgram](docs/LoyaltyProgram.md) - [LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) - [LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md) - [LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) + - [LoyaltyProjection](docs/LoyaltyProjection.md) + - [LoyaltyProjectionData](docs/LoyaltyProjectionData.md) - [LoyaltyStatistics](docs/LoyaltyStatistics.md) - [LoyaltySubLedger](docs/LoyaltySubLedger.md) - [LoyaltyTier](docs/LoyaltyTier.md) + - [ManagementKey](docs/ManagementKey.md) - [ManagerConfig](docs/ManagerConfig.md) - [Meta](docs/Meta.md) - [MultiApplicationEntity](docs/MultiApplicationEntity.md) + - [MultipleAttribute](docs/MultipleAttribute.md) + - [MultipleAudiences](docs/MultipleAudiences.md) + - [MultipleAudiencesItem](docs/MultipleAudiencesItem.md) - [MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md) - [MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md) - [MultipleCustomerProfileIntegrationResponseV2](docs/MultipleCustomerProfileIntegrationResponseV2.md) + - [MultipleNewAttribute](docs/MultipleNewAttribute.md) + - [MultipleNewAudiences](docs/MultipleNewAudiences.md) - [MutableEntity](docs/MutableEntity.md) - [NewAccount](docs/NewAccount.md) - [NewAccountSignUp](docs/NewAccountSignUp.md) @@ -557,9 +637,12 @@ Class | Method | HTTP request | Description - [NewAttribute](docs/NewAttribute.md) - [NewAudience](docs/NewAudience.md) - [NewCampaign](docs/NewCampaign.md) + - [NewCampaignCollection](docs/NewCampaignCollection.md) - [NewCampaignGroup](docs/NewCampaignGroup.md) - [NewCampaignSet](docs/NewCampaignSet.md) + - [NewCampaignSetV2](docs/NewCampaignSetV2.md) - [NewCampaignTemplate](docs/NewCampaignTemplate.md) + - [NewCatalog](docs/NewCatalog.md) - [NewCollection](docs/NewCollection.md) - [NewCouponCreationJob](docs/NewCouponCreationJob.md) - [NewCoupons](docs/NewCoupons.md) @@ -571,14 +654,19 @@ Class | Method | HTTP request | Description - [NewEvent](docs/NewEvent.md) - [NewEventType](docs/NewEventType.md) - [NewGiveawaysPool](docs/NewGiveawaysPool.md) + - [NewInternalAudience](docs/NewInternalAudience.md) - [NewInvitation](docs/NewInvitation.md) - [NewInviteEmail](docs/NewInviteEmail.md) - [NewLoyaltyProgram](docs/NewLoyaltyProgram.md) - [NewLoyaltyTier](docs/NewLoyaltyTier.md) + - [NewManagementKey](docs/NewManagementKey.md) + - [NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md) + - [NewNotificationWebhook](docs/NewNotificationWebhook.md) - [NewPassword](docs/NewPassword.md) - [NewPasswordEmail](docs/NewPasswordEmail.md) - [NewReferral](docs/NewReferral.md) - [NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md) + - [NewReturn](docs/NewReturn.md) - [NewRole](docs/NewRole.md) - [NewRuleset](docs/NewRuleset.md) - [NewSamlConnection](docs/NewSamlConnection.md) @@ -586,6 +674,9 @@ Class | Method | HTTP request | Description - [NewUser](docs/NewUser.md) - [NewWebhook](docs/NewWebhook.md) - [Notification](docs/Notification.md) + - [NotificationWebhook](docs/NotificationWebhook.md) + - [PatchItemCatalogAction](docs/PatchItemCatalogAction.md) + - [PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md) - [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) - [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) - [Referral](docs/Referral.md) @@ -594,6 +685,11 @@ Class | Method | HTTP request | Description - [ReferralRejectionReason](docs/ReferralRejectionReason.md) - [RejectCouponEffectProps](docs/RejectCouponEffectProps.md) - [RejectReferralEffectProps](docs/RejectReferralEffectProps.md) + - [RemoveItemCatalogAction](docs/RemoveItemCatalogAction.md) + - [RemoveManyItemsCatalogAction](docs/RemoveManyItemsCatalogAction.md) + - [Return](docs/Return.md) + - [ReturnIntegrationRequest](docs/ReturnIntegrationRequest.md) + - [ReturnedCartItem](docs/ReturnedCartItem.md) - [Role](docs/Role.md) - [RoleAssign](docs/RoleAssign.md) - [RoleMembership](docs/RoleMembership.md) @@ -611,6 +707,7 @@ Class | Method | HTTP request | Description - [Session](docs/Session.md) - [SetDiscountEffectProps](docs/SetDiscountEffectProps.md) - [SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md) + - [SetDiscountPerAdditionalCostPerItemEffectProps](docs/SetDiscountPerAdditionalCostPerItemEffectProps.md) - [SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md) - [ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md) - [ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md) @@ -625,12 +722,15 @@ Class | Method | HTTP request | Description - [UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md) - [UpdateAudience](docs/UpdateAudience.md) - [UpdateCampaign](docs/UpdateCampaign.md) + - [UpdateCampaignCollection](docs/UpdateCampaignCollection.md) - [UpdateCampaignGroup](docs/UpdateCampaignGroup.md) - [UpdateCampaignTemplate](docs/UpdateCampaignTemplate.md) + - [UpdateCatalog](docs/UpdateCatalog.md) - [UpdateCollection](docs/UpdateCollection.md) - [UpdateCoupon](docs/UpdateCoupon.md) - [UpdateCouponBatch](docs/UpdateCouponBatch.md) - [UpdateCustomEffect](docs/UpdateCustomEffect.md) + - [UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md) - [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) - [UpdateReferral](docs/UpdateReferral.md) - [UpdateReferralBatch](docs/UpdateReferralBatch.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index fcdf4f67..addd9c72 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -1,46 +1,81 @@ openapi: 3.0.1 info: description: | - The Talon.One API is used to manage applications and campaigns, as well as to - integrate with your application. The operations in the _Integration API_ section - are used to integrate with our platform, while the other operations are - used to manage applications and campaigns. + Use the Talon.One API to integrate with your application and to + manage applications and campaigns: - ### Where is the API? + - Use the operations in the [Integration API section](#integration-api) + are used to integrate with our platform + - Use the operation in the [Management API section](#management-api) to + manage applications and campaigns. - The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` + ## Determining the base URL of the endpoints - [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + The API is available at the same hostname as your Campaign Manager deployment. + For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, + the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint + is `https://mycompany.talon.one/v2/customer_sessions/{Id}` title: Talon.One API version: 1.0.0 servers: -- url: / +- url: https://yourbaseurl.talon.one/ security: - manager_auth: [] tags: +- description: | + Represents the API used to send [Integration API](https://docs.talon.one/docs/dev/integration-api/overview) requests to a given Application. + name: API keys - description: | Operations for updating account information such as billing email addresses, inviting users, etc. name: Accounts and users +- description: | + An extra fee applied to the cart. For example, shipping fees, or processing fees. See [the docs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). + name: Additional costs - description: | Analytics are used to retrieve statistical data about the performance of campaigns within an application. name: Analytics - description: | - Every request to the Integration API comes from an application. + Represents an Application in the Campaign Manager, see the [docs](https://docs.talon.one/docs/product/applications/overview). + It is also the target of every Integration API request to Talon.One. - An application is typically an e-commerce site, a mobile app, or some other source of customer actions. + One Application can hold various API keys used for Integration API requests. - An application is the owner of the API key used to send integration data. - You may have multiple applications within one account, for example staging and production, or different international markets. + You may have multiple Applications within one account, + for example staging and production, or different international markets. name: Applications - description: | - Represents an arbitrary group of customer profiles grouped by mParticle. + Represents a piece of information related to one of the entities avaialbe in the Campaign Manager. Use + them to create highly customized rules. See [the docs](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). + name: Attributes +- description: | + Represents an arbitrary group of customer profiles. Audiences can be synced from Customer Data Platforms such as mParticle or created from scratch. name: Audiences +- description: | + Represents the campaign groups users can create in their applications. + name: Campaign groups +- description: | + Represents templates used to generate campaigns from. + name: Campaign templates - description: | Campaigns are the primary resource used to control the behavior of the Talon.One Rule Engine. They combine rulesets, coupons, and limits into a single unit. name: Campaigns +- description: | + Represents a catalog of cart items with unique SKUs. Cart item catalogs allow you to synchronize your entire inventory with Talon.One. + See the [documentation](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). + name: Catalogs +- description: | + Represents a collection of arbitrary values that you can use inside rules. For example, a list of SKUs. + See the [documentation](https://docs.talon.one/docs/product/campaigns/managing-collections/). + name: Collections +- description: | + Represents a configuration for the Campaign Manager. + name: Config - description: | Coupons are unique codes belonging to a particular campaign. They don't define any behavior on their own, instead the campaign ruleset can include rules that validate coupons and carry out particular effects. name: Coupons +- description: | + Represents the custom effects that users can create. + name: Custom effects - description: | Represents the data of a customer, including sessions and events used for reporting and debugging in the Campaign Manager. name: Customer data @@ -49,68 +84,158 @@ tags: name: Customer profiles - description: | Represents the data related to a customer session. Typically, a customer session is the value and content of the customer's cart. + Sessions can be anonymous or linked to a customer profile and they have a life cycle from `open` to `closed`. In general, a session is closed when the customer completes the checkout step. + + Sessions are a key concept of Talon.One, we strongly recommend you read the [documentation about customer sessions](/docs/dev/concepts/entities#customer-session). name: Customer sessions -- description: Operations to alter the data model and Rule Engine to better suit Talon.One - to the needs of your business. - name: Customization - description: | - Represents a single occurrence of various customer actions. - Each customer session contains one or more events. For example, updating a customer session records a `talon_session_updated` event. + Represents a single occurrence of various customer actions. There are 2 versions: + - For V1 events, each customer **session** contains one or more events. For example, updating a customer session records a `talon_session_updated` event. + - For V2 events, each customer **profile** contains one or more events. For example, updating a customer session records a `talon_session_updated` event linked to the profile in question. name: Events +- description: | + How we enable features in accounts. + name: Feature flags - description: | Represents a program that rewards customers with giveaways, such as free gift cards. name: Giveaways - description: | - Represents set of string values that can be used in rule conditions. - name: Collections -- description: | - Use the Integration API to push data to and retrieve data from the Talon.One platform. + Use the Integration API to push data to and retrieve data from Talon.One in real time. + For more background information about this API, see [Integration API overview](/docs/dev/integration-api/overview) For example, use this API to share shopping cart information as a session with Talon.One and evaluate promotion rules. You can also create custom events to track specific actions that do not fit into the session data model. Ensure you [authenticate](#section/Authentication) to make requests to the API. - **Note:** To programmatically do what the Campaign Manager does, - see the [Management API](/management-api). +
+

Are you looking for a different API?

+ + If you need the API to: + + - Interact with the Campaign Manager for backoffice operations, see [the Management API reference docs](https://docs.talon.one/management-api). + - Integrate with Talon.One from a CEP or CDP platform, see [the Third-party API reference docs](https://docs.talon.one/third-party-api). + +
+ + # Authentication + + name: Integration API - description: | Operations to query the Talon.One logs. They contain all incoming and outgoing requests. name: Logs - description: | - Represents a way to manage point wallets and subledgers. + Represents a loyalty program, or concepts related to them, such as loyalty cards. See [the docs](https://docs.talon.one/docs/product/loyalty-programs/overview). name: Loyalty - description: | The Talon.One Management API is the channel between the Campaign Manager and the Rule Engine. + For more background information about this API, see [Management API overview](/docs/dev/management-api/overview) Use the Management API to programmatically do what the Campaign Manager does. For example, use it for management purposes and backoffice systems. Ensure you [authenticate](#section/Authentication) to make requests to the API. - **Warning:** This API is not meant to be used in real-time integrations that directly serve your end users. + **Warnings:** + - This API is not meant to be used in real-time integrations that directly serve your end users. + - This API supports a maximum of **3 requests per second** for each of these endpoints. + +
+

Are you looking for a different API?

+ + If you need the API to: + + - Integrate with Talon.One directly and send real-time data, see [the Integration API reference docs](https://docs.talon.one/integration-api). + - Integrate with Talon.One from a CEP or CDP platform, see [the Third-party API reference docs](https://docs.talon.one/third-party-api). +

+
+ + # Authentication - To send external data to and retrieve data from Talon.One in real-time integrations, - use the [Integration API](/integration-api) instead. + name: Management API +- description: | + Represents a key to access specified endpoints of the Management API programmatically. + name: Management keys +- description: | + Represents the built-in webhooks that manage the outbound notifications. + name: Notification webhooks +- description: | + Represents the default notifications. Not to be confused with the outbound notifications relying on webhooks. + name: Notifications - description: | A referral is a code shared between a customer and a prospect. - A referral is defined by an advocate, a friend and a referral code. The advocate is the person who - invited their friend via referral program. The friend is the person who receives the invite from an advocate. - The referral code is a code which is generated similar to a coupon code the code can be redeemed by - either one or multiple advocates. + + A referral is defined by: + - an advocate: person who invited their friend via referral program. + - a friend: person who receives the invite from an advocate. + - a referral code: code to be redeemed by the advocate(s) once they referred their friend. name: Referrals - description: | Represents a set of permissions assigned to a user. name: Roles +- description: | + Represents the endpoints related to the SAML config used for SSO. + name: SAML - description: | Represents a session used for authentication purposes. Create one with the [Create session](#operation/createSession) endpoint. name: Sessions +- description: | + Talang template operations. + name: Talang templates +- description: | + A way to send information from Talon.One to the URI of your choice. See [the docs](https://docs.talon.one/docs/dev/getting-started/webhooks). + name: Webhooks paths: /v2/customer_sessions/{customerSessionId}: + get: + description: | + Get the details of the given customer session. + + You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: + + - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) + - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) + operationId: getCustomerSession + parameters: + - description: | + The `integration ID` of the customer session. You set this ID when you create a customer session. + + You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the + [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). + in: path + name: customerSessionId + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationCustomerSessionResponse' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + security: + - api_key_v1: [] + summary: Get customer session + tags: + - integration put: description: | Update or create a [customer session](/docs/dev/concepts/entities#customer-session). @@ -120,7 +245,7 @@ paths: **Note:** The currency for the session and the cart items in the session is the same as the Application that owns this session. - **Session management** + ### Session management The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same Application you can either: @@ -131,30 +256,23 @@ paths: If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. - See more information and tips about session management in [Entities](/docs/dev/concepts/entities#customer-session). - - **Sessions and customer profiles** + See more information and tips about session management in the [documentation](/docs/dev/concepts/entities#customer-session). - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - To track an anonymous session use the empty string (`""`) as the `profileId`. - **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. - - **Performance tips** + ### Sessions and customer profiles - Updating a customer session returns a response with the requested integration state. + - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. + - While you can create an anonymous session with `profileId=""`, we recommend you use a guest ID instead. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get - the customer profile details directly without extra requests. - - You can also set `runRuleEngine` to `false` to prevent unwanted rule executions. This allows you to - improve response times. + **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. - If `runRuleEngine` is set to `true`, the response also includes: +
+

Performance tips

- - The effects generated by the triggered campaigns. - - The created coupons and referral objects. + Updating a customer session returns a response with the requested integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get + the customer profile details directly without extra requests. - For more information, see the [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). + For more information, see the [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). +
operationId: updateCustomerSessionV2 parameters: - description: Indicates whether to persist the changes. Changes are ignored @@ -163,8 +281,11 @@ paths: name: dry schema: type: boolean - - description: The custom identifier for this session, must be unique within - the account. + - description: | + The `integration ID` of the customer session. You set this ID when you create a customer session. + + You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the + [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). in: path name: customerSessionId required: true @@ -183,86 +304,133 @@ paths: schema: $ref: '#/components/schemas/IntegrationStateV2' description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "409": + content: + application/json: + schema: + type: object + description: Too many requests - Avoid parallel requests, see the [docs](/docs/dev/tutorials/integrating-talon-one/#managing-parallel-requests). security: - api_key_v1: [] summary: Update customer session tags: - integration x-codegen-request-body-name: body - /v2/customer_profiles: - put: + /v2/customer_sessions/{customerSessionId}/returns: + post: description: | - Update (or create) up to 1000 [customer profiles](/docs/dev/concepts/entities#customer-profile) in 1 request. + Create a new return request for the specified cart items. - The `integrationId` must be any identifier that remains stable for - the customer. Do not use an ID that the customer can update - themselves. For example, you can use a database ID. + This endpoint automatically changes the session state from `closed` to `partially_returned`. - A customer profile [can be linked to one or more sessions](/integration-api/#tag/Customer-sessions). - operationId: updateCustomerProfilesV2 + Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) + is enabled for the Application. + + **Note:** This will roll back any effects associated with these cart items. For more information, see + [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) + and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). + operationId: returnCartItems parameters: - - description: | - Possible values: `yes` or `no`. - - `yes`: Increases the perfomance of the API call by returning a 204 response. - - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. + - description: Indicates whether to persist the changes. Changes are ignored + when `dry=true`. in: query - name: silent + name: dry + schema: + type: boolean + - description: | + The `integration ID` of the customer session. You set this ID when you create a customer session. + + You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the + [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). + in: path + name: customerSessionId + required: true schema: - default: "yes" type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequest' + $ref: '#/components/schemas/ReturnIntegrationRequest' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MultipleCustomerProfileIntegrationResponseV2' + $ref: '#/components/schemas/IntegrationStateV2' description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key security: - api_key_v1: [] - summary: Update multiple customer profiles + summary: Return cart items tags: - integration x-codegen-request-body-name: body /v2/customer_profiles/{integrationId}: put: description: | - Update (or create) a [Customer Profile](/docs/dev/concepts/entities#customer-profile). - - The `integrationId` must be any identifier that remains stable for - the customer. Do not use an ID that the customer can update - themselves. For example, you can use a database ID. - - **Performance tips** + Update or create a [Customer Profile](/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. - Updating a customer profile returns a response with the requested integration state. + You can use this endpoint to: + - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. + - Modify the audience the customer profile is a member of. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get - the customer profile details directly without extra requests. +
+

Performance tips

- You can also set `runRuleEngine` to `false` to prevent unwanted rule executions. This allows you to - improve response times. + Updating a customer profile returns a response with the requested integration state. - If `runRuleEngine` is set to `true`, the response includes: - - - The effects generated by the triggered campaigns. - - The created coupons and referral objects. + You can use the `responseContent` property to save yourself extra API calls. For example, you can get + the customer profile details directly without extra requests. +
operationId: updateCustomerProfileV2 parameters: - - description: The custom identifier for this profile. Must be unique within - the account. + - description: | + The integration identifier for this customer profile. Must be: + - Unique within the deployment. + - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. + + Once set, you cannot update this identifier. in: path name: integrationId required: true schema: type: string - - description: Indicates whether to run the rule engine. Setting this property - to `false` improves response times. + - description: | + Indicates whether to run the Rule Engine. + + If `true`, the response includes: + - The effects generated by the triggered campaigns are returned in the `effects` property. + - The created coupons and referral objects. + + If `false`: + - The rules are not executed and the `effects` property is always empty. + - The response time improves. + - You cannot use `responseContent` in the body. in: query name: runRuleEngine schema: @@ -270,7 +438,8 @@ paths: type: boolean - description: | Indicates whether to persist the changes. Changes are ignored when `dry=true`. - Only used when `runRuleEngine` is set to `true`. + + This property only works when `runRuleEngine=true`. in: query name: dry schema: @@ -288,21 +457,99 @@ paths: schema: $ref: '#/components/schemas/IntegrationStateV2' description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "409": + content: + application/json: + schema: + type: object + description: Too many requests - Avoid parallel requests, see the [docs](/docs/dev/tutorials/integrating-talon-one/#managing-parallel-requests). security: - api_key_v1: [] summary: Update customer profile tags: - integration x-codegen-request-body-name: body + /v2/customer_profiles: + put: + description: | + Update (or create) up to 1000 [customer profiles](/docs/dev/concepts/entities#customer-profile) in 1 request. + + The `integrationId` must be any identifier that remains stable for + the customer. Do not use an ID that the customer can update + themselves. For example, you can use a database ID. + + A customer profile [can be linked to one or more sessions](/integration-api/#tag/Customer-sessions). + operationId: updateCustomerProfilesV2 + parameters: + - description: | + Possible values: `yes` or `no`. + - `yes`: Increases the perfomance of the API call by returning a 204 response. + - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. + in: query + name: silent + schema: + default: "yes" + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MultipleCustomerProfileIntegrationResponseV2' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + security: + - api_key_v1: [] + summary: Update multiple customer profiles + tags: + - integration + x-codegen-request-body-name: body /v2/audiences: post: description: | - Create an Audience. - Only use this endpoint to sync existing audiences from other platforms through a 3rd party integration. + Create an audience. The audience can be created directly from scratch or can come from third party platforms. + + To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): + 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. + 1. Set `integrationId` to the ID of this audience in a third-party platform. + + To create an audience from an existing audience in another platform: + 1. Do not use the `integration` property. + 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. - Once you create your first audience, new audience-specific rule conditions are enabled in the Rule Builder. + To create an audience from scratch: + 1. Only set the `name` property. - **Important:** The authentication requires an mParticle API key instead of a Talon.One API key. + Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder. operationId: createAudienceV2 requestBody: content: @@ -317,6 +564,25 @@ paths: schema: $ref: '#/components/schemas/Audience' description: Created + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Conflict. An Audience with this ID already exists for this + integration. security: - api_key_v1: [] summary: Create audience @@ -329,8 +595,6 @@ paths: Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. - - **Important:** The authentication requires an mParticle API key instead of a Talon.One API key. operationId: deleteAudienceV2 parameters: - description: The ID of the audience. You get it via the `id` property when @@ -344,14 +608,32 @@ paths: "204": content: {} description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found summary: Delete audience tags: - integration put: description: | - Update an Audience created by a third-party integration. + Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the rule engine. - **Important:** The authentication requires an mParticle API key instead of a Talon.One API key. + To update the audience's members, use the [Update customer profile endpoint](#tag/Customer-profiles/operation/updateCustomerProfileV2). operationId: updateAudienceV2 parameters: - description: The ID of the audience. You get it via the `id` property when @@ -374,9 +656,21 @@ paths: schema: $ref: '#/components/schemas/Audience' description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] - summary: Update audience + summary: Update audience name tags: - integration x-codegen-request-body-name: body @@ -384,8 +678,6 @@ paths: delete: description: | Remove all members from this audience. - - **Important:** The authentication requires an mParticle API key instead of a Talon.One API key. operationId: deleteAudienceMembershipsV2 parameters: - description: The ID of the audience. You get it via the `id` property when @@ -399,15 +691,28 @@ paths: "204": content: {} description: No Content + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found summary: Delete audience memberships tags: - integration /v2/customer_audiences: post: description: | - Update one or multiple customer profiles with the specified audiences. + Update the specified customer profiles with the specified audiences. Use this endpoint + when customers join or leave audiences. - **Important:** The authentication requires an mParticle API key instead of a Talon.One API key. + The limit of customer profiles per request is 1000. operationId: updateCustomerProfileAudiences requestBody: content: @@ -419,6 +724,24 @@ paths: "204": content: {} description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] summary: Update multiple customer profiles' audiences @@ -428,9 +751,7 @@ paths: /v2/audience_customers/{audienceId}/attributes: put: description: | - Update the specified profile attributes to the provided value for all customers in the specified audience. - - **Important:** The authentication requires an mParticle API key instead of a Talon.One API key. + Update the specified profile attributes to the provided values for all customers in the specified audience. operationId: updateAudienceCustomersAttributes parameters: - description: The ID of the audience. You get it via the `id` property when @@ -450,6 +771,18 @@ paths: "204": content: {} description: No Content + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] summary: Update profile attributes for all customers in audience @@ -459,13 +792,17 @@ paths: /v1/events: post: description: | - Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. + **Important:** This endpoint is **DEPRECATED**. Use [Track Event V2](https://docs.talon.one/integration-api/#tag/Events/operation/trackEventV2) instead. - The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. +
+ Triggers a custom event in a customer session. You can then check this event in your rules. **Important:** Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create a custom event when you can use a built-in event. + For example, use this endpoint to trigger an event when a user updates their payment information. - As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. + Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event). - Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. + An event is always part of a session. If either the profile or the session does not exist, + a new empty profile/session is created. If the specified session already exists, it must belong to the same `profileId` or an error will be returned. +
operationId: trackEvent parameters: - description: Indicates whether to persist the changes. Changes are ignored @@ -487,37 +824,130 @@ paths: schema: $ref: '#/components/schemas/IntegrationState' description: Created - security: - - api_key_v1: [] - summary: Track an Event - tags: - - integration - x-codegen-request-body-name: body - /v1/referrals: - post: - description: | - Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. - operationId: createReferral - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewReferral' - required: true - responses: - "201": + "400": content: application/json: schema: - $ref: '#/components/schemas/Referral' - description: Created + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "409": + content: + application/json: + schema: + type: object + description: Too many requests - Avoid parallel requests, see the [docs](/docs/dev/tutorials/integrating-talon-one/#managing-parallel-requests). security: - api_key_v1: [] - summary: Create referral code for an advocate + summary: Track event tags: - integration x-codegen-request-body-name: body - /v1/referrals_for_multiple_advocates: + /v2/events: + post: + description: | + Triggers a custom event. You can then check this event in your rules. + + Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create + a custom event when you can use a built-in event. + + For example, use this endpoint to trigger an event when a customer shares a link to a product. + See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). + + **Important:** + - `profileId` is required. An event V2 is associated with a customer profile. + - Before using this endpoint, create your event as a custom attribute of type `event`. + See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event). + operationId: trackEventV2 + parameters: + - description: | + Possible values: `yes` or `no`. + - `yes`: Increases the perfomance of the API call by returning a 204 response. + - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. + in: query + name: silent + schema: + default: "yes" + type: string + - description: Indicates whether to persist the changes. Changes are ignored + when `dry=true`. + in: query + name: dry + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationEventV2Request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationStateV2' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + security: + - api_key_v1: [] + summary: Track event V2 + tags: + - integration + x-codegen-request-body-name: body + /v1/referrals: + post: + description: | + Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. + operationId: createReferral + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewReferral' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Referral' + description: Created + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + security: + - api_key_v1: [] + summary: Create referral code for an advocate + tags: + - integration + x-codegen-request-body-name: body + /v1/referrals_for_multiple_advocates: post: description: | Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. @@ -548,6 +978,18 @@ paths: "204": content: {} description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key security: - api_key_v1: [] summary: Create referral codes for multiple advocates @@ -557,11 +999,15 @@ paths: /v1/customer_data/{integrationId}: delete: description: | - Delete all attributes on the customer profile and on entities that reference that customer profile. + Delete all attributes on the customer profile and on entities that reference this customer profile. + + **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. operationId: deleteCustomerData parameters: - - description: The custom identifier for this profile, must be unique within - the account. + - description: | + The integration ID of the customer profile. You can get the `integrationId` of a profile using: + - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). + - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). in: path name: integrationId required: true @@ -571,18 +1017,31 @@ paths: "204": content: {} description: No Content + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] - summary: Delete the personal data of a customer + summary: Delete customer's personal data tags: - integration /v1/coupon_reservations/{couponValue}: delete: description: | - Remove all passed customer profiles reservation from this coupon. + Remove all the coupon reservations from the provided customer profile integration IDs and the provided + coupon code. operationId: deleteCouponReservation parameters: - - description: The value of a coupon + - description: The code of the coupon. in: path name: couponValue required: true @@ -598,6 +1057,24 @@ paths: "204": content: {} description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] summary: Delete coupon reservations @@ -617,15 +1094,20 @@ paths: When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data endpoint](/integration-api/#operation/getCustomerInventory). - **Important:** This endpoint doesn't create a **strict** reservation. _Any_ customer - can use a reserved coupon code and proceed to checkout. + **Important:** + - This endpoint creates a **soft** reservation. _Any_ customer + can use a reserved coupon code and proceed to checkout. + - To create a hard reservation, use the + [Create coupons](/management-api/#operation/createCoupons) or + [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints + setting the `recipientsIntegrationId` property. - For example, you can use this endpoint and `List customer data` to create a "coupon wallet" by - reserving coupon codes for a customer, and then displaying their "coupon wallet" + For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by + reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. operationId: createCouponReservation parameters: - - description: The value of a coupon + - description: The code of the coupon. in: path name: couponValue required: true @@ -644,6 +1126,24 @@ paths: schema: $ref: '#/components/schemas/Coupon' description: Created + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] summary: Create coupon reservation @@ -653,10 +1153,14 @@ paths: /v1/coupon_reservations/customerprofiles/{couponValue}: get: description: | - Return all users that have this coupon marked as reserved. + Return all customers that have this coupon marked as reserved. + + Coupons are reserved in the following ways: + - To create a soft reservation (any customer can use the coupon), use the [Create coupon reservation](#operation/createCouponReservation) endpoint. + - To create a hard reservation (only the given customer can use the coupon), create a coupon in the Campaign Manager for a given `recipientIntegrationId` or use the [Create coupons](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints. operationId: getReservedCustomers parameters: - - description: The value of a coupon + - description: The code of the coupon. in: path name: couponValue required: true @@ -669,9 +1173,27 @@ paths: schema: $ref: '#/components/schemas/inline_response_200' description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] - summary: List users that have this coupon reserved + summary: List customers that have this coupon reserved tags: - integration /v1/customer_profiles/{integrationId}/inventory: @@ -681,13 +1203,15 @@ paths: Typical entities returned are: customer profile information, referral codes, loyalty points and reserved coupons. Reserved coupons also include redeemed coupons. + + You can also use this endpoint to get the projected loyalty balances in order to notify + your customers about points that are about to expire, or to remind them how many points they have. operationId: getCustomerInventory parameters: - description: | - The custom identifier for this profile, must be unique within the account. - - To get the `integrationId` of the profile from a `sessionId`, use the - [Update customer session](/integration-api/#operation/updateCustomerSessionV2). + The integration ID of the customer profile. You can get the `integrationId` of a profile using: + - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). + - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). in: path name: integrationId required: true @@ -719,6 +1243,13 @@ paths: name: giveaways schema: type: boolean + - description: Set an end date to query the projected loyalty balances. You + can project results up to 31 days from today. + in: query + name: loyaltyProjectionEndDate + schema: + format: date-time + type: string responses: "200": content: @@ -726,14 +1257,110 @@ paths: schema: $ref: '#/components/schemas/CustomerInventory' description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + security: + - api_key_v1: [] + summary: List customer data + tags: + - integration + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions: + get: + description: | + Retrieve paginated loyalty transaction logs for the given Integration ID in the specified loyalty program. + You can filter transactions by date. If no filters are applied, the last 30 loyalty transactions for the given integration ID are returned. + operationId: getLoyaltyTransactions + parameters: + - description: | + Identifier of the loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + The integration identifier for this customer profile. Must be: + - Unique within the deployment. + - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. + + Once set, you cannot update this identifier. + in: path + name: integrationId + required: true + schema: + type: string + - description: Time from which results are returned. It must be an RFC3339 timestamp + string. + in: query + name: startDate + schema: + format: date-time + type: string + - description: Only return results older than this timestamp. It must be an + RFC3339 timestamp string. + in: query + name: endDate + schema: + format: date-time + type: string + - description: The number of items in this response. When omitted, the maximum + value of 1000 will be used. + in: query + name: pageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LedgerTransactionLogEntryIntegrationAPI' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found security: - api_key_v1: [] - summary: List data associated with a specific customer profile + summary: Get loyalty ledger transaction logs tags: - integration /v1/applications: get: - description: List all application in the current account. + description: List all applications in the current account. operationId: getApplications parameters: - description: The number of items to include in this response. When omitted, @@ -741,6 +1368,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -762,7 +1391,7 @@ paths: schema: $ref: '#/components/schemas/inline_response_200_1' description: OK - summary: List Applications + summary: List applications tags: - management /v1/applications/{applicationId}: @@ -770,7 +1399,9 @@ paths: description: Get the application specified by the ID. operationId: getApplication parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: @@ -782,7 +1413,7 @@ paths: schema: $ref: '#/components/schemas/Application' description: OK - summary: Get Application + summary: Get application tags: - management /v1/applications/{applicationId}/campaigns: @@ -796,6 +1427,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -810,7 +1443,9 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: @@ -821,8 +1456,9 @@ paths: - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - - `expired`: Capmaigns that are expired. + - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. + - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -881,15 +1517,46 @@ paths: schema: $ref: '#/components/schemas/inline_response_200_2' description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request summary: List campaigns tags: - management + /v1/applications/{applicationId}/notification_webhooks: + get: + description: List all outbound notification webhooks for this application. + operationId: getNotificationWebhooks + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_3' + description: OK + summary: List notification webhooks + tags: + - management post: description: | - Create a campaign. A campaign is part of an Application and contains a set of promotion rules. - operationId: createCampaign + Create an outbound notification webhook. An outbound notification webhook is different from regular webhooks + in that it is application-scoped and has a predefined payload (regular webhooks have user-definable payloads). + operationId: createNotificationWebhook parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: @@ -898,31 +1565,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NewCampaign' + $ref: '#/components/schemas/NewNotificationWebhook' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Campaign' + $ref: '#/components/schemas/NotificationWebhook' description: Created - summary: Create campaign + summary: Create notification webhook tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}: + /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}: delete: - description: Delete the given campaign. - operationId: deleteCampaign + description: Remove the given existing outbound notification webhook. + operationId: deleteNotificationWebhook parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - in: path - name: campaignId + name: notificationWebhookId required: true schema: type: integer @@ -930,20 +1599,22 @@ paths: "204": content: {} description: No Content - summary: Delete campaign + summary: Delete notification webhook tags: - management get: - description: Retrieve the given campaign. - operationId: getCampaign + description: Return the given outbound notification webhook. + operationId: getNotificationWebhook parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - in: path - name: campaignId + name: notificationWebhookId required: true schema: type: integer @@ -952,22 +1623,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Campaign' + $ref: '#/components/schemas/NotificationWebhook' description: OK - summary: Get campaign + summary: Get notification webhook tags: - management put: - description: Update the given campaign. - operationId: updateCampaign + description: Update the given outbound notification webhook. + operationId: updateNotificationWebhook parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - in: path - name: campaignId + name: notificationWebhookId required: true schema: type: integer @@ -975,49 +1648,142 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateCampaign' + $ref: '#/components/schemas/NewNotificationWebhook' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Campaign' + $ref: '#/components/schemas/NotificationWebhook' description: OK - summary: Update campaign + summary: Update notification webhook tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/copy: - post: - description: Copy the campaign into every specified application. - operationId: copyCampaignToApplications + /v1/applications/{applicationId}/campaigns/{campaignId}: + delete: + description: Delete the given campaign. + operationId: deleteCampaign parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CampaignCopy' - required: true responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/inline_response_200_2' - description: OK - summary: Copy the campaign into every specified application - tags: + "204": + content: {} + description: No Content + summary: Delete campaign + tags: + - management + get: + description: Retrieve the given campaign. + operationId: getCampaign + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + description: OK + summary: Get campaign + tags: + - management + put: + description: Update the given campaign. + operationId: updateCampaign + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCampaign' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + description: OK + summary: Update campaign + tags: + - management + x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns/{campaignId}/copy: + post: + description: Copy the campaign into all specified application. + operationId: copyCampaignToApplications + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignCopy' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_2' + description: OK + summary: Copy the campaign into the specified application + tags: - management x-codegen-request-body-name: body /v1/applications/{applicationId}/campaigns_search: @@ -1031,6 +1797,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -1045,7 +1813,9 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: @@ -1056,8 +1826,9 @@ paths: - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - - `expired`: Capmaigns that are expired. + - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. + - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -1100,6 +1871,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -1114,12 +1887,16 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1129,54 +1906,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_3' + $ref: '#/components/schemas/inline_response_200_4' description: OK summary: List campaign rulesets tags: - management - post: - description: Create a set of rules. A ruleset is a revision of all the rules - of a campaign. - operationId: createRuleset - parameters: - - in: path - name: applicationId - required: true - schema: - type: integer - - in: path - name: campaignId - required: true - schema: - type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewRuleset' - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Ruleset' - description: Created - summary: Create ruleset - tags: - - management - x-codegen-request-body-name: body /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}: get: description: Retrieve the specified ruleset. operationId: getRuleset parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1196,62 +1945,69 @@ paths: summary: Get ruleset tags: - management - put: - description: Update a ruleset. - operationId: updateRuleset + /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients: + post: + description: Create coupons according to some pattern for up to 1000 recipients. + operationId: createCouponsForMultipleRecipients parameters: - - in: path + - description: | + Possible values: `yes` or `no`. + - `yes`: Increases the perfomance of the API call by returning a 204 response. + - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. + in: query + name: silent + schema: + default: "yes" + type: string + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: type: integer - - in: path - name: rulesetId - required: true - schema: - type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/NewRuleset' + $ref: '#/components/schemas/NewCouponsForMultipleRecipients' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Ruleset' + $ref: '#/components/schemas/inline_response_200_5' description: OK - summary: Update ruleset + "204": + content: {} + description: No Content + summary: Create coupons for multiple recipients tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients: + /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async: post: - description: Create coupons according to some pattern for up to 1000 recipients. - operationId: createCouponsForMultipleRecipients + description: Create any number of coupons from 20,001 to 5,000,000. + operationId: createCouponsAsync parameters: - - description: | - Possible values: `yes` or `no`. - - `yes`: Increases the perfomance of the API call by returning a 204 response. - - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. - in: query - name: silent - schema: - default: "yes" - type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1260,19 +2016,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NewCouponsForMultipleRecipients' + $ref: '#/components/schemas/NewCouponCreationJob' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_4' + $ref: '#/components/schemas/AsyncCouponCreationResponse' description: OK - "204": - content: {} - description: No Content - summary: Create coupons for multiple recipients + summary: Create coupons asynchronously tags: - management x-codegen-request-body-name: body @@ -1281,12 +2034,16 @@ paths: description: Deletes all the coupons matching the specified criteria. operationId: deleteCoupons parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1347,7 +2104,9 @@ paths: format: date-time type: string - description: | - Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. + - `expired`: Matches coupons in which the expiry date is set and in the past. + - `validNow`: Matches coupons in which start date is null or in the past and expiry date is null or in the future. + - `validFuture`: Matches coupons in which start date is set and in the future. in: query name: valid schema: @@ -1362,7 +2121,8 @@ paths: schema: type: string - description: | - Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. + - `true`: only coupons where `usageCounter < usageLimit` will be returned. + - `false`: only coupons where `usageCounter >= usageLimit` will be returned. in: query name: usable schema: @@ -1377,8 +2137,8 @@ paths: name: referralId schema: type: integer - - description: Filter results by match with a profile id specified in the coupon's - RecipientIntegrationId field + - description: | + Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. in: query name: recipientIntegrationId schema: @@ -1412,12 +2172,16 @@ paths: schema: default: "yes" type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1433,7 +2197,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_4' + $ref: '#/components/schemas/inline_response_200_5' description: OK "204": content: {} @@ -1444,18 +2208,27 @@ paths: x-codegen-request-body-name: body put: description: | - Update a batch of coupons. You can find the `batchId` in the **Coupons** view of your Application + Update all coupons of an campaign, or a specific batch of coupons. + You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager or by using [List coupons](#operation/getCouponsWithoutTotalCount). + **Important**: + - Only send sequential requests to this endpoint. + - Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team. + To update a specific coupon, use [Update coupon](#operation/updateCoupon). operationId: updateCouponBatch parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1470,7 +2243,7 @@ paths: "204": content: {} description: No Content - summary: Update a batch of coupons + summary: Update coupons tags: - management x-codegen-request-body-name: body @@ -1485,6 +2258,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -1499,12 +2274,16 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1581,7 +2360,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_5' + $ref: '#/components/schemas/inline_response_200_6' description: OK summary: List coupons tags: @@ -1591,17 +2370,21 @@ paths: description: Delete the specified coupon. operationId: deleteCoupon parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: type: integer - - description: The ID of the coupon code to delete + - description: The ID of the coupon code to update in: path name: couponId required: true @@ -1618,12 +2401,16 @@ paths: description: Update the specified coupon. operationId: updateCoupon parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1651,19 +2438,25 @@ paths: tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search: + /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total: post: description: | - Get a list of all the coupons that exactly match a set of attributes. + List the coupons whose attributes match the query criteria + in the given campaign. + + The match is successful if all the attributes of the request are found in a coupon, + even if the coupon has more attributes that are not present on the request. - The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. - operationId: getCouponsByAttributes + **Note:** The total count is not included in the response. + operationId: searchCouponsAdvancedWithoutTotalCount parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -1678,12 +2471,16 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -1759,30 +2556,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CouponSearch' + $ref: '#/components/schemas/AttributeQuery' required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_4' + $ref: '#/components/schemas/inline_response_200_6' description: OK - summary: List coupons that match the given attributes + summary: List coupons that match the given attributes in campaign (without total + count) tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total: + /v1/applications/{applicationId}/coupons_search_advanced/no_total: post: description: | - Gets a list of all the coupons with attributes matching the query criteria - operationId: searchCouponsAdvancedWithoutTotalCount + List the coupons whose attributes match the query criteria in all **active** campaigns of the given Application. + + The match is successful if all the attributes of the request are found in a coupon, + even if the coupon has more attributes that are not present on the request. + + **Note:** The total count is not included in the response. + operationId: searchCouponsAdvancedApplicationWideWithoutTotalCount parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -1797,16 +2602,13 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path - name: campaignId - required: true - schema: - type: integer - description: Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. @@ -1862,6 +2664,11 @@ paths: name: recipientIntegrationId schema: type: string + - description: Filter results by batches of coupons + in: query + name: batchId + schema: + type: string - description: Filter results to an exact case-insensitive matching against the coupon code in: query @@ -1869,133 +2676,15 @@ paths: schema: default: false type: boolean - - description: Filter results by batches of coupons - in: query - name: batchId - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AttributeQuery' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/inline_response_200_5' - description: OK - summary: List coupons that match the given attributes - tags: - - management - x-codegen-request-body-name: body - /v1/applications/{applicationId}/coupons_search_advanced/no_total: - post: - description: | - Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application - operationId: searchCouponsAdvancedApplicationWideWithoutTotalCount - parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize - schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip - schema: - type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - - in: path - name: applicationId - required: true - schema: - type: integer - - description: Filter results performing case-insensitive matching against the - coupon code. Both the code and the query are folded to remove all non-alpha-numeric - characters. - in: query - name: value - schema: - type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any timezone. Talon.One will convert to UTC internally. - in: query - name: createdBefore - schema: - format: date-time - type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any timezone. Talon.One will convert to UTC internally. - in: query - name: createdAfter - schema: - format: date-time - type: string - - description: | - Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. - in: query - name: valid - schema: - enum: - - expired - - validNow - - validFuture - type: string - - description: | - Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. - in: query - name: usable - schema: - enum: - - "true" - - "false" - type: string - - description: Filter the results by matching them with the Id of a referral, - that meaning the coupons that had been created as an effect of the usage - of a referral code. - in: query - name: referralId - schema: - type: integer - - description: Filter results by match with a profile id specified in the coupon's - RecipientIntegrationId field - in: query - name: recipientIntegrationId - schema: - type: string - - description: Filter results by batches of coupons - in: query - name: batchId - schema: - type: string - - description: Filter results to an exact case-insensitive matching against - the coupon code - in: query - name: exactMatch - schema: - default: false - type: boolean - - description: | - Filter results by the state of the campaign. - - - `enabled`: Campaigns that are scheduled, running (activated), or expired. - - `running`: Campaigns that are running (activated). - - `disabled`: Campaigns that are disabled. - - `expired`: Capmaigns that are expired. - - `archived`: Campaigns that are archived. + - description: | + Filter results by the state of the campaign. + + - `enabled`: Campaigns that are scheduled, running (activated), or expired. + - `running`: Campaigns that are running (activated). + - `disabled`: Campaigns that are disabled. + - `expired`: Campaigns that are expired. + - `archived`: Campaigns that are archived. + - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -2019,10 +2708,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_5' + $ref: '#/components/schemas/inline_response_200_6' description: OK - summary: List coupons that match the given attributes in all active campaigns - of an application + summary: List coupons that match the given attributes (without total count) tags: - management x-codegen-request-body-name: body @@ -2031,12 +2719,16 @@ paths: description: Delete the specified referral. operationId: deleteReferral parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -2058,12 +2750,16 @@ paths: description: Update the specified referral. operationId: updateReferral parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -2101,6 +2797,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -2115,12 +2813,16 @@ paths: name: sort schema: type: string - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -2178,11 +2880,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_6' + $ref: '#/components/schemas/inline_response_200_7' description: OK summary: List referrals tags: - management + /v1/applications/{applicationId}/create_campaign_from_template: + post: + description: | + Use the campaign template referenced in the request body to create + a new campaign in one of the connected Applications. + + If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), + the corresponding collections for the new campaign are created automatically. + operationId: createCampaignFromTemplate + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTemplateCampaign' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTemplateCampaignResponse' + description: Created + summary: Create campaign from campaign template + tags: + - management + x-codegen-request-body-name: body /v1/loyalty_programs: get: description: List the loyalty programs of the account. @@ -2192,20 +2928,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/inline_response_200_8' description: OK summary: List loyalty programs tags: - management - /v1/loyalty_programs/{programID}: + /v1/loyalty_programs/{loyaltyProgramId}: get: description: | - Get the specified [loyalty program](https://www.talon.one/glossary/loyalty). - To list all loyalty programs, use [List loyalty programs](#operation/getLoyaltyPrograms). + Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). + To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). + + To list the loyalty programs that a customer profile is part of, use the + [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) operationId: getLoyaltyProgram parameters: - - in: path - name: programID + - description: | + Identifier of the loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). + in: path + name: loyaltyProgramId required: true schema: type: integer @@ -2219,13 +2961,14 @@ paths: summary: Get loyalty program tags: - management - /v1/loyalty_programs/{programID}/import_points: + /v1/loyalty_programs/{loyaltyProgramId}/import_points: post: description: | Upload a CSV file containing the [loyalty](https://www.talon.one/pillar-pages/loyalty) points that should be created. The file should be sent as multipart data. - **Important**: Importing points does **not** overwrite existing points for any customer. + **Important**: For existing customer profiles, the imported points are _added_ to + their active points. Learn more about [Loyalty programs](https://docs.talon.one/docs/product/loyalty-programs/overview). The CSV file can contain the following columns: @@ -2236,18 +2979,23 @@ paths: - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): A reason why these points were awarded. + **Important:** Do not leave empty columns in the file. + You can use the timezone of your choice. It is converted to UTC internally by Talon.One. - Example: + **Example:** - ```csv + ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` operationId: importLoyaltyPoints parameters: - - in: path - name: programID + - description: | + Identifier of the loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). + in: path + name: loyaltyProgramId required: true schema: type: integer @@ -2268,10 +3016,10 @@ paths: schema: $ref: '#/components/schemas/Import' description: OK - summary: Import loyalty points via CSV file + summary: Import loyalty points tags: - management - /v1/loyalty_programs/{programID}/profile/{integrationID}: + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}: get: description: | Get the loyalty ledger for this profile integration ID. @@ -2280,17 +3028,15 @@ paths: [Update customer session](/integration-api/#operation/updateCustomerSessionV2). operationId: getLoyaltyPoints parameters: - - description: The identifier for the application, must be unique within the - account. + - description: The identifier for the loyalty program. in: path - name: programID + name: loyaltyProgramId required: true schema: type: string - - description: The identifier for the application, must be unique within the - account. + - description: The identifier of the profile. in: path - name: integrationID + name: integrationId required: true schema: type: string @@ -2304,7 +3050,7 @@ paths: summary: Get the Loyalty Ledger for this integrationID tags: - management - /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points: + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points: put: description: | Add points in the specified loyalty program for the given customer. @@ -2313,13 +3059,15 @@ paths: [Update customer session](/integration-api/#operation/updateCustomerSessionV2). operationId: addLoyaltyPoints parameters: - - in: path - name: programID + - description: The identifier for the loyalty program. + in: path + name: loyaltyProgramId required: true schema: type: string - - in: path - name: integrationID + - description: The identifier of the profile. + in: path + name: integrationId required: true schema: type: string @@ -2333,11 +3081,29 @@ paths: "204": content: {} description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found summary: Add points in loyalty program for given customer tags: - management x-codegen-request-body-name: body - /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points: + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points: put: description: | Remove points from the specified loyalty program and specified customer profile. @@ -2346,13 +3112,15 @@ paths: [Update customer session](/integration-api/#operation/updateCustomerSessionV2). operationId: removeLoyaltyPoints parameters: - - in: path - name: programID + - description: The identifier for the loyalty program. + in: path + name: loyaltyProgramId required: true schema: type: string - - in: path - name: integrationID + - description: The identifier of the profile. + in: path + name: integrationId required: true schema: type: string @@ -2366,17 +3134,36 @@ paths: "204": content: {} description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found summary: Deduct points in loyalty program for given customer tags: - management x-codegen-request-body-name: body - /v1/loyalty_programs/{programID}/profile/{integrationID}/export_log: + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log: get: - description: Download a file with a customer's ledger log in the loyalty program + description: Download a CSV file containing a customer's ledger log in the loyalty + program operationId: exportLoyaltyLedger parameters: - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string + timestamp string. in: query name: rangeStart required: true @@ -2384,7 +3171,7 @@ paths: format: date-time type: string - description: Only return results from before this timestamp, must be an RFC3339 - timestamp string + timestamp string. in: query name: rangeEnd required: true @@ -2399,13 +3186,15 @@ paths: - excel - ISO8601 type: string - - in: path - name: programID + - description: The identifier for the loyalty program. + in: path + name: loyaltyProgramId required: true schema: type: string - - in: path - name: integrationID + - description: The identifier of the profile. + in: path + name: integrationId required: true schema: type: string @@ -2417,18 +3206,21 @@ paths: format: csv type: string description: OK - summary: Export a customer's loyalty ledger log to CSV file + summary: Export a customer's loyalty ledger log tags: - management - /v1/loyalty_programs/{programID}/statistics: + /v1/loyalty_programs/{loyaltyProgramId}/statistics: get: description: | Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points and expired points. operationId: getLoyaltyStatistics parameters: - - in: path - name: programID + - description: | + Identifier of the loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). + in: path + name: loyaltyProgramId required: true schema: type: integer @@ -2442,14 +3234,15 @@ paths: summary: Get loyalty program statistics by loyalty program ID tags: - management - /v1/loyalty_programs/{programID}/export_customer_balance: + /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance: get: - description: Download a file with the balance of each customer in the loyalty - program + description: Download a CSV file containing the balance of each customer in + the loyalty program. operationId: exportLoyaltyBalance parameters: - - in: path - name: programID + - description: The identifier for the loyalty program. + in: path + name: loyaltyProgramId required: true schema: type: string @@ -2461,6 +3254,18 @@ paths: format: csv type: string description: OK + "400": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized summary: Export customer loyalty balance to a CSV file tags: - management @@ -2474,10 +3279,22 @@ paths: - `startdate`: the start date in RFC3339 of the code redemption period. - `enddate`: the last date in RFC3339 of the code redemption period. - `attributes`: A json object describing _custom_ giveaway attribute names and their values. Double the double-quotes in the object. - For example, if you created a custom attribute called `provider`, set it with `"{""provider"": ""myPartnerCompany""}"`. + For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) + called `provider` associated to the giveaway entity, set it with `"{""provider"": ""myPartnerCompany""}"`. + + **Important:** Do not leave empty columns in the file. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + + **Example:** + + ```text + code,startdate,enddate,attributes + GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}" + GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}" + GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Aliexpress""}" + ``` operationId: importPoolGiveaways parameters: - in: path @@ -2505,128 +3322,223 @@ paths: summary: Import giveaway codes into a giveaway pool tags: - management - /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import: - post: - description: Upload a CSV file containing the collection of string values that - should be attached as payload for collection. The file should be sent as multipart - data. - operationId: importCollection + /v1/collections: + get: + description: List collections in account. + operationId: listAccountCollections parameters: - - in: path - name: applicationId - required: true + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - - in: path - name: campaignId - required: true + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip schema: type: integer - - in: path - name: collectionId - required: true + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. + in: query + name: sort schema: - type: integer - requestBody: - content: - multipart/form-data: - schema: - properties: - upFile: - description: The file with the information about the data that should - be imported. - format: csv - type: string + type: string + - description: | + 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. + in: query + name: withTotalResultSize + schema: + type: boolean + - description: Filter by the name of the Collection. + in: query + name: name + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Import' + $ref: '#/components/schemas/inline_response_200_9' description: OK - summary: Import collection via CSV file + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: List collections in account tags: - management - /v1/applications/{applicationId}/health_report: - get: - description: | - Display the health of the application and show the last time the Application - was used. - operationId: getApplicationApiHealth + post: + description: Create account-level collection. + operationId: createAccountCollection + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCollection' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Collection' + description: Created + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Conflict. A Collection with this name already exists. + summary: Create account-level collection + tags: + - management + x-codegen-request-body-name: body + /v1/collections/{collectionId}: + delete: + description: Delete the given account-level collection. + operationId: deleteAccountCollection parameters: - - in: path - name: applicationId + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId required: true schema: type: integer responses: - "200": + "204": + content: {} + description: No Content + "404": content: application/json: schema: - $ref: '#/components/schemas/ApplicationApiHealth' - description: OK - summary: Get report of health of application API + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Delete account-level collection tags: - management - /v1/applications/{applicationId}/access_logs/no_total: get: - description: | - Retrieve the list of API calls to this Application matching the specified criteria. - operationId: getAccessLogsWithoutTotalCount + description: Retrieve a given account-level collection. + operationId: getAccountCollection parameters: - - in: path - name: applicationId + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId required: true schema: type: integer - - description: Only return results where the request path matches the given - regular expression. - in: query - name: path - schema: - type: string - - description: Only return results where the request method matches the given - regular expression. - in: query - name: method - schema: - enum: - - get - - put - - post - - delete - - patch - type: string - - description: Filter results by HTTP status codes. - in: query - name: status - schema: - enum: - - success - - error - type: string - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string - in: query - name: rangeStart + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Collection' + description: OK + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Get account-level collection + tags: + - management + put: + description: Edit the description of the account-level collection and enable + or disable the collection in the specified Applications. + operationId: updateAccountCollection + parameters: + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId required: true schema: - format: date-time - type: string - - description: Only return results from before this timestamp, must be an RFC3339 - timestamp string - in: query - name: rangeEnd + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCollection' required: true - schema: - format: date-time - type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Collection' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Conflict. A Collection with this name already exists. + summary: Update account-level collection + tags: + - management + x-codegen-request-body-name: body + /v1/collections/{collectionId}/items: + get: + description: Retrieve the items from the given collection. + operationId: getCollectionItems + parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -2634,76 +3546,48 @@ paths: name: skip schema: type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId + required: true schema: - type: string + type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_8' + $ref: '#/components/schemas/inline_response_200_10' description: OK - summary: Get access logs for Application + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Get collection items tags: - management - /v1/access_logs: + /v1/applications/{applicationId}/collections: get: - description: | - Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. - operationId: getAllAccessLogs + description: List collections from all campaigns in the Application. + operationId: listCollectionsInApplication parameters: - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string - in: query - name: rangeStart - required: true - schema: - format: date-time - type: string - - description: Only return results from before this timestamp, must be an RFC3339 - timestamp string - in: query - name: rangeEnd + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId required: true schema: - format: date-time - type: string - - description: Only return results where the request path matches the given - regular expression. - in: query - name: path - schema: - type: string - - description: Only return results where the request method matches the given - regular expression. - in: query - name: method - schema: - enum: - - get - - put - - post - - delete - - patch - type: string - - description: Filter results by HTTP status codes. - in: query - name: status - schema: - enum: - - success - - error - type: string + type: integer - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -2718,104 +3602,90 @@ paths: name: sort schema: type: string + - description: | + 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. + in: query + name: withTotalResultSize + schema: + type: boolean + - description: Filter by the name of the Collection. + in: query + name: name + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/inline_response_200_11' description: OK - summary: List access logs + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: List collections in application tags: - management - /v1/applications/{applicationId}/campaigns/{campaignId}/analytics: + /v1/applications/{applicationId}/campaigns/{campaignId}/collections: get: - description: Retrieve statistical data about the performance of the given campaign. - operationId: getCampaignAnalytics + description: List collections in the campaign. + operationId: listCollections parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: type: integer - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: rangeStart - required: true + name: pageSize schema: - format: date-time - type: string - - description: Only return results from before this timestamp, must be an RFC3339 - timestamp string + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: rangeEnd - required: true - schema: - format: date-time - type: string - - description: The time interval between the results in the returned time-series. - in: query - name: granularity - schema: - enum: - - 1 hour - - 1 day - - 1 week - - 1 month - - 1 year - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/inline_response_200_10' - description: OK - summary: Get analytics of campaigns - tags: - - management - /v1/applications/{applicationId}/customers: - get: - description: List all the customers of the specified application. - operationId: getApplicationCustomers - parameters: - - in: path - name: applicationId - required: true + name: skip schema: type: integer - - description: Filter results performing an exact matching against the profile - integration identifier. + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: integrationId + name: sort schema: type: string - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize - schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip - schema: - type: integer - description: | - When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. - With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. + 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. in: query name: withTotalResultSize schema: type: boolean + - description: Filter by the name of the Collection. + in: query + name: name + schema: + type: string responses: "200": content: @@ -2823,110 +3693,111 @@ paths: schema: $ref: '#/components/schemas/inline_response_200_11' description: OK - summary: List application's customers + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: List collections tags: - management - /v1/applications/{applicationId}/customer_search: post: - description: | - Get a list of the application customers matching the provided criteria. - - The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. - operationId: getApplicationCustomersByAttributes + description: Create a collection. + operationId: createCollection parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize - schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true schema: type: integer - - description: | - When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. - With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. - in: query - name: withTotalResultSize - schema: - type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomerProfileSearchQuery' + $ref: '#/components/schemas/NewCampaignCollection' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' - description: OK - summary: List application customers matching the given attributes + $ref: '#/components/schemas/Collection' + description: Created + summary: Create collection tags: - management x-codegen-request-body-name: body - /v1/customer_search/no_total: - post: - description: | - Get a list of the customer profiles matching the provided criteria. - - The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. - operationId: getCustomersByAttributes + /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}: + delete: + description: Delete the given collection. + operationId: deleteCollection parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomerProfileSearchQuery' + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId required: true + schema: + type: integer responses: - "200": + "204": + content: {} + description: No Content + "401": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' - description: OK - summary: List customer profiles matching the given attributes + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + summary: Delete collection tags: - management - x-codegen-request-body-name: body - /v1/customers/{customerId}: get: - description: | - Return the details of the specified customer profile. - - **Performance tip:** You can retrieve the same information via the Integration API, which can save you - extra API requests. Consider these options: - - Request the customer profile to be part of the response content using - [Update Customer Session](/integration-api/operation#updateCustomerSessionV2). - - Send an empty update with the [Update Customer Profile](/integration-api/#operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. - operationId: getCustomerProfile + description: Retrieve a given collection. + operationId: getCollection parameters: - - in: path - name: customerId + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId required: true schema: type: integer @@ -2935,164 +3806,362 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CustomerProfile' + $ref: '#/components/schemas/Collection' description: OK - summary: Get customer profile + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Get collection tags: - management - /v1/customers/no_total: - get: - description: List all customer profiles. - operationId: getCustomerProfiles + put: + description: Edit the description of the collection. + operationId: updateCollection parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId + required: true schema: type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCampaignCollection' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/Collection' description: OK - summary: List customer profiles + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + summary: Update collection description tags: - management - /v1/applications/{applicationId}/customers/{customerId}: - get: + x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import: + post: description: | - Retrieve the customers of the specified application. + Upload a CSV file containing the collection of string values that should be attached as payload for collection. + The file should be sent as multipart data. - The `customerId` parameter is the value of the `id` property of a customer profile. - Get it with the [List application's customers](#operation/getApplicationCustomers) endpoint. - operationId: getApplicationCustomer + The import **replaces** the initial content of the collection. + + The CSV file **must** only contain the following column: + + - `item`: the values in your collection. + + A collection is limited to 500,000 items. + + Example: + + ``` + item + Addidas + Nike + Asics + ``` + + **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection. + operationId: importCollection parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path - name: customerId + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId required: true schema: type: integer + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationCustomer' + $ref: '#/components/schemas/Import' description: OK - summary: Get application's customer + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + summary: Import data in existing collection tags: - management - /v1/applications/{applicationId}/customer_activity_reports/no_total: - get: - description: Fetch summary reports for all application customers based on a - time range. Instead of having the total number of results in the response, - this endpoint only if there are more results. - operationId: getCustomerActivityReportsWithoutTotalCount + /v1/collections/{collectionId}/import: + post: + description: | + Upload a CSV file containing the collection of string values that should be attached as payload for collection. + The file should be sent as multipart data. + + The import **replaces** the initial content of the collection. + + The CSV file **must** only contain the following column: + + - `item`: the values in your collection. + + A collection is limited to 500,000 items. + + Example: + + ``` + item + Addidas + Nike + Asics + ``` + + **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection. + operationId: importAccountCollection parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId + required: true schema: type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + summary: Import data in existing account-level collection + tags: + - management + /v1/collections/{collectionId}/export: + get: + description: Download a CSV file containing items from an account-level collection. + operationId: exportAccountCollectionItems + parameters: + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId + required: true schema: type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort + responses: + "200": + content: + application/csv: + example: | + item + SKU1 + SKU2 + SKU3 + schema: + format: csv + type: string + description: OK + "401": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Export account-level collection's items + tags: + - management + /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export: + get: + description: Download a CSV file containing a collection's items. + operationId: exportCollectionItems + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: - type: string - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string - in: query - name: rangeStart + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId required: true schema: - format: date-time - type: string - - description: Only return results from before this timestamp, must be an RFC3339 - timestamp string - in: query - name: rangeEnd + type: integer + - description: The ID of the collection. You can get it with the [List collection + in account endpoint](#operation/listCollectionsInApplication). + in: path + name: collectionId required: true schema: - format: date-time - type: string - - in: path + type: integer + responses: + "200": + content: + application/csv: + example: | + item + SKU1 + SKU2 + SKU3 + schema: + format: csv + type: string + description: OK + "401": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Export a collection's items + tags: + - management + /v1/applications/{applicationId}/health_report: + get: + description: | + Display the health of the application and show the last time the Application + was used. + operationId: getApplicationApiHealth + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - description: Only return reports matching the customer name - in: query - name: name - schema: - type: string - - description: Only return reports matching the integrationId - in: query - name: integrationId - schema: - type: string - - description: Only return reports matching the campaignName - in: query - name: campaignName - schema: - type: string - - description: Only return reports matching the current customer referrer name - in: query - name: advocateName - schema: - type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_14' + $ref: '#/components/schemas/ApplicationApiHealth' description: OK - summary: Get Activity Reports for Application Customers + summary: Get report of health of application API tags: - management - /v1/applications/{applicationId}/customer_activity_reports/{customerId}: + /v1/applications/{applicationId}/access_logs/no_total: get: - description: Fetch the summary report of a given customer in the given application, - in a time range. - operationId: getCustomerActivityReport + description: | + Retrieve the list of API calls to this Application matching the specified criteria. + operationId: getAccessLogsWithoutTotalCount parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: type: integer - - description: Skips the given number of items when paging through large result - sets. + - description: Only return results where the request path matches the given + regular expression. in: query - name: skip + name: path schema: - type: integer + type: string + - description: Only return results where the request method matches the given + regular expression. + in: query + name: method + schema: + enum: + - get + - put + - post + - delete + - patch + type: string + - description: Filter results by HTTP status codes. + in: query + name: status + schema: + enum: + - success + - error + type: string - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string + timestamp string. in: query name: rangeStart required: true @@ -3100,43 +4169,20 @@ paths: format: date-time type: string - description: Only return results from before this timestamp, must be an RFC3339 - timestamp string + timestamp string. in: query name: rangeEnd required: true schema: format: date-time type: string - - in: path - name: applicationId - required: true - schema: - type: integer - - in: path - name: customerId - required: true - schema: - type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CustomerActivityReport' - description: OK - summary: Get customer's activity report - tags: - - management - /v1/applications/{applicationId}/customers/{customerId}/analytics: - get: - description: Fetch analytics for a given customer in the given application. - operationId: getCustomerAnalytics - parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3151,252 +4197,176 @@ paths: name: sort schema: type: string - - in: path - name: applicationId - required: true - schema: - type: integer - - in: path - name: customerId - required: true - schema: - type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CustomerAnalytics' + $ref: '#/components/schemas/inline_response_200_12' description: OK - summary: Get customer's analytics report + summary: Get access logs for Application tags: - management - /v1/applications/{applicationId}/sessions: + /v1/access_logs: get: description: | - List all the sessions of the specified Application. - operationId: getApplicationSessions + Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. + operationId: getAllAccessLogs parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize - schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. + - description: Only return results from after this timestamp, must be an RFC3339 + timestamp string. in: query - name: skip + name: rangeStart + required: true schema: - type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. + format: date-time + type: string + - description: Only return results from before this timestamp, must be an RFC3339 + timestamp string. in: query - name: sort + name: rangeEnd + required: true schema: + format: date-time type: string - - description: Profile integration ID filter for sessions. Must be exact match. + - description: Only return results where the request path matches the given + regular expression. in: query - name: profile + name: path schema: type: string - - description: Filter by sessions with this state. Must be exact match. + - description: Only return results where the request method matches the given + regular expression. in: query - name: state + name: method schema: enum: - - open - - closed - - cancelled - type: string - - description: Only return events created before this date. You can use any - timezone. Talon.One will convert to UTC internally. - in: query - name: createdBefore - schema: - format: date-time + - get + - put + - post + - delete + - patch type: string - - description: Only return events created after this date. You can use any timezone. - Talon.One will convert to UTC internally. + - description: Filter results by HTTP status codes. in: query - name: createdAfter + name: status schema: - format: date-time + enum: + - success + - error type: string - - description: Filter by sessions with this coupon. Must be exact match. + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: coupon + name: pageSize schema: - type: string - - description: Filter by sessions with this referral. Must be exact match. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: referral + name: skip schema: - type: string - - description: Filter by sessions with this integrationId. Must be exact match. + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: integrationId + name: sort schema: type: string - - in: path - name: applicationId - required: true - schema: - type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/inline_response_200_13' description: OK - summary: List Application sessions + summary: List access logs tags: - management - /v1/applications/{applicationId}/sessions/{sessionId}: + /v1/applications/{applicationId}/campaigns/{campaignId}/analytics: get: - description: | - Get the details of the given session. - You can list the sessions with the [List application sessions](#operation/getApplicationSessions) endpoint. - operationId: getApplicationSession + description: Retrieve statistical data about the performance of the given campaign. + operationId: getCampaignAnalytics parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path - name: sessionId + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId required: true schema: type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationSession' - description: OK - summary: Get Application session - tags: - - management - /v1/applications/{applicationId}/events/no_total: - get: - description: | - Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results. - operationId: getApplicationEventsWithoutTotalCount - parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize - schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip - schema: - type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - - description: Comma-separated list of types by which to filter events. Must - be exact match(es). - in: query - name: type - schema: - type: string - - description: Only return events created before this date. You can use any - timezone. Talon.One will convert to UTC internally. + - description: Only return results from after this timestamp, must be an RFC3339 + timestamp string. in: query - name: createdBefore + name: rangeStart + required: true schema: format: date-time type: string - - description: Only return events created after this date. You can use any timezone. - Talon.One will convert to UTC internally. + - description: Only return results from before this timestamp, must be an RFC3339 + timestamp string. in: query - name: createdAfter + name: rangeEnd + required: true schema: format: date-time type: string - - description: Session integration ID filter for events. Must be exact match. - in: query - name: session - schema: - type: string - - description: Profile integration ID filter for events. Must be exact match. - in: query - name: profile - schema: - type: string - - description: Customer name filter for events. Will match substrings case-insensitively. - in: query - name: customerName - schema: - minLength: 2 - type: string - - description: Customer e-mail address filter for events. Will match substrings - case-insensitively. - in: query - name: customerEmail - schema: - minLength: 2 - type: string - - description: Coupon code - in: query - name: couponCode - schema: - type: string - - description: Referral code - in: query - name: referralCode - schema: - type: string - - description: Rule name filter for events - in: query - name: ruleQuery - schema: - type: string - - description: Campaign name filter for events + - description: The time interval between the results in the returned time-series. in: query - name: campaignQuery + name: granularity schema: + enum: + - 1 hour + - 1 day + - 1 week + - 1 month + - 1 year type: string - - in: path - name: applicationId - required: true - schema: - type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_16' + $ref: '#/components/schemas/inline_response_200_14' description: OK - summary: List Applications events + summary: Get analytics of campaigns tags: - management - /v1/applications/{applicationId}/event_types: + /v1/applications/{applicationId}/customers: get: - description: | - Get all of the distinct values of the Event `type` property for events recorded in the application. - - See also: [Track an event](/integration-api/#operation/trackEvent) - operationId: getApplicationEventTypes + description: List all the customers of the specified application. + operationId: getApplicationCustomers parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: Filter results performing an exact matching against the profile + integration identifier. + in: query + name: integrationId + schema: + type: string - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3404,39 +4374,47 @@ paths: name: skip schema: type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. + - description: | + 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. in: query - name: sort - schema: - type: string - - in: path - name: applicationId - required: true + name: withTotalResultSize schema: - type: integer + type: boolean responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_17' + $ref: '#/components/schemas/inline_response_200_15' description: OK - summary: List Applications event types + summary: List application's customers tags: - management - /v1/audiences: - get: + /v1/applications/{applicationId}/customer_search: + post: description: | - Get All audiences created in the account. - operationId: getAudiences + Get a list of the application customers matching the provided criteria. + + The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. + operationId: getApplicationCustomersByAttributes parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3444,42 +4422,47 @@ paths: name: skip schema: type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - description: | - When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. - With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. + 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. in: query name: withTotalResultSize schema: type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerProfileSearchQuery' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_18' + $ref: '#/components/schemas/inline_response_200_16' description: OK - summary: List audiences + summary: List application customers matching the given attributes tags: - management - /v1/applications/{applicationId}/profile/{integrationId}/friends: - get: + x-codegen-request-body-name: body + /v1/customer_search/no_total: + post: description: | - List the friends referred by the specified customer profile in this Application. - operationId: getApplicationCustomerFriends + Get a list of the customer profiles matching the provided criteria. + + The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. + operationId: getCustomersByAttributes parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3487,53 +4470,69 @@ paths: name: skip schema: type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - - in: path - name: applicationId + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerProfileSearchQuery' required: true - schema: - type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + description: OK + summary: List customer profiles matching the given attributes + tags: + - management + x-codegen-request-body-name: body + /v1/customers/{customerId}: + get: + description: | + Return the details of the specified customer profile. + +
+

Performance tips

+ + You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: + + - Request the customer profile to be part of the response content using + [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). + - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. +
+ operationId: getCustomerProfile + parameters: - description: | - When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. - With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. - in: query - name: withTotalResultSize - schema: - type: boolean - - description: The Integration ID of the Advocate's Profile. + The value of the `id` property of a customer profile. Get it with the + [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. in: path - name: integrationId + name: customerId required: true schema: - type: string + type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_19' + $ref: '#/components/schemas/CustomerProfile' description: OK - summary: List friends referred by customer profile + summary: Get customer profile tags: - management - /v1/attributes: + /v1/customers/no_total: get: - description: | - Returns all the defined custom attributes for the account. - operationId: getAttributes + description: List all customer profiles. + operationId: getCustomerProfiles parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3541,118 +4540,202 @@ paths: name: skip schema: type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - - description: Returned attributes will be filtered by supplied entity - in: query - name: entity - schema: - type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_20' + $ref: '#/components/schemas/inline_response_200_17' description: OK - summary: List custom attributes + summary: List customer profiles tags: - management - post: + /v1/applications/{applicationId}/customers/{customerId}: + get: description: | - Create a _custom attribute_ in this account. Custom attributes allow you - to attach new fields to Talon.One domain objects like campaigns, coupons, - customers and so on. - - These attributes can then be given values when creating/updating these objects, and these values can be - used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, - and add a rule to your campaign that only allows certain ZIP codes. - - These attributes are shared across all applications in your account, and are never required. - operationId: createAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewAttribute' + Retrieve the customers of the specified application. + operationId: getApplicationCustomer + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: | + The value of the `id` property of a customer profile. Get it with the + [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. + in: path + name: customerId required: true + schema: + type: integer responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Attribute' - description: Created - summary: Create custom attribute + $ref: '#/components/schemas/ApplicationCustomer' + description: OK + summary: Get application's customer tags: - management - x-codegen-request-body-name: body - /v1/attributes/{attributeId}: + /v1/applications/{applicationId}/customer_activity_reports/no_total: get: description: | - Returns custom attribute for the account by its id. - operationId: getAttribute + Fetch summary reports for all application customers based on a time range. Instead of having the total number of results + in the response, this endpoint only mentions whether there are more results. + operationId: getCustomerActivityReportsWithoutTotalCount parameters: - - in: path - name: attributeId + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip + schema: + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. + in: query + name: sort + schema: + type: string + - description: Only return results from after this timestamp, must be an RFC3339 + timestamp string. + in: query + name: rangeStart + required: true + schema: + format: date-time + type: string + - description: Only return results from before this timestamp, must be an RFC3339 + timestamp string. + in: query + name: rangeEnd + required: true + schema: + format: date-time + type: string + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId required: true schema: type: integer + - description: Only return reports matching the customer name + in: query + name: name + schema: + type: string + - description: Filter results performing an exact matching against the profile + integration identifier. + in: query + name: integrationId + schema: + type: string + - description: Only return reports matching the campaignName + in: query + name: campaignName + schema: + type: string + - description: Only return reports matching the current customer referrer name + in: query + name: advocateName + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Attribute' + $ref: '#/components/schemas/inline_response_200_18' description: OK - summary: Get a custom attribute + summary: Get Activity Reports for Application Customers tags: - management - put: - description: | - Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. - - If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one. - operationId: updateAttribute + /v1/applications/{applicationId}/customer_activity_reports/{customerId}: + get: + description: Fetch the summary report of a given customer in the given application, + in a time range. + operationId: getCustomerActivityReport parameters: - - in: path - name: attributeId + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip + schema: + type: integer + - description: Only return results from after this timestamp, must be an RFC3339 + timestamp string. + in: query + name: rangeStart + required: true + schema: + format: date-time + type: string + - description: Only return results from before this timestamp, must be an RFC3339 + timestamp string. + in: query + name: rangeEnd + required: true + schema: + format: date-time + type: string + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewAttribute' + - description: | + The value of the `id` property of a customer profile. Get it with the + [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. + in: path + name: customerId required: true + schema: + type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Attribute' + $ref: '#/components/schemas/CustomerActivityReport' description: OK - summary: Update a custom attribute + summary: Get customer's activity report tags: - management - x-codegen-request-body-name: body - /v1/additional_costs: + /v1/applications/{applicationId}/customers/{customerId}/analytics: get: - description: | - Returns all the defined additional costs for the account. - operationId: getAdditionalCosts + description: Fetch analytics for a given customer in the given application. + operationId: getCustomerAnalytics parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3667,97 +4750,51 @@ paths: name: sort schema: type: string + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: | + The value of the `id` property of a customer profile. Get it with the + [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. + in: path + name: customerId + required: true + schema: + type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_21' + $ref: '#/components/schemas/CustomerAnalytics' description: OK - summary: List additional costs - tags: - - management - post: - description: | - Defines a new _additional cost_ in this account. - - These additional costs are shared across all applications in your account, and are never required. - operationId: createAdditionalCost - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewAdditionalCost' - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/AccountAdditionalCost' - description: Created - summary: Define a new additional cost + summary: Get customer's analytics report tags: - management - x-codegen-request-body-name: body - /v1/additional_costs/{additionalCostId}: + /v1/applications/{applicationId}/sessions: get: description: | - Returns additional cost for the account by its id. - operationId: getAdditionalCost - parameters: - - in: path - name: additionalCostId - required: true - schema: - type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AccountAdditionalCost' - description: OK - summary: Get an additional cost - tags: - - management - put: - description: | - Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. - operationId: updateAdditionalCost + List all the sessions of the specified Application. + operationId: getApplicationSessions parameters: - - in: path - name: additionalCostId - required: true + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewAdditionalCost' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AccountAdditionalCost' - description: OK - summary: Update an additional cost - tags: - - management - x-codegen-request-body-name: body - /v1/webhooks: - get: - description: List all webhooks. - operationId: getWebhooks - parameters: - - description: Filter by one or more application ids separated by comma + - description: Skips the given number of items when paging through large result + sets. in: query - name: applicationIds + name: skip schema: - type: string + type: integer - description: The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. @@ -3765,16 +4802,55 @@ paths: name: sort schema: type: string - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: Profile integration ID filter for sessions. Must be exact match. in: query - name: pageSize + name: profile schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. + type: string + - description: Filter by sessions with this state. Must be exact match. in: query - name: skip + name: state + schema: + enum: + - open + - closed + - partially_returned + - cancelled + type: string + - description: Only return events created before this date. You can use any + timezone. Talon.One will convert to UTC internally. + in: query + name: createdBefore + schema: + format: date-time + type: string + - description: Only return events created after this date. You can use any timezone. + Talon.One will convert to UTC internally. + in: query + name: createdAfter + schema: + format: date-time + type: string + - description: Filter by sessions with this coupon. Must be exact match. + in: query + name: coupon + schema: + type: string + - description: Filter by sessions with this referral. Must be exact match. + in: query + name: referral + schema: + type: string + - description: Filter by sessions with this integrationId. Must be exact match. + in: query + name: integrationId + schema: + type: string + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: type: integer responses: @@ -3782,18 +4858,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_22' + $ref: '#/components/schemas/inline_response_200_19' description: OK - summary: List webhooks + summary: List Application sessions tags: - management - /v1/webhooks/{webhookId}: + /v1/applications/{applicationId}/sessions/{sessionId}: get: - description: Returns an webhook by its id. - operationId: getWebhook + description: | + Get the details of the given session. + You can list the sessions with the [List Application sessions](/#tag/Customer-data/operation/getApplicationSession) endpoint. + operationId: getApplicationSession parameters: - - in: path - name: webhookId + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: | + The **internal** ID of the session. You can get the ID with the [List Application sessions endpoint](/#tag/Customer-data/operation/getApplicationSession). + in: path + name: sessionId required: true schema: type: integer @@ -3802,22 +4889,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: '#/components/schemas/ApplicationSession' description: OK - summary: Get Webhook + summary: Get Application session tags: - management - /v1/webhook_activation_logs: + /v1/applications/{applicationId}/events/no_total: get: - description: Webhook activation log entries would be created as soon as an integration - request triggered an effect with a webhook - operationId: getWebhookActivationLogs + description: | + Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results. + operationId: getApplicationEventsWithoutTotalCount parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3832,25 +4921,12 @@ paths: name: sort schema: type: string - - description: Filter results by integration request UUID. + - description: Comma-separated list of types by which to filter events. Must + be exact match(es). in: query - name: integrationRequestUuid + name: type schema: type: string - - description: Filter results by Webhook. - in: query - name: webhookId - schema: - type: number - - in: query - name: applicationId - schema: - type: number - - description: Filter results by campaign. - in: query - name: campaignId - schema: - type: number - description: Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. in: query @@ -3858,34 +4934,88 @@ paths: schema: format: date-time type: string - - description: Filter results where request and response times to return entries - after parameter value, expected to be an RFC3339 timestamp string. You can - use any timezone. Talon.One will convert to UTC internally. + - description: Only return events created after this date. You can use any timezone. + Talon.One will convert to UTC internally. in: query name: createdAfter schema: format: date-time type: string + - description: Session integration ID filter for events. Must be exact match. + in: query + name: session + schema: + type: string + - description: Profile integration ID filter for events. Must be exact match. + in: query + name: profile + schema: + type: string + - description: Customer name filter for events. Will match substrings case-insensitively. + in: query + name: customerName + schema: + minLength: 2 + type: string + - description: Customer e-mail address filter for events. Will match substrings + case-insensitively. + in: query + name: customerEmail + schema: + minLength: 2 + type: string + - description: Coupon code + in: query + name: couponCode + schema: + type: string + - description: Referral code + in: query + name: referralCode + schema: + type: string + - description: Rule name filter for events + in: query + name: ruleQuery + schema: + type: string + - description: Campaign name filter for events + in: query + name: campaignQuery + schema: + type: string + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_23' + $ref: '#/components/schemas/inline_response_200_20' description: OK - summary: List webhook activation log entries + summary: List Applications events tags: - management - /v1/webhook_logs: + /v1/applications/{applicationId}/event_types: get: - description: Retrieve all webhook log entries. - operationId: getWebhookLogs + description: | + Get all of the distinct values of the Event `type` property for events recorded in the application. + + See also: [Track an event](/integration-api/#operation/trackEvent) + operationId: getApplicationEventTypes parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3900,87 +5030,141 @@ paths: name: sort schema: type: string - - description: Filter results by HTTP status codes. - in: query - name: status + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: - enum: - - success - - error - type: string - - description: Filter results by Webhook. - in: query - name: webhookId - schema: - type: number - - in: query - name: applicationId - schema: - type: number - - description: Filter results by campaign. + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_21' + description: OK + summary: List Applications event types + tags: + - management + /v1/audiences: + get: + description: | + Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2). + operationId: getAudiences + parameters: + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: campaignId + name: pageSize schema: - type: number - - description: Filter results by request UUID. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: requestUuid + name: skip schema: - type: string - - description: Filter results where request and response times to return entries - before parameter value, expected to be an RFC3339 timestamp string. You - can use any timezone. Talon.One will convert to UTC internally. + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: createdBefore + name: sort schema: - format: date-time type: string - - description: Filter results where request and response times to return entries - after parameter value, expected to be an RFC3339 timestamp string. You can - use any timezone. Talon.One will convert to UTC internally. + - description: | + 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. in: query - name: createdAfter + name: withTotalResultSize schema: - format: date-time - type: string + type: boolean responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_24' + $ref: '#/components/schemas/inline_response_200_22' description: OK - summary: List webhook log entries + summary: List audiences tags: - management - /v1/event_types: + /v1/applications/{applicationId}/profile/{integrationId}/friends: get: description: | - Fetch all event type definitions for your account. - operationId: getEventTypes + List the friends referred by the specified customer profile in this Application. + operationId: getApplicationCustomerFriends parameters: - - description: Filter by one or more application ids separated by comma + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: applicationIds + name: pageSize schema: - type: string - - description: Filter results to event types with the given name. This parameter - implies `includeOldVersions`. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: name + name: skip + schema: + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. + in: query + name: sort schema: type: string - - description: Include all versions of every event type. + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: | + 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. in: query - name: includeOldVersions + name: withTotalResultSize schema: - default: false type: boolean + - description: The Integration ID of the Advocate's Profile. + in: path + name: integrationId + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_23' + description: OK + summary: List friends referred by customer profile + tags: + - management + /v1/attributes: + get: + description: | + Returns all the defined custom attributes for the account. + operationId: getAttributes + parameters: - description: The number of items to include in this response. When omitted, the maximum value of 1000 will be used. in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -3995,50 +5179,127 @@ paths: name: sort schema: type: string + - description: Returned attributes will be filtered by supplied entity. + in: query + name: entity + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_25' + $ref: '#/components/schemas/inline_response_200_24' description: OK - summary: List Event Types + summary: List custom attributes tags: - management - /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons: post: description: | - Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. - - The CSV file can contain the following columns: - - - `value` (required): The coupon code. - - `expirydate`: The end date in RFC3339 of the code redemption period. - - `startdate`: The start date in RFC3339 of the code redemption period. - - `limitval`: The maximum amount of redemptions of this code. Defaults to `1` when not provided. - - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. - For example, if you created a custom attribute called `category`, set it with `"{""category"": ""10_off""}"`. - - You can use thhe timezone of your choice. It is converted to UTC internally by Talon.One. + Create a _custom attribute_ in this account. Custom attributes allow you + to attach new fields to Talon.One domain objects like campaigns, coupons, + customers and so on. - Example: + These attributes can then be given values when creating/updating these objects, and these values can be + used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, + and add a rule to your campaign that only allows certain ZIP codes. - ``` - "value","expirydate","startdate","recipientintegrationid","limitval","attributes" - COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"": ""10_off""}" - ``` + These attributes are shared across all applications in your account, and are never required. + operationId: createAttribute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAttribute' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Attribute' + description: Created + summary: Create custom attribute + tags: + - management + x-codegen-request-body-name: body + /v1/attributes/{attributeId}: + get: + description: | + Returns custom attribute for the account by its id. + operationId: getAttribute + parameters: + - in: path + name: attributeId + required: true + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Attribute' + description: OK + summary: Get custom attribute + tags: + - management + put: + description: | + Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. - Once imported, you can find the `batchId` in the Campaign Manager or by - using [List coupons](#operation/getReservedCustomers). - operationId: importCoupons + If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one. + operationId: updateAttribute parameters: - in: path - name: applicationId + name: attributeId required: true schema: type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAttribute' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Attribute' + description: OK + summary: Update custom attribute + tags: + - management + x-codegen-request-body-name: body + /v1/attributes/{attributeId}/allowed_list/import: + post: + description: | + Upload a CSV file containing a list of allowed values for the specified attribute. + These values are also called [picklist values](/docs/product/account/dev-tools/managing-attributes/#picklist-values). + + The file should be sent as multipart data. + + The import **replaces** the previous list of allowed values for this attribute, if any. + + The CSV file **must** only contain the following column: + - `item` (required): the values in your allowed list, for example a list of SKU's. + + An allowed list is limited to 500,000 items. + + Example: + + ```text + item + CS-VG-04032021-UP-50D-10 + CS-DV-04042021-UP-49D-12 + CS-DG-02082021-UP-50G-07 + ``` + operationId: importAllowedList + parameters: - in: path - name: campaignId + name: attributeId required: true schema: type: integer @@ -4059,346 +5320,673 @@ paths: schema: $ref: '#/components/schemas/Import' description: OK - summary: Import coupons via CSV file + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Import allowed values for attribute tags: - management - /v1/applications/{applicationId}/export_coupons: - get: - description: Download a file containing the coupons that match the given properties. - operationId: exportCoupons - parameters: - - in: path - name: applicationId - required: true - schema: - type: integer - - description: Filter results by campaign. - in: query - name: campaignId - schema: - type: number - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - - description: Filter results performing case-insensitive matching against the - coupon code. Both the code and the query are folded to remove all non-alpha-numeric - characters. - in: query - name: value + /v1/catalogs/{catalogId}/sync: + put: + description: | + Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: + + - Add an item to the catalog. + - Edit the attributes of an item in the catalog. + - Edit the attributes of more than one item in the catalog. + - Remove an item from the catalog. + - Remove more than one item from the catalog. + + **Note**: For more information, see [our documentation on managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). + + ### Filtering cart items + + Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) + to filter items and select the ones you want to edit or delete when editing or deleting more than one item + at a time. + + The `filters` object contains the following properties: + + - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) + connected to the catalog. It is applied to all items in the catalog. + - `op`: The filtering operator indicating the relationship between the value of each + cart item in the catalog and the value of the `value` property for the attribute selected + in `attr`. + + The value of `op` can be one of the following: + + - `EQ`: Equal to `value` + - `LT`: Less than `value` + - `LE`: Less than or equal to `value` + - `GT`: Greater than `value` + - `GE`: Greater than or equal to `value` + - `IN`: One of the comma-separated values that `value` is set to. + + **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. + + - `value`: The value of the attribute selected in `attr`. + + ### Payload examples + + Synchronization actions are sent as `PUT` requests. See the structure for each action: + +
+ Adding an item to the catalog +
+ + ```json + { + "actions": [ + { + "payload": { + "attributes": { + "color": "Navy blue", + "type": "shoe" + }, + "replaceIfExists": true, + "sku": "SKU1241028" + }, + "type": "ADD" + } + ] + } + ``` +
+
+ +
+ Editing the attributes of an item in the catalog +
+ + ```json + { + "actions": [ + { + "payload": { + "attributes": { + "age": 11, + "origin": "germany" + }, + "createIfNotExists": false, + "sku": "SKU1241028" + }, + "type": "PATCH" + } + ] + } + ``` +
+
+ +
+ Editing the attributes of several items at once +
+ + ```json + { + "actions": [ + { + "payload": { + "attributes": { + "color": "red" + }, + "filters": [ + { + "attr": "color", + "op": "EQ", + "value": "blue" + } + ] + }, + "type": "PATCH_MANY" + } + ] + } + ``` + +
+
+ +
+ Removing an item from the catalog +
+ + ```json + { + "actions": [ + { + "payload": { + "sku": "SKU1241028" + }, + "type": "REMOVE" + } + ] + } + ``` + +
+
+ +
+ Removing several items from the catalog at once +
+ + ```json + { + "actions": [ + { + "payload": { + "filters": [ + { + "attr": "color", + "op": "EQ", + "value": "blue" + } + ] + }, + "type": "REMOVE_MANY" + } + ] + } + ``` +
+
+ +
+ Removing shoes of sizes above 45 from the catalog +
+

+ Let's imagine that we have a shoe store and we have decided to stop selling + shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 + with a single action:

+ + ```json + { + "actions": [ + { + "payload": { + "filters": [ + { + "attr": "size", + "op": "GT", + "value": "45" + } + ] + }, + "type": "REMOVE_MANY" + } + ] + } + ``` +
+
+ operationId: syncCatalog + parameters: + - in: path + name: catalogId + required: true schema: - type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any timezone. Talon.One will convert to UTC internally. + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogSyncRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Catalog' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Sync cart item catalog + tags: + - integration + x-codegen-request-body-name: body + /v1/additional_costs: + get: + description: | + Returns all the defined additional costs for the account. + operationId: getAdditionalCosts + parameters: + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: createdBefore + name: pageSize schema: - format: date-time - type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any timezone. Talon.One will convert to UTC internally. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: createdAfter + name: skip schema: - format: date-time - type: string - - description: | - Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: valid + name: sort schema: - enum: - - expired - - validNow - - validFuture type: string - - description: | - Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. - in: query - name: usable + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_25' + description: OK + summary: List additional costs + tags: + - management + post: + description: | + Create an [additional cost](/docs/product/account/dev-tools/managing-additional-costs/). + + These additional costs are shared across all applications in your account, and are never required. + operationId: createAdditionalCost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAdditionalCost' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AccountAdditionalCost' + description: Created + summary: Create additional cost + tags: + - management + x-codegen-request-body-name: body + /v1/additional_costs/{additionalCostId}: + get: + description: | + Returns the additional cost. + operationId: getAdditionalCost + parameters: + - in: path + name: additionalCostId + required: true schema: - enum: - - "true" - - "false" - type: string - - description: Filter the results by matching them with the Id of a referral, - that meaning the coupons that had been created as an effect of the usage - of a referral code. - in: query - name: referralId + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/AccountAdditionalCost' + description: OK + summary: Get additional cost + tags: + - management + put: + description: | + Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. + operationId: updateAdditionalCost + parameters: + - in: path + name: additionalCostId + required: true schema: type: integer - - description: Filter results by match with a profile id specified in the coupon's - RecipientIntegrationId field + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAdditionalCost' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/AccountAdditionalCost' + description: OK + summary: Update additional cost + tags: + - management + x-codegen-request-body-name: body + /v1/webhooks: + get: + description: List all webhooks. + operationId: getWebhooks + parameters: + - description: Filter by one or more application ids separated by comma. in: query - name: recipientIntegrationId + name: applicationIds schema: type: string - - description: Filter results by batches of coupons + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: batchId + name: sort schema: type: string - - description: Filter results to an exact case-insensitive matching against - the coupon code - in: query - name: exactMatch - schema: - default: false - type: boolean - - description: Determines the format of dates in the export document. + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: dateFormat + name: pageSize schema: - enum: - - excel - - ISO8601 - type: string - - description: | - Filter results by the state of the campaign. - - - `enabled`: Campaigns that are scheduled, running (activated), or expired. - - `running`: Campaigns that are running (activated). - - `disabled`: Campaigns that are disabled. - - `expired`: Capmaigns that are expired. - - `archived`: Campaigns that are archived. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: campaignState + name: skip schema: - enum: - - enabled - - disabled - - archived - - draft - - scheduled - - running - - expired - type: string + type: integer responses: "200": content: - application/csv: + application/json: schema: - format: csv - type: string + $ref: '#/components/schemas/inline_response_200_26' description: OK - summary: Export coupons to CSV file + summary: List webhooks tags: - management - /v1/applications/{applicationId}/export_referrals: + /v1/webhooks/{webhookId}: get: - description: Download a file containing the referrals that match the given parameters. - operationId: exportReferrals + description: Returns a webhook by its id. + operationId: getWebhook parameters: - in: path - name: applicationId + name: webhookId required: true schema: type: integer - - description: Filter results by campaign. - in: query - name: campaignId - schema: - type: number - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the referral creation timestamp. You can - use any timezone. Talon.One will convert to UTC internally. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Webhook' + description: OK + summary: Get webhook + tags: + - management + /v1/webhook_activation_logs: + get: + description: Webhook activation log entries would be created as soon as an integration + request triggered an effect with a webhook. + operationId: getWebhookActivationLogs + parameters: + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: createdBefore + name: pageSize schema: - format: date-time - type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the referral creation timestamp. You can - use any timezone. Talon.One will convert to UTC internally. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: createdAfter + name: skip schema: - format: date-time - type: string - - description: | - Either "expired", "validNow", or "validFuture". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future. + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: valid + name: sort schema: - enum: - - expired - - validNow - - validFuture type: string - - description: | - If `true`, only referrals where `usageCounter < usageLimit` will be returned. If `false`, only referrals where `usageCounter >= usageLimit` will be returned. + - description: Filter results by integration request UUID. in: query - name: usable + name: integrationRequestUuid schema: - enum: - - "true" - - "false" type: string - - description: Filter results by batches of referrals + - description: Filter results by Webhook. in: query - name: batchId + name: webhookId + schema: + type: number + - description: Filter results by Application ID. + in: query + name: applicationId + schema: + type: number + - description: Filter results by campaign. + in: query + name: campaignId + schema: + type: number + - description: Only return events created before this date. You can use any + timezone. Talon.One will convert to UTC internally. + in: query + name: createdBefore schema: + format: date-time type: string - - description: Determines the format of dates in the export document. + - description: Only return events created after this date. You can use any timezone. + Talon.One will convert to UTC internally. in: query - name: dateFormat + name: createdAfter schema: - enum: - - excel - - ISO8601 + format: date-time type: string responses: "200": content: - application/csv: + application/json: schema: - format: csv - type: string + $ref: '#/components/schemas/inline_response_200_27' description: OK - summary: Export referrals to CSV file + summary: List webhook activation log entries tags: - management - /v1/applications/{applicationId}/export_effects: + /v1/webhook_logs: get: - description: Download a file containing the triggered effects that match the - given attributes. - operationId: exportEffects + description: Retrieve all webhook log entries. + operationId: getWebhookLogs parameters: - - in: path - name: applicationId - required: true + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip schema: type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. + in: query + name: sort + schema: + type: string + - description: Filter results by HTTP status codes. + in: query + name: status + schema: + enum: + - success + - error + type: string + - description: Filter results by Webhook. + in: query + name: webhookId + schema: + type: number + - description: Filter results by Application ID. + in: query + name: applicationId + schema: + type: number - description: Filter results by campaign. in: query name: campaignId schema: type: number - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any timezone. Talon.One will convert to UTC internally. + - description: Filter results by request UUID. in: query - name: createdBefore + name: requestUuid schema: - format: date-time type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any timezone. Talon.One will convert to UTC internally. + - description: Filter results where request and response times to return entries + before parameter value, expected to be an RFC3339 timestamp string. You + can use any timezone. Talon.One will convert to UTC internally. in: query - name: createdAfter + name: createdBefore schema: format: date-time type: string - - description: Determines the format of dates in the export document. + - description: Filter results where request and response times to return entries + after parameter value, expected to be an RFC3339 timestamp string. You can + use any timezone. Talon.One will convert to UTC internally. in: query - name: dateFormat + name: createdAfter schema: - enum: - - excel - - ISO8601 + format: date-time type: string responses: "200": content: - application/csv: + application/json: schema: - format: csv - type: string + $ref: '#/components/schemas/inline_response_200_28' description: OK - summary: Export triggered effects to CSV file + summary: List webhook log entries tags: - management - /v1/applications/{applicationId}/export_customer_sessions: + /v1/event_types: get: - description: Download a file containing the customer sessions that match the - request. - operationId: exportCustomerSessions + description: | + Fetch all event type definitions for your account. + operationId: getEventTypes parameters: - - in: path - name: applicationId - required: true - schema: - type: integer - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string. + - description: Filter results to event types with the given name. This parameter + implies `includeOldVersions`. in: query - name: createdBefore + name: name schema: - format: date-time type: string - - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string. + - description: Include all versions of every event type. in: query - name: createdAfter + name: includeOldVersions schema: - format: date-time - type: string - - description: Only return sessions for the customer that matches this customer - integration ID. + default: false + type: boolean + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. in: query - name: profileIntegrationId + name: pageSize schema: - type: string - - description: Determines the format of dates in the export document. + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. in: query - name: dateFormat + name: skip schema: - enum: - - excel - - ISO8601 - type: string - - description: Filter results by state. + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. in: query - name: customerSessionState + name: sort schema: - enum: - - open - - closed - - cancelled type: string responses: "200": content: - application/csv: + application/json: schema: - format: csv - type: string + $ref: '#/components/schemas/inline_response_200_29' description: OK - summary: Export customer sessions to CSV file + summary: List event types tags: - management - /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals: + /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons: post: description: | - Upload a CSV file containing the referrals that should be created. - The file should be sent as multipart data. + Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file can contain the following columns: - - `code` (required): The referral code. - - `advocateprofileintegrationid` (required): The profile ID of the advocate. - - `startdate`: The start date in RFC3339 of the code redemption period. + - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - - `limitval`: The maximum amount of redemptions of this code. Unlimited (0) when blank. + - `startdate`: The start date in RFC3339 of the code redemption period. + - `limitval`: The maximum amount of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. - For example, if you created a custom attribute called `category`, set it with `"{""category"": ""10_off""}"`. + - `discountlimit`: The amount of discounts that can be given with this coupon code. + For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) + called `category` associated to the coupon entity, set it with `"{""category"": ""10_off""}"`. + + **Important:** Do not leave empty columns in the file. You can use the timezone of your choice. It is converted to UTC internally by Talon.One. - operationId: importReferrals + + **Example:** + + ```text + "value","expirydate","startdate","recipientintegrationid","limitval","attributes","discountlimit" + COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"": ""10_off""}",2.4 + ``` + + Once imported, you can find the `batchId` in the Campaign Manager or by + using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). + operationId: importCoupons parameters: - - in: path + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId required: true schema: type: integer - - in: path + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path name: campaignId required: true schema: @@ -4420,27 +6008,27 @@ paths: schema: $ref: '#/components/schemas/Import' description: OK - summary: Import referrals via CSV file + summary: Import coupons tags: - management - /v1/users: + /v1/applications/{applicationId}/export_coupons: get: - description: | - Retrieve all users in your account. - operationId: getUsers + description: Download a CSV file containing the coupons that match the given + properties. + operationId: exportCoupons parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true schema: type: integer - - description: Skips the given number of items when paging through large result - sets. + - description: Filter results by campaign. in: query - name: skip + name: campaignId schema: - type: integer + type: number - description: The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. @@ -4448,78 +6036,219 @@ paths: name: sort schema: type: string + - description: Filter results performing case-insensitive matching against the + coupon code. Both the code and the query are folded to remove all non-alpha-numeric + characters. + in: query + name: value + schema: + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can use + any timezone. Talon.One will convert to UTC internally. + in: query + name: createdBefore + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can use + any timezone. Talon.One will convert to UTC internally. + in: query + name: createdAfter + schema: + format: date-time + type: string + - description: | + Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. + in: query + name: valid + schema: + enum: + - expired + - validNow + - validFuture + type: string + - description: | + Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. + in: query + name: usable + schema: + enum: + - "true" + - "false" + type: string + - description: Filter the results by matching them with the Id of a referral, + that meaning the coupons that had been created as an effect of the usage + of a referral code. + in: query + name: referralId + schema: + type: integer + - description: Filter results by match with a profile id specified in the coupon's + RecipientIntegrationId field + in: query + name: recipientIntegrationId + schema: + type: string + - description: Filter results by batches of coupons + in: query + name: batchId + schema: + type: string + - description: Filter results to an exact case-insensitive matching against + the coupon code + in: query + name: exactMatch + schema: + default: false + type: boolean + - description: Determines the format of dates in the export document. + in: query + name: dateFormat + schema: + enum: + - excel + - ISO8601 + type: string + - description: | + Filter results by the state of the campaign. + + - `enabled`: Campaigns that are scheduled, running (activated), or expired. + - `running`: Campaigns that are running (activated). + - `disabled`: Campaigns that are disabled. + - `expired`: Campaigns that are expired. + - `archived`: Campaigns that are archived. + - `draft`: Campaigns that are drafts. + in: query + name: campaignState + schema: + enum: + - enabled + - disabled + - archived + - draft + - scheduled + - running + - expired + type: string responses: "200": content: - application/json: + application/csv: + example: | + id,created,campaignid,value,expirydate,startdate,attributes,applicationid,deleted,deleted_changelogid,accountid,referralid,recipientintegrationid,importid,batchid,reservation,limits,limitval,counter,discount_counter,discount_limitval + 20191301,2022-04-26T11:02:38Z,3882,COUP1,2022-04-27T10:56:47Z,2022-04-26T10:56:47Z,"{""test"": ""premium""}",270,,0,1,,cust123,671,axghjfdy,,"[]",1,0,0,1.5 schema: - $ref: '#/components/schemas/inline_response_200_26' + format: csv + type: string description: OK - summary: List users in account + summary: Export coupons tags: - management - /v1/users/{userId}: + /v1/applications/{applicationId}/export_referrals: get: - description: | - Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves. - operationId: getUser + description: Download a CSV file containing the referrals that match the given + parameters. + operationId: exportReferrals parameters: - - in: path - name: userId + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId required: true schema: type: integer + - description: Filter results by campaign. + in: query + name: campaignId + schema: + type: number + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the referral creation timestamp. You can + use any timezone. Talon.One will convert to UTC internally. + in: query + name: createdBefore + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the referral creation timestamp. You can + use any timezone. Talon.One will convert to UTC internally. + in: query + name: createdAfter + schema: + format: date-time + type: string + - description: | + - `expired`: Matches referrals in which the expiry date is set and in the past. + - `validNow`: Matches referrals in which start date is null or in the past and expiry date is null or in the future. + - `validFuture`: Matches referrals in which start date is set and in the future. + in: query + name: valid + schema: + enum: + - expired + - validNow + - validFuture + type: string + - description: | + - `true`, only referrals where `usageCounter < usageLimit` will be returned. + - `false`, only referrals where `usageCounter >= usageLimit` will be returned. + in: query + name: usable + schema: + enum: + - "true" + - "false" + type: string + - description: Filter results by batches of referrals + in: query + name: batchId + schema: + type: string + - description: Determines the format of dates in the export document. + in: query + name: dateFormat + schema: + enum: + - excel + - ISO8601 + type: string responses: "200": content: - application/json: + application/csv: + example: | + id,created,campaignid,advocateprofileintegrationid,friendprofileintegrationid,startdate,expirydate,code,importid,attributes,batchid,counter,limitval + 687,2021-09-10 09:21:06,3882,UGAV4628K,,,,3LFC-4BPC,,"{}",pimcxobg,0,9999 schema: - $ref: '#/components/schemas/User' + format: csv + type: string description: OK - summary: Get a single user + summary: Export referrals tags: - management - /v1/changes: + /v1/applications/{applicationId}/export_effects: get: - description: Get list of changes caused by API calls for an account. Only accessible - for admins. - operationId: getChanges + description: | + Download a CSV file containing the triggered effects that match the given attributes. + operationId: exportEffects parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. - in: query - name: pageSize - schema: - type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip - schema: - type: integer - - description: The field by which results should be sorted. Sorting defaults - to ascending order, prefix the field name with `-` to sort in descending - order. - in: query - name: sort - schema: - type: string - - in: query + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path name: applicationId + required: true schema: type: integer - - description: Filter results on a case insensitive matching of the url path - of the entity + - description: Filter results by campaign. in: query - name: entityPath - schema: - type: string - - in: query - name: userId + name: campaignId schema: - type: integer + type: number - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the change creation timestamp. You can use + an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. in: query name: createdBefore @@ -4527,53 +6256,325 @@ paths: format: date-time type: string - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the change creation timestamp. You can use + an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. in: query name: createdAfter schema: format: date-time type: string - - description: | - When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. - With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. - in: query - name: withTotalResultSize - schema: - type: boolean - - description: When this flag is set to false, the state without the change - will not be returned. The default value is true. + - description: Determines the format of dates in the export document. in: query - name: includeOld + name: dateFormat schema: - type: boolean + enum: + - excel + - ISO8601 + type: string responses: "200": content: - application/json: + application/csv: + example: | + created,name,applicationid,campaignid,rulesetid,ruleindex,sessionintegrationid,profileintegrationid,sessionid,profileid,eventid,event_type,total_revenue,props,couponid + 2021-06-02T21:14:16Z,rejectCoupon,270,0,0,0,newsession1,,9168,0,95797,talon_session_created,265.00,"{""value"": ""XMAS20"", ""rejectionReason"": ""CouponNotFound""}", + 2021-09-01T13:04:04Z,setDiscountPerItem,270,3882,13599,0,test_flattening_2,integid_4,9707,4800,98806,talon_session_updated,405.00,"{""name"": ""10% off per item#1"", ""value"": 11.0, ""position"": 1}" schema: - $ref: '#/components/schemas/inline_response_200_27' + format: csv + type: string description: OK - summary: Get audit log for an account + summary: Export triggered effects tags: - management - /v1/password_recovery_emails: - post: + /v1/applications/{applicationId}/export_customer_sessions: + get: description: | - Send an email with a password recovery link to the email address of an existing account. - operationId: createPasswordRecoveryEmail - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewPasswordEmail' + 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/product/server-infrastructure-and-data-retention#data-retention-policy). + operationId: exportCustomerSessions + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId required: true - responses: - "204": - content: - application/json: - schema: + schema: + type: integer + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string. + in: query + name: createdBefore + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string. + in: query + name: createdAfter + schema: + format: date-time + type: string + - description: Only return sessions for the customer that matches this customer + integration ID. + in: query + name: profileIntegrationId + schema: + type: string + - description: Determines the format of dates in the export document. + in: query + name: dateFormat + schema: + enum: + - excel + - ISO8601 + type: string + - description: Filter results by state. + in: query + name: customerSessionState + schema: + enum: + - open + - closed + - partially_returned + - cancelled + type: string + responses: + "200": + content: + application/csv: + example: | + id,firstsession,integrationid,applicationid,profileid,profileintegrationid,created,state,cartitems,discounts,total,attributes,closedat,cancelledat,referral,identifiers,additional_costs,updated,coupons + 12327,true,62791173fbf323ee5cfd96f3,270,6111,dxclwds,2022-05-09T13:05:31Z,open,"[{""sku"": ""B00004TKVY"", ""name"": ""Gravel bike - \""Aisle of Man\"""", ""price"": 1800, ""weight"": 6, ""category"": ""gravelbikes"", ""position"": 0, ""quantity"": 1, ""attributes"": {""color"": [""black,white""], ""material"": ""titanium""}, ""returnedQuantity"": 0, ""remainingQuantity"": 1}]","{}",1850.00,"{""ShippingCost"": 50, ""PaymentMethod"": ""creditcard"", ""ShippingMethod"": ""Standard""}",0001-01-01T00:00:00Z,0001-01-01T00:00:00Z,,"null","{""ShippingCost"": {""price"": 50}}",2022-05-09T13:13:28Z,"[""SORRY5QMUJRWA""]" + schema: + format: csv + type: string + description: OK + summary: Export customer sessions + tags: + - management + /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals: + post: + description: | + Upload a CSV file containing the referrals that should be created. + The file should be sent as multipart data. + + The CSV file can contain the following columns: + + - `code` (required): The referral code. + - `advocateprofileintegrationid` (required): The profile ID of the advocate. + - `startdate`: The start date in RFC3339 of the code redemption period. + - `expirydate`: The end date in RFC3339 of the code redemption period. + - `limitval`: The maximum amount of redemptions of this code. Defaults to `1` when left blank. + - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. + + For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) + called `category` associated to the referral entity, set it with `"{""category"": ""10_off""}"`. + + You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + + **Example:** + + ```text + code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes + REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"{""my_attribute"": ""10_off""}" + REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"{""my_attribute"": ""20_off""}" + ``` + operationId: importReferrals + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + summary: Import referrals + tags: + - management + /v1/users: + get: + description: | + Retrieve all users in your account. + operationId: getUsers + parameters: + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip + schema: + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. + in: query + name: sort + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_30' + description: OK + summary: List users in account + tags: + - management + /v1/users/{userId}: + get: + description: | + Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile. + operationId: getUser + parameters: + - description: The ID of the user. + in: path + name: userId + required: true + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: OK + summary: Get user + tags: + - management + /v1/changes: + get: + description: | + Export the audit logs displayed in **Accounts > Audit logs**. + operationId: getChanges + parameters: + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip + schema: + type: integer + - description: The field by which results should be sorted. Sorting defaults + to ascending order, prefix the field name with `-` to sort in descending + order. + in: query + name: sort + schema: + type: string + - description: Filter results by Application ID. + in: query + name: applicationId + schema: + type: number + - description: Filter results on a case insensitive matching of the url path + of the entity + in: query + name: entityPath + schema: + type: string + - description: Filter results that match the given user ID. + in: query + name: userId + schema: + type: integer + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the change creation timestamp. You can use + any timezone. Talon.One will convert to UTC internally. + in: query + name: createdBefore + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the change creation timestamp. You can use + any timezone. Talon.One will convert to UTC internally. + in: query + name: createdAfter + schema: + format: date-time + type: string + - description: | + 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. + in: query + name: withTotalResultSize + schema: + type: boolean + - description: When this flag is set to false, the state without the change + will not be returned. The default value is true. + in: query + name: includeOld + schema: + type: boolean + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_31' + description: OK + summary: Get audit logs for an account + tags: + - management + /v1/password_recovery_emails: + post: + description: | + Send an email with a password recovery link to the email address of an existing account. + operationId: createPasswordRecoveryEmail + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewPasswordEmail' + required: true + responses: + "204": + content: + application/json: + schema: $ref: '#/components/schemas/NewPasswordEmail' description: Created summary: Request a password reset @@ -4609,7 +6610,11 @@ paths: Return the details of your companies Talon.One account. operationId: getAccount parameters: - - in: path + - description: | + The identifier of the account. Retrieve it via the + [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` + property. + in: path name: accountId required: true schema: @@ -4627,10 +6632,14 @@ paths: /v1/accounts/{accountId}/analytics: get: description: | - Return the analytics of your companies Talon.One account. + Return the analytics of your Talon.One account. operationId: getAccountAnalytics parameters: - - in: path + - description: | + The identifier of the account. Retrieve it via the + [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` + property. + in: path name: accountId required: true schema: @@ -4665,6 +6674,9 @@ paths: for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. + + **Note:** You can also use your browser's developer's console when you log into the Campaign Manager. + Keep in mind that logging out destroys the token displayed in the console. operationId: createSession requestBody: content: @@ -4694,6 +6706,8 @@ paths: in: query name: pageSize schema: + maximum: 1000 + minimum: 1 type: integer - description: Skips the given number of items when paging through large result sets. @@ -4701,11 +6715,13 @@ paths: name: skip schema: type: integer - - in: query + - description: Filter results by Application ID. + in: query name: applicationId schema: - type: integer - - in: query + type: number + - description: Filter by the campaign ID on which the limit counters are used. + in: query name: campaignId schema: type: integer @@ -4720,15 +6736,16 @@ paths: - CustomerSession - LoyaltyLedger - LoyaltyLedgerLog + - Collection type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_28' + $ref: '#/components/schemas/inline_response_200_32' description: OK - summary: Get Exports + summary: Get exports tags: - management /v1/roles: @@ -4740,7 +6757,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_29' + $ref: '#/components/schemas/inline_response_200_33' description: OK summary: List roles tags: @@ -4751,7 +6768,8 @@ paths: Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles). operationId: getRole parameters: - - in: path + - description: 'The Id of role. ' + in: path name: roleId required: true schema: @@ -4781,6 +6799,19 @@ components: required: - message type: object + ErrorResponseWithStatus: + properties: + message: + type: string + errors: + description: An array of individual problems encountered during the request. + items: + $ref: '#/components/schemas/APIError' + type: array + StatusCode: + description: The error code + type: integer + type: object APIError: properties: title: @@ -4798,10 +6829,10 @@ components: FeatureFlag: properties: name: - description: The name for the featureflag + description: The name for the featureflag. type: string value: - description: The value for the featureflag + description: The value for the featureflag. type: string created: description: The exact moment this entity was last created. @@ -4830,17 +6861,19 @@ components: 'N/A' if unknown. type: string resource: - description: Pointer to the resource that caused this error + description: Pointer to the resource that caused this error. type: string type: object Entity: properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string required: @@ -4864,6 +6897,7 @@ components: properties: modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string required: @@ -4909,6 +6943,7 @@ components: properties: programID: description: The ID of the loyalty program that owns this entity. + example: 125 type: integer required: - programID @@ -4962,13 +6997,14 @@ components: IntegrationEntity: properties: integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. + description: The integration ID set by your integration layer. example: URNGV8294NV format: string + maxLength: 1000 type: string created: description: The exact moment this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string required: @@ -4978,16 +7014,17 @@ components: IntegrationProfileEntity: properties: profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string type: object CouponValue: properties: value: - description: The actual coupon code. + description: The coupon code. example: XMAS-20-2021 minLength: 4 title: Coupon Code @@ -4997,7 +7034,7 @@ components: properties: usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -5021,20 +7058,35 @@ components: type: object CodeGeneratorSettings: example: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" properties: validCharacters: - description: Set of characters to be used when generating random part of - code. Defaults to [A-Z, 0-9] (in terms of RegExp). + description: | + List of characters used to generate the random parts of a code. Defaults to a list equivalent to the + `[A-Z, 0-9]` regexp. + example: + - A + - B + - C + - D + - E + - "2" + - "0" items: type: string type: array couponPattern: description: | - The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. + example: SUMMER-####-#### maxLength: 100 minLength: 3 type: string @@ -5049,7 +7101,7 @@ components: token: dy_Fa_lQ4iDAnqldJFvVEmnsN8xDTxej19l0LZDBJhQ properties: userId: - description: The ID of the user of this session + description: The ID of the user of this session. example: 109 type: integer token: @@ -5124,74 +7176,93 @@ components: properties: name: description: The name of this application. + example: My Application minLength: 1 type: string description: description: A longer description of the application. + example: A test Application type: string timezone: description: A string containing an IANA timezone descriptor. + example: Europe/Berlin minLength: 1 type: string currency: - description: A string describing a default currency for new customer sessions. + description: The default currency for new customer sessions. + example: EUR minLength: 1 type: string caseSensitivity: - description: A string indicating how should campaigns in this application - deal with case sensitivity on coupon codes. + description: The case sensitivity behavior to check coupon codes in the + campaigns of this Application. enum: - sensitive - insensitive-uppercase - insensitive-lowercase + example: sensitive type: string attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object limits: - description: Default limits for campaigns created in this application + description: Default limits for campaigns created in this application. items: $ref: '#/components/schemas/LimitConfig' type: array campaignPriority: - description: Default priority for campaigns created in this application, - can be one of (universal, stackable, exclusive). If no value is provided, - this is set to "universal" + default: universal + description: | + Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns + created in this Application. enum: - universal - stackable - exclusive + example: universal type: string exclusiveCampaignsStrategy: - description: The strategy used when choosing exclusive campaigns for evaluation, - can be one of (listOrder, lowestDiscount, highestDiscount). If no value - is provided, this is set to "listOrder" + default: listOrder + description: The strategy used when choosing exclusive campaigns for evaluation. enum: - listOrder - lowestDiscount - highestDiscount + example: listOrder type: string defaultDiscountScope: - description: The default scope to apply "setDiscount" effects on if no scope - was provided with the effect. + description: | + The default scope to apply `setDiscount` effects on if no scope was provided with the effect. enum: - sessionTotal - cartItems - additionalCosts type: string enableCascadingDiscounts: - description: Indicates if discounts should cascade for this application + description: Indicates if discounts should cascade for this Application. type: boolean enableFlattenedCartItems: - description: Indicates if cart items of quantity larger than one should - be separated into different items of quantity one + description: | + Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' sandbox: - description: Indicates if this is a live or sandbox application + description: Indicates if this is a live or sandbox Application. + type: boolean + enablePartialDiscounts: + description: Indicates if this Application supports partial discounts. + example: false type: boolean + defaultDiscountAdditionalCostPerItemScope: + description: | + The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. + enum: + - price + - itemTotal + - additionalCosts + type: string required: - currency - name @@ -5202,77 +7273,96 @@ components: properties: name: description: The name of this application. + example: My Application minLength: 1 type: string description: description: A longer description of the application. + example: A test Application type: string timezone: description: A string containing an IANA timezone descriptor. + example: Europe/Berlin minLength: 1 type: string currency: - description: A string describing a default currency for new customer sessions. + description: The default currency for new customer sessions. + example: EUR minLength: 1 type: string caseSensitivity: - description: A string indicating how should campaigns in this application - deal with case sensitivity on coupon codes. + description: The case sensitivity behavior to check coupon codes in the + campaigns of this Application. enum: - sensitive - insensitive-uppercase - insensitive-lowercase + example: sensitive type: string attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object limits: - description: Default limits for campaigns created in this application + description: Default limits for campaigns created in this application. items: $ref: '#/components/schemas/LimitConfig' type: array campaignPriority: - description: Default priority for campaigns created in this application, - can be one of (universal, stackable, exclusive). If no value is provided, - this is set to "universal" + default: universal + description: | + Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns + created in this Application. enum: - universal - stackable - exclusive + example: universal type: string exclusiveCampaignsStrategy: - description: The strategy used when choosing exclusive campaigns for evaluation, - can be one of (listOrder, lowestDiscount, highestDiscount). If no value - is provided, this is set to "listOrder" + default: listOrder + description: The strategy used when choosing exclusive campaigns for evaluation. enum: - listOrder - lowestDiscount - highestDiscount + example: listOrder type: string defaultDiscountScope: - description: The default scope to apply "setDiscount" effects on if no scope - was provided with the effect. + description: | + The default scope to apply `setDiscount` effects on if no scope was provided with the effect. enum: - sessionTotal - cartItems - additionalCosts type: string enableCascadingDiscounts: - description: Indicates if discounts should cascade for this application + description: Indicates if discounts should cascade for this Application. type: boolean enableFlattenedCartItems: - description: Indicates if cart items of quantity larger than one should - be separated into different items of quantity one + description: | + Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' sandbox: - description: Indicates if this is a live or sandbox application + description: Indicates if this is a live or sandbox Application. + type: boolean + enablePartialDiscounts: + description: Indicates if this Application supports partial discounts. + example: false type: boolean + defaultDiscountAdditionalCostPerItemScope: + description: | + The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. + enum: + - price + - itemTotal + - additionalCosts + type: string key: description: Hex key for HMAC-signing API calls as coming from this application - (16 hex digits) + (16 hex digits). pattern: ^[a-fA-F0-9]{16}$ type: string required: @@ -5284,10 +7374,10 @@ components: description: "" example: enableFlattenedCartItems: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin sandbox: true - description: description + description: A test Application attributesSettings: mandatory: campaigns: @@ -5301,85 +7391,102 @@ components: enableCascadingDiscounts: true campaignPriority: universal loyaltyPrograms: - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending + - cardBased: true tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description - id: 6 - title: title + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending - tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program id: 6 - title: title + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 - name: name + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program + id: 6 + name: My Application exclusiveCampaignsStrategy: listOrder - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z defaultDiscountScope: sessionTotal - currency: currency + currency: EUR attributes: '{}' + defaultDiscountAdditionalCostPerItemScope: price id: 6 limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action + limit: 1000.0 + action: createCoupon + enablePartialDiscounts: false properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string accountId: @@ -5388,77 +7495,96 @@ components: type: integer name: description: The name of this application. + example: My Application minLength: 1 type: string description: description: A longer description of the application. + example: A test Application type: string timezone: description: A string containing an IANA timezone descriptor. + example: Europe/Berlin minLength: 1 type: string currency: - description: A string describing a default currency for new customer sessions. + description: The default currency for new customer sessions. + example: EUR minLength: 1 type: string caseSensitivity: - description: A string indicating how should campaigns in this application - deal with case sensitivity on coupon codes. + description: The case sensitivity behavior to check coupon codes in the + campaigns of this Application. enum: - sensitive - insensitive-uppercase - insensitive-lowercase + example: sensitive type: string attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object limits: - description: Default limits for campaigns created in this application + description: Default limits for campaigns created in this application. items: $ref: '#/components/schemas/LimitConfig' type: array campaignPriority: - description: Default priority for campaigns created in this application, - can be one of (universal, stackable, exclusive). If no value is provided, - this is set to "universal" + default: universal + description: | + Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns + created in this Application. enum: - universal - stackable - exclusive + example: universal type: string exclusiveCampaignsStrategy: - description: The strategy used when choosing exclusive campaigns for evaluation, - can be one of (listOrder, lowestDiscount, highestDiscount). If no value - is provided, this is set to "listOrder" + default: listOrder + description: The strategy used when choosing exclusive campaigns for evaluation. enum: - listOrder - lowestDiscount - highestDiscount + example: listOrder type: string defaultDiscountScope: - description: The default scope to apply "setDiscount" effects on if no scope - was provided with the effect. + description: | + The default scope to apply `setDiscount` effects on if no scope was provided with the effect. enum: - sessionTotal - cartItems - additionalCosts type: string enableCascadingDiscounts: - description: Indicates if discounts should cascade for this application + description: Indicates if discounts should cascade for this Application. type: boolean enableFlattenedCartItems: - description: Indicates if cart items of quantity larger than one should - be separated into different items of quantity one + description: | + Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' sandbox: - description: Indicates if this is a live or sandbox application + description: Indicates if this is a live or sandbox Application. + type: boolean + enablePartialDiscounts: + description: Indicates if this Application supports partial discounts. + example: false type: boolean + defaultDiscountAdditionalCostPerItemScope: + description: | + The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. + enum: + - price + - itemTotal + - additionalCosts + type: string loyaltyPrograms: description: An array containing all the loyalty programs to which this - application is subscribed + application is subscribed. items: $ref: '#/components/schemas/LoyaltyProgram' type: array @@ -5483,13 +7609,13 @@ components: type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this campaign group - is enabled for + is enabled for. items: type: integer type: array campaignIds: description: A list of the IDs of the campaigns that this campaign group - owns + owns. items: type: integer type: array @@ -5500,15 +7626,18 @@ components: description: "" properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string accountId: @@ -5524,13 +7653,13 @@ components: type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this campaign group - is enabled for + is enabled for. items: type: integer type: array campaignIds: description: A list of the IDs of the campaigns that this campaign group - owns + owns. items: type: integer type: array @@ -5553,13 +7682,13 @@ components: type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this campaign group - is enabled for + is enabled for. items: type: integer type: array campaignIds: description: A list of the IDs of the campaigns that this campaign group - owns + owns. items: type: integer type: array @@ -5567,69 +7696,30 @@ components: - name type: object NewCampaign: - example: - activeRulesetId: 0 - description: description - campaignGroups: - - 6 - - 6 - tags: - - tags - - tags - - tags - - tags - - tags - features: - - coupons - - coupons - name: name - referralSettings: - couponPattern: couponPattern - validCharacters: - - validCharacters - - validCharacters - couponSettings: - couponPattern: couponPattern - validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - attributes: '{}' - endTime: 2000-01-23T04:56:07.000+00:00 - state: enabled - limits: - - period: daily - entities: - - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily - entities: - - Coupon - - Coupon - limit: 0.5944895607614016 - action: action properties: name: description: A user-facing name for this campaign. + example: Summer promotions minLength: 1 title: Campaign Name type: string description: description: A detailed description of the campaign. + example: Campaign for all summer 2021 promotions title: Campaign Description type: string startTime: description: Timestamp when the campaign will become active. + example: 2021-07-20T22:00:00Z format: date-time type: string endTime: description: Timestamp the campaign will become inactive. + example: 2021-09-22T22:00:00Z format: date-time type: string attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object state: @@ -5642,10 +7732,14 @@ components: - archived type: string activeRulesetId: - description: ID of Ruleset this campaign applies on customer session evaluation. + description: | + [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this + campaign applies on customer session evaluation. type: integer tags: description: A list of tags for the campaign. + example: + - summer items: maxLength: 50 minLength: 1 @@ -5653,7 +7747,10 @@ components: maxItems: 50 type: array features: - description: A list of features for the campaign. + description: The features enabled in this campaign. + example: + - coupons + - referrals items: enum: - coupons @@ -5667,12 +7764,17 @@ components: referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: - description: The set of limits that will operate for this campaign + description: | + The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. items: $ref: '#/components/schemas/LimitConfig' type: array campaignGroups: - description: The IDs of the campaign groups that own this entity. + description: | + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + example: + - 1 + - 3 items: type: integer type: array @@ -5701,32 +7803,40 @@ components: - coupons name: name referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" startTime: 2000-01-23T04:56:07.000+00:00 attributes: '{}' endTime: 2000-01-23T04:56:07.000+00:00 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action + limit: 1000.0 + action: createCoupon properties: name: description: A user-facing name for this campaign. @@ -5746,7 +7856,7 @@ components: format: date-time type: string attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object state: @@ -5784,7 +7894,7 @@ components: referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: - description: The set of limits that will operate for this campaign + description: The set of limits that will operate for this campaign. items: $ref: '#/components/schemas/LimitConfig' type: array @@ -5802,65 +7912,72 @@ components: Campaign: description: "" example: - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 @@ -5881,23 +7998,27 @@ components: type: integer name: description: A user-facing name for this campaign. + example: Summer promotions minLength: 1 title: Campaign Name type: string description: description: A detailed description of the campaign. + example: Campaign for all summer 2021 promotions title: Campaign Description type: string startTime: description: Timestamp when the campaign will become active. + example: 2021-07-20T22:00:00Z format: date-time type: string endTime: description: Timestamp the campaign will become inactive. + example: 2021-09-22T22:00:00Z format: date-time type: string attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object state: @@ -5910,10 +8031,14 @@ components: - archived type: string activeRulesetId: - description: ID of Ruleset this campaign applies on customer session evaluation. + description: | + [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this + campaign applies on customer session evaluation. type: integer tags: description: A list of tags for the campaign. + example: + - summer items: maxLength: 50 minLength: 1 @@ -5921,7 +8046,10 @@ components: maxItems: 50 type: array features: - description: A list of features for the campaign. + description: The features enabled in this campaign. + example: + - coupons + - referrals items: enum: - coupons @@ -5935,67 +8063,101 @@ components: referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: - description: The set of limits that will operate for this campaign + description: | + The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. items: $ref: '#/components/schemas/LimitConfig' type: array campaignGroups: - description: The IDs of the campaign groups that own this entity. + description: | + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + example: + - 1 + - 3 items: type: integer type: array couponRedemptionCount: description: Number of coupons redeemed in the campaign. + example: 163 type: integer referralRedemptionCount: description: Number of referral codes redeemed in the campaign. + example: 3 type: integer discountCount: description: Total amount of discounts redeemed in the campaign. + example: 288.0 type: number discountEffectCount: description: Total number of times discounts were redeemed in this campaign. + example: 343 type: integer couponCreationCount: description: Total number of coupons created by rules in this campaign. + example: 16 + type: integer + customEffectCount: + description: Total number of custom effects triggered by rules in this campaign. + example: 0 type: integer referralCreationCount: description: Total number of referrals created by rules in this campaign. + example: 8 + type: integer + addFreeItemEffectCount: + description: Total number of times triggering add free item effext is allowed + in this campaign. + example: 0 type: integer awardedGiveawaysCount: description: Total number of giveaways awarded by rules in this campaign. + example: 9 type: integer createdLoyaltyPointsCount: description: Total number of loyalty points created by rules in this campaign. + example: 9.0 type: number createdLoyaltyPointsEffectCount: description: Total number of loyalty point creation effects triggered by rules in this campaign. + example: 2 type: integer redeemedLoyaltyPointsCount: description: Total number of loyalty points redeemed by rules in this campaign. + example: 8.0 type: number redeemedLoyaltyPointsEffectCount: description: Total number of loyalty point redemption effects triggered by rules in this campaign. + example: 9 + type: integer + callApiEffectCount: + description: Total number of webhook triggered by rules in this campaign. + example: 0 type: integer lastActivity: description: Timestamp of the most recent event received by this campaign. + example: 2022-11-10T23:00:00Z format: date-time type: string updated: - description: Timestamp of the most recent update to the campaign or any - of its elements. + description: | + Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign + are **not** registered by this property, such as collection or coupon updates. format: date-time type: string createdBy: description: Name of the user who created this campaign if available. + example: John Doe type: string updatedBy: description: Name of the user who last updated this campaign if available. + example: Jane Doe type: string templateId: description: The ID of the Campaign Template this Campaign was created from. + example: 3 type: integer required: - applicationId @@ -6010,59 +8172,6 @@ components: - userId type: object NewRuleset: - example: - rbVersion: rbVersion - bindings: - - expression: - - '{}' - - '{}' - name: name - type: type - - expression: - - '{}' - - '{}' - name: name - type: type - activate: true - rules: - - condition: - - '{}' - - '{}' - effects: - - '{}' - - '{}' - bindings: - - expression: - - '{}' - - '{}' - name: name - type: type - - expression: - - '{}' - - '{}' - name: name - type: type - description: description - title: title - - condition: - - '{}' - - '{}' - effects: - - '{}' - - '{}' - bindings: - - expression: - - '{}' - - '{}' - name: name - type: type - - expression: - - '{}' - - '{}' - name: name - type: type - description: description - title: title properties: rules: description: Set of rules to apply. @@ -6074,16 +8183,17 @@ components: talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. + example: [] items: $ref: '#/components/schemas/Binding' type: array rbVersion: - description: A string indicating which version of the rulebuilder was used - to create this ruleset. + description: The version of the rulebuilder used to create this ruleset. + example: v2 type: string activate: - description: A boolean indicating whether this newly created ruleset should - also be activated for the campaign that owns it + description: Indicates whether this created ruleset should be activated + for the campaign that owns it. type: boolean required: - bindings @@ -6092,71 +8202,85 @@ components: Ruleset: description: "" example: - rbVersion: rbVersion - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 1 - bindings: - - expression: - - '{}' - - '{}' - name: name - type: type - - expression: - - '{}' - - '{}' - name: name - type: type + rbVersion: v2 + created: 2020-06-10T09:05:27.993483Z + campaignId: 320 + bindings: [] activatedAt: 2000-01-23T04:56:07.000+00:00 activate: true rules: - condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon - condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon id: 6 - templateId: 5 + templateId: 3 userId: 6 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string userId: @@ -6172,23 +8296,26 @@ components: talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. + example: [] items: $ref: '#/components/schemas/Binding' type: array rbVersion: - description: A string indicating which version of the rulebuilder was used - to create this ruleset. + description: The version of the rulebuilder used to create this ruleset. + example: v2 type: string activate: - description: A boolean indicating whether this newly created ruleset should - also be activated for the campaign that owns it + description: Indicates whether this created ruleset should be activated + for the campaign that owns it. type: boolean campaignId: description: The ID of the campaign that owns this entity. + example: 320 title: Campaign ID type: integer templateId: description: The ID of the campaign template that owns this entity. + example: 3 title: Campaign Template ID type: integer activatedAt: @@ -6207,14 +8334,22 @@ components: expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter properties: name: description: A descriptive name for the value to be bound. + example: my property type: string type: - description: The kind of binding. Possible values are cartItemFilter, subledgerBalance. + description: | + The kind of binding. Possible values are: + - `bundle` + - `cartItemFilter` + - `subledgerBalance` + - `templateParameter` + example: templateParameter type: string expression: description: A Talang expression that will be evaluated and its result attached @@ -6223,37 +8358,58 @@ components: properties: {} type: object type: array - required: + valueType: + description: | + Can be one of the following: + - `string` + - `number` + - `boolean` + example: string + type: string + required: - expression - name type: object Rule: example: condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon properties: title: description: A short description of the rule. + example: Give discount via coupon type: string description: description: A longer, more detailed description of the rule. + example: Creates a discount when a coupon is valid type: string bindings: description: An array that provides objects with variable names (name) and @@ -6266,6 +8422,9 @@ components: condition: description: A Talang expression that will be evaluated in the context of the given event. + example: + - and + - - couponValid items: properties: {} type: object @@ -6274,6 +8433,18 @@ components: effects: description: An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. + example: + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 items: properties: {} type: object @@ -6287,22 +8458,32 @@ components: description: "" properties: action: - description: The limitable action to which this limit will be applied + description: | + The limitable action to which this limit applies. For example: + - `setDiscount` + - `setDiscountEffect` + - `redeemCoupon` + - `createCoupon` + example: createCoupon type: string limit: - description: The value to set for the limit + description: The value to set for the limit. + example: 1000.0 minimum: 0 type: number period: - description: The period on which the budget limit recurs + description: The period on which the budget limit recurs. enum: - daily - weekly - monthly - yearly + example: yearly type: string entities: - description: The entities that make the address of this limit + description: The entity that this limit applies to. + example: + - Coupon items: enum: - Coupon @@ -6311,41 +8492,46 @@ components: - Identifier type: string type: array - description: - description: The description of this budget configuration - type: string required: - action - - description - entities - limit type: object LimitConfig: example: - period: daily + period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action + limit: 1000.0 + action: createCoupon properties: action: - description: The limitable action to which this limit will be applied + description: | + The limitable action to which this limit applies. For example: + - `setDiscount` + - `setDiscountEffect` + - `redeemCoupon` + - `createCoupon` + example: createCoupon type: string limit: - description: The value to set for the limit + description: The value to set for the limit. + example: 1000.0 minimum: 0 type: number period: - description: The period on which the budget limit recurs + description: The period on which the budget limit recurs. enum: - daily - weekly - monthly - yearly + example: yearly type: string entities: - description: The entities that make the address of this limit + description: The entity that this limit applies to. + example: + - Coupon items: enum: - Coupon @@ -6363,11 +8549,13 @@ components: description: "" properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string applicationId: @@ -6375,7 +8563,7 @@ components: example: 322 type: integer version: - description: Version of the campaign set + description: Version of the campaign set. minimum: 1 type: integer set: @@ -6387,6 +8575,58 @@ components: - set - version type: object + CampaignSetV2: + description: "" + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + version: + description: Version of the campaign set. + minimum: 1 + type: integer + set: + $ref: '#/components/schemas/CampaignPrioritiesV2' + required: + - applicationId + - created + - id + - set + - version + type: object + CampaignSetIDs: + description: Campaign IDs for each priority. + properties: + campaignId: + description: ID of the campaign + type: integer + type: object + CampaignPrioritiesV2: + properties: + exclusive: + items: + $ref: '#/components/schemas/CampaignSetIDs' + type: array + stackable: + items: + $ref: '#/components/schemas/CampaignSetIDs' + type: array + universal: + items: + $ref: '#/components/schemas/CampaignSetIDs' + type: array + type: object CampaignSetNode: properties: type: @@ -6397,7 +8637,7 @@ components: CampaignSetBranchNode: properties: type: - description: Indicates the node type + description: Indicates the node type. enum: - SET type: string @@ -6405,13 +8645,13 @@ components: description: Name of the set type: string operator: - description: How does the set operates on its elements + description: How does the set operates on its elements. enum: - ALL - FIRST type: string elements: - description: Child elements of this set + description: Child elements of this set. items: $ref: '#/components/schemas/CampaignSetNode' type: array @@ -6424,7 +8664,7 @@ components: CampaignSetLeafNode: properties: type: - description: Indicates the node type + description: Indicates the node type. enum: - CAMPAIGN type: string @@ -6443,7 +8683,7 @@ components: example: 322 type: integer version: - description: Version of the campaign set + description: Version of the campaign set. minimum: 1 type: integer set: @@ -6453,22 +8693,43 @@ components: - set - version type: object + NewCampaignSetV2: + description: "" + properties: + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + version: + description: Version of the campaign set. + minimum: 1 + type: integer + set: + $ref: '#/components/schemas/CampaignPrioritiesV2' + required: + - applicationId + - set + - version + type: object ReferralConstraints: properties: startDate: description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z format: date-time title: Referral code valid from type: string expiryDate: description: Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until type: string usageLimit: description: | - The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. + example: 1 maximum: 999999 minimum: 0 title: Referral code Usage Limit @@ -6477,7 +8738,7 @@ components: UpdateReferralBatch: properties: attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object batchID: @@ -6487,18 +8748,21 @@ components: type: string startDate: description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z format: date-time title: Referral code valid from type: string expiryDate: description: Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until type: string usageLimit: description: | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + example: 1 maximum: 999999 minimum: 0 title: Referral code Usage Limit @@ -6509,28 +8773,31 @@ components: NewReferral: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - friendProfileIntegrationId: friendProfileIntegrationId - usageLimit: 80082 - campaignId: 6 + expiryDate: 2021-11-10T23:00:00Z + friendProfileIntegrationId: BZGGC2454PA + usageLimit: 1 + campaignId: 78 attributes: '{}' - startDate: 2000-01-23T04:56:07.000+00:00 - advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2020-11-10T23:00:00Z + advocateProfileIntegrationId: URNGV8294NV properties: startDate: description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z format: date-time title: Referral code valid from type: string expiryDate: description: Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until type: string usageLimit: description: | - The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. + example: 1 maximum: 999999 minimum: 0 title: Referral code Usage Limit @@ -6538,14 +8805,18 @@ components: campaignId: description: ID of the campaign from which the referral received the referral code. + example: 78 title: Referral's Campaign ID type: integer advocateProfileIntegrationId: description: The Integration ID of the Advocate's Profile. + example: URNGV8294NV + maxLength: 1000 title: Advocate's Profile ID type: string friendProfileIntegrationId: - description: An optional Integration ID of the Friend's Profile + description: An optional Integration ID of the Friend's Profile. + example: BZGGC2454PA title: Friend's Profile ID type: string attributes: @@ -6565,42 +8836,47 @@ components: Referral: description: "" example: - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string startDate: description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z format: date-time title: Referral code valid from type: string expiryDate: description: Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until type: string usageLimit: description: | - The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. + example: 1 maximum: 999999 minimum: 0 title: Referral code Usage Limit @@ -6608,14 +8884,18 @@ components: campaignId: description: ID of the campaign from which the referral received the referral code. + example: 78 title: Referral's Campaign ID type: integer advocateProfileIntegrationId: description: The Integration ID of the Advocate's Profile. + example: URNGV8294NV + maxLength: 1000 title: Advocate's Profile ID type: string friendProfileIntegrationId: - description: An optional Integration ID of the Friend's Profile + description: An optional Integration ID of the Friend's Profile. + example: BZGGC2454PA title: Friend's Profile ID type: string attributes: @@ -6626,17 +8906,20 @@ components: description: The ID of the Import which created this referral. type: integer code: - description: The actual referral code. + description: The referral code. + example: 27G47Y54VH9L minLength: 4 title: Referral code type: string usageCounter: description: The number of times this referral code has been successfully used. + example: 1 title: Referral code Usages type: integer batchId: description: The ID of the batch the referrals belong to. + example: tqyrgahe title: Batch ID type: string required: @@ -6650,72 +8933,82 @@ components: type: object UpdateReferral: example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - friendProfileIntegrationId: friendProfileIntegrationId - usageLimit: 80082 + expiryDate: 2021-11-10T23:00:00Z + friendProfileIntegrationId: BZGGC2454PA + usageLimit: 1 attributes: '{}' - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z properties: friendProfileIntegrationId: - description: An optional Integration ID of the Friend's Profile + description: An optional Integration ID of the Friend's Profile. + example: BZGGC2454PA + maxLength: 1000 title: Friend's Profile ID type: string startDate: description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z format: date-time title: Referral code valid from type: string expiryDate: description: Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until type: string usageLimit: description: | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + example: 1 maximum: 999999 minimum: 0 title: Referral code Usage Limit type: integer attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object type: object NewReferralsForMultipleAdvocates: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 + expiryDate: 2021-11-10T23:00:00Z advocateProfileIntegrationIds: - - advocateProfileIntegrationIds - - advocateProfileIntegrationIds - - advocateProfileIntegrationIds - - advocateProfileIntegrationIds - - advocateProfileIntegrationIds + - URNGV8294NV + - DRPVV9476AF validCharacters: - - validCharacters - - validCharacters - usageLimit: 80082 - campaignId: 6 - referralPattern: referralPattern + - E + - F + - I + - Z + - "1" + - "2" + - "3" + usageLimit: 1 + campaignId: 45 + referralPattern: REF-###-### attributes: '{}' - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z properties: startDate: description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z format: date-time title: Referral code valid from type: string expiryDate: description: Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until type: string usageLimit: description: | - The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. + example: 1 maximum: 999999 minimum: 0 title: Referral code Usage Limit @@ -6723,10 +9016,14 @@ components: campaignId: description: The ID of the campaign from which the referral received the referral code. + example: 45 title: Referral's Campaign ID type: integer advocateProfileIntegrationIds: description: An array containing all the respective advocate profiles. + example: + - URNGV8294NV + - DRPVV9476AF items: type: string maxItems: 1000 @@ -6738,14 +9035,24 @@ components: properties: {} type: object validCharacters: - description: Set of characters to be used when generating random part of - code. Defaults to [A-Z, 0-9] (in terms of RegExp). + description: | + List of characters used to generate the random parts of a code. By default, the list of characters + is equivalent to the `[A-Z, 0-9]` regular expression. + example: + - E + - F + - I + - Z + - "1" + - "2" + - "3" items: type: string type: array referralPattern: description: | - The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. + example: REF-###-### maxLength: 100 minLength: 3 type: string @@ -6754,19 +9061,126 @@ components: - campaignId - usageLimit type: object + InventoryReferral: + description: "" + example: + code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 5 + friendProfileIntegrationId: BZGGC2454PA + attributes: '{}' + referredCustomers: + - referredCustomers + - referredCustomers + id: 6 + startDate: 2020-11-10T23:00:00Z + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + startDate: + description: Timestamp at which point the referral code becomes valid. + example: 2020-11-10T23:00:00Z + format: date-time + title: Referral code valid from + type: string + expiryDate: + description: Expiry date of the referral code. Referral never expires if + this is omitted, zero, or negative. + example: 2021-11-10T23:00:00Z + format: date-time + title: Referral code valid until + type: string + usageLimit: + description: | + The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. + example: 1 + maximum: 999999 + minimum: 0 + title: Referral code Usage Limit + type: integer + campaignId: + description: ID of the campaign from which the referral received the referral + code. + example: 78 + title: Referral's Campaign ID + type: integer + advocateProfileIntegrationId: + description: The Integration ID of the Advocate's Profile. + example: URNGV8294NV + maxLength: 1000 + title: Advocate's Profile ID + type: string + friendProfileIntegrationId: + description: An optional Integration ID of the Friend's Profile. + example: BZGGC2454PA + title: Friend's Profile ID + type: string + attributes: + description: Arbitrary properties associated with this item. + properties: {} + type: object + importId: + description: The ID of the Import which created this referral. + type: integer + code: + description: The referral code. + example: 27G47Y54VH9L + minLength: 4 + title: Referral code + type: string + usageCounter: + description: The number of times this referral code has been successfully + used. + example: 1 + title: Referral code Usages + type: integer + batchId: + description: The ID of the batch the referrals belong to. + example: tqyrgahe + title: Batch ID + type: string + referredCustomers: + description: An array of referred customers. + items: + type: string + type: array + required: + - advocateProfileIntegrationId + - campaignId + - code + - created + - id + - referredCustomers + - usageCounter + - usageLimit + type: object AttributeQuery: description: Object representing a set of of attributes and their respective values. example: - language: english + my_attribute_1: some value + my_attribute_2: some other value + my_attribute_3: some other value type: object CouponSearch: - example: - attributes: '{}' properties: attributes: description: Properties to match against a coupon. All provided attributes - will be exactly matched against attributes + will be exactly matched against attributes. properties: {} type: object required: @@ -6778,7 +9192,7 @@ components: properties: attributes: description: Properties to match against a campaign. All provided attributes - will be exactly matched against campaign attributes + will be exactly matched against campaign attributes. properties: {} type: object required: @@ -6802,11 +9216,11 @@ components: properties: name: description: Name of the copied campaign (Defaults to "Copy of original - campaign name") + campaign name"). type: string applicationIds: description: Application IDs of the applications to which a campaign should - be copied to + be copied to. items: type: integer type: array @@ -6837,21 +9251,34 @@ components: description: "" example: expiryDate: 2000-01-23T04:56:07.000+00:00 - recipientIntegrationId: recipientIntegrationId + recipientIntegrationId: URNGV8294NV uniquePrefix: uniquePrefix - couponPattern: couponPattern + couponPattern: SUMMER-##### validCharacters: - - validCharacters - - validCharacters + - A + - B + - G + - "Y" usageLimit: 100 - numberOfCoupons: 0 + numberOfCoupons: 1 attributes: '{}' discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon properties: usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -6872,31 +9299,53 @@ components: omitted, zero, or negative. format: date-time type: string + limits: + description: | + Limits configuration for a coupon. These limits will override the limits + set from the campaign. + + **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. + Only per-profile limits are allowed to be configured. + items: + $ref: '#/components/schemas/LimitConfig' + type: array numberOfCoupons: description: The number of new coupon codes to generate for the campaign. Must be at least 1. + example: 1 type: integer uniquePrefix: - description: A unique prefix to prepend to all generated coupons. + description: | + **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously endpoint](https://docs.talon.one/management-api/#operation/createCouponsAsync). title: Coupon code unique prefix type: string attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object recipientIntegrationId: - description: The integration ID for this coupon's beneficiary's profile + description: The integration ID for this coupon's beneficiary's profile. + example: URNGV8294NV + maxLength: 1000 title: Receiving customer profile integration ID type: string validCharacters: - description: Set of characters to be used when generating random part of - code. Defaults to [A-Z, 0-9] (in terms of RegExp). + description: | + List of characters used to generate the random parts of a code. By default, + the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. + example: + - A + - B + - G + - "Y" items: type: string type: array couponPattern: description: | - The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + The pattern used to generate coupon codes. + The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. + example: SUMMER-##### maxLength: 100 minLength: 3 type: string @@ -6925,7 +9374,7 @@ components: properties: usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -6947,11 +9396,11 @@ components: format: date-time type: string attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object recipientsIntegrationIds: - description: The integration IDs for recipients + description: The integration IDs for recipients. items: type: string maxItems: 1000 @@ -6959,14 +9408,15 @@ components: title: Receiving customer profiles integration IDs type: array validCharacters: - description: Set of characters to be used when generating random part of - code. Defaults to [A-Z, 0-9] (in terms of RegExp). + description: | + List of characters used to generate the random parts of a code. By default, the list of + characters is equivalent to the `[A-Z, 0-9]` regular expression. items: type: string type: array couponPattern: description: | - The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. maxLength: 100 minLength: 3 type: string @@ -6983,10 +9433,21 @@ components: attributes: '{}' discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon properties: usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -7007,12 +9468,23 @@ components: omitted, zero, or negative. format: date-time type: string + limits: + description: | + Limits configuration for a coupon. These limits will override the limits + set from the campaign. + + **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. + Only per-profile limits are allowed to be configured. + items: + $ref: '#/components/schemas/LimitConfig' + type: array recipientIntegrationId: - description: The integration ID for this coupon's beneficiary's profile + description: The integration ID for this coupon's beneficiary's profile. + maxLength: 1000 title: Receiving customer profile integration ID type: string attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object type: object @@ -7028,7 +9500,7 @@ components: properties: usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -7050,43 +9522,54 @@ components: format: date-time type: string attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object batchID: description: The id of the batch the coupon belongs to. title: Batch ID type: string - required: - - batchID type: object Coupon: description: "" example: - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string campaignId: @@ -7095,14 +9578,14 @@ components: title: Campaign ID type: integer value: - description: The actual coupon code. + description: The coupon code. example: XMAS-20-2021 minLength: 4 title: Coupon Code type: string usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -7123,6 +9606,16 @@ components: omitted, zero, or negative. format: date-time type: string + limits: + description: | + Limits configuration for a coupon. These limits will override the limits + set from the campaign. + + **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. + Only per-profile limits are allowed to be configured. + items: + $ref: '#/components/schemas/LimitConfig' + type: array usageCounter: description: The number of times this coupon has been successfully used. example: 10 @@ -7138,7 +9631,7 @@ components: title: Coupon Discount Remainder type: number attributes: - description: Arbitrary properties associated with this item + description: Custom attributes associated with this coupon. properties: {} title: Attributes of coupon type: object @@ -7151,6 +9644,8 @@ components: recipientIntegrationId: description: The Integration ID of the customer that is allowed to redeem this coupon. + example: URNGV8294NV + maxLength: 1000 title: Recipient ID type: string importId: @@ -7158,11 +9653,12 @@ components: title: Import ID type: integer reservation: - description: This value controls what reservations mean to a coupon. If - set to true the coupon reservation is used to mark it as a favorite, if - set to false the coupon reservation is used as a requirement of usage. - This value defaults to true if not specified. - example: true + default: true + description: | + Defines the type of reservation: + - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation endpoint](/integration-api/#operation/createCouponReservation). + - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons endpoint](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients endpoint](/management-api/#operation/createCouponsForMultipleRecipients). + example: false title: Reservation Status type: boolean batchId: @@ -7181,8 +9677,8 @@ components: InventoryCoupon: description: "" example: - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 @@ -7192,21 +9688,34 @@ components: discountCounter: 0.8008281904610115 expiryDate: 2000-01-23T04:56:07.000+00:00 importId: 1 - reservation: true + reservation: false attributes: '{}' id: 6 - state: state + state: active value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon discountRemainder: 6.027456183070403 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string campaignId: @@ -7215,14 +9724,14 @@ components: title: Campaign ID type: integer value: - description: The actual coupon code. + description: The coupon code. example: XMAS-20-2021 minLength: 4 title: Coupon Code type: string usageLimit: description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. example: 100 maximum: 999999 minimum: 0 @@ -7243,7 +9752,17 @@ components: omitted, zero, or negative. format: date-time type: string - usageCounter: + limits: + description: | + Limits configuration for a coupon. These limits will override the limits + set from the campaign. + + **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. + Only per-profile limits are allowed to be configured. + items: + $ref: '#/components/schemas/LimitConfig' + type: array + usageCounter: description: The number of times this coupon has been successfully used. example: 10 title: Number of coupon usages @@ -7258,7 +9777,7 @@ components: title: Coupon Discount Remainder type: number attributes: - description: Arbitrary properties associated with this item + description: Custom attributes associated with this coupon. properties: {} title: Attributes of coupon type: object @@ -7271,6 +9790,8 @@ components: recipientIntegrationId: description: The Integration ID of the customer that is allowed to redeem this coupon. + example: URNGV8294NV + maxLength: 1000 title: Recipient ID type: string importId: @@ -7278,11 +9799,12 @@ components: title: Import ID type: integer reservation: - description: This value controls what reservations mean to a coupon. If - set to true the coupon reservation is used to mark it as a favorite, if - set to false the coupon reservation is used as a requirement of usage. - This value defaults to true if not specified. - example: true + default: true + description: | + Defines the type of reservation: + - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation endpoint](/integration-api/#operation/createCouponReservation). + - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons endpoint](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients endpoint](/management-api/#operation/createCouponsForMultipleRecipients). + example: false title: Reservation Status type: boolean batchId: @@ -7296,13 +9818,14 @@ components: type: integer state: description: | - Can be either active, used, expired, pending or disabled. - active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. - used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. - expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. - pending: coupons that have a start date in the future. - disabled: coupons of non-active campaigns. - title: State of the coupon + Can be: + + - `active`: The coupon can be used. It is a reserved coupon that is neither pending, used nor expired, and has a non-exhausted limit counter. + - `used`: The coupon has been redeemed and cannot be used again. It is not pending and has reached its redemption limit or was redeemed by the profile before expiration. + - `expired`: The coupon was never redeemed and it is now expired. It is non-pending, non-active and non-used by the profile. + - `pending`: The coupon will be usable in the future. + - `disabled`: The coupon is part of a non-active campaign. + example: active type: string required: - campaignId @@ -7566,14 +10089,14 @@ components: - createdViaRuleEngine type: object ApplicationApiHealth: - description: Report of health of the API connection of an application + description: Report of health of the API connection of an application. example: summary: OK - lastUsed: 2000-01-23T04:56:07.000+00:00 + lastUsed: 2021-09-12T10:12:42Z properties: summary: description: One-word summary of the health of the API connection of an - application + application. enum: - OK - WARNING @@ -7582,7 +10105,8 @@ components: - NONE type: string lastUsed: - description: time of last request relevant to the API health test + description: time of last request relevant to the API health test. + example: 2021-09-12T10:12:42Z format: date-time type: string required: @@ -7590,7 +10114,7 @@ components: - summary type: object AccessLogEntry: - description: Log of application accesses + description: Log of application accesses. example: method: method requestPayload: requestPayload @@ -7601,13 +10125,13 @@ components: status: 0 properties: uuid: - description: UUID reference of request + description: UUID reference of request. type: string status: - description: HTTP status code of response + description: HTTP status code of response. type: integer method: - description: HTTP method of request + description: HTTP method of request. type: string requestUri: description: target URI of request @@ -7632,7 +10156,7 @@ components: - uuid type: object WebhookLogEntry: - description: Log of webhook api calls + description: Log of webhook api calls. example: requestTime: 2000-01-23T04:56:07.000+00:00 request: request @@ -7646,17 +10170,17 @@ components: status: 5 properties: id: - description: UUID reference of the webhook request + description: UUID reference of the webhook request. type: string integrationRequestUuid: description: UUID reference of the integration request linked to this webhook - request + request. type: string webhookId: - description: ID of the webhook that triggered the request + description: ID of the webhook that triggered the request. type: integer applicationId: - description: ID of the application that triggered the webhook + description: ID of the application that triggered the webhook. type: integer url: description: Target url of request @@ -7668,7 +10192,7 @@ components: description: Response message type: string status: - description: HTTP status code of response + description: HTTP status code of response. type: integer requestTime: description: Timestamp of request @@ -7687,7 +10211,7 @@ components: - webhookId type: object WebhookActivationLogEntry: - description: Log of activated webhooks + description: Log of activated webhooks. example: webhookId: 6 campaignId: 5 @@ -7697,16 +10221,16 @@ components: properties: integrationRequestUuid: description: UUID reference of the integration request that triggered the - effect with the webhook + effect with the webhook. type: string webhookId: - description: ID of the webhook that triggered the request + description: ID of the webhook that triggered the request. type: integer applicationId: - description: ID of the application that triggered the webhook + description: ID of the application that triggered the webhook. type: integer campaignId: - description: ID of the campaign that triggered the webhook + description: ID of the campaign that triggered the webhook. type: integer created: description: Timestamp of request @@ -7722,32 +10246,35 @@ components: User: description: "" example: - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z roles: - - 6 - - 6 + - 71 accountId: 3886 applicationNotificationSubscriptions: '{}' - inviteToken: inviteToken - name: name - modified: 2000-01-23T04:56:07.000+00:00 + inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 + name: John Doe + modified: 2021-09-12T10:12:42Z id: 6 state: invited - latestFeedTimestamp: 2000-01-23T04:56:07.000+00:00 - authMethod: authMethod + latestFeedTimestamp: 2020-06-01T00:00:00Z + authMethod: basic_auth email: john.doe@example.com - policy: '{}' + policy: + Role: 127 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string email: @@ -7761,6 +10288,7 @@ components: type: integer inviteToken: description: Invite token, empty if the user as already accepted their invite. + example: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 type: string state: description: Current user state. @@ -7768,20 +10296,27 @@ components: - invited - active - deactivated + example: invited type: string name: description: Full name + example: John Doe type: string policy: description: User ACL Policy + example: + Role: 127 properties: {} type: object latestFeedTimestamp: description: Latest timestamp the user has been notified for feed. + example: 2020-06-01T00:00:00Z format: date-time type: string roles: - description: Contains a list of all roles the user is a member of + description: Contains a list of all roles the user is a member of. + example: + - 71 items: type: integer type: array @@ -7789,7 +10324,8 @@ components: properties: {} type: object authMethod: - description: The Authentication method for this user + description: The Authentication method for this user. + example: basic_auth type: string required: - accountId @@ -7803,19 +10339,26 @@ components: - state type: object NewInvitation: - description: Parameters for inviting a new user + description: Parameters for inviting a new user. properties: name: description: Name of the user being invited. + example: John Doe type: string email: + example: john.doe@example.com format: email type: string acl: - description: a blob of acl json + description: | + The `Access Control List` json defining the role of the user. This represents the actual access control on the user level. + Use one of the following: + - normal user: `{"Role": 0}` + - admin: `{"Role": 127}` + example: '{"Role":0}' type: string roles: - description: An array of roleIDs to assign the new user to + description: An array of roleIDs to assign the new user to. items: type: integer type: array @@ -7826,30 +10369,43 @@ components: Change: description: "" example: - new: '{}' - created: 2000-01-23T04:56:07.000+00:00 + new: + applicationId": 359 + attributes": {} + campaignGroups": [] + created": 2022-07-08T13:04:02.972762328Z + description": "" + features": + - referrals + - loyalty + id: 6727 + created: 2020-06-10T09:05:27.993483Z old: '{}' id: 6 - applicationId: 1 + applicationId: 359 userId: 6 - entity: entity + entity: /v1/applications/359/campaigns/6727 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string userId: description: The ID of the account that owns this entity. type: integer applicationId: - description: ID of application associated with change + description: ID of application associated with change. + example: 359 type: integer entity: description: API endpoint on which the change was initiated. + example: /v1/applications/359/campaigns/6727 type: string old: description: Resource before the change occurred. @@ -7857,6 +10413,16 @@ components: type: object new: description: Resource after the change occurred. + example: + applicationId": 359 + attributes": {} + campaignGroups": [] + created": 2022-07-08T13:04:02.972762328Z + description": "" + features": + - referrals + - loyalty + id: 6727 properties: {} type: object required: @@ -7866,23 +10432,24 @@ components: - userId type: object LoyaltyPoints: - description: Points to add or deduct + description: Points to add or deduct. example: name: name validityDuration: validityDuration pendingDuration: pendingDuration subLedgerID: subLedgerID - points: 8008281.904610115 + points: 300.0 properties: points: - description: Amount of loyalty points - exclusiveMaximum: true + description: Amount of loyalty points. + example: 300.0 + exclusiveMaximum: false exclusiveMinimum: true - maximum: 1E+8 + maximum: 999999999999.99 minimum: 0 type: number name: - description: Allows to specify a name for the addition or deduction + description: Allows to specify a name/reason for the point addition or deduction. type: string validityDuration: description: Indicates the duration after which the added loyalty points @@ -7896,7 +10463,7 @@ components: type: string subLedgerID: description: This specifies if we are adding loyalty points to the main - ledger or a subledger + ledger or a subledger. type: string required: - points @@ -7904,47 +10471,62 @@ components: LoyaltyProgram: description: "" example: - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending + cardBased: true tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description - id: 6 - title: title + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program + id: 6 properties: id: - description: The ID of loyalty program. Unique ID for this entity. + description: The ID of loyalty program. Unique ID for this entity. Not to + be confused with the Integration ID, which is set by your integration + layer and used in most endpoints. type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string title: description: The display title for the Loyalty Program. + example: Point collection type: string description: description: Description of our Loyalty Program. + example: Customers collect 10 points per 1$ spent type: string subscribedApplications: description: A list containing the IDs of all applications that are subscribed to this Loyalty Program. + example: + - 132 + - 97 items: type: integer type: array @@ -7952,34 +10534,72 @@ components: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. + example: unlimited type: string defaultPending: description: Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + example: immediate type: string allowSubledger: - description: Indicates if this program supports subledgers inside the program + description: Indicates if this program supports subledgers inside the program. + example: false type: boolean - timezone: - description: A string containing an IANA timezone descriptor. - minLength: 1 - type: string + usersPerCardLimit: + description: | + The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. + This property is only used when `cardBased` is `true`. + example: 111 + minimum: 0 + type: integer accountID: description: The ID of the Talon.One account that owns this program. + example: 1 type: integer name: description: The internal name for the Loyalty Program. This is an immutable value. + example: my_program type: string tiers: - description: The tiers in this loyalty program + description: The tiers in this loyalty program. + example: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 items: $ref: '#/components/schemas/LoyaltyTier' type: array + timezone: + description: A string containing an IANA timezone descriptor. + example: Europe/Berlin + minLength: 1 + type: string + cardBased: + default: false + description: | + Defines the type of loyalty program: + - `true`: the program is a card-based. + - `false`: the program is profile-based. + example: true + type: boolean required: - accountID - allowSubledger + - cardBased - created - defaultPending - defaultValidity @@ -7987,36 +10607,36 @@ components: - id - name - subscribedApplications + - timezone - title type: object LoyaltyTier: description: "" - example: - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string programID: description: The ID of the loyalty program that owns this entity. + example: 125 type: integer name: description: The name of the tier + example: Gold type: string minPoints: description: The minimum amount of points required to be eligible for the - tier - exclusiveMaximum: true - maximum: 1E+8 + tier. + example: 300.0 + exclusiveMaximum: false + maximum: 999999999999.99 minimum: 0 type: number required: @@ -8027,16 +10647,18 @@ components: - programID type: object NewLoyaltyTier: - description: A tier in a loyalty program + description: A tier in a loyalty program. properties: name: description: The name of the tier + example: Gold type: string minPoints: description: The minimum amount of points required to be eligible for the - tier - exclusiveMaximum: true - maximum: 1E+8 + tier. + example: 300.0 + exclusiveMaximum: false + maximum: 999999999999.99 minimum: 0 type: number required: @@ -8047,13 +10669,18 @@ components: properties: title: description: The display title for the Loyalty Program. + example: Point collection type: string description: description: Description of our Loyalty Program. + example: Customers collect 10 points per 1$ spent type: string subscribedApplications: description: A list containing the IDs of all applications that are subscribed to this Loyalty Program. + example: + - 132 + - 97 items: type: integer type: array @@ -8061,32 +10688,43 @@ components: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. + example: unlimited type: string defaultPending: description: Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + example: immediate type: string allowSubledger: - description: Indicates if this program supports subledgers inside the program + description: Indicates if this program supports subledgers inside the program. + example: false type: boolean - timezone: - description: A string containing an IANA timezone descriptor. - minLength: 1 - type: string + usersPerCardLimit: + description: | + The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. + This property is only used when `cardBased` is `true`. + example: 111 + minimum: 0 + type: integer type: object NewLoyaltyProgram: description: "" properties: title: description: The display title for the Loyalty Program. + example: Point collection type: string description: description: Description of our Loyalty Program. + example: Customers collect 10 points per 1$ spent type: string subscribedApplications: description: A list containing the IDs of all applications that are subscribed to this Loyalty Program. + example: + - 132 + - 97 items: type: integer type: array @@ -8094,33 +10732,54 @@ components: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. + example: unlimited type: string defaultPending: description: Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + example: immediate type: string allowSubledger: - description: Indicates if this program supports subledgers inside the program + description: Indicates if this program supports subledgers inside the program. + example: false type: boolean - timezone: - description: A string containing an IANA timezone descriptor. - minLength: 1 - type: string + usersPerCardLimit: + description: | + The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. + This property is only used when `cardBased` is `true`. + example: 111 + minimum: 0 + type: integer name: description: The internal name for the Loyalty Program. This is an immutable value. + example: GeneralPointCollection type: string tiers: - description: The tiers in this loyalty program + description: The tiers in this loyalty program. items: $ref: '#/components/schemas/NewLoyaltyTier' type: array + timezone: + description: A string containing an IANA timezone descriptor. + minLength: 1 + type: string + cardBased: + default: false + description: | + Defines the type of loyalty program: + - `true`: the program is a card-based. + - `false`: the program is profile-based. + example: true + type: boolean required: - allowSubledger + - cardBased - defaultPending - defaultValidity - name + - timezone - title type: object UpdateLoyaltyProgram: @@ -8128,13 +10787,18 @@ components: properties: title: description: The display title for the Loyalty Program. + example: Point collection type: string description: description: Description of our Loyalty Program. + example: Customers collect 10 points per 1$ spent type: string subscribedApplications: description: A list containing the IDs of all applications that are subscribed to this Loyalty Program. + example: + - 132 + - 97 items: type: integer type: array @@ -8142,38 +10806,58 @@ components: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. + example: unlimited type: string defaultPending: description: Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + example: immediate type: string allowSubledger: - description: Indicates if this program supports subledgers inside the program + description: Indicates if this program supports subledgers inside the program. + example: false type: boolean - timezone: - description: A string containing an IANA timezone descriptor. - minLength: 1 - type: string + usersPerCardLimit: + description: | + The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. + This property is only used when `cardBased` is `true`. + example: 111 + minimum: 0 + type: integer tiers: - description: The tiers in this loyalty program + description: The tiers in this loyalty program. items: $ref: '#/components/schemas/NewLoyaltyTier' type: array type: object + LoyaltyLedgerTransactions: + description: List of loyalty ledger transactions. + properties: + hasMore: + description: true means there is more data in the source collection to request. + example: true + type: boolean + data: + description: List of transaction entries from a loyalty ledger. + items: + $ref: '#/components/schemas/LoyaltyLedgerEntry' + type: array + type: object LoyaltyLedgerEntry: description: A single row of the ledger, describing one addition or deduction. example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 properties: @@ -8184,6 +10868,8 @@ components: type: integer customerProfileID: type: string + cardID: + type: integer customerSessionID: type: string eventID: @@ -8206,7 +10892,7 @@ components: type: string subLedgerID: description: This specifies if we are adding loyalty points to the main - ledger or a subledger + ledger or a subledger. type: string userID: description: This is the ID of the user who created this entry, if the addition @@ -8215,12 +10901,45 @@ components: required: - amount - created - - customerProfileID - name - programID - subLedgerID - type type: object + LoyaltyBalances: + description: List of loyalty balances for a ledger and its subledgers. + properties: + balance: + $ref: '#/components/schemas/LoyaltyBalance' + subledgerBalances: + additionalProperties: + $ref: '#/components/schemas/LoyaltyBalance' + description: Map of the loyalty balances of the subledgers of a ledger. + type: object + type: object + LoyaltyBalance: + description: Point balance of a ledger in the Loyalty Program. + properties: + activePoints: + description: Total amount of points awarded to this customer and available + to spend. + title: Current Balance + type: number + pendingPoints: + description: Total amount of points awarded to this customer but not available + until their start date. + title: Total pending points + type: number + spentPoints: + description: Total amount of points already spent by this customer. + title: Total spent points + type: number + expiredPoints: + description: Total amount of points awarded but never redeemed. They cannot + be used anymore. + title: Total expired points + type: number + type: object LoyaltyLedger: description: Ledger of Balance in Loyalty Program for a Customer. example: @@ -8228,134 +10947,144 @@ components: total: 0.8008281904610115 totalSpentPoints: 5.962133916683182 activePoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 expiringPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 totalActivePoints: 6.027456183070403 totalPendingPoints: 1.4658129805029452 totalExpiredPoints: 5.637376656633329 transactions: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 expiredPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 currentTier: - name: name - id: 9 + name: bronze + id: 11 pendingPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 subLedgers: @@ -8363,134 +11092,144 @@ components: total: 0.8008281904610115 totalSpentPoints: 5.962133916683182 activePoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 expiringPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 totalActivePoints: 6.027456183070403 totalPendingPoints: 1.4658129805029452 totalExpiredPoints: 5.637376656633329 transactions: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 expiredPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 currentTier: - name: name - id: 9 + name: bronze + id: 11 pendingPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 properties: @@ -8510,140 +11249,150 @@ components: total: 0.8008281904610115 totalSpentPoints: 5.962133916683182 activePoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 expiringPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 totalActivePoints: 6.027456183070403 totalPendingPoints: 1.4658129805029452 totalExpiredPoints: 5.637376656633329 transactions: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 expiredPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 currentTier: - name: name - id: 9 + name: bronze + id: 11 pendingPoints: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 7 - amount: 9.301444243932576 - customerProfileID: customerProfileID + - eventID: 9 + amount: 3.616076749251911 created: 2000-01-23T04:56:07.000+00:00 - name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 3 + userID: 2 + expiryDate: 2000-01-23T04:56:07.000+00:00 + customerProfileID: customerProfileID + cardID: 7 + name: name programID: 2 startDate: 2000-01-23T04:56:07.000+00:00 properties: total: description: | - ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance. + **DEPRECATED** Use `totalActivePoints` property instead. Total amount of currently active and available points in the customer's balance. title: Current Balance (Deprecated) type: number totalActivePoints: @@ -8702,37 +11451,255 @@ components: Loyalty: description: Customer specific information about loyalty points. example: + cards: + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status programs: key: ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 + name: bronze + id: 11 subLedgers: key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 - name: name - id: 1 - title: title + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program properties: + cards: + description: Displays information about the balances of the loyalty cards. + items: + $ref: '#/components/schemas/LoyaltyCard' + title: Point balances of the loyalty cards used. + type: array programs: additionalProperties: $ref: '#/components/schemas/LoyaltyProgramLedgers' - description: A map holding information about the loyalty programs balance + description: Displays information about point balances in profile-based + programs. title: Customer's current loyalty program balance. type: object required: @@ -8742,45 +11709,96 @@ components: description: Customer specific information about loyalty points. example: ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 + name: bronze + id: 11 subLedgers: key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 - name: name - id: 1 - title: title + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program properties: id: - description: The internal ID of loyalty program + description: The internal ID of loyalty program. + example: 5 type: integer title: - description: Visible name of loyalty program + description: Visible name of loyalty program. + example: My loyalty program type: string name: - description: Internal name of loyalty program + description: Internal name of loyalty program. + example: program1 type: string ledger: $ref: '#/components/schemas/LedgerInfo' subLedgers: additionalProperties: $ref: '#/components/schemas/LedgerInfo' - description: A map containing information about each loyalty subledger + description: A map containing information about each loyalty subledger. type: object required: - id @@ -8791,42 +11809,74 @@ components: LedgerInfo: description: "" example: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 + name: bronze + id: 11 properties: currentBalance: - description: Sum of current active points amounts + description: Sum of currently active points. + example: 46.0 title: Current balance type: number pendingBalance: - description: Sum of pending points amounts + description: Sum of pending points. + example: 10.0 title: Pending balance type: number expiredBalance: - description: Sum of expired points amounts + description: Sum of expired points. + example: 30.0 title: Expired balance type: number spentBalance: - description: Sum of spent points amounts + description: Sum of spent points. + example: 84.0 title: Spent balance type: number tentativeCurrentBalance: - description: Sum of current active points amounts, including additions and - deductions on open sessions + description: Sum of currently active points, including points added and + deducted in open sessions. + example: 56.0 title: Tentative current balance type: number currentTier: $ref: '#/components/schemas/Tier' pointsToNextTier: description: Points required to move up a tier. + example: 20.0 type: number + projection: + $ref: '#/components/schemas/LoyaltyProjection' required: - currentBalance - expiredBalance @@ -8836,41 +11886,491 @@ components: type: object Tier: example: - name: name - id: 9 + name: bronze + id: 11 properties: id: - description: The internal ID of the tier + description: The internal ID of the tier. + example: 11 type: integer name: - description: The name of the tier + description: The name of the tier. + example: bronze + type: string + required: + - id + - name + type: object + LoyaltyCard: + description: "" + example: + ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + programID: + description: The ID of the loyalty program that owns this entity. + example: 125 + type: integer + status: + description: | + Status of the loyalty card. Can be one of: ['active', 'disabled'] + type: string + identifier: + description: The alphanumeric identifier of the loyalty card. + type: string + usersPerCardLimit: + description: | + The max amount of user profiles a card can be shared with. 0 means unlimited. + example: 111 + minimum: 0 + type: integer + profiles: + description: Integration IDs of the customers associated with the card. + items: + $ref: '#/components/schemas/LoyaltyCardProfileRegistration' + type: array + ledger: + $ref: '#/components/schemas/LedgerInfo' + subledgers: + additionalProperties: + $ref: '#/components/schemas/LedgerInfo' + description: Displays point balances of the card in the subledgers of the + loyalty program. + type: object + modified: + description: Timestamp of the most recent update of the loyalty card. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + required: + - created + - id + - identifier + - programID + - status + - usersPerCardLimit + type: object + CardLedgerTransactionLogEntry: + description: Log entry for a given loyalty card transaction. + properties: + created: + description: Date and time the loyalty card transaction occurred. + format: date-time + type: string + programId: + description: ID of the loyalty program. + example: 324 + type: integer + cardIdentifier: + description: Identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 255 + type: string + applicationId: + description: The ID of the Application that owns this entity. + example: 322 + type: integer + sessionId: + description: | + The **internal** ID of the session. + example: 233 + type: integer + customerSessionId: + description: ID of the customer session where the transaction occurred. + example: 05c2da0d-48fa-4aa1-b629-898f58f1584d + maxLength: 255 + type: string + type: + description: | + Type of transaction. Possible values are: + - `addition`: Points were added. + - `subtraction`: Points were subtracted. + enum: + - addition + - subtraction + example: addition + maxLength: 255 + type: string + name: + description: Name or reason of the loyalty ledger transaction. + example: Reward 10% points of a purchase's current total + maxLength: 255 + type: string + startDate: + description: | + Date when points become active. Possible values are: + - `immediate`: Points are active immediately. + - `timestamp value`: Points become active from the given date. + example: 2022-01-02T15:04:05Z07:00 + maxLength: 64 + type: string + expiryDate: + description: | + Date when points expire. Possible values are: + - `unlimited`: Points have no expiration date. + - `timestamp value`: Points become active from the given date. + example: 2022-01-02T15:04:05Z07:00 + type: string + subledgerId: + description: ID of the subledger. + example: sub-123 + maxLength: 64 + type: string + amount: + description: Amount of loyalty points added or deducted in the transaction. + example: 10.25 + type: number + id: + description: ID of the loyalty ledger entry. + example: 123 + type: integer + required: + - amount + - cardIdentifier + - created + - customerSessionId + - expiryDate + - id + - name + - programId + - startDate + - subledgerId + - type + type: object + CardLedgerTransactionLogEntryIntegrationAPI: + description: Log entry for a given loyalty card transaction. + properties: + created: + description: Date and time the loyalty card transaction occurred. + format: date-time + type: string + programId: + description: ID of the loyalty program. + example: 324 + type: integer + cardIdentifier: + description: Identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 255 + type: string + customerSessionId: + description: ID of the customer session where the transaction occurred. + example: 05c2da0d-48fa-4aa1-b629-898f58f1584d + maxLength: 255 + type: string + type: + description: | + Type of transaction. Possible values are: + - `addition`: Points were added. + - `subtraction`: Points were subtracted. + enum: + - addition + - subtraction + example: addition + maxLength: 255 + type: string + name: + description: Name or reason of the loyalty ledger transaction. + example: Reward 10% points of a purchase's current total + maxLength: 255 + type: string + startDate: + description: | + Date when points become active. Possible values are: + - `immediate`: Points are active immediately. + - `timestamp value`: Points become active from the given date. + example: 2022-01-02T15:04:05Z07:00 + maxLength: 64 + type: string + expiryDate: + description: | + Date when points expire. Possible values are: + - `unlimited`: Points have no expiration date. + - `timestamp value`: Points expire on the given date. + example: 2022-01-02T15:04:05Z07:00 + type: string + subledgerId: + description: ID of the subledger. + example: sub-123 + maxLength: 64 + type: string + amount: + description: Amount of loyalty points added or deducted in the transaction. + example: 10.25 + type: number + id: + description: ID of the loyalty ledger transaction. + example: 123 + type: integer + rulesetId: + description: The ID of the ruleset containing the rule that triggered this + effect. + example: 11 + type: integer + ruleName: + description: The name of the rule that triggered this effect. + example: Add 2 points + type: string + required: + - amount + - cardIdentifier + - created + - customerSessionId + - expiryDate + - id + - name + - programId + - startDate + - subledgerId + - type + type: object + LedgerTransactionLogEntryIntegrationAPI: + description: Log entry for a given loyalty card transaction. + example: + expiryDate: 2022-01-02T15:04:05Z07:00 + rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + ruleName: Add 2 points + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + id: 123 + type: addition + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + properties: + created: + description: Date and time the loyalty card transaction occurred. + format: date-time + type: string + programId: + description: ID of the loyalty program. + example: 324 + type: integer + customerSessionId: + description: ID of the customer session where the transaction occurred. + example: 05c2da0d-48fa-4aa1-b629-898f58f1584d + maxLength: 255 + type: string + type: + description: | + Type of transaction. Possible values are: + - `addition`: Points were added. + - `subtraction`: Points were subtracted. + enum: + - addition + - subtraction + example: addition + maxLength: 255 + type: string + name: + description: Name or reason of the loyalty ledger transaction. + example: Reward 10% points of a purchase's current total + maxLength: 255 + type: string + startDate: + description: | + Date when points become active. Possible values are: + - `immediate`: Points are active immediately. + - `timestamp value`: Points become active from the given date. + example: 2022-01-02T15:04:05Z07:00 + maxLength: 64 + type: string + expiryDate: + description: | + Date when points expire. Possible values are: + - `unlimited`: Points have no expiration date. + - `timestamp value`: Points expire on the given date. + example: 2022-01-02T15:04:05Z07:00 + type: string + subledgerId: + description: ID of the subledger. + example: sub-123 + maxLength: 64 + type: string + amount: + description: Amount of loyalty points added or deducted in the transaction. + example: 10.25 + type: number + id: + description: ID of the loyalty ledger transaction. + example: 123 + type: integer + rulesetId: + description: The ID of the ruleset containing the rule that triggered this + effect. + example: 11 + type: integer + ruleName: + description: The name of the rule that triggered this effect. + example: Add 2 points type: string required: + - amount + - created + - customerSessionId + - expiryDate - id - name + - programId + - startDate + - subledgerId + - type + type: object + UpdateLoyaltyCard: + properties: + status: + description: | + Status of the loyalty card. Can be one of: ['active', 'disabled'] + type: string + required: + - status + type: object + LoyaltyCardProfileRegistration: + example: + integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + properties: + integrationId: + description: Integration ID of the customer associated with the card. + maxLength: 1000 + type: string + timestamp: + description: Timestamp of the registration to the card. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + required: + - integrationId + - timestamp + type: object + LoyaltyCardRegistration: + properties: + integrationId: + description: The integrationId of the customer profile. + example: my_customer_profile + title: Customer Profile Id + type: string + required: + - integrationId type: object LoyaltyProgramBalance: description: The balance in a Loyalty Program for some Customer. properties: currentBalance: - description: Sum of current active points amounts + description: Sum of currently active points. + example: 46.0 title: Current balance type: number pendingBalance: - description: Sum of pending points amounts + description: Sum of pending points. + example: 10.0 title: Pending balance type: number expiredBalance: - description: Sum of expired points amounts + description: Sum of expired points. + example: 30.0 title: Expired balance type: number spentBalance: - description: Sum of spent points amounts + description: Sum of spent points. + example: 84.0 title: Spent balance type: number tentativeCurrentBalance: - description: Sum of current active points amounts, including additions and - deductions on open sessions + description: Sum of currently active points, including points added and + deducted in open sessions. + example: 56.0 title: Tentative current balance type: number required: @@ -8880,34 +12380,110 @@ components: - spentBalance - tentativeCurrentBalance type: object - CustomerProfileSearchQuery: + LoyaltyProjection: + description: Group of all loyalty points expected in the future. example: - integrationIDs: - - integrationIDs - - integrationIDs - profileIDs: - - 0 - - 0 - attributes: '{}' + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 properties: - attributes: - description: Properties to match against a customer profile. All provided - attributes will be exactly matched against profile attributes - properties: {} - type: object - integrationIDs: + projections: items: - type: string - type: array - profileIDs: - items: - type: integer + $ref: '#/components/schemas/LoyaltyProjectionData' + maxItems: 31 type: array - type: object - NewCustomerProfile: - properties: + totalExpiringPoints: + description: Sum of points to be expired by the projection date set in the + query parameter. + example: 10.0 + type: number + totalActivatingPoints: + description: Sum of points to be active by the projection date set in the + query parameter. + example: 40.0 + type: number + required: + - totalActivatingPoints + - totalExpiringPoints + type: object + LoyaltyProjectionData: + example: + date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + properties: + date: + description: Specific date of projection. + format: date-time + type: string + expiringPoints: + description: Points that will be expired by the specified date. + example: 14.0 + type: number + activatingPoints: + description: Points that will be active by the specified date. + example: 25.0 + type: number + projectedBalance: + description: Current balance plus projected active points, minus expiring + points. + example: 57.0 + type: number + required: + - activatingPoints + - date + - expiringPoints + - projectedBalance + type: object + CustomerProfileSearchQuery: + example: + integrationIDs: + - integrationIDs + - integrationIDs + profileIDs: + - 0 + - 0 + attributes: '{}' + properties: + attributes: + description: Properties to match against a customer profile. All provided + attributes will be exactly matched against profile attributes. + properties: {} + type: object + integrationIDs: + items: + type: string + type: array + profileIDs: + items: + type: integer + type: array + type: object + NewCustomerProfile: + properties: attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. example: Language: english ShippingCountry: DE @@ -8917,7 +12493,7 @@ components: CustomerProfile: description: "" example: - accountId: 7 + accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -8925,21 +12501,22 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: @@ -8948,13 +12525,13 @@ components: format: date-time type: string integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. + description: The integration ID set by your integration layer. example: URNGV8294NV format: string + maxLength: 1000 type: string attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. example: Language: english ShippingCountry: DE @@ -8962,6 +12539,7 @@ components: type: object accountId: description: The ID of the Talon.One account that owns this profile. + example: 31 title: Profile belongs to Account type: integer closedSessions: @@ -8971,26 +12549,33 @@ components: title: Closed sessions type: integer totalSales: - description: Sum of all purchases made by this customer + description: Sum of all purchases made by this customer. example: 299.99 title: Total Sales type: number loyaltyMemberships: - description: A list of loyalty programs joined by the customer + description: | + **DEPRECATED** A list of loyalty programs joined by the customer. items: $ref: '#/components/schemas/LoyaltyMembership' title: Loyalty programed joined type: array audienceMemberships: - description: A list of audiences the customer belongs to + description: A list of audiences the customer belongs to. items: $ref: '#/components/schemas/AudienceMembership' title: Audience memberships type: array lastActivity: - description: Timestamp of the most recent event received from this customer + description: | + Timestamp of the most recent event received from this customer. + This field is updated on calls that trigger the rule-engine and that are + not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). + + For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) + for a customer doesn't impact this field. + example: 2020-02-08T14:15:20Z format: date-time - title: Last activity of customer type: string required: - accountId @@ -9005,8 +12590,8 @@ components: CustomerInventory: example: coupons: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 @@ -9016,16 +12601,27 @@ components: discountCounter: 0.8008281904610115 expiryDate: 2000-01-23T04:56:07.000+00:00 importId: 1 - reservation: true + reservation: false attributes: '{}' id: 6 - state: state + state: active value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon discountRemainder: 6.027456183070403 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 @@ -9035,43 +12631,60 @@ components: discountCounter: 0.8008281904610115 expiryDate: 2000-01-23T04:56:07.000+00:00 importId: 1 - reservation: true + reservation: false attributes: '{}' id: 6 - state: state + state: active value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon discountRemainder: 6.027456183070403 referrals: - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 5 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' + referredCustomers: + - referredCustomers + - referredCustomers id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + startDate: 2020-11-10T23:00:00Z + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 5 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' + referredCustomers: + - referredCustomers + - referredCustomers id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z profile: - accountId: 7 + accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -9079,59 +12692,270 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 loyalty: + cards: + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status programs: key: ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 + name: bronze + id: 11 subLedgers: key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 - name: name - id: 1 - title: title + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program giveaways: - code: code - importId: 1 + importId: 5 endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z poolId: 4 attributes: '{}' id: 6 used: true startDate: 2000-01-23T04:56:07.000+00:00 - code: code - importId: 1 + importId: 5 endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z poolId: 4 attributes: '{}' id: 6 @@ -9144,9 +12968,11 @@ components: $ref: '#/components/schemas/Loyalty' referrals: items: - $ref: '#/components/schemas/Referral' + $ref: '#/components/schemas/InventoryReferral' type: array coupons: + description: | + The coupons reserved by this profile. This array includes hard and soft reservations. See each coupon's `reservation` property. items: $ref: '#/components/schemas/InventoryCoupon' type: array @@ -9159,9 +12985,10 @@ components: description: "" properties: profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string coupon: @@ -9177,16 +13004,18 @@ components: state: default: open description: | - Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: + Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` - 3. `closed` → `cancelled` + 3. `closed` → `cancelled` or `partially_returned` + 4. `partially_returned` → `cancelled` - For more information, see [Entities](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). enum: - open - closed + - partially_returned - cancelled title: Customer's session state type: string @@ -9201,7 +13030,7 @@ components: Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices - and limit discounts abuse in case of customers creating multiple accounts. + and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). example: - 91.11.156.141 items: @@ -9221,7 +13050,10 @@ components: NewCustomerSessionV2: description: "" example: - couponCodes: XMAS-20-2021 + couponCodes: + - XMAS-20-2021 + loyaltyCards: + - loyalty-card-1 additionalCosts: shipping: price: 9 @@ -9233,73 +13065,109 @@ components: ShippingCity: Berlin state: open cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 properties: profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string couponCodes: - description: Any coupon codes entered. - example: XMAS-20-2021 + description: | + Any coupon codes entered. + + **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign, ensure the session contains a coupon code by the time you close it. + example: + - XMAS-20-2021 items: maxLength: 100 type: string title: Coupons entered in session type: array referralCode: - description: Any referral code entered. + description: | + Any referral code entered. + + **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign, ensure the session contains a referral code by the time you close it. example: NT2K54D9 maxLength: 100 title: Referral code entered in session type: string + loyaltyCards: + description: Any loyalty cards used. + example: + - loyalty-card-1 + items: + type: string + maxItems: 1 + type: array state: default: open description: | - Indicates the current state of the session. Sessions can be created as `open` or `closed`, - after which valid transitions are: + Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` - 3. `closed` → `cancelled` + 3. Either: + - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or + - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) + 4. `partially_returned` → `cancelled` - For more information, see [Entites](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). enum: - open - closed + - partially_returned - cancelled example: open title: Customer's session state type: string cartItems: - description: All items the customer will be purchasing in this session + description: | + The items to add to this sessions. + - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. + - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. items: $ref: '#/components/schemas/CartItem' title: Customer session's cart items @@ -9307,9 +13175,11 @@ components: additionalCosts: additionalProperties: $ref: '#/components/schemas/AdditionalCost' - description: Any costs associated with the session that can not be explicitly - attributed to cart items. Examples include shipping costs and service - fees. + description: | + Use this property to set a value for the additional costs of this session, such as a shipping cost. + + They must be created in the Campaign Manager + before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). example: shipping: price: 9 @@ -9320,6 +13190,10 @@ components: For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. + See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). + + **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign, ensure the session contains an identifier by the time you close it. example: - 91.11.156.141 items: @@ -9328,14 +13202,17 @@ components: type: array attributes: description: | - A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. + Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. + + You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). + Custom attributes must be created in the Campaign Manager before you set them with this property. example: ShippingCity: Berlin properties: {} type: object type: object CustomerAnalytics: - description: "" + description: A summary report of customer activity for a given time range. example: freeItems: 1 acceptedCoupons: 0 @@ -9346,25 +13223,25 @@ components: createdCoupons: 6 properties: acceptedCoupons: - description: Total accepted coupons for this customer + description: Total accepted coupons for this customer. type: integer createdCoupons: - description: Total created coupons for this customer + description: Total created coupons for this customer. type: integer freeItems: - description: Total free items given to this customer + description: Total free items given to this customer. type: integer totalOrders: - description: Total orders made by this customer + description: Total orders made by this customer. type: integer totalDiscountedOrders: - description: Total orders made by this customer that had a discount + description: Total orders made by this customer that had a discount. type: integer totalRevenue: - description: Total Revenue across all closed sessions + description: Total Revenue across all closed sessions. type: number totalDiscounts: - description: The sum of discounts that were given across all closed sessions + description: The sum of discounts that were given across all closed sessions. type: number required: - acceptedCoupons @@ -9376,10 +13253,10 @@ components: - totalRevenue type: object CustomerActivityReport: - description: "" + description: A summary report of customer activity for a given time range. example: couponUseAttempts: 1 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z totalOrdersNoCoupon: 9 integrationId: URNGV8294NV couponRedemptions: 6 @@ -9393,13 +13270,14 @@ components: accruedDiscounts: 5.637376656633329 properties: integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. + description: The integration ID set by your integration layer. example: URNGV8294NV format: string + maxLength: 1000 type: string created: description: The exact moment this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string name: @@ -9454,7 +13332,7 @@ components: description: "" example: coupon: coupon - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z identifiers: - 91.11.156.141 integrationId: integrationId @@ -9467,42 +13345,55 @@ components: state: open applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - updated: 2000-01-23T04:56:07.000+00:00 + updated: 2021-09-12T10:12:42Z firstSession: true properties: integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. + description: The integration ID set by your integration layer. format: string + maxLength: 1000 type: string created: description: The exact moment this entity was created. + example: 2020-02-07T08:15:22Z format: date-time type: string applicationId: @@ -9510,9 +13401,10 @@ components: example: 322 type: integer profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string coupon: @@ -9528,16 +13420,18 @@ components: state: default: open description: | - Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: + Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` - 3. `closed` → `cancelled` + 3. `closed` → `cancelled` or `partially_returned` + 4. `partially_returned` → `cancelled` - For more information, see [Entities](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). enum: - open - closed + - partially_returned - cancelled title: Customer's session state type: string @@ -9552,7 +13446,7 @@ components: Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices - and limit discounts abuse in case of customers creating multiple accounts. + and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). example: - 91.11.156.141 items: @@ -9571,6 +13465,7 @@ components: firstSession: description: Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. + example: true title: First session ever? type: boolean discounts: @@ -9581,7 +13476,8 @@ components: title: Customer's current discounts type: object updated: - description: Timestamp of the most recent event received on this session + description: Timestamp of the most recent event received on this session. + example: 2021-09-12T10:12:42Z format: date-time title: Last activity on the session type: string @@ -9603,107 +13499,153 @@ components: CustomerSessionV2: description: "" example: - couponCodes: XMAS-20-2021 + couponCodes: + - XMAS-20-2021 created: 2000-01-23T04:56:07.000+00:00 identifiers: - 91.11.156.141 integrationId: URNGV8294NV - total: 5.637376656633329 + total: 119.99 + loyaltyCards: + - loyalty-card-1 additionalCosts: shipping: price: 9 - additionalCostTotal: 2.3021358869347655 + additionalCostTotal: 20.0 profileId: URNGV8294NV referralCode: NT2K54D9 attributes: ShippingCity: Berlin + id: 6 state: open applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - updated: 2000-01-23T04:56:07.000+00:00 + updated: 2020-02-08T14:15:22Z firstSession: true cartItemTotal: 99.99 properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. The exact moment + this entity was created. + format: date-time + type: string integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. + description: The integration ID set by your integration layer. example: URNGV8294NV format: string - type: string - created: - description: The exact moment this entity was created. - format: date-time + maxLength: 1000 type: string applicationId: description: The ID of the application that owns this entity. example: 322 type: integer profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string couponCodes: - description: Any coupon codes entered. - example: XMAS-20-2021 + description: | + Any coupon codes entered. + + **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign, ensure the session contains a coupon code by the time you close it. + example: + - XMAS-20-2021 items: maxLength: 100 type: string title: Coupons entered in session type: array referralCode: - description: Any referral code entered. + description: | + Any referral code entered. + + **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign, ensure the session contains a referral code by the time you close it. example: NT2K54D9 maxLength: 100 title: Referral code entered in session type: string + loyaltyCards: + description: Any loyalty cards used. + example: + - loyalty-card-1 + items: + type: string + maxItems: 1 + type: array state: default: open description: | - Indicates the current state of the session. Sessions can be created as `open` or `closed`, - after which valid transitions are: + Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` - 3. `closed` → `cancelled` + 3. Either: + - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or + - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) + 4. `partially_returned` → `cancelled` - For more information, see [Entites](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). enum: - open - closed + - partially_returned - cancelled example: open title: Customer's session state type: string cartItems: - description: All items the customer will be purchasing in this session + description: | + The items to add to this sessions. + - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. + - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. items: $ref: '#/components/schemas/CartItem' title: Customer session's cart items @@ -9711,9 +13653,11 @@ components: additionalCosts: additionalProperties: $ref: '#/components/schemas/AdditionalCost' - description: Any costs associated with the session that can not be explicitly - attributed to cart items. Examples include shipping costs and service - fees. + description: | + Use this property to set a value for the additional costs of this session, such as a shipping cost. + + They must be created in the Campaign Manager + before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). example: shipping: price: 9 @@ -9724,6 +13668,10 @@ components: For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. + See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). + + **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign, ensure the session contains an identifier by the time you close it. example: - 91.11.156.141 items: @@ -9732,7 +13680,10 @@ components: type: array attributes: description: | - A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. + Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. + + You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). + Custom attributes must be created in the Campaign Manager before you set them with this property. example: ShippingCity: Berlin properties: {} @@ -9740,24 +13691,28 @@ components: firstSession: description: Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. + example: true title: First session ever? type: boolean total: description: The total sum of cart-items, as well as additional costs, before - any discounts applied + any discounts applied. + example: 119.99 title: Session Total type: number cartItemTotal: - description: The total sum of cart-items before any discounts applied + description: The total sum of cart-items before any discounts applied. example: 99.99 title: Cart Items Total type: number additionalCostTotal: - description: The total sum of additional costs before any discounts applied + description: The total sum of additional costs before any discounts applied. + example: 20.0 title: Additional Costs Total type: number updated: - description: Timestamp of the most recent event received on this session + description: Timestamp of the most recent event received on this session. + example: 2020-02-08T14:15:22Z format: date-time title: Last activity on the session type: string @@ -9769,6 +13724,7 @@ components: - cartItems - created - firstSession + - id - integrationId - profileId - state @@ -9777,81 +13733,115 @@ components: type: object CartItem: example: + remainingQuantity: 1 quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 properties: name: - description: Name of item + description: Name of item. example: Air Glide minLength: 1 title: Name of item type: string sku: - description: Stock keeping unit of item - example: "124102847" + description: Stock keeping unit of item. + example: SKU1241028 minLength: 1 title: SKU of item type: string quantity: description: | - Quantity of item. **Important:** If you enabled [cart item flattening](https://help.talon.one/hc/en-us/articles/360016036899-Flattening-Cart-Items), + Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. example: 1 minimum: 1 title: Quantity of item type: integer + returnedQuantity: + description: Number of returned items, calculated internally based on returns + of this item. + example: 1 + title: Returned quantity of item + type: integer + remainingQuantity: + description: Remaining quantity of the item, calculated internally based + on returns of this item. + example: 1 + title: Remaining quantity of item + type: integer price: - description: Price of item + description: | + Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/). If it is part of a catalog, setting a price here overrides the price from the catalog. example: 99.99 title: Price of item type: number category: - description: Type, group or model of the item + description: Type, group or model of the item. example: shoes title: Item category type: string weight: - description: Weight of item in grams + description: Weight of item in grams. example: 1130.0 title: Weight of item type: number height: - description: Height of item in mm + description: Height of item in mm. title: Height of item type: number width: - description: Width of item in mm + description: Width of item in mm. title: Width of item type: number length: - description: Length of item in mm + description: Length of item in mm. title: Length of item type: number position: - description: Position of the Cart Item in the Cart (calculated internally) + description: Position of the Cart Item in the Cart (calculated internally). title: Position of Cart Item type: number attributes: description: | - Arbitrary properties associated with this item. - You can use built-in attributes or create your own. See [Attributes](https://docs.talon.one/docs/dev/concepts/attributes). + Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. + + Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. example: image: 11.jpeg material: leather properties: {} title: Item attributes type: object + additionalCosts: + additionalProperties: + $ref: '#/components/schemas/AdditionalCost' + description: | + Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager + before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). + example: + shipping: + price: 9 + type: object + catalogItemID: + description: The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-cart-item-catalogs). + title: The catalog item ID + type: integer required: - name - price @@ -9872,19 +13862,23 @@ components: description: "" properties: profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string type: description: A string representing the event. Must not be a reserved event name. + example: pageViews minLength: 1 title: Event Type type: string attributes: description: Arbitrary additional JSON data associated with the event. + example: + myAttribute: myValue properties: {} type: object required: @@ -9895,30 +13889,35 @@ components: description: "" example: profileId: URNGV8294NV - attributes: '{}' - sessionId: sessionId - type: type + attributes: + myAttribute: myValue + sessionId: 175KJPS947296 + type: pageViews properties: profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string type: description: A string representing the event. Must not be a reserved event name. + example: pageViews minLength: 1 title: Event Type type: string attributes: description: Arbitrary additional JSON data associated with the event. + example: + myAttribute: myValue properties: {} type: object sessionId: description: The ID of the session that this event occurred in. + example: 175KJPS947296 minLength: 1 - title: Session ID of Event type: string required: - attributes @@ -9929,8 +13928,9 @@ components: description: "" example: effects: - - addItemToCart - created: 2000-01-23T04:56:07.000+00:00 + - '{}' + - '{}' + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV meta: campaigns: '{}' @@ -9938,45 +13938,48 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 warnings: '{}' couponRejectionReason: reason: CouponNotFound campaignId: 244 couponId: 4928 ledgerEntries: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + referenceId: 6 + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - attributes: '{}' + referenceId: 6 + attributes: + myAttribute: myValue id: 6 - sessionId: sessionId + sessionId: 175KJPS947296 applicationId: 322 - type: type + type: pageViews properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string applicationId: @@ -9984,30 +13987,35 @@ components: example: 322 type: integer profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string type: description: A string representing the event. Must not be a reserved event name. + example: pageViews minLength: 1 title: Event Type type: string attributes: description: Arbitrary additional JSON data associated with the event. + example: + myAttribute: myValue properties: {} type: object sessionId: description: The ID of the session that this event occurred in. + example: 175KJPS947296 title: Session ID of Event type: string effects: description: | - An array of "effects" that must be applied in response to this event. Example effects include `addItemToCart` or `setDiscount`. - example: - - addItemToCart + An array of effects generated by the rules of the enabled campaigns of the Application. + + You decide how to apply them in your system. See the list of [API effects](/docs/dev/integration-api/api-effects). items: properties: {} type: object @@ -10033,26 +14041,37 @@ components: Contains all state that might interest application integration plugins. This is the response type returned by all of the Integration API operations. example: coupon: - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 session: coupon: coupon - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z identifiers: - 91.11.156.141 integrationId: integrationId @@ -10065,36 +14084,48 @@ components: state: open applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - updated: 2000-01-23T04:56:07.000+00:00 + updated: 2021-09-12T10:12:42Z firstSession: true profile: - accountId: 7 + accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -10102,49 +14133,261 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 loyalty: + cards: + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status programs: key: ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 + name: bronze + id: 11 subLedgers: key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 currentTier: - name: name - id: 9 - name: name - id: 1 - title: title + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program event: effects: - - addItemToCart - created: 2000-01-23T04:56:07.000+00:00 + - '{}' + - '{}' + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV meta: campaigns: '{}' @@ -10152,38 +14395,39 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 warnings: '{}' couponRejectionReason: reason: CouponNotFound campaignId: 244 couponId: 4928 ledgerEntries: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + referenceId: 6 + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - attributes: '{}' + referenceId: 6 + attributes: + myAttribute: myValue id: 6 - sessionId: sessionId + sessionId: 175KJPS947296 applicationId: 322 - type: type + type: pageViews properties: session: $ref: '#/components/schemas/CustomerSession' @@ -10204,9 +14448,372 @@ components: description: | Contains all entities that might interest Talon.One integrations. This is the response type returned by the V2 PUT customer_session endpoint example: + customerProfile: + accountId: 31 + closedSessions: 3 + created: 2000-01-23T04:56:07.000+00:00 + integrationId: URNGV8294NV + attributes: + Language: english + ShippingCountry: DE + totalSales: 299.99 + lastActivity: 2020-02-08T14:15:20Z + id: 6 + loyaltyMemberships: + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 323414846 + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 323414846 + audienceMemberships: + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 + loyalty: + cards: + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + programs: + key: + ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + subLedgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program + awardedGiveaways: + - code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + createdCoupons: + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + usageLimit: 100 + referralId: 326632952 + usageCounter: 10 + batchId: 32535-43255 + discountCounter: 2.3021358869347655 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 9 + reservation: false + attributes: '{}' + id: 6 + value: XMAS-20-2021 + discountLimit: 30.0 + startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + usageLimit: 100 + referralId: 326632952 + usageCounter: 10 + batchId: 32535-43255 + discountCounter: 2.3021358869347655 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 9 + reservation: false + attributes: '{}' + id: 6 + value: XMAS-20-2021 + discountLimit: 30.0 + startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + createdReferrals: + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA + attributes: '{}' + id: 6 + startDate: 2020-11-10T23:00:00Z + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA + attributes: '{}' + id: 6 + startDate: 2020-11-10T23:00:00Z effects: - rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 @@ -10214,303 +14821,324 @@ components: props: '{}' - rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 effectType: rejectCoupon props: '{}' referral: - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 5 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' + referredCustomers: + - referredCustomers + - referredCustomers id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z triggeredCampaigns: - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 coupons: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - customerProfile: - accountId: 7 - closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 - integrationId: URNGV8294NV - attributes: - Language: english - ShippingCountry: DE - totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 - id: 6 - loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 - audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 customerSession: - couponCodes: XMAS-20-2021 + couponCodes: + - XMAS-20-2021 created: 2000-01-23T04:56:07.000+00:00 identifiers: - 91.11.156.141 integrationId: URNGV8294NV - total: 5.637376656633329 + total: 119.99 + loyaltyCards: + - loyalty-card-1 additionalCosts: shipping: price: 9 - additionalCostTotal: 2.3021358869347655 + additionalCostTotal: 20.0 profileId: URNGV8294NV referralCode: NT2K54D9 attributes: ShippingCity: Berlin + id: 6 state: open applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - updated: 2000-01-23T04:56:07.000+00:00 + updated: 2020-02-08T14:15:22Z firstSession: true cartItemTotal: 99.99 - loyalty: - programs: - key: - ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 - currentTier: - name: name - id: 9 - subLedgers: - key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 - currentTier: - name: name - id: 9 - name: name - id: 1 - title: title - awardedGiveaways: - - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + previousReturns: + - returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + sessionId: 123 + applicationId: 322 + - returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 + sessionId: 123 + applicationId: 322 event: effects: - - addItemToCart - created: 2000-01-23T04:56:07.000+00:00 + - '{}' + - '{}' + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV meta: campaigns: '{}' @@ -10518,125 +15146,80 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 warnings: '{}' couponRejectionReason: reason: CouponNotFound campaignId: 244 couponId: 4928 ledgerEntries: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + referenceId: 6 + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - attributes: '{}' + referenceId: 6 + attributes: + myAttribute: myValue id: 6 - sessionId: sessionId + sessionId: 175KJPS947296 applicationId: 322 - type: type - createdCoupons: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 3.5571952270680973 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true - attributes: '{}' - id: 6 - value: XMAS-20-2021 - discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 3.5571952270680973 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true - attributes: '{}' - id: 6 - value: XMAS-20-2021 - discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 + type: pageViews ruleFailureReasons: - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - createdReferrals: - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId - attributes: '{}' - id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId - attributes: '{}' + return: + returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + sessionId: 123 + applicationId: 322 properties: customerSession: $ref: '#/components/schemas/CustomerSessionV2' @@ -10647,7 +15230,7 @@ components: loyalty: $ref: '#/components/schemas/Loyalty' referral: - $ref: '#/components/schemas/Referral' + $ref: '#/components/schemas/InventoryReferral' coupons: items: $ref: '#/components/schemas/Coupon' @@ -10676,11 +15259,107 @@ components: items: $ref: '#/components/schemas/Giveaway' type: array + return: + $ref: '#/components/schemas/Return' + previousReturns: + items: + $ref: '#/components/schemas/Return' + type: array required: - createdCoupons - createdReferrals - effects type: object + IntegrationCustomerSessionResponse: + example: + effects: + - rulesetId: 73 + ruleIndex: 2 + triggeredForCatalogItem: 786 + campaignId: 244 + ruleName: Give 20% discount + triggeredByCoupon: 4928 + effectType: rejectCoupon + props: '{}' + - rulesetId: 73 + ruleIndex: 2 + triggeredForCatalogItem: 786 + campaignId: 244 + ruleName: Give 20% discount + triggeredByCoupon: 4928 + effectType: rejectCoupon + props: '{}' + customerSession: + couponCodes: + - XMAS-20-2021 + created: 2000-01-23T04:56:07.000+00:00 + identifiers: + - 91.11.156.141 + integrationId: URNGV8294NV + total: 119.99 + loyaltyCards: + - loyalty-card-1 + additionalCosts: + shipping: + price: 9 + additionalCostTotal: 20.0 + profileId: URNGV8294NV + referralCode: NT2K54D9 + attributes: + ShippingCity: Berlin + id: 6 + state: open + applicationId: 322 + cartItems: + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 + price: 99.99 + name: Air Glide + width: 6.027456183070403 + attributes: + image: 11.jpeg + material: leather + position: 5.962133916683182 + sku: SKU1241028 + category: shoes + height: 0.8008281904610115 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 + price: 99.99 + name: Air Glide + width: 6.027456183070403 + attributes: + image: 11.jpeg + material: leather + position: 5.962133916683182 + sku: SKU1241028 + category: shoes + height: 0.8008281904610115 + updated: 2020-02-08T14:15:22Z + firstSession: true + cartItemTotal: 99.99 + properties: + customerSession: + $ref: '#/components/schemas/CustomerSessionV2' + effects: + items: + $ref: '#/components/schemas/Effect' + type: array + type: object ApplicationCustomer: description: "" example: @@ -10692,22 +15371,25 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 properties: id: - description: Unique ID for this entity. Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + Unique ID for this entity. Not to be confused with the Integration ID, + which is set by your integration layer and used in most endpoints. type: integer created: description: The exact moment this entity was created. The exact moment @@ -10716,13 +15398,13 @@ components: format: date-time type: string integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. The integration ID for this entity sent to and used - in the Talon.One system. + description: The integration ID set by your integration layer. The integration + ID set by your integration layer. format: string + maxLength: 1000 type: string attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. example: Language: english ShippingCountry: DE @@ -10739,30 +15421,38 @@ components: title: Closed sessions type: integer totalSales: - description: Sum of all purchases made by this customer + description: Sum of all purchases made by this customer. example: 299.99 title: Total Sales type: number loyaltyMemberships: - description: A list of loyalty programs joined by the customer + description: | + **DEPRECATED** A list of loyalty programs joined by the customer. items: $ref: '#/components/schemas/LoyaltyMembership' title: Loyalty programed joined type: array audienceMemberships: - description: A list of audiences the customer belongs to + description: A list of audiences the customer belongs to. items: $ref: '#/components/schemas/AudienceMembership' title: Audience memberships type: array lastActivity: - description: Timestamp of the most recent event received from this customer + description: | + Timestamp of the most recent event received from this customer. + This field is updated on calls that trigger the rule-engine and that are + not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). + + For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) + for a customer doesn't impact this field. + example: 2020-02-08T14:15:20Z format: date-time - title: Last activity of customer type: string advocateIntegrationId: description: The Integration ID of the Customer Profile that referred this Customer in the Application. + maxLength: 1000 type: string required: - accountId @@ -10790,21 +15480,23 @@ components: type: integer sessionId: description: Integration ID of the session in which the customer redeemed - the referral + the referral. type: string advocateIntegrationId: - description: Integration ID of the Advocate's Profile + description: Integration ID of the Advocate's Profile. + maxLength: 1000 title: Advocate's Profile ID type: string friendIntegrationId: - description: Integration ID of the Friend's Profile + description: Integration ID of the Friend's Profile. + maxLength: 1000 title: Friend's Profile ID type: string code: description: Advocate's referral code. type: string created: - description: Timestamp of the moment the customer redeemed the referral + description: Timestamp of the moment the customer redeemed the referral. format: date-time type: string required: @@ -10818,49 +15510,63 @@ components: ApplicationSession: description: "" example: - coupon: coupon + coupon: BKDB946 created: 2000-01-23T04:56:07.000+00:00 + totalDiscounts: 100.0 integrationId: URNGV8294NV - profileintegrationid: profileintegrationid - total: 6.027456183070403 - referral: referral + profileintegrationid: 382370BKDB946 + total: 200.0 + referral: BKDB946 discounts: key: 0.8008281904610115 profileId: 138 attributes: '{}' id: 6 - state: open + state: closed applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: @@ -10878,28 +15584,40 @@ components: example: 138 type: integer integrationId: - description: The integration ID for this entity sent to and used in the - Talon.One system. + description: The integration ID set by your integration layer. example: URNGV8294NV format: string + maxLength: 1000 type: string profileintegrationid: description: Integration ID of the customer for the session. + example: 382370BKDB946 + maxLength: 1000 type: string coupon: description: Any coupon code entered. + example: BKDB946 type: string referral: description: Any referral code entered. + example: BKDB946 type: string state: description: | - Indicating if the customer session is in progress (`open`), `closed`, or `cancelled`. - For more information about customer sessions, see [Customer sessions](/docs/dev/concepts/entities#customer-session-states) in the docs. + Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: + + 1. `open` → `closed` + 2. `open` → `cancelled` + 3. `closed` → `cancelled` or `partially_returned` + 4. `partially_returned` → `cancelled` + + For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). enum: - open - closed + - partially_returned - cancelled + example: closed type: string cartItems: description: Serialized JSON representation. @@ -10909,14 +15627,21 @@ components: discounts: additionalProperties: type: number - description: A map of labelled discount values, in the same currency as - the session. + description: | + **API V1 only.** A map of labeled discount values, in the same currency as the session. + + If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. type: object + totalDiscounts: + description: The total sum of the discounts applied to this session. + example: 100.0 + type: number total: description: The total sum of the session before any discounts applied. + example: 200.0 type: number attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. properties: {} type: object required: @@ -10930,6 +15655,7 @@ components: - referral - state - total + - totalDiscounts type: object ApplicationEvent: description: "" @@ -10937,7 +15663,7 @@ components: effects: - '{}' - '{}' - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: 138 attributes: '{}' id: 6 @@ -10945,25 +15671,25 @@ components: applicationId: 322 type: type ruleFailureReasons: - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue @@ -10971,11 +15697,13 @@ components: couponValue: couponValue properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string applicationId: @@ -11030,79 +15758,101 @@ components: type: object AccountAnalytics: example: - liveActiveCampaigns: 2 - expiredCoupons: 3 - roles: 1 - activeCampaigns: 5 - activeCoupons: 9 - sandboxApplications: 1 - activeRules: 1 - users: 1 + liveActiveCampaigns: 10 + expiredCoupons: 200 + roles: 10 + activeCampaigns: 15 + activeCoupons: 650 + liveLoyaltyPrograms: 5 + sandboxApplications: 2 + activeRules: 35 + users: 0 liveApplications: 6 - campaigns: 5 - coupons: 7 - expiredReferralCodes: 7 - webhooks: 7 - loyaltyPrograms: 1 - referralCodes: 2 - applications: 0 - activeReferralCodes: 4 - customAttributes: 6 + campaigns: 35 + coupons: 850 + expiredReferralCodes: 400 + webhooks: 2 + loyaltyPrograms: 5 + referralCodes: 500 + applications: 11 + activeReferralCodes: 100 + customAttributes: 18 properties: applications: - description: Total number of applications in the account + description: Total number of applications in the account. + example: 11 type: integer liveApplications: - description: Total number of live applications in the account + description: Total number of live applications in the account. + example: 6 type: integer sandboxApplications: - description: Total number of sandbox applications in the account + description: Total number of sandbox applications in the account. + example: 2 type: integer campaigns: - description: Total number of campaigns in the account + description: Total number of campaigns in the account. + example: 35 type: integer activeCampaigns: - description: Total number of active campaigns in the account + description: Total number of active campaigns in the account. + example: 15 type: integer liveActiveCampaigns: description: Total number of active campaigns in live applications in the - account + account. + example: 10 type: integer coupons: - description: Total number of coupons in the account + description: Total number of coupons in the account. + example: 850 type: integer activeCoupons: - description: Total number of active coupons in the account + description: Total number of active coupons in the account. + example: 650 type: integer expiredCoupons: - description: Total number of expired coupons in the account + description: Total number of expired coupons in the account. + example: 200 type: integer referralCodes: - description: Total number of referral codes in the account + description: Total number of referral codes in the account. + example: 500 type: integer activeReferralCodes: - description: Total number of active referral codes in the account + description: Total number of active referral codes in the account. + example: 100 type: integer expiredReferralCodes: - description: Total number of expired referral codes in the account + description: Total number of expired referral codes in the account. + example: 400 type: integer activeRules: - description: Total number of active rules in the account + description: Total number of active rules in the account. + example: 35 type: integer users: - description: Total number of users in the account + description: Total number of users in the account. type: integer roles: - description: Total number of roles in the account + description: Total number of roles in the account. + example: 10 type: integer customAttributes: - description: Total number of custom attributes in the account + description: Total number of custom attributes in the account. + example: 18 type: integer webhooks: - description: Total number of webhooks in the account + description: Total number of webhooks in the account. + example: 2 type: integer loyaltyPrograms: - description: Total number of loyalty programs in the account + description: Total number of all loyalty programs in the account. + example: 5 + type: integer + liveLoyaltyPrograms: + description: Total number of live loyalty programs in the account. + example: 5 type: integer required: - activeCampaigns @@ -11117,6 +15867,7 @@ components: - expiredReferralCodes - liveActiveCampaigns - liveApplications + - liveLoyaltyPrograms - loyaltyPrograms - referralCodes - roles @@ -11127,41 +15878,41 @@ components: AccountLimits: properties: liveApplications: - description: Total number of allowed live applications in the account + description: Total number of allowed live applications in the account. type: integer sandboxApplications: - description: Total number of allowed sandbox applications in the account + description: Total number of allowed sandbox applications in the account. type: integer activeCampaigns: description: Total number of allowed active campaigns in live applications - in the account + in the account. type: integer coupons: - description: Total number of allowed coupons in the account + description: Total number of allowed coupons in the account. type: integer referralCodes: - description: Total number of allowed referral codes in the account + description: Total number of allowed referral codes in the account. type: integer activeRules: - description: Total number of allowed active rulesets in the account + description: Total number of allowed active rulesets in the account. type: integer liveLoyaltyPrograms: - description: Total number of allowed live loyalty programs in the account + description: Total number of allowed live loyalty programs in the account. type: integer sandboxLoyaltyPrograms: - description: Total number of allowed sandbox loyalty programs in the account + description: Total number of allowed sandbox loyalty programs in the account. type: integer webhooks: - description: Total number of allowed webhooks in the account + description: Total number of allowed webhooks in the account. type: integer users: - description: Total number of allowed users in the account + description: Total number of allowed users in the account. type: integer apiVolume: - description: Allowed volume of API requests to the account + description: Allowed volume of API requests to the account. type: integer promotionTypes: - description: Array of promotion types that are employed in the account + description: Array of promotion types that are employed in the account. items: type: string type: array @@ -11182,7 +15933,7 @@ components: UpdateAccount: properties: attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object companyName: @@ -11194,7 +15945,7 @@ components: format: email type: string state: - description: State of the account (active, deactivated) + description: State of the account (active, deactivated). enum: - active - deactivated @@ -11212,7 +15963,7 @@ components: example: applicationCount: 5 planExpires: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z campaignsActiveCount: 7 companyName: companyName campaignsInactiveCount: 9 @@ -11223,32 +15974,35 @@ components: campaignLimit: 1 domainName: domainName apiLimit: 5 - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z attributes: '{}' id: 6 state: active userLimit: 6 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string companyName: minLength: 1 type: string domainName: - description: Subdomain Name for yourcompany.talon.one + description: Subdomain Name for yourcompany.talon.one. type: string state: - description: State of the account (active, deactivated) + description: State of the account (active, deactivated). enum: - active - deactivated @@ -11291,7 +16045,7 @@ components: description: The current number of inactive Campaigns in your account. type: integer attributes: - description: Arbitrary properties associated with this campaign + description: Arbitrary properties associated with this campaign. properties: {} type: object required: @@ -11343,6 +16097,7 @@ components: description: Your name. type: string inviteToken: + example: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 minLength: 1 type: string required: @@ -11353,10 +16108,11 @@ components: UpdateUser: properties: name: - description: Your name. + description: The user name. type: string policy: - description: a blob of acl json + description: ACL Json. + example: "" type: string state: description: New state ("deactivated" or "active") for the user. Only usable @@ -11364,9 +16120,13 @@ components: enum: - deactivated - active + example: deactivated type: string roles: - description: Update + description: List of roles to assign to the user. + example: + - 1 + - 3 items: type: integer type: array @@ -11429,11 +16189,13 @@ components: description: "" properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string applicationId: @@ -11457,7 +16219,7 @@ components: type: array variables: description: A stringified version of the environment's Talang variables - scope + scope. type: string giveawaysPools: description: The giveaways pools that the application is subscribed to. @@ -11485,6 +16247,12 @@ components: items: $ref: '#/components/schemas/Audience' type: array + collections: + description: The account-level collections that the application is subscribed + to. + items: + $ref: '#/components/schemas/Collection' + type: array required: - applicationId - created @@ -11608,12 +16376,23 @@ components: minLength: 1 type: string type: - description: Can be one of the following three ['string','number','boolean'] + description: Defines the type of parameter value. + enum: + - string + - number + - boolean + - percent + - (list string) + - time type: string description: description: Explains the meaning of this template parameter and the placeholder value that will define it. It is used on campaign creation from this template. type: string + attributeId: + description: ID of the corresponding attribute. + example: 42 + type: integer required: - description - name @@ -11675,7 +16454,7 @@ components: referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: - description: The set of limits that will operate for this campaign template + description: The set of limits that will operate for this campaign template. items: $ref: '#/components/schemas/TemplateLimitConfig' type: array @@ -11685,6 +16464,16 @@ components: items: $ref: '#/components/schemas/CampaignTemplateParams' type: array + campaignCollections: + description: The campaign collections from the blueprint campaign for the + template. + items: + $ref: '#/components/schemas/CampaignTemplateCollection' + type: array + defaultCampaignGroupId: + description: The default campaignGroupId. + example: 42 + type: integer required: - description - instructions @@ -11750,7 +16539,7 @@ components: referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: - description: The set of limits that will operate for this campaign template + description: The set of limits that will operate for this campaign template. items: $ref: '#/components/schemas/TemplateLimitConfig' type: array @@ -11762,10 +16551,20 @@ components: type: array applicationsIds: description: A list of the IDs of the applications that are subscribed to - this campaign template + this campaign template. items: type: integer type: array + campaignCollections: + description: The campaign collections from the blueprint campaign for the + template. + items: + $ref: '#/components/schemas/CampaignTemplateCollection' + type: array + defaultCampaignGroupId: + description: The default campaignGroupId. + example: 42 + type: integer required: - applicationsIds - description @@ -11773,15 +16572,32 @@ components: - name - state type: object + CampaignTemplateCollection: + properties: + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[A-Za-z](\w|\s)*$ + type: string + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + required: + - name + type: object CampaignTemplate: description: "" properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string accountId: @@ -11848,7 +16664,7 @@ components: referralSettings: $ref: '#/components/schemas/CodeGeneratorSettings' limits: - description: The set of limits that will operate for this campaign template + description: The set of limits that will operate for this campaign template. items: $ref: '#/components/schemas/TemplateLimitConfig' type: array @@ -11860,12 +16676,22 @@ components: type: array applicationsIds: description: A list of the IDs of the applications that are subscribed to - this campaign template A list of the IDs of the applications that are - subscribed to this campaign template + this campaign template. A list of the IDs of the applications that are + subscribed to this campaign template. items: description: "" type: integer type: array + campaignCollections: + description: The campaign collections from the blueprint campaign for the + template. + items: + $ref: '#/components/schemas/CampaignTemplateCollection' + type: array + defaultCampaignGroupId: + description: The default campaignGroupId. + example: 42 + type: integer updated: description: Timestamp of the most recent update to the campaign template or any of its elements. @@ -11893,22 +16719,59 @@ components: - validApplicationIds type: object CreateTemplateCampaign: + example: + campaignAttributesOverrides: '{}' + name: Discount campaign + description: This template is for discount campaigns. + limitOverrides: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + templateParamValues: + - expression: + - '{}' + - '{}' + valueType: string + name: my property + type: templateParameter + - expression: + - '{}' + - '{}' + valueType: string + name: my property + type: templateParameter + templateId: 4 + campaignGroups: + - 1 + - 3 + tags: + - summer properties: name: description: A user-facing name for this campaign. + example: Discount campaign minLength: 1 title: Campaign Name type: string description: description: A detailed description of the campaign. + example: This template is for discount campaigns. title: Campaign Description type: string templateId: description: The ID of the Campaign Template which will be used in order to create the Campaign. + example: 4 type: integer campaignAttributesOverrides: - description: Custom Campaign Attributes. If the the Campaign Template defines + description: Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden. properties: {} type: object @@ -11924,16 +16787,217 @@ components: items: $ref: '#/components/schemas/LimitConfig' type: array + campaignGroups: + description: | + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + example: + - 1 + - 3 + items: + type: integer + type: array + tags: + description: A list of tags for the campaign. If the campaign template has + tags, they will be overridden by this list. + example: + - summer + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 50 + type: array required: - name - templateId type: object CreateTemplateCampaignResponse: - properties: + example: + collections: + - accountId: 3886 + createdBy: 134 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 + - accountId: 3886 + createdBy: 134 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 + ruleset: + rbVersion: v2 + created: 2020-06-10T09:05:27.993483Z + campaignId: 320 + bindings: [] + activatedAt: 2000-01-23T04:56:07.000+00:00 + activate: true + rules: + - condition: + - and + - - couponValid + effects: + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 + bindings: + - expression: + - '{}' + - '{}' + valueType: string + name: my property + type: templateParameter + - expression: + - '{}' + - '{}' + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon + - condition: + - and + - - couponValid + effects: + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 + bindings: + - expression: + - '{}' + - '{}' + valueType: string + name: my property + type: templateParameter + - expression: + - '{}' + - '{}' + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon + id: 6 + templateId: 3 + userId: 6 + campaign: + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions + templateId: 3 + customEffectCount: 0 + features: + - coupons + - referrals + createdLoyaltyPointsCount: 9.0 + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 + state: enabled + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe + created: 2000-01-23T04:56:07.000+00:00 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 + campaignGroups: + - 1 + - 3 + tags: + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - "2" + - "0" + attributes: '{}' + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z + applicationId: 322 + referralRedemptionCount: 3 + updated: 2000-01-23T04:56:07.000+00:00 + properties: campaign: $ref: '#/components/schemas/Campaign' ruleset: $ref: '#/components/schemas/Ruleset' + collections: + items: + $ref: '#/components/schemas/Collection' + type: array required: - campaign - ruleset @@ -11982,11 +17046,13 @@ components: description: "" properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string applicationId: @@ -12045,20 +17111,28 @@ components: description: "" example: editable: true - name: name subscribedApplicationsIds: - 0 - 0 description: description + restrictedBySuggestions: false + eventType: eventType + title: title + type: string + hasAllowedList: false + allowedSubscriptions: + - application + - application + name: name suggestions: - suggestions - suggestions - suggestions - suggestions - suggestions - eventType: eventType - title: title - type: string + subscribedCatalogsIds: + - 6 + - 6 entity: Account properties: entity: @@ -12084,11 +17158,13 @@ components: description: The attribute name that will be used in API requests and Talang. E.g. if `name == "region"` then you would set the region attribute by including an `attributes.region` property in your request payload. + pattern: ^[A-Za-z]\w*$ type: string title: description: The human-readable name for the attribute that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. + pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string type: description: The data type of the attribute, a `time` attribute must be @@ -12115,15 +17191,43 @@ components: type: string maxItems: 50 type: array + hasAllowedList: + default: false + description: Whether or not this attribute has an allowed list of values + associated with it. + type: boolean + restrictedBySuggestions: + default: false + description: | + Whether or not this attribute's value is restricted by suggestions (`suggestions` property) + or by an allowed list of value (`hasAllowedList` property). + type: boolean editable: description: Whether or not this attribute can be edited. type: boolean subscribedApplicationsIds: - description: A list of the IDs of the applications that are subscribed to - this attribute + description: A list of the IDs of the applications where this attribute + is available. + items: + type: integer + type: array + subscribedCatalogsIds: + description: A list of the IDs of the catalogs where this attribute is available. items: type: integer type: array + allowedSubscriptions: + description: | + A list of allowed subscription types for this attribute. + + **Note:** This only applies to attributes associated with the `CartItem` entity. + items: + enum: + - application + - catalog + type: string + maxItems: 2 + type: array required: - description - editable @@ -12136,14 +17240,23 @@ components: Attribute: description: "" example: - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z editable: true - name: name subscribedApplicationsIds: - 6 - 6 description: description + restrictedBySuggestions: false + eventType: eventType + title: title + type: string + accountId: 3886 + eventTypeId: 22 + hasAllowedList: false + allowedSubscriptions: + - application + - application + name: name suggestions: - suggestions - suggestions @@ -12151,17 +17264,19 @@ components: - suggestions - suggestions id: 6 - eventType: eventType - title: title - type: string + subscribedCatalogsIds: + - 1 + - 1 entity: Account properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string accountId: @@ -12191,11 +17306,13 @@ components: description: The attribute name that will be used in API requests and Talang. E.g. if `name == "region"` then you would set the region attribute by including an `attributes.region` property in your request payload. + pattern: ^[A-Za-z]\w*$ type: string title: description: The human-readable name for the attribute that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. + pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string type: description: The data type of the attribute, a `time` attribute must be @@ -12222,15 +17339,46 @@ components: type: string maxItems: 50 type: array + hasAllowedList: + default: false + description: Whether or not this attribute has an allowed list of values + associated with it. + type: boolean + restrictedBySuggestions: + default: false + description: | + Whether or not this attribute's value is restricted by suggestions (`suggestions` property) + or by an allowed list of value (`hasAllowedList` property). + type: boolean editable: description: Whether or not this attribute can be edited. type: boolean subscribedApplicationsIds: - description: A list of the IDs of the applications that are subscribed to - this attribute + description: A list of the IDs of the applications where this attribute + is available. items: type: integer type: array + subscribedCatalogsIds: + description: A list of the IDs of the catalogs where this attribute is available. + items: + type: integer + type: array + allowedSubscriptions: + description: | + A list of allowed subscription types for this attribute. + + **Note:** This only applies to attributes associated with the `CartItem` entity. + items: + enum: + - application + - catalog + type: string + maxItems: 2 + type: array + eventTypeId: + example: 22 + type: integer required: - accountId - created @@ -12252,27 +17400,42 @@ components: - 0 description: description title: title + type: session properties: name: description: The additional cost name that will be used in API requests and Talang. E.g. if `name == "shipping"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. + pattern: ^[A-Za-z](\w|\s)*$ type: string title: description: The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. + pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string description: description: A description of this additional cost. type: string subscribedApplicationsIds: description: A list of the IDs of the applications that are subscribed to - this additional cost + this additional cost. items: type: integer type: array + type: + default: session + description: | + The type of additional cost. The following options can be chosen: + - `session`: Additional cost will be added per session, + - `item`: Additional cost will be added per item, + - `both`: Additional cost will be added per item and session. + enum: + - session + - item + - both + type: string required: - description - name @@ -12282,7 +17445,7 @@ components: description: "" example: accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z name: name subscribedApplicationsIds: - 6 @@ -12290,13 +17453,16 @@ components: description: description id: 6 title: title + type: session properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string accountId: @@ -12308,21 +17474,35 @@ components: and Talang. E.g. if `name == "shipping"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. + pattern: ^[A-Za-z](\w|\s)*$ type: string title: description: The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. + pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string description: description: A description of this additional cost. type: string subscribedApplicationsIds: description: A list of the IDs of the applications that are subscribed to - this additional cost + this additional cost. items: type: integer type: array + type: + default: session + description: | + The type of additional cost. The following options can be chosen: + - `session`: Additional cost will be added per session, + - `item`: Additional cost will be added per item, + - `both`: Additional cost will be added per item and session. + enum: + - session + - item + - both + type: string required: - accountId - created @@ -12334,12 +17514,6 @@ components: NewEventType: description: "" properties: - applicationIds: - description: The IDs of the applications that are related to this entity. - items: - type: integer - minItems: 1 - type: array title: description: The human-friendly display name for this event type. Use a short, past-tense, description of the event. @@ -12357,79 +17531,29 @@ components: > The "Payment Accepted" event is triggered after successful processing of a payment by our payment gateway. type: string - mimeType: - description: This defines how the request payload will be parsed before - your handler code is run. - enum: - - application/json - - application/x-www-form-urlencoded - - none - type: string - examplePayload: - description: It is often helpful to include an example payload with the - event type definition for documentation purposes. - type: string - schema: - description: | - It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. - properties: {} - type: object - handlerLanguage: - description: The language of the handler code. Currently only `"talang"` - is supported. - enum: - - talang - type: string - handler: - description: | - Code that will be run after successful parsing & validation of the payload for this event. - This code _may_ choose to evaluate campaign rules. - type: string - version: - description: | - The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. - type: integer required: - - applicationIds - - description - - handler - - mimeType - name - title - - version type: object EventType: description: "" example: - schema: '{}' - handler: handler - examplePayload: examplePayload - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z name: name description: description id: 6 - mimeType: application/json - handlerLanguage: talang title: title - version: 1 - applicationIds: - - 6 - - 6 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string - applicationIds: - description: The IDs of the applications that are related to this entity. - items: - type: integer - minItems: 1 - type: array title: description: The human-friendly display name for this event type. Use a short, past-tense, description of the event. @@ -12447,48 +17571,11 @@ components: > The "Payment Accepted" event is triggered after successful processing of a payment by our payment gateway. type: string - mimeType: - description: This defines how the request payload will be parsed before - your handler code is run. - enum: - - application/json - - application/x-www-form-urlencoded - - none - type: string - examplePayload: - description: It is often helpful to include an example payload with the - event type definition for documentation purposes. - type: string - schema: - description: | - It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. - properties: {} - type: object - handlerLanguage: - description: The language of the handler code. Currently only `"talang"` - is supported. - enum: - - talang - type: string - handler: - description: | - Code that will be run after successful parsing & validation of the payload for this event. - This code _may_ choose to evaluate campaign rules. - type: string - version: - description: | - The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. - type: integer required: - - applicationIds - created - - description - - handler - id - - mimeType - name - title - - version type: object NewWebhook: description: "" @@ -12500,10 +17587,11 @@ components: minItems: 1 type: array title: - description: Friendly title for this webhook + description: Friendly title for this webhook. + pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string verb: - description: API method for this webhook + description: API method for this webhook. enum: - POST - PUT @@ -12512,25 +17600,25 @@ components: - PATCH type: string url: - description: API url (supports templating using parameters) for this webhook + description: API url (supports templating using parameters) for this webhook. type: string headers: - description: List of API HTTP headers for this webhook + description: List of API HTTP headers for this webhook. items: pattern: ^([^:,]*):([^]*|[^,]*)$ type: string type: array payload: description: API payload (supports templating using parameters) for this - webhook + webhook. type: string params: - description: Array of template argument definitions + description: Array of template argument definitions. items: $ref: '#/components/schemas/TemplateArgDef' type: array enabled: - description: Enables or disables webhook from showing in rule builder + description: Enables or disables webhook from showing in rule builder. type: boolean required: - applicationIds @@ -12548,9 +17636,9 @@ components: - headers - headers payload: payload - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z verb: POST - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z id: 6 title: title params: @@ -12569,15 +17657,18 @@ components: - 6 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string applicationIds: @@ -12589,10 +17680,11 @@ components: minItems: 1 type: array title: - description: Friendly title for this webhook + description: Friendly title for this webhook. + pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string verb: - description: API method for this webhook + description: API method for this webhook. enum: - POST - PUT @@ -12601,25 +17693,25 @@ components: - PATCH type: string url: - description: API url (supports templating using parameters) for this webhook + description: API url (supports templating using parameters) for this webhook. type: string headers: - description: List of API HTTP headers for this webhook + description: List of API HTTP headers for this webhook. items: pattern: ^([^:,]*):([^]*|[^,]*)$ type: string type: array payload: description: API payload (supports templating using parameters) for this - webhook + webhook. type: string params: - description: Array of template argument definitions + description: Array of template argument definitions. items: $ref: '#/components/schemas/TemplateArgDef' type: array enabled: - description: Enables or disables webhook from showing in rule builder + description: Enables or disables webhook from showing in rule builder. type: boolean required: - applicationIds @@ -12633,114 +17725,278 @@ components: - url - verb type: object - NewAudience: - example: - name: mPTravel - integration: mparticle - integrationId: URNGV8294NV + MultipleNewAudiences: + properties: + audiences: + items: + $ref: '#/components/schemas/NewMultipleAudiencesItem' + type: array + required: + - audiences + type: object + MultipleAudiences: + properties: + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + audiences: + items: + $ref: '#/components/schemas/MultipleAudiencesItem' + type: array + required: + - accountId + - audiences + type: object + AudienceIntegrationID: properties: - name: - description: The human-friendly display name for this Audience. - example: mPTravel - minLength: 1 - type: string - integration: - description: Integration that this audience was created in. - enum: - - mparticle - example: mparticle - type: string integrationId: - description: The ID of this Audience in the third-party integration - example: URNGV8294NV + description: The ID of this audience in the third-party integration. + example: 382370BKDB946 + maxLength: 1000 minLength: 1 type: string - required: - - integration - - integrationId - - name type: object - UpdateAudience: - example: - name: mPTravel + NewMultipleAudiencesItem: + description: "" properties: name: - description: The human-friendly display name for this Audience. - example: mPTravel + description: The human-friendly display name for this audience. + example: Travel audience + minLength: 1 + type: string + integrationId: + description: The ID of this audience in the third-party integration. + example: 382370BKDB946 + maxLength: 1000 minLength: 1 type: string required: - name type: object - Audience: + MultipleAudiencesItem: description: "" - example: - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 - name: mPTravel - integration: mparticle - integrationId: URNGV8294NV - id: 6 properties: - accountId: - description: The ID of the account that owns this entity. - example: 3886 - type: integer id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string name: - description: The human-friendly display name for this Audience. - example: mPTravel + description: The human-friendly display name for this audience. + example: Travel audience minLength: 1 type: string - integration: - description: Integration that this audience was created in. - enum: - - mparticle - example: mparticle - type: string integrationId: - description: The ID of this Audience in the third-party integration - example: URNGV8294NV + description: The ID of this audience in the third-party integration. + example: 382370BKDB946 + maxLength: 1000 minLength: 1 type: string + status: + description: | + Indicates whether the audience is new, updated or unmodified by the request. + enum: + - unmodified + - updated + - new + example: new + type: string required: - - accountId - created - id - - integration - integrationId - name + - status type: object - ManagerConfig: + NewInternalAudience: properties: - schemaVersion: - type: integer - required: - - schemaVersion + name: + description: The human-friendly display name for this audience. + example: Travel audience + minLength: 1 + type: string + sandbox: + description: Indicates if this is a live or sandbox Application. + example: true + type: boolean + description: + description: A description of the audience. + example: Travel audience 18-25 + type: string + required: + - name + type: object + NewAudience: + description: "" + example: + name: Travel audience + sandbox: true + integration: mparticle + description: Travel audience 18-25 + integrationId: 382370BKDB946 + createdIn3rdParty: false + properties: + name: + description: The human-friendly display name for this audience. + example: Travel audience + minLength: 1 + type: string + sandbox: + description: Indicates if this is a live or sandbox Application. + example: true + type: boolean + description: + description: A description of the audience. + example: Travel audience 18-25 + type: string + integration: + description: | + The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. + + For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. + + **Note:** If you do not integrate with any of these platforms, do not use this property. + example: mparticle + type: string + integrationId: + description: | + The ID of this audience in the third-party integration. + + **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. + example: 382370BKDB946 + maxLength: 1000 + minLength: 1 + type: string + createdIn3rdParty: + description: Determines if this audience is a 3rd party audience or not. + example: false + type: boolean + required: + - name + type: object + UpdateAudience: + example: + name: Travel audience + properties: + name: + description: The human-friendly display name for this audience. + example: Travel audience + minLength: 1 + type: string + required: + - name + type: object + Audience: + description: "" + example: + accountId: 3886 + created: 2020-06-10T09:05:27.993483Z + name: Travel audience + sandbox: true + integration: mparticle + description: Travel audience 18-25 + integrationId: 382370BKDB946 + id: 6 + createdIn3rdParty: false + properties: + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + name: + description: The human-friendly display name for this audience. + example: Travel audience + minLength: 1 + type: string + sandbox: + description: Indicates if this is a live or sandbox Application. + example: true + type: boolean + description: + description: A description of the audience. + example: Travel audience 18-25 + type: string + integration: + description: | + The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. + + For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. + + **Note:** If you do not integrate with any of these platforms, do not use this property. + example: mparticle + type: string + integrationId: + description: | + The ID of this audience in the third-party integration. + + **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. + example: 382370BKDB946 + maxLength: 1000 + minLength: 1 + type: string + createdIn3rdParty: + description: Determines if this audience is a 3rd party audience or not. + example: false + type: boolean + required: + - accountId + - created + - id + - name + type: object + AudienceAnalytics: + description: The audiences and their members count. + properties: + audienceId: + description: The ID of the audience. + example: 1 + type: integer + membersCount: + description: The count of members under a single audience. + example: 1234 + type: integer + type: object + ManagerConfig: + properties: + schemaVersion: + type: integer + required: + - schemaVersion type: object Export: description: "" example: filter: '{}' accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z id: 6 userId: 6 entity: Coupon properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string accountId: @@ -12759,10 +18015,11 @@ components: - CustomerSession - LoyaltyLedger - LoyaltyLedgerLog + - Collection type: string filter: description: Map of keys and values that were used to filter the exported - rows + rows. properties: {} type: object required: @@ -12777,18 +18034,20 @@ components: description: "" example: accountId: 3886 - amount: 0 - created: 2000-01-23T04:56:07.000+00:00 + amount: 10 + created: 2020-06-10T09:05:27.993483Z id: 6 userId: 0 - entity: entity + entity: AttributeAllowedList properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string accountId: @@ -12799,11 +18058,13 @@ components: description: The ID of the account that owns this entity. type: integer entity: - description: The name of the entity that was imported. Possible values are - Coupons and LoyaltyPoints. + description: | + The name of the entity that was imported. + example: AttributeAllowedList type: string amount: - description: The number of members that imported. + description: The number of values that were imported. + example: 10 minimum: 0 type: integer required: @@ -12885,27 +18146,30 @@ components: description: "" example: accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z campaignGroupID: 6 members: - 1 - 1 name: name - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z description: description id: 6 acl: '{}' properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string accountId: @@ -12913,21 +18177,23 @@ components: example: 3886 type: integer campaignGroupID: - description: The ID of the Campaign Group this role was created for. + description: | + The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups/) + this role was created for. type: integer name: - description: Name of the role + description: Name of the role. type: string description: - description: Description of the role + description: Description of the role. type: string members: - description: A list of user identifiers assigned to this role + description: A list of user identifiers assigned to this role. items: type: integer type: array acl: - description: Role ACL Policy + description: Role ACL Policy. properties: {} type: object required: @@ -12942,16 +18208,16 @@ components: description: "" properties: name: - description: Name of the role + description: Name of the role. type: string description: - description: Description of the role + description: Description of the role. type: string acl: - description: Role Policy this should be a stringified blob of json + description: Role Policy this should be a stringified blob of json. type: string members: - description: An array of user identifiers + description: An array of user identifiers. items: type: integer type: array @@ -12963,16 +18229,16 @@ components: UpdateRole: properties: name: - description: Name of the role + description: Name of the role. type: string description: - description: Description of the role + description: Description of the role. type: string acl: - description: Role Policy this should be a stringified blob of json + description: Role Policy this should be a stringified blob of json. type: string members: - description: An array of user identifiers + description: An array of user identifiers. items: type: integer type: array @@ -12981,12 +18247,12 @@ components: description: "" properties: users: - description: An array of userIDs + description: An array of userIDs. items: type: integer type: array roles: - description: An array of roleIDs + description: An array of roleIDs. items: type: integer type: array @@ -12997,10 +18263,10 @@ components: RoleMembership: properties: RoleID: - description: ID of role + description: ID of role. type: integer UserID: - description: ID of User + description: ID of User. type: integer required: - RoleID @@ -13013,7 +18279,7 @@ components: - 3gy32-008ye9 properties: integrationIDs: - description: List of Integration IDs + description: List of customer integration IDs. example: - ty238-32fke9 - 3gy32-008ye9 @@ -13026,54 +18292,60 @@ components: LedgerEntry: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 + referenceId: 6 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string profileId: - description: ID of the customers profile as used within this Talon.One account. - May be omitted or set to the empty string if the customer does not yet - have a known profile ID. + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string accountId: description: The ID of the Talon.One account that owns this profile. type: integer loyaltyProgramId: - description: ID of the ledger + description: ID of the ledger. example: 323414846 type: integer eventId: - description: ID of the related event + description: ID of the related event. + example: 3 type: integer amount: - description: Amount of loyalty points + description: Amount of loyalty points. example: 100 type: integer reason: - description: reason for awarding/deducting points + description: reason for awarding/deducting points. + example: Customer appeasement. type: string expiryDate: - description: Expiry date of the points + description: Expiry date of the points. + example: 2022-04-26T11:02:38Z format: date-time type: string referenceId: - description: The ID of the balancing ledgerEntry + description: The ID of the balancing ledgerEntry. type: integer required: - accountId @@ -13089,7 +18361,7 @@ components: LoyaltyMembership: example: joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 properties: joined: description: The moment in which the loyalty program was joined. @@ -13098,6 +18370,7 @@ components: type: string loyaltyProgramId: description: The ID of the loyalty program belonging to this entity. + example: 323414846 title: Loyalty program ID type: integer required: @@ -13110,7 +18383,7 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 warnings: '{}' couponRejectionReason: reason: CouponNotFound @@ -13176,7 +18449,7 @@ components: example: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 properties: campaignId: type: integer @@ -13205,14 +18478,18 @@ components: description: "" properties: title: - description: Title for API Key + description: Title for API Key. + example: My generated key type: string expires: - description: The date the API key expired + description: The date the API key expired. + example: 2023-08-24T14:00:00Z format: date-time type: string platform: - description: Platform the API key is valid for. + description: | + The third-party platform the API key is valid for. Use `none` for a generic API key to be used + from your own integration layer. enum: - none - segment @@ -13220,21 +18497,30 @@ components: - mparticle - selligent - iterable + - customer_engagement + - customer_data + - salesforce + example: none type: string id: - description: ID of the API Key + description: ID of the API Key. + example: 34 type: integer createdBy: - description: ID of user who created + description: ID of user who created. + example: 280 type: integer accountID: - description: ID of account the key is used for + description: ID of account the key is used for. + example: 13 type: integer applicationID: - description: ID of application the key is used for + description: ID of application the key is used for. + example: 54 type: integer created: - description: The date the API key was created + description: The date the API key was created. + example: 2022-03-02T16:46:17.758585Z format: date-time type: string required: @@ -13250,14 +18536,18 @@ components: description: "" properties: title: - description: Title for API Key + description: Title for API Key. + example: My generated key type: string expires: - description: The date the API key expired + description: The date the API key expired. + example: 2023-08-24T14:00:00Z format: date-time type: string platform: - description: Platform the API key is valid for. + description: | + The third-party platform the API key is valid for. Use `none` for a generic API key to be used + from your own integration layer. enum: - none - segment @@ -13265,25 +18555,35 @@ components: - mparticle - selligent - iterable + - customer_engagement + - customer_data + - salesforce + example: none type: string id: - description: ID of the API Key + description: ID of the API Key. + example: 34 type: integer createdBy: - description: ID of user who created + description: ID of user who created. + example: 280 type: integer accountID: - description: ID of account the key is used for + description: ID of account the key is used for. + example: 13 type: integer applicationID: - description: ID of application the key is used for + description: ID of application the key is used for. + example: 54 type: integer created: - description: The date the API key was created + description: The date the API key was created. + example: 2022-03-02T16:46:17.758585Z format: date-time type: string key: - description: Raw API Key + description: The API key. + example: f45f90d21dcd9bac965c45e547e9754a3196891d09948e35adbcbedc4e9e4b01 type: string required: - accountID @@ -13298,14 +18598,18 @@ components: CreateApplicationAPIKey: properties: title: - description: Title for API Key + description: Title for API Key. + example: My generated key type: string expires: - description: The date the API key expired + description: The date the API key expired. + example: 2023-08-24T14:00:00Z format: date-time type: string platform: - description: Platform the API key is valid for. + description: | + The third-party platform the API key is valid for. Use `none` for a generic API key to be used + from your own integration layer. enum: - none - segment @@ -13313,21 +18617,146 @@ components: - mparticle - selligent - iterable + - customer_engagement + - customer_data + - salesforce + example: none type: string required: - expires - title type: object + CreateManagementKey: + properties: + name: + description: Name for management key. + example: My generated key + type: string + expiryDate: + description: The date the management key expires. + example: 2023-08-24T14:00:00Z + format: date-time + type: string + endpoints: + description: The list of endpoints that can be accessed with the key + items: + $ref: '#/components/schemas/Endpoint' + type: array + required: + - endpoints + - expiryDate + - name + type: object + ManagementKey: + description: "" + properties: + name: + description: Name for management key. + example: My generated key + type: string + expiryDate: + description: The date the management key expires. + example: 2023-08-24T14:00:00Z + format: date-time + type: string + endpoints: + description: The list of endpoints that can be accessed with the key + items: + $ref: '#/components/schemas/Endpoint' + type: array + id: + description: ID of the management key. + example: 34 + type: integer + createdBy: + description: ID of the user who created it. + example: 280 + type: integer + accountID: + description: ID of account the key is used for. + example: 13 + type: integer + created: + description: The date the management key was created. + example: 2022-03-02T16:46:17.758585Z + format: date-time + type: string + required: + - accountID + - created + - createdBy + - endpoints + - expiryDate + - id + - name + type: object + NewManagementKey: + description: "" + properties: + name: + description: Name for management key. + example: My generated key + type: string + expiryDate: + description: The date the management key expires. + example: 2023-08-24T14:00:00Z + format: date-time + type: string + endpoints: + description: The list of endpoints that can be accessed with the key + items: + $ref: '#/components/schemas/Endpoint' + type: array + id: + description: ID of the management key. + example: 34 + type: integer + createdBy: + description: ID of the user who created it. + example: 280 + type: integer + accountID: + description: ID of account the key is used for. + example: 13 + type: integer + created: + description: The date the management key was created. + example: 2022-03-02T16:46:17.758585Z + format: date-time + type: string + key: + description: The management key. + example: f45f90d21dcd9bac965c45e547e9754a3196891d09948e35adbcbedc4e9e4b01 + type: string + required: + - accountID + - created + - createdBy + - endpoints + - expiryDate + - id + - key + - name + type: object + Endpoint: + properties: + path: + description: allowed endpoint + example: /coupons + type: string + required: + - path + type: object Notification: properties: id: - description: id of the notification + description: id of the notification. type: integer name: - description: name of the notification + description: name of the notification. type: string description: - description: description of the notification + description: description of the notification. type: string required: - description @@ -13374,11 +18803,13 @@ components: This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. type: string id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string required: @@ -13514,6 +18945,7 @@ components: example: rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 @@ -13521,32 +18953,37 @@ components: props: '{}' properties: campaignId: - description: The ID of the campaign that triggered this effect + description: The ID of the campaign that triggered this effect. example: 244 type: integer rulesetId: description: The ID of the ruleset that was active in the campaign when - this effect was triggered + this effect was triggered. example: 73 type: integer ruleIndex: description: The position of the rule that triggered this effect within - the ruleset + the ruleset. example: 2 type: integer ruleName: - description: The name of the rule that triggered this effect + description: The name of the rule that triggered this effect. example: Give 20% discount type: string effectType: - description: The type of effect that was triggered + description: The type of effect that was triggered. example: rejectCoupon type: string triggeredByCoupon: description: The ID of the coupon that was being evaluated when this effect - was triggered + was triggered. example: 4928 type: integer + triggeredForCatalogItem: + description: The ID of the catalog item that was being evaluated when this + effect was triggered. + example: 786 + type: integer props: type: object required: @@ -13559,35 +18996,40 @@ components: type: object EffectEntity: description: Definition of all properties that are present on all effects, independent - of their type + of their type. properties: campaignId: - description: The ID of the campaign that triggered this effect + description: The ID of the campaign that triggered this effect. example: 244 type: integer rulesetId: description: The ID of the ruleset that was active in the campaign when - this effect was triggered + this effect was triggered. example: 73 type: integer ruleIndex: description: The position of the rule that triggered this effect within - the ruleset + the ruleset. example: 2 type: integer ruleName: - description: The name of the rule that triggered this effect + description: The name of the rule that triggered this effect. example: Give 20% discount type: string effectType: - description: The type of effect that was triggered + description: The type of effect that was triggered. example: rejectCoupon type: string triggeredByCoupon: description: The ID of the coupon that was being evaluated when this effect - was triggered + was triggered. example: 4928 type: integer + triggeredForCatalogItem: + description: The ID of the catalog item that was being evaluated when this + effect was triggered. + example: 786 + type: integer required: - campaignId - effectType @@ -13603,7 +19045,7 @@ components: of its campaign are met. properties: value: - description: The coupon code that was accepted + description: The coupon code that was accepted. type: string required: - value @@ -13614,21 +19056,21 @@ components: the rules of its campaign are met. properties: value: - description: The referral code that was accepted + description: The referral code that was accepted. type: string required: - value type: object RedeemReferralEffectProps: - description: The properties specific to the "redeemReferral" effect. This gets - triggered whenever the referral code is valid, and a rule was triggered that - contains a "redeem referral" effect. + description: | + This effect is **deprecated**. The properties specific to the "redeemReferral" effect. + This gets triggered whenever the referral code is valid, and a rule was triggered that contains a "redeem referral" effect. properties: id: - description: The id of the referral code that was redeemed + description: The id of the referral code that was redeemed. type: integer value: - description: The referral code that was redeemed + description: The referral code that was redeemed. type: string required: - id @@ -13640,20 +19082,20 @@ components: on why. properties: value: - description: The coupon code that was rejected + description: The coupon code that was rejected. type: string rejectionReason: - description: The reason why this coupon was rejected + description: The reason why this coupon was rejected. type: string conditionIndex: description: The index of the condition that caused the rejection of the - coupon + coupon. type: integer effectIndex: - description: The index of the effect that caused the rejection of the coupon + description: The index of the effect that caused the rejection of the coupon. type: integer details: - description: More details about the failure + description: More details about the failure. type: string required: - rejectionReason @@ -13665,20 +19107,20 @@ components: more info on why. properties: value: - description: The referral code that was rejected + description: The referral code that was rejected. type: string rejectionReason: - description: The reason why this referral code was rejected + description: The reason why this referral code was rejected. type: string conditionIndex: description: The index of the condition that caused the rejection of the - referral + referral. type: integer effectIndex: - description: The index of the effect that caused the rejection of the referral + description: The index of the effect that caused the rejection of the referral. type: integer details: - description: More details about the failure + description: More details about the failure. type: string required: - rejectionReason @@ -13691,11 +19133,11 @@ components: for all details of this coupon. properties: value: - description: The coupon code that was created + description: The coupon code that was created. type: string profileId: description: The integration identifier of the customer for whom this coupon - was created + was created. type: string required: - profileId @@ -13708,7 +19150,7 @@ components: the response for all details of this referral code. properties: value: - description: The referral code that was created + description: The referral code that was created. type: string required: - value @@ -13719,39 +19161,111 @@ components: is a discount that should be applied on the scope of defined with it. properties: name: - description: The name/description of this discount + description: The name/description of this discount. type: string value: - description: The total monetary value of the discount + description: The total monetary value of the discount. type: number scope: description: The scope which the discount was applied on, can be one of - (cartItems,additionalCosts,sessionTotal) + (cartItems,additionalCosts,sessionTotal). type: string + desiredValue: + description: The original value of the discount. + type: number required: - name - value type: object SetDiscountPerItemEffectProps: - description: The properties specific to the "setDiscountPerItem" effect. This - gets triggered whenever a validated rule contained a "set per item discount" - effect. This is a discount that should be applied on a specific item. + description: | + The properties specific to the `setDiscountPerItem` effect, triggered whenever a validated rule contained a + "set per item discount" effect. + This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. + This depends on the chosen scope. properties: name: - description: The name/description of this discount + description: | + The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies + to. It is identical to the value of the `position` property. type: string value: - description: The total monetary value of the discount + description: The total monetary value of the discount. type: number position: description: The index of the item in the cart items list on which this - discount should be applied + discount should be applied. + type: number + subPosition: + description: | + Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. + Indicates which item the discount applies to for cart items with `quantity` > 1. + type: number + desiredValue: + description: The original value of the discount. + type: number + scope: + description: | + The scope of the discount: + - `additionalCosts`: The discount applies to all the additional costs of the item. + - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. + - `price`: The discount applies to the price of the item. + type: string + totalDiscount: + description: The total discount given if this effect is a result of a prorated + discount. + type: number + desiredTotalDiscount: + description: The original total discount to give if this effect is a result + of a prorated discount. + type: number + bundleIndex: + description: The position of the bundle in a list of item bundles created + from the same bundle definition. + type: integer + bundleName: + description: The name of the bundle binding. + type: string + required: + - name + - position + - value + type: object + SetDiscountPerAdditionalCostPerItemEffectProps: + description: The properties specific to the "setDiscountPerAdditionalCostPerItem" + effect. This gets triggered whenever a validated rule contained a "set discount + per additional cost per item" effect. This is a discount that should be applied + on a specific additional cost in a specific item. + properties: + name: + description: The name/description of this discount. + type: string + additionalCostId: + description: The ID of the additional cost. + type: integer + value: + description: The total monetary value of the discount. + type: number + position: + description: The index of the item in the cart item list containing the + additional cost to be discounted. type: number subPosition: - description: The sub-index of the item in an item stack on which this discount - should be applied + description: | + Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. + Indicates which item the discount applies to for cart items with `quantity` > 1. + type: number + additionalCost: + description: The name of the additional cost. + type: string + desiredValue: + description: | + Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). + Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. type: number required: + - additionalCost + - additionalCostId - name - position - value @@ -13763,16 +19277,19 @@ components: additional cost. properties: name: - description: The name/description of this discount + description: The name/description of this discount. type: string additionalCostId: - description: The ID of the additional cost + description: The ID of the additional cost. type: integer additionalCost: - description: The name of the additional cost + description: The name of the additional cost. type: string value: - description: The total monetary value of the discount + description: The total monetary value of the discount. + type: number + desiredValue: + description: The original value of the discount. type: number required: - additionalCost @@ -13787,46 +19304,61 @@ components: side. properties: webhookId: - description: The ID of the webhook that was triggered + description: The ID of the webhook that was triggered. type: number webhookName: - description: The name of the webhook that was triggered + description: The name of the webhook that was triggered. type: string required: - webhookId - webhookName type: object AddLoyaltyPointsEffectProps: - description: The properties specific to the "addLoyaltyPoints" effect. This - gets triggered whenever a validated rule contained an "add loyalty" effect. - These points are automatically stored and managed inside Talon.One. + description: | + The properties specific to the "addLoyaltyPoints" effect. This gets triggered whenever a validated rule contained an "add loyalty" effect. These points are automatically stored and managed inside Talon.One. properties: name: - description: The name/description of this loyalty point addition + description: The reason of the point addition. type: string programId: - description: The ID of the loyalty program where these points were added + description: The ID of the loyalty program where these points were added. type: integer subLedgerId: description: The ID of the subledger within the loyalty program where these - points were added + points were added. type: string value: - description: The amount of points that were added + description: The amount of points that were added. + type: number + desiredValue: + description: The original amount of loyalty points to be awarded. type: number recipientIntegrationId: - description: The user for whom these points were added + description: The user for whom these points were added. + maxLength: 1000 type: string startDate: - description: Date after which points will be valid + description: Date after which points will be valid. format: date-time type: string expiryDate: - description: Date after which points will expire + description: Date after which points will expire. format: date-time type: string transactionUUID: - description: The identifier of this addition in the loyalty ledger + description: The identifier of this addition in the loyalty ledger. + type: string + cartItemPosition: + description: The index of the item in the cart items list on which the loyal + points addition should be applied. + type: number + cartItemSubPosition: + description: | + The sub position is triggered when application flattening is enabled. + It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. + type: number + cardIdentifier: + description: The card on which these points were added. type: string required: - name @@ -13844,25 +19376,28 @@ components: properties: ruleTitle: description: The title of the rule that contained triggered this points - deduction + deduction. type: string programId: - description: The ID of the loyalty program where these points were added + description: The ID of the loyalty program where these points were added. type: integer subLedgerId: description: The ID of the subledger within the loyalty program where these - points were added + points were added. type: string value: - description: The amount of points that were deducted + description: The amount of points that were deducted. type: number transactionUUID: - description: The identifier of this deduction in the loyalty ledger + description: The identifier of this deduction in the loyalty ledger. type: string name: description: | The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. type: string + cardIdentifier: + description: The card on which these points were added. + type: string required: - name - programId @@ -13876,10 +19411,11 @@ components: triggered whenever a validated rule contained an "add free item" effect. properties: sku: - description: SKU of the item that needs to be added + description: SKU of the item that needs to be added. + example: SKU1241028 type: string name: - description: The name/description of the effect + description: The name/description of the effect. type: string required: - name @@ -13890,13 +19426,13 @@ components: gets triggered whenever a validated rule contained a "show notification" effect. properties: notificationType: - description: The type of notification that should be shown (e.g. error/warning/info) + description: The type of notification that should be shown (e.g. error/warning/info). type: string title: - description: Title of the notification + description: Title of the notification. type: string body: - description: Body of the notification + description: Body of the notification. type: string required: - body @@ -13908,12 +19444,17 @@ components: triggered whenever a validated rule contained an "update an attribute" effect. properties: path: - description: The exact path of the attribute that was updated + description: The exact path of the attribute that was updated. type: string value: - description: The new value of this attribute. Value can be any of the following - types (time, string, number, location, boolean) or a list of any of those - types + description: | + The new value of this attribute. The value can be of the following types: + - boolean + - location + - number + - string + - time + - list of any of those types type: object required: - path @@ -13925,7 +19466,7 @@ components: redemption was cancelled on our internal usage limit counters. properties: value: - description: The coupon code whose usage has been rolled back + description: The coupon code whose usage has been rolled back. type: string required: - value @@ -13936,22 +19477,44 @@ components: redemption was cancelled on our internal usage limit counters. properties: value: - description: The referral code whose usage has been rolled back + description: The referral code whose usage has been rolled back. type: string required: - value type: object RollbackDiscountEffectProps: description: The properties specific to the "rollbackDiscount" effect. This - gets triggered whenever previously closed session is now cancelled and a setDiscount - effect was cancelled on our internal discount limit counters. + gets triggered whenever previously closed session is now cancelled or partially + returned and a setDiscount effect was cancelled on our internal discount limit + counters. properties: name: - description: The name of the "setDiscount" effect that was rolled back + description: The name of the "setDiscount" effect that was rolled back. type: string value: - description: The value of the discount that was rolled back + description: The value of the discount that was rolled back. + type: number + cartItemPosition: + description: The index of the item in the cart items for which the discount + was rolled back. + type: number + cartItemSubPosition: + description: | + The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is + only returned when cart item flattening is enabled. type: number + additionalCostId: + description: The ID of the additional cost that was rolled back. + type: integer + additionalCost: + description: The name of the additional cost that was rolled back. + type: string + scope: + description: | + The scope of the rolled back discount + - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` + - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` + type: string required: - name - value @@ -13963,22 +19526,35 @@ components: properties: programId: description: The ID of the loyalty program where the points were originally - added + added. type: integer subLedgerId: description: The ID of the subledger within the loyalty program where these - points were originally added + points were originally added. type: string value: - description: The amount of points that were rolled back + description: The amount of points that were rolled back. type: number recipientIntegrationId: - description: The user for whom these points were originally added + description: The user for whom these points were originally added. + maxLength: 1000 type: string transactionUUID: description: The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. type: string + cartItemPosition: + description: The index of the item in the cart items for which the loyalty + points were rolled back. + type: number + cartItemSubPosition: + description: | + The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. + It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. + type: number + cardIdentifier: + description: The card on which these points were originally added. + type: string required: - programId - recipientIntegrationId @@ -13992,29 +19568,33 @@ components: and a deductLoyaltyPoints effect was revoked. properties: programId: - description: The ID of the loyalty program where these points were reimbursed + description: The ID of the loyalty program where these points were reimbursed. type: integer subLedgerId: description: The ID of the subledger within the loyalty program where these - points were reimbursed + points were reimbursed. type: string value: - description: The amount of reimbursed points that were added + description: The amount of reimbursed points that were added. type: number recipientIntegrationId: - description: The user for whom these points were reimbursed + description: The user for whom these points were reimbursed. + maxLength: 1000 type: string startDate: - description: Date after which the reimbursed points will be valid + description: Date after which the reimbursed points will be valid. format: date-time type: string expiryDate: - description: Date after which the reimbursed points will expire + description: Date after which the reimbursed points will expire. format: date-time type: string transactionUUID: description: The identifier of 'addition' entries added to the ledger as - the `deductLoyaltyPoints` effect is rolled back + the `deductLoyaltyPoints` effect is rolled back. + type: string + cardIdentifier: + description: The card on which these points were added. type: string required: - programId @@ -14024,22 +19604,21 @@ components: - value type: object ShowBundleMetadataEffectProps: - description: The properties specific to the "ShowBundleMetadata" effect. This - effect contains information that allows you to associate the discounts from - a rule in a bundle campaign with specific cart items. This way you can distinguish - from "normal" discounts that were not the result of a product bundle. + description: | + This effect is **deprecated**. + The properties specific to the "ShowBundleMetadata" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from "normal" discounts that were not the result of a product bundle. properties: description: - description: Description of the product bundle + description: Description of the product bundle. type: string bundleAttributes: description: The cart item attributes that determined which items are being - bundled together + bundled together. items: type: string type: array itemsIndices: - description: The indices in the cart items array of the bundled items + description: The indices in the cart items array of the bundled items. items: type: number type: array @@ -14061,6 +19640,7 @@ components: type: string recipientIntegrationId: description: The integration ID of the profile that was awarded the giveaway. + maxLength: 1000 type: string giveawayId: description: The internal ID for the giveaway that was awarded. @@ -14090,6 +19670,7 @@ components: recipientIntegrationId: description: The integration ID of the profile that will be awarded the giveaway. + maxLength: 1000 type: string required: - poolId @@ -14110,7 +19691,7 @@ components: description: Effect containing custom payload. properties: effectId: - description: The ID of the custom effect that was triggered + description: The ID of the custom effect that was triggered. type: integer name: description: The type of the custom effect. @@ -14131,7 +19712,10 @@ components: extra properties that should be returned in the response. example: customerSession: - couponCodes: XMAS-20-2021 + couponCodes: + - XMAS-20-2021 + loyaltyCards: + - loyalty-card-1 additionalCosts: shipping: price: 9 @@ -14143,43 +19727,60 @@ components: ShippingCity: Berlin state: open cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 responseContent: - - "" - - "" + - customerSession + - customerProfile properties: customerSession: $ref: '#/components/schemas/NewCustomerSessionV2' responseContent: description: | - Optional list of requested information to be present on the response related to the customer session update. + Optional list of extra data that you want to get in the response. Use this property to get as much data + as you need in one request instead of sending extra requests to other endpoints. - **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. + **Note:** `ruleFailureReasons` is always part of the response when the + [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. + example: + - customerSession + - customerProfile items: enum: - customerSession @@ -14191,12 +19792,54 @@ components: - event - awardedGiveaways - ruleFailureReasons - example: "" + - previousReturns type: string type: array required: - customerSession type: object + ReturnIntegrationRequest: + description: The body of a return integration API request. Next to the cart + items details, this contains an optional listing of extra properties that + should be returned in the response. + example: + return: + returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + responseContent: + - customerSession + - customerProfile + properties: + return: + $ref: '#/components/schemas/NewReturn' + responseContent: + description: | + Optional list of extra data that you want to get in the response. Use this property to get as much data + as you need in one request instead of sending extra requests to other endpoints. + + **Note:** `ruleFailureReasons` is always part of the response when the + [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. + example: + - customerSession + - customerProfile + items: + enum: + - customerSession + - customerProfile + - coupons + - triggeredCampaigns + - referral + - loyalty + - event + - previousReturns + type: string + type: array + required: + - return + type: object CustomerProfileIntegrationRequestV2: description: "" example: @@ -14205,17 +19848,16 @@ components: ShippingCountry: DE audiencesChanges: deletes: - - 6 - - 6 + - 7 adds: - - 0 - - 0 + - 2 + - 4 responseContent: - - customerProfile + - triggeredCampaigns - customerProfile properties: attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. example: Language: english ShippingCountry: DE @@ -14225,11 +19867,14 @@ components: $ref: '#/components/schemas/ProfileAudiencesChanges' responseContent: description: | - Optional list of requested information to be present on the response related to the customer profile update. - - Currently supported: "customerProfile", "triggeredCampaigns", "loyalty", "event", "awardedGiveaways", "ruleFailureReasons". + Optional list of extra data that you want to get in the response. Use this property to get as much data + as you need in one request instead of sending extra requests to other endpoints. - **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. + **Note:** `ruleFailureReasons` is always part of the response when the + [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. + example: + - triggeredCampaigns + - customerProfile items: enum: - customerProfile @@ -14244,20 +19889,24 @@ components: ProfileAudiencesChanges: example: deletes: - - 6 - - 6 + - 7 adds: - - 0 - - 0 + - 2 + - 4 properties: adds: description: The IDs of the audiences for the customer to join. + example: + - 2 + - 4 items: type: integer title: Audiences to join type: array deletes: description: The IDs of the audiences for the customer to leave. + example: + - 7 items: type: integer title: Audiences to leave @@ -14268,15 +19917,17 @@ components: type: object AudienceMembership: example: - name: name - id: 3 + name: Travel audience + id: 2 properties: id: description: The ID of the audience belonging to this entity. + example: 2 title: Audience ID type: integer name: description: The Name of the audience belonging to this entity. + example: Travel audience title: Audience Name type: string required: @@ -14309,7 +19960,7 @@ components: ShippingCountry: DE properties: attributes: - description: Arbitrary properties associated with this item + description: Arbitrary properties associated with this item. example: Language: english ShippingCountry: DE @@ -14317,11 +19968,12 @@ components: type: object integrationId: description: | - The custom identifier for this profile, must be unique within the account. + The identifier of this profile, set by your integration layer. It must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). example: R195412 + maxLength: 1000 type: string required: - integrationId @@ -14329,9 +19981,372 @@ components: MultipleCustomerProfileIntegrationResponseV2: example: integrationStates: - - effects: + - customerProfile: + accountId: 31 + closedSessions: 3 + created: 2000-01-23T04:56:07.000+00:00 + integrationId: URNGV8294NV + attributes: + Language: english + ShippingCountry: DE + totalSales: 299.99 + lastActivity: 2020-02-08T14:15:20Z + id: 6 + loyaltyMemberships: + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 323414846 + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 323414846 + audienceMemberships: + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 + loyalty: + cards: + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + programs: + key: + ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + subLedgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program + awardedGiveaways: + - code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + createdCoupons: + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + usageLimit: 100 + referralId: 326632952 + usageCounter: 10 + batchId: 32535-43255 + discountCounter: 2.3021358869347655 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 9 + reservation: false + attributes: '{}' + id: 6 + value: XMAS-20-2021 + discountLimit: 30.0 + startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + usageLimit: 100 + referralId: 326632952 + usageCounter: 10 + batchId: 32535-43255 + discountCounter: 2.3021358869347655 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 9 + reservation: false + attributes: '{}' + id: 6 + value: XMAS-20-2021 + discountLimit: 30.0 + startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + createdReferrals: + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA + attributes: '{}' + id: 6 + startDate: 2020-11-10T23:00:00Z + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA + attributes: '{}' + id: 6 + startDate: 2020-11-10T23:00:00Z + effects: - rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 @@ -14339,303 +20354,324 @@ components: props: '{}' - rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 effectType: rejectCoupon props: '{}' referral: - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 5 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' + referredCustomers: + - referredCustomers + - referredCustomers id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z triggeredCampaigns: - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 coupons: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - customerProfile: - accountId: 7 - closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 - integrationId: URNGV8294NV - attributes: - Language: english - ShippingCountry: DE - totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 - id: 6 - loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 - audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 customerSession: - couponCodes: XMAS-20-2021 + couponCodes: + - XMAS-20-2021 created: 2000-01-23T04:56:07.000+00:00 identifiers: - 91.11.156.141 integrationId: URNGV8294NV - total: 5.637376656633329 + total: 119.99 + loyaltyCards: + - loyalty-card-1 additionalCosts: shipping: price: 9 - additionalCostTotal: 2.3021358869347655 + additionalCostTotal: 20.0 profileId: URNGV8294NV referralCode: NT2K54D9 attributes: ShippingCity: Berlin + id: 6 state: open applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - updated: 2000-01-23T04:56:07.000+00:00 + updated: 2020-02-08T14:15:22Z firstSession: true cartItemTotal: 99.99 - loyalty: - programs: - key: - ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 - currentTier: - name: name - id: 9 - subLedgers: - key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 - currentTier: - name: name - id: 9 - name: name - id: 1 - title: title - awardedGiveaways: - - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + previousReturns: + - returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + sessionId: 123 + applicationId: 322 + - returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 + sessionId: 123 + applicationId: 322 event: effects: - - addItemToCart - created: 2000-01-23T04:56:07.000+00:00 + - '{}' + - '{}' + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV meta: campaigns: '{}' @@ -14643,128 +20679,446 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 warnings: '{}' couponRejectionReason: reason: CouponNotFound campaignId: 244 couponId: 4928 ledgerEntries: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + referenceId: 6 + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - attributes: '{}' + referenceId: 6 + attributes: + myAttribute: myValue id: 6 - sessionId: sessionId + sessionId: 175KJPS947296 applicationId: 322 - type: type - createdCoupons: - - recipientIntegrationId: recipientIntegrationId + type: pageViews + ruleFailureReasons: + - rulesetID: 1 + ruleIndex: 1 + campaignID: 7 + referralID: 1 + ruleName: ruleName + conditionIndex: 6 + effectIndex: 7 + details: details + couponID: 4928 + referralValue: referralValue + campaignName: campaignName + couponValue: couponValue + - rulesetID: 1 + ruleIndex: 1 + campaignID: 7 + referralID: 1 + ruleName: ruleName + conditionIndex: 6 + effectIndex: 7 + details: details + couponID: 4928 + referralValue: referralValue + campaignName: campaignName + couponValue: couponValue + return: + returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 + id: 6 + sessionId: 123 + applicationId: 322 + - customerProfile: + accountId: 31 + closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + integrationId: URNGV8294NV + attributes: + Language: english + ShippingCountry: DE + totalSales: 299.99 + lastActivity: 2020-02-08T14:15:20Z + id: 6 + loyaltyMemberships: + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 323414846 + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 323414846 + audienceMemberships: + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 + loyalty: + cards: + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + - ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + identifier: identifier + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + - integrationId: integrationId + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + programID: 125 + status: status + programs: + key: + ledger: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + subLedgers: + key: + pendingBalance: 10.0 + currentBalance: 46.0 + spentBalance: 84.0 + tentativeCurrentBalance: 56.0 + pointsToNextTier: 20.0 + projection: + projections: + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + - date: 2000-01-23T04:56:07.000+00:00 + activatingPoints: 25.0 + projectedBalance: 57.0 + expiringPoints: 14.0 + totalActivatingPoints: 40.0 + totalExpiringPoints: 10.0 + expiredBalance: 30.0 + currentTier: + name: bronze + id: 11 + name: program1 + id: 5 + title: My loyalty program + awardedGiveaways: + - code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + createdCoupons: + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - ruleFailureReasons: - - rulesetID: 5 - ruleIndex: 4 - campaignID: 7 - referralID: 3 - ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 - details: details - couponID: 4928 - referralValue: referralValue - campaignName: campaignName - couponValue: couponValue - - rulesetID: 5 - ruleIndex: 4 - campaignID: 7 - referralID: 3 - ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 - details: details - couponID: 4928 - referralValue: referralValue - campaignName: campaignName - couponValue: couponValue + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 createdReferrals: - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + startDate: 2020-11-10T23:00:00Z + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - effects: + startDate: 2020-11-10T23:00:00Z + effects: - rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 @@ -14772,303 +21126,324 @@ components: props: '{}' - rulesetId: 73 ruleIndex: 2 + triggeredForCatalogItem: 786 campaignId: 244 ruleName: Give 20% discount triggeredByCoupon: 4928 effectType: rejectCoupon props: '{}' referral: - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 5 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' + referredCustomers: + - referredCustomers + - referredCustomers id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z triggeredCampaigns: - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 coupons: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - customerProfile: - accountId: 7 - closedSessions: 3 - created: 2000-01-23T04:56:07.000+00:00 - integrationId: URNGV8294NV - attributes: - Language: english - ShippingCountry: DE - totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 - id: 6 - loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 - audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 customerSession: - couponCodes: XMAS-20-2021 + couponCodes: + - XMAS-20-2021 created: 2000-01-23T04:56:07.000+00:00 identifiers: - 91.11.156.141 integrationId: URNGV8294NV - total: 5.637376656633329 + total: 119.99 + loyaltyCards: + - loyalty-card-1 additionalCosts: shipping: price: 9 - additionalCostTotal: 2.3021358869347655 + additionalCostTotal: 20.0 profileId: URNGV8294NV referralCode: NT2K54D9 attributes: ShippingCity: Berlin + id: 6 state: open applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - updated: 2000-01-23T04:56:07.000+00:00 + updated: 2020-02-08T14:15:22Z firstSession: true cartItemTotal: 99.99 - loyalty: - programs: - key: - ledger: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 - currentTier: - name: name - id: 9 - subLedgers: - key: - pendingBalance: 7.457744773683766 - currentBalance: 6.84685269835264 - spentBalance: 4.965218492984954 - tentativeCurrentBalance: 5.025004791520295 - pointsToNextTier: 9.369310271410669 - expiredBalance: 1.1730742509559433 - currentTier: - name: name - id: 9 - name: name - id: 1 - title: title - awardedGiveaways: - - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + previousReturns: + - returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + sessionId: 123 + applicationId: 322 + - returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 + sessionId: 123 + applicationId: 322 event: effects: - - addItemToCart - created: 2000-01-23T04:56:07.000+00:00 + - '{}' + - '{}' + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV meta: campaigns: '{}' @@ -15076,125 +21451,80 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 1 - referralId: 1 + referralId: 5 warnings: '{}' couponRejectionReason: reason: CouponNotFound campaignId: 244 couponId: 4928 ledgerEntries: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 2 - eventId: 4 - reason: reason + referenceId: 6 + - expiryDate: 2022-04-26T11:02:38Z + accountId: 0 + eventId: 3 + reason: Customer appeasement. amount: 100 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: URNGV8294NV loyaltyProgramId: 323414846 id: 6 - referenceId: 7 - attributes: '{}' + referenceId: 6 + attributes: + myAttribute: myValue id: 6 - sessionId: sessionId + sessionId: 175KJPS947296 applicationId: 322 - type: type - createdCoupons: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 3.5571952270680973 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true - attributes: '{}' - id: 6 - value: XMAS-20-2021 - discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 211 - usageLimit: 100 - referralId: 326632952 - usageCounter: 10 - batchId: 32535-43255 - discountCounter: 3.5571952270680973 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true - attributes: '{}' - id: 6 - value: XMAS-20-2021 - discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 + type: pageViews ruleFailureReasons: - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - createdReferrals: - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId - attributes: '{}' - id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId - attributes: '{}' + return: + returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + sessionId: 123 + applicationId: 322 properties: integrationStates: items: @@ -15204,10 +21534,10 @@ components: CustomerProfileAudienceRequest: example: data: - - profileIntegrationId: "3518" + - profileIntegrationId: R195412 action: add audienceId: 748 - - profileIntegrationId: "3518" + - profileIntegrationId: R195412 action: add audienceId: 748 properties: @@ -15218,19 +21548,24 @@ components: type: object CustomerProfileAudienceRequestItem: example: - profileIntegrationId: "3518" + profileIntegrationId: R195412 action: add audienceId: 748 properties: action: + description: | + Defines the action to perform: + - `add`: Adds the customer profile to the audience. + - `delete`: Removes the customer profile from the audience. enum: - add - delete example: add type: string profileIntegrationId: - description: The ID of this audience in the third-party integration. - example: "3518" + description: The ID of this customer profile in the third-party integration. + example: R195412 + maxLength: 1000 type: string audienceId: description: The ID of the audience. You get it via the `id` property when @@ -15243,24 +21578,24 @@ components: - profileIntegrationId type: object FeedNotification: - description: A feed notification for CAMA users + description: A feed notification for CAMA users. properties: title: - description: Title of the feed notification + description: Title of the feed notification. type: string created: - description: Timestamp of the moment this feed notification was created + description: Timestamp of the moment this feed notification was created. format: date-time type: string updated: - description: Timestamp of the moment this feed notification was last updated + description: Timestamp of the moment this feed notification was last updated. format: date-time type: string articleUrl: - description: URL to the feed notification in the help center + description: URL to the feed notification in the help center. type: string type: - description: The type of the feed notification + description: The type of the feed notification. enum: - feed - feature @@ -15269,7 +21604,7 @@ components: - test type: string body: - description: Body of the feed notification + description: Body of the feed notification. type: string required: - articleUrl @@ -15280,14 +21615,14 @@ components: - updated type: object UserFeedNotifications: - description: notifications to notify CAMA user about + description: Notifications to notify CAMA user about. properties: lastUpdate: - description: Timestamp of the last request for this list + description: Timestamp of the last request for this list. format: date-time type: string notifications: - description: List of all notifications to notify the user about + description: List of all notifications to notify the user about. items: $ref: '#/components/schemas/FeedNotification' type: array @@ -15296,10 +21631,10 @@ components: - notifications type: object UpdateUserLatestFeedTimestamp: - description: Updates current user's latest seen notifications timestamp + description: Updates current user's latest seen notifications timestamp. properties: newLatestFeedTimestamp: - description: New timestamp to update for the current user + description: New timestamp to update for the current user. format: date-time type: string required: @@ -15310,291 +21645,1518 @@ components: $ref: '#/components/schemas/ApplicationCampaignStats' type: object ApplicationCampaignStats: - description: Provides statistics regarding an application's campaigns + description: Provides statistics regarding an application's campaigns. properties: draft: - description: Number of draft campaigns + description: Number of draft campaigns. type: integer disabled: - description: Number of disabled campaigns + description: Number of disabled campaigns. type: integer scheduled: - description: Number of scheduled campaigns + description: Number of scheduled campaigns. type: integer running: - description: Number of running campaigns + description: Number of running campaigns. type: integer expired: - description: Number of expired campaigns + description: Number of expired campaigns. type: integer archived: - description: Number of archived campaigns + description: Number of archived campaigns. + type: integer + required: + - archived + - disabled + - draft + - expired + - running + - scheduled + type: object + RuleFailureReason: + description: Details about why a rule failed. + example: + rulesetID: 1 + ruleIndex: 1 + campaignID: 7 + referralID: 1 + ruleName: ruleName + conditionIndex: 6 + effectIndex: 7 + details: details + couponID: 4928 + referralValue: referralValue + campaignName: campaignName + couponValue: couponValue + properties: + campaignID: + description: The ID of the campaign that contains the rule that failed. + type: integer + campaignName: + description: The name of the campaign that contains the rule that failed. + type: string + rulesetID: + description: The ID of the ruleset that contains the rule that failed. + type: integer + couponID: + description: The ID of the coupon that was being evaluated at the time of + the rule failure. + example: 4928 + type: integer + couponValue: + description: The code of the coupon that was being evaluated at the time + of the rule failure. + type: string + referralID: + description: The ID of the referral that was being evaluated at the time + of the rule failure. + type: integer + referralValue: + description: The code of the referral that was being evaluated at the time + of the rule failure. + type: string + ruleIndex: + description: The index of the rule that failed within the ruleset. + type: integer + ruleName: + description: The name of the rule that failed within the ruleset. + type: string + conditionIndex: + description: The index of the condition that failed. + type: integer + effectIndex: + description: The index of the effect that failed. + type: integer + details: + description: More details about the failure. + type: string + required: + - campaignID + - campaignName + - ruleIndex + - ruleName + - rulesetID + type: object + Giveaway: + description: "" + example: + code: code + importId: 5 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z + poolId: 4 + attributes: '{}' + id: 6 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + code: + description: The code value of this giveaway. + type: string + poolId: + description: The ID of the pool to return giveaway codes from. + type: integer + startDate: + description: Timestamp at which point the giveaway becomes valid. + format: date-time + type: string + endDate: + description: Timestamp at which point the giveaway becomes invalid. + format: date-time + type: string + attributes: + description: Arbitrary properties associated with this giveaway. + properties: {} + type: object + used: + description: Indicates whether this giveaway code was given before. + type: boolean + importId: + description: The ID of the Import which created this giveaway. + type: integer + required: + - code + - created + - id + - poolId + type: object + NewGiveawaysPool: + properties: + name: + description: The name of this giveaways pool. + type: string + description: + description: The description of this giveaways pool. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this giveaways pool + is enabled for. + items: + type: integer + type: array + required: + - name + type: object + GiveawaysPool: + description: Giveaways pools is an entity for managing multiple similar giveaways. + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + name: + description: The name of this giveaways pool. + type: string + description: + description: The description of this giveaways pool. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this giveaways pool + is enabled for. + items: + type: integer + type: array + modified: + description: Timestamp of the most recent update to the giveaways pool. + format: date-time + type: string + createdBy: + description: ID of the user who created this giveaways pool. + type: integer + modifiedBy: + description: ID of the user who last updated this giveaways pool if available. + type: integer + required: + - accountId + - created + - createdBy + - id + - name + type: object + NewCustomEffect: + description: "" + properties: + applicationIds: + description: The IDs of the applications that are related to this entity. + items: + type: integer + minItems: 1 + type: array + name: + description: The name of this effect. + pattern: ^[A-Za-z](\w|\s)*$ + type: string + title: + description: The title of this effect. + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + payload: + description: The JSON payload of this effect. + type: string + description: + description: The description of this effect. + type: string + enabled: + description: Determines if this effect is active. + type: boolean + params: + description: Array of template argument definitions. + items: + $ref: '#/components/schemas/TemplateArgDef' + type: array + required: + - applicationIds + - enabled + - name + - payload + - title + type: object + UpdateCustomEffect: + description: "" + properties: + applicationIds: + description: The IDs of the applications that are related to this entity. + items: + type: integer + minItems: 1 + type: array + name: + description: The name of this effect. + pattern: ^[A-Za-z](\w|\s)*$ + type: string + title: + description: The title of this effect. + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + payload: + description: The JSON payload of this effect. + type: string + description: + description: The description of this effect. + type: string + enabled: + description: Determines if this effect is active. + type: boolean + params: + description: Array of template argument definitions. + items: + $ref: '#/components/schemas/TemplateArgDef' + type: array + required: + - applicationIds + - enabled + - name + - payload + - title + type: object + CustomEffect: + description: "" + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + example: 3886 type: integer + modified: + description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + applicationIds: + description: The IDs of the applications that are related to this entity. + items: + type: integer + minItems: 1 + type: array + name: + description: The name of this effect. + pattern: ^[A-Za-z](\w|\s)*$ + type: string + title: + description: The title of this effect. + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + payload: + description: The JSON payload of this effect. + type: string + description: + description: The description of this effect. + type: string + enabled: + description: Determines if this effect is active. + type: boolean + params: + description: Array of template argument definitions. + items: + $ref: '#/components/schemas/TemplateArgDef' + type: array + modifiedBy: + description: ID of the user who last updated this effect if available. + type: integer + createdBy: + description: ID of the user who created this effect. + type: integer + required: + - accountId + - applicationIds + - created + - createdBy + - enabled + - id + - modified + - name + - payload + - title + type: object + UpdateCampaignCollection: + example: + description: My collection of SKUs + properties: + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + type: object + NewCampaignCollection: + description: "" + example: + name: My collection + description: My collection of SKUs + properties: + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + required: + - name + type: object + CampaignCollectionWithoutPayload: + description: "" + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + modified: + description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + modifiedBy: + description: ID of the user who last updated this effect if available. + example: 48 + type: integer + createdBy: + description: ID of the user who created this effect. + example: 134 + type: integer + applicationId: + description: The ID of the Application that owns this entity. + example: 1 + type: integer + campaignId: + description: The ID of the campaign that owns this entity. + example: 7 + type: integer + required: + - accountId + - created + - createdBy + - id + - modified + - name + type: object + CampaignCollection: + description: "" + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + modified: + description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + modifiedBy: + description: ID of the user who last updated this effect if available. + example: 48 + type: integer + createdBy: + description: ID of the user who created this effect. + example: 134 + type: integer + applicationId: + description: The ID of the Application that owns this entity. + example: 1 + type: integer + campaignId: + description: The ID of the campaign that owns this entity. + example: 7 + type: integer + payload: + description: The content of the collection. + example: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + items: + type: string + maxItems: 50 + type: array + required: + - accountId + - created + - createdBy + - id + - modified + - name + type: object + UpdateCollection: + example: + subscribedApplicationsIds: + - 1 + - 2 + - 3 + description: My collection of SKUs + properties: + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + subscribedApplicationsIds: + description: A list of the IDs of the Applications where this collection + is enabled. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + type: object + NewCollection: + description: "" + example: + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + description: My collection of SKUs + properties: + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + subscribedApplicationsIds: + description: A list of the IDs of the Applications where this collection + is enabled. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + required: + - name + type: object + CollectionWithoutPayload: + description: "" + example: + accountId: 3886 + createdBy: 134 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + modified: + description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + subscribedApplicationsIds: + description: A list of the IDs of the Applications where this collection + is enabled. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + modifiedBy: + description: ID of the user who last updated this effect if available. + example: 48 + type: integer + createdBy: + description: ID of the user who created this effect. + example: 134 + type: integer + applicationId: + description: The ID of the Application that owns this entity. + example: 1 + type: integer + campaignId: + description: The ID of the campaign that owns this entity. + example: 7 + type: integer + required: + - accountId + - created + - createdBy + - id + - modified + - name + type: object + Collection: + description: "" + example: + accountId: 3886 + createdBy: 134 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + modified: + description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + description: + description: A short description of the purpose of this collection. + example: My collection of SKUs + type: string + subscribedApplicationsIds: + description: A list of the IDs of the Applications where this collection + is enabled. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + name: + description: The name of this collection. + example: My collection + minLength: 1 + pattern: ^[^[:cntrl:]\s][^[:cntrl:]]*$ + type: string + modifiedBy: + description: ID of the user who last updated this effect if available. + example: 48 + type: integer + createdBy: + description: ID of the user who created this effect. + example: 134 + type: integer + applicationId: + description: The ID of the Application that owns this entity. + example: 1 + type: integer + campaignId: + description: The ID of the campaign that owns this entity. + example: 7 + type: integer + payload: + description: The content of the collection. + example: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + items: + type: string + maxItems: 50 + type: array + required: + - accountId + - created + - createdBy + - id + - modified + - name + type: object + CollectionItem: + description: "" + example: + item: item + properties: + item: + type: string + required: + - item + type: object + NewCouponCreationJob: + description: "" + example: + expiryDate: 2000-01-23T04:56:07.000+00:00 + usageLimit: 100 + numberOfCoupons: 200000 + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - "2" + - "0" + attributes: '{}' + discountLimit: 30.0 + startDate: 2000-01-23T04:56:07.000+00:00 + properties: + usageLimit: + description: | + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. + example: 100 + maximum: 999999 + minimum: 0 + type: integer + discountLimit: + description: | + The amount of discounts that can be given with this coupon code. + example: 30.0 + maximum: 999999 + minimum: 0 + type: number + startDate: + description: Timestamp at which point the coupon becomes valid. + format: date-time + type: string + expiryDate: + description: Expiry date of the coupon. Coupon never expires if this is + omitted, zero, or negative. + format: date-time + type: string + numberOfCoupons: + description: The number of new coupon codes to generate for the campaign. + Must be between 20,001 and 5,000,000. + example: 200000 + maximum: 5E+6 + type: integer + couponSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + attributes: + description: Arbitrary properties associated with coupons. + properties: {} + type: object + required: + - attributes + - numberOfCoupons + - usageLimit + type: object + CouponCreationJob: + description: "" + properties: + id: + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. + example: 6 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + campaignId: + description: The ID of the campaign that owns this entity. + example: 211 + title: Campaign ID + type: integer + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + usageLimit: + description: | + The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. + example: 100 + maximum: 999999 + minimum: 0 + type: integer + discountLimit: + description: | + The amount of discounts that can be given with this coupon code. + example: 30.0 + maximum: 999999 + minimum: 0 + type: number + startDate: + description: Timestamp at which point the coupon becomes valid. + format: date-time + type: string + expiryDate: + description: Expiry date of the coupon. Coupon never expires if this is + omitted, zero, or negative. + format: date-time + type: string + numberOfCoupons: + description: The number of new coupon codes to generate for the campaign. + Must be between 20,001 and 5,000,000. + example: 200000 + maximum: 5E+6 + type: integer + couponSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + attributes: + description: Arbitrary properties associated with coupons. + properties: {} + type: object + batchId: + description: The batch ID coupons created by this job will bear. + example: tqyrgahe + title: Batch ID + type: string + status: + description: | + The current status of this request. Possible values: + - `pending` + - `completed` + - `failed` + - `coupon pattern full` + example: pending + title: Job Status + type: string + createdAmount: + description: The number of coupon codes that were already created for this + request. + example: 1000000 + title: Created Amount + type: integer + failCount: + description: The number of times this job failed. + example: 10 + title: Fail Count + type: integer + errors: + description: An array of individual problems encountered during the request. + example: + - Connection to database was reset + - failed to generate enough unique codes + - attribute 'PizzaLover' not found on entity 'Coupons' + items: + type: string + title: Errors + type: array + createdBy: + description: ID of the user who created this effect. + example: 1 + title: Created By + type: integer + communicated: + description: Whether or not the user that created this job was notified + of its final state. + example: false + type: boolean + chunkExecutionCount: + description: The number of times an attempt to create a chunk of coupons + was made during the processing of the job. + example: 0 + title: Iterations + type: integer + chunkSize: + description: The number of coupons that will be created in a single transactions. + Coupons will be created in chunks until arriving at the requested amount. + example: 20000 + title: Chunk size + type: integer + required: + - accountId + - applicationId + - attributes + - batchId + - campaignId + - chunkExecutionCount + - communicated + - created + - createdAmount + - createdBy + - errors + - failCount + - id + - numberOfCoupons + - status + - usageLimit + type: object + AsyncCouponCreationResponse: + example: + batchId: tqyrgahe + properties: + batchId: + description: The batch ID that all coupons created by the request will have. + example: tqyrgahe + type: string + required: + - batchId + type: object + LimitCounter: + description: "" + properties: + campaignId: + description: The ID of the campaign that owns this entity. + example: 211 + title: Campaign ID + type: integer + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + id: + description: Unique ID for this entity. + example: 6 + type: integer + action: + description: The limitable action of the limit counter. + example: setDiscount + type: string + profileId: + description: The profile ID for which this limit counter is used. + type: integer + profileIntegrationId: + description: The profile integration ID for which this limit counter is + used. + maxLength: 1000 + type: string + couponId: + description: The coupon ID for which this limit counter is used. + type: integer + couponValue: + description: The coupon value for which this limit counter is used. + type: string + referralId: + description: The referral ID for which this limit counter is used. + type: integer + referralValue: + description: The referral value for which this limit counter is used. + type: string + identifier: + description: The arbitrary identifier for which this limit counter is used. + type: integer + period: + description: The time period for which this limit counter is used. + example: Y2021M8 + type: string + limit: + description: The highest possible value for this limit counter. + example: 10.0 + type: number + counter: + description: The current value for this limit counter. + example: 5.0 + type: number + required: + - accountId + - action + - applicationId + - campaignId + - counter + - id + - limit + type: object + BulkCampaignNotification: + properties: + totalResultSize: + type: integer + data: + items: + $ref: '#/components/schemas/CampaignNotification' + type: array + required: + - data + - totalResultSize + type: object + CampaignNotification: + properties: + event: + description: | + The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] + type: string + required: + - event + type: object + BulkApplicationNotification: + properties: + totalResultSize: + type: integer + data: + items: + $ref: '#/components/schemas/ApplicationNotification' + type: array + required: + - data + - totalResultSize + type: object + ApplicationNotification: + properties: + event: + description: | + Event type. It can be one of the following: ['campaign_priorities_changed'] + type: string + required: + - event + type: object + CampaignStateChangedNotification: + description: A notification regarding a campaign whose state changed. + properties: + campaign: + $ref: '#/components/schemas/Campaign' + oldState: + description: | + The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + type: string + newState: + description: | + The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + type: string + required: + - campaign + - newState + - oldState + type: object + CampaignRulesetChangedNotification: + description: A notification regarding a campaign whose ruleset was changed. + properties: + campaign: + $ref: '#/components/schemas/Campaign' + oldRuleset: + $ref: '#/components/schemas/Ruleset' + ruleset: + $ref: '#/components/schemas/Ruleset' + required: + - campaign + - ruleset + type: object + CampaignEditedNotification: + description: A notification regarding a campaign which was edited. + properties: + campaign: + $ref: '#/components/schemas/Campaign' + oldCampaign: + $ref: '#/components/schemas/Campaign' + required: + - campaign + - oldCampaign + type: object + CampaignCreatedNotification: + description: A notification regarding a campaign that was created. + properties: + campaign: + $ref: '#/components/schemas/Campaign' + required: + - campaign + type: object + CampaignDeletedNotification: + description: A notification regarding a campaign that was deleted. + properties: + campaign: + $ref: '#/components/schemas/Campaign' + required: + - campaign + type: object + CampaignPrioritiesChangedNotification: + description: Notification about an Application whose campaigns' priorities changed. + properties: + application: + $ref: '#/components/schemas/Application' + oldPriorities: + additionalProperties: + items: + type: integer + type: array + description: | + Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] + type: object + priorities: + additionalProperties: + items: + type: integer + type: array + description: | + Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] + type: object required: - - archived - - disabled - - draft - - expired - - running - - scheduled + - application + - priorities type: object - RuleFailureReason: - description: Details about why a rule failed. + CampaignPriorities: + additionalProperties: + items: + type: integer + type: array + description: | + Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] + type: object + NewNotificationWebhook: example: - rulesetID: 5 - ruleIndex: 4 - campaignID: 7 - referralID: 3 - ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 - details: details - couponID: 4928 - referralValue: referralValue - campaignName: campaignName - couponValue: couponValue + headers: + - headers + - headers + url: url properties: - campaignID: - description: The ID of the campaign that contains the rule that failed - type: integer - campaignName: - description: The name of the campaign that contains the rule that failed - type: string - rulesetID: - description: The ID of the ruleset that contains the rule that failed - type: integer - couponID: - description: The ID of the coupon that was being evaluated at the time of - the rule failure - example: 4928 - type: integer - couponValue: - description: The value of the coupon that was being evaluated at the time - of the rule failure - type: string - referralID: - description: The ID of the referral that was being evaluated at the time - of the rule failure - type: integer - referralValue: - description: The value of the referral that was being evaluated at the time - of the rule failure - type: string - ruleIndex: - description: The index of the rule that failed within the ruleset - type: integer - ruleName: - description: The name of the rule that failed within the ruleset - type: string - conditionIndex: - description: The index of the condition that failed - type: integer - effectIndex: - description: The index of the effect that failed - type: integer - details: - description: More details about the failure + url: + description: API url for this notification webhook. type: string + headers: + description: List of API HTTP headers for this notification webhook. + items: + pattern: ^[^:,]+:[^,]*$ + type: string + type: array required: - - campaignID - - campaignName - - ruleIndex - - ruleName - - rulesetID + - headers + - url type: object - Giveaway: + NotificationWebhook: description: "" example: - code: code - importId: 1 - endDate: 2000-01-23T04:56:07.000+00:00 - created: 2000-01-23T04:56:07.000+00:00 - poolId: 4 - attributes: '{}' + headers: + - headers + - headers + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z id: 6 - used: true - startDate: 2000-01-23T04:56:07.000+00:00 + applicationId: 322 + url: url properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string - code: - description: The code value of this giveaway. - type: string - poolId: - description: The ID of the pool to return giveaway codes from. - type: integer - startDate: - description: Timestamp at which point the giveaway becomes valid. - format: date-time - type: string - endDate: - description: Timestamp at which point the giveaway becomes invalid. + modified: + description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string - attributes: - description: Arbitrary properties associated with this giveaway. - properties: {} - type: object - used: - description: Indicates whether this giveaway code was given before. - type: boolean - importId: - description: The ID of the Import which created this giveaway. + applicationId: + description: The ID of the application that owns this entity. + example: 322 type: integer + url: + description: API url for this notification webhook. + type: string + headers: + description: List of API HTTP headers for this notification webhook. + items: + pattern: ^[^:,]+:[^,]*$ + type: string + type: array required: - - code + - applicationId - created + - headers - id - - poolId + - modified + - url type: object - NewGiveawaysPool: + CouponLimitConfigs: properties: - name: - description: The name of this giveaways pool. - type: string - description: - description: The description of this giveaways pool. - type: string - subscribedApplicationsIds: - description: A list of the IDs of the applications that this giveaways pool - is enabled for + limits: + description: | + Limits configuration for a coupon. These limits will override the limits + set from the campaign. + + **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. + Only per-profile limits are allowed to be configured. items: - type: integer + $ref: '#/components/schemas/LimitConfig' type: array - required: - - name type: object - GiveawaysPool: + Return: description: "" + example: + returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + accountId: 3886 + eventId: 123 + profileIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + sessionIntegrationId: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + createdBy: 123 + created: 2020-06-10T09:05:27.993483Z + profileId: 123 + id: 6 + sessionId: 123 + applicationId: 322 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer accountId: description: The ID of the account that owns this entity. example: 3886 type: integer - name: - description: The name of this giveaways pool. + returnedCartItems: + description: List of cart items to be returned. + items: + $ref: '#/components/schemas/ReturnedCartItem' + type: array + eventId: + description: The event ID of that was generated for this return. + example: 123 + title: Event ID + type: integer + sessionId: + description: The internal ID of the session this return was requested on. + example: 123 + title: Session ID + type: integer + sessionIntegrationId: + description: The integration ID of the session this return was requested + on. + example: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + maxLength: 1000 + title: Session Integration ID type: string - description: - description: The description of this giveaways pool. + profileId: + description: The internal ID of the profile this return was requested on. + example: 123 + title: Profile ID + type: integer + profileIntegrationId: + description: The integration ID of the profile this return was requested + on. + example: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c + maxLength: 1000 + title: Profile Integration ID type: string - subscribedApplicationsIds: - description: A list of the IDs of the applications that this giveaways pool - is enabled for + createdBy: + description: ID of the user who requested this return. + example: 123 + title: Created By + type: integer + required: + - accountId + - applicationId + - created + - eventId + - id + - returnedCartItems + - sessionId + - sessionIntegrationId + type: object + NewReturn: + example: + returnedCartItems: + - quantity: 1 + position: 2 + - quantity: 1 + position: 2 + properties: + returnedCartItems: + description: List of cart items to be returned. + items: + $ref: '#/components/schemas/ReturnedCartItem' + type: array + required: + - returnedCartItems + type: object + ReturnedCartItem: + example: + quantity: 1 + position: 2 + properties: + position: + description: The index of the cart item in the provided customer session's + `cartItems` property. + example: 2 + type: integer + quantity: + description: | + Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) + is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. + example: 1 + type: integer + required: + - position + type: object + EventV2: + description: "" + properties: + profileId: + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. + example: URNGV8294NV + type: string + type: + description: A string representing the event. Must not be a reserved event + name. + example: email_opened + minLength: 1 + title: Event Type + type: string + attributes: + description: Arbitrary additional JSON data associated with the event. + example: + myAttribute: myValue + properties: {} + type: object + required: + - type + type: object + IntegrationEventV2Request: + description: "" + example: + profileId: URNGV8294NV + attributes: + myAttribute: myValue + type: email_opened + responseContent: + - triggeredCampaigns + - customerProfile + properties: + profileId: + description: | + ID of the customer profile set by your integration layer. + + **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. + example: URNGV8294NV + type: string + type: + description: A string representing the event. Must not be a reserved event + name. + example: email_opened + minLength: 1 + title: Event Type + type: string + attributes: + description: Arbitrary additional JSON data associated with the event. + example: + myAttribute: myValue + properties: {} + type: object + responseContent: + description: | + Optional list of requested information to be present on the response related to the tracking custom event. + example: + - triggeredCampaigns + - customerProfile + items: + enum: + - customerProfile + - triggeredCampaigns + - loyalty + - event + - awardedGiveaways + - ruleFailureReasons + type: string + type: array + required: + - type + type: object + MultipleNewAttribute: + properties: + attributes: items: - type: integer + $ref: '#/components/schemas/NewAttribute' type: array - modified: - description: Timestamp of the most recent update to the giveaways pool. - format: date-time - type: string - createdBy: - description: ID of the user who created this giveaways pool. - type: integer - modifiedBy: - description: ID of the user who last updated this giveaways pool if available. - type: integer - required: - - accountId - - created - - createdBy - - id - - name type: object - NewCustomEffect: - description: "" + MultipleAttribute: properties: - applicationIds: - description: The IDs of the applications that are related to this entity. + attributes: items: - type: integer - minItems: 1 + $ref: '#/components/schemas/Attribute' type: array - name: - description: The name of this effect. - type: string - title: - description: The title of this effect. - type: string - payload: - description: The JSON payload of this effect. - type: string + type: object + UpdateCatalog: + properties: description: - description: The description of this effect. + description: A description of this cart item catalog. + example: seafood catalog type: string - enabled: - description: Determines if this effect is active. - type: boolean - params: - description: Array of template argument definitions + name: + description: Name of this cart item catalog. + example: seafood + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that are subscribed to + this catalog. + example: + - 1 + - 2 + - 3 items: - $ref: '#/components/schemas/TemplateArgDef' + type: integer type: array - required: - - applicationIds - - enabled - - name - - payload - - title type: object - UpdateCustomEffect: + NewCatalog: description: "" properties: - applicationIds: - description: The IDs of the applications that are related to this entity. - items: - type: integer - minItems: 1 - type: array name: - description: The name of this effect. - type: string - title: - description: The title of this effect. - type: string - payload: - description: The JSON payload of this effect. + description: The cart item catalog name. + example: seafood type: string description: - description: The description of this effect. + description: A description of this cart item catalog. + example: seafood catalog type: string - enabled: - description: Determines if this effect is active. - type: boolean - params: - description: Array of template argument definitions + subscribedApplicationsIds: + description: A list of the IDs of the applications that are subscribed to + this catalog. + example: + - 1 + - 2 + - 3 items: - $ref: '#/components/schemas/TemplateArgDef' + type: integer type: array required: - - applicationIds - - enabled + - description - name - - payload - - title type: object - CustomEffect: + Catalog: description: "" + example: + accountId: 3886 + createdBy: 6 + created: 2020-06-10T09:05:27.993483Z + name: seafood + subscribedApplicationsIds: + - 1 + - 2 + - 3 + modified: 2021-09-12T10:12:42Z + description: seafood catalog + id: 6 + version: 6 properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string accountId: @@ -15603,382 +23165,316 @@ components: type: integer modified: description: The exact moment this entity was last modified. + example: 2021-09-12T10:12:42Z format: date-time type: string - applicationIds: - description: The IDs of the applications that are related to this entity. - items: - type: integer - minItems: 1 - type: array name: - description: The name of this effect. - type: string - title: - description: The title of this effect. - type: string - payload: - description: The JSON payload of this effect. + description: The cart item catalog name. + example: seafood type: string description: - description: The description of this effect. + description: A description of this cart item catalog. + example: seafood catalog type: string - enabled: - description: Determines if this effect is active. - type: boolean - params: - description: Array of template argument definitions + subscribedApplicationsIds: + description: A list of the IDs of the applications that are subscribed to + this catalog. + example: + - 1 + - 2 + - 3 items: - $ref: '#/components/schemas/TemplateArgDef' + type: integer type: array - modifiedBy: - description: ID of the user who last updated this effect if available. + version: + description: The current version of this catalog. + example: 6 type: integer createdBy: - description: ID of the user who created this effect. + description: The ID of user who created this catalog. + example: 6 type: integer required: - accountId - - applicationIds - created - createdBy - - enabled + - description - id - modified - name - - payload - - title + - version type: object - NewCollection: + CatalogSyncRequest: + example: + actions: + - payload: '{}' + type: ADD + - payload: '{}' + type: ADD + - payload: '{}' + type: ADD + - payload: '{}' + type: ADD + - payload: '{}' + type: ADD + version: 244 properties: - name: - description: The name of this collection. - minLength: 1 - type: string - description: - description: A short description of the purpose of this collection. - type: string + actions: + items: + $ref: '#/components/schemas/CatalogAction' + maxItems: 1000 + minItems: 1 + type: array + version: + description: The version number of the catalog to apply the actions on. + example: 244 + type: integer required: - - name + - actions type: object - UpdateCollection: - description: "" + CatalogAction: + description: Definition of all the properties that are needed for a single catalog + sync action. + example: + payload: '{}' + type: ADD properties: - name: - description: The name of this collection. - minLength: 1 - type: string - description: - description: A short description of the purpose of this collection. + type: + description: The type of sync action. + enum: + - ADD + - PATCH + - PATCH_MANY + - REMOVE + - REMOVE_MANY + example: ADD type: string + payload: + type: object required: - - name + - payload + - type type: object - Collection: - description: "" + CatalogActionPayload: + type: object + CatalogActionFilter: + description: The properties for a single filtering condition in a catalog sync + action. properties: - id: - description: Unique ID for this entity. - example: 6 - type: integer - created: - description: The exact moment this entity was created. - format: date-time - type: string - accountId: - description: The ID of the account that owns this entity. - example: 3886 - type: integer - applicationId: - description: The ID of the application that owns this entity. - example: 322 - type: integer - campaignId: - description: The ID of the campaign that owns this entity. - example: 211 - title: Campaign ID - type: integer - modified: - description: The exact moment this entity was last modified. - format: date-time + attr: + description: The name of the attribute to filter on. type: string - name: - description: The name of this collection. - minLength: 1 - type: string - description: - description: A short description of the purpose of this collection. + op: + description: The filtering operator. + enum: + - EQ + - LT + - LE + - GT + - GE + - IN type: string - payload: - description: Payload contains limited amount of collection items - items: - type: string - type: array - modifiedBy: - description: ID of the user who last updated this effect if available. - type: integer - createdBy: - description: ID of the user who created this effect. - type: integer + value: + description: The value to filter for. + type: object required: - - accountId - - applicationId - - campaignId - - created - - createdBy - - id - - modified - - name + - attr + - op + - value type: object - NewCouponCreationJob: - description: "" + AddItemCatalogAction: + description: The specific properties of the "ADD" catalog sync action. properties: - usageLimit: - description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. - example: 100 - maximum: 999999 - minimum: 0 - type: integer - discountLimit: - description: | - The amount of discounts that can be given with this coupon code. - example: 30.0 - maximum: 999999 - minimum: 0 - type: number - startDate: - description: Timestamp at which point the coupon becomes valid. - format: date-time + sku: + description: The unique SKU of the item to add. + example: SKU1241028 type: string - expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. - format: date-time + price: + description: Price of the item. + example: 99.99 + type: number + attributes: + description: The attributes of the item to add. + example: + origin: germany + color: blue + properties: {} + type: object + replaceIfExists: + default: false + description: Indicates whether to replace the attributes of the item if + the same SKU exists. + example: false + type: boolean + required: + - sku + type: object + PatchItemCatalogAction: + description: The specific properties of the "PATCH" catalog sync action. + properties: + sku: + description: The unique SKU of the item to patch. type: string - numberOfCoupons: - description: The number of new coupon codes to generate for the campaign. - Must be between 20,001 and 5,000,000. - type: integer - couponSettings: - $ref: '#/components/schemas/CodeGeneratorSettings' + price: + description: Price of the item. + example: 99.99 + type: number attributes: - description: Arbitrary properties associated with coupons + description: The attributes of the item to patch. properties: {} type: object + createIfNotExists: + default: false + description: Indicates whether to create an item if the SKU does not exist. + type: boolean required: - - attributes - - numberOfCoupons - - usageLimit + - sku type: object - CouponCreationJob: + PatchManyItemsCatalogAction: + description: The specific properties of the "PATCH_MANY" catalog sync action. + properties: + price: + description: Price of the item. + example: 99.99 + type: number + filters: + description: | + The list of filters used to select the items to patch, joined by `AND`. + + **Note:** Every item in the catalog will be modified if there are no filters. + items: + $ref: '#/components/schemas/CatalogActionFilter' + type: array + attributes: + description: The attributes of the items to patch. + properties: {} + type: object + type: object + RemoveItemCatalogAction: + description: The specific properties of the "REMOVE" catalog sync action. + properties: + sku: + description: The unique SKU of the item to remove. + type: string + required: + - sku + type: object + RemoveManyItemsCatalogAction: + description: The specific properties of the "REMOVE_MANY" catalog sync action. + properties: + filters: + description: | + The list of filters used to select the items to patch, joined by `AND`. + + **Note:** Every item in the catalog will be removed if there are no filters. + items: + $ref: '#/components/schemas/CatalogActionFilter' + type: array + type: object + CatalogItem: description: "" properties: id: - description: Unique ID for this entity. + description: Unique ID for this entity. Not to be confused with the Integration + ID, which is set by your integration layer and used in most endpoints. example: 6 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string - campaignId: - description: The ID of the campaign that owns this entity. - example: 211 - title: Campaign ID - type: integer - applicationId: - description: The ID of the application that owns this entity. - example: 322 - type: integer - accountId: - description: The ID of the account that owns this entity. - example: 3886 - type: integer - usageLimit: - description: | - The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. - example: 100 - maximum: 999999 - minimum: 0 - type: integer - discountLimit: - description: | - The amount of discounts that can be given with this coupon code. - example: 30.0 - maximum: 999999 - minimum: 0 - type: number - startDate: - description: Timestamp at which point the coupon becomes valid. - format: date-time - type: string - expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. - format: date-time - type: string - numberOfCoupons: - description: The number of new coupon codes to generate for the campaign. - Must be between 20,001 and 5,000,000. - type: integer - couponSettings: - $ref: '#/components/schemas/CodeGeneratorSettings' - attributes: - description: Arbitrary properties associated with coupons - properties: {} - type: object - batchId: - description: The batch ID coupons created by this job will bear - title: Batch ID - type: string - status: - description: The current status of this request. The value should be either - 'pending', 'completed' or 'failed' - title: Job Status + sku: + description: The stock keeping unit of the item. + example: SKU1241028 type: string - createdAmount: - description: The number of coupon codes that were already created for this - request - title: Created Amount + price: + description: Price of the item. + example: 99.99 + type: number + x-fieldType: NullDecimal + catalogid: + description: The ID of the catalog the item belongs to. + example: 6 type: integer - failCount: - description: The number of times this job failed - title: Fail Count + version: + description: The version of the catalog item. + minimum: 1 type: integer - errors: - description: An array of individual problems encountered during the request. + attributes: items: - type: string - title: Errors + $ref: '#/components/schemas/ItemAttribute' type: array - createdBy: - description: ID of the user who created this effect. - title: Created By - type: integer - communicated: - description: Whether or not the user that created this job was notified - of its final state - type: boolean - batchExecutionCount: - description: The number of times an attempt to create a batch of coupons - was made during the processing of the job - title: Iterations - type: integer required: - - accountId - - applicationId - - attributes - - batchExecutionCount - - batchId - - campaignId - - communicated + - catalogid - created - - createdAmount - - createdBy - - errors - - failCount - id - - numberOfCoupons - - status - - usageLimit + - sku + - version type: object - LimitCounter: + ItemAttribute: description: "" properties: - campaignId: - description: The ID of the campaign that owns this entity. - example: 211 - title: Campaign ID - type: integer - applicationId: - description: The ID of the application that owns this entity. - example: 322 - type: integer - accountId: - description: The ID of the account that owns this entity. - example: 3886 - type: integer - id: - description: Unique ID for this entity. + attributeid: + description: The ID of the attribute of the item. example: 6 type: integer - action: - description: The limitable action of the limit counter. - example: setDiscount - type: string - profileId: - description: The profile ID for which this limit counter is used. - type: integer - profileIntegrationId: - description: The profile integration ID for which this limit counter is - used. - type: string - couponId: - description: The coupon ID for which this limit counter is used. - type: integer - couponValue: - description: The coupon value for which this limit counter is used. - type: string - referralId: - description: The referral ID for which this limit counter is used. - type: integer - referralValue: - description: The referral value for which this limit counter is used. - type: string - identifier: - description: The arbitrary identifier for which this limit counter is used. - type: integer - period: - description: The time period for which this limit counter is used. - example: Y2021M8 + name: + description: The name of the attribute. type: string - limit: - description: The highest possible value for this limit counter. - example: 10.0 - type: number - counter: - description: The current value for this limit counter. - example: 5.0 - type: number + value: + description: The value of the attribute. + type: object required: - - accountId - - action - - applicationId - - campaignId - - counter - - id - - limit + - attributeid + - name + - value + type: object + CampaignActivationRequest: + properties: + userIds: + description: The list of IDs of the users who will receive the activation + request. + example: + - 1 + - 2 + - 3 + items: + type: integer + maxItems: 5 + type: array + required: + - userIds type: object inline_response_201: example: data: - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId + startDate: 2020-11-10T23:00:00Z + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-11-10T23:00:00Z totalResultSize: 0 properties: totalResultSize: @@ -15993,7 +23489,7 @@ components: inline_response_200: example: data: - - accountId: 7 + - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -16001,19 +23497,19 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 - - accountId: 7 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 + - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -16021,18 +23517,18 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 totalResultSize: 0 properties: totalResultSize: @@ -16048,10 +23544,10 @@ components: example: data: - enableFlattenedCartItems: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin sandbox: true - description: description + description: A test Application attributesSettings: mandatory: campaigns: @@ -16065,79 +23561,93 @@ components: enableCascadingDiscounts: true campaignPriority: universal loyaltyPrograms: - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending + - cardBased: true tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description - id: 6 - title: title + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending - tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program id: 6 - title: title + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 - name: name + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program + id: 6 + name: My Application exclusiveCampaignsStrategy: listOrder - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z defaultDiscountScope: sessionTotal - currency: currency + currency: EUR attributes: '{}' + defaultDiscountAdditionalCostPerItemScope: price id: 6 limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action + limit: 1000.0 + action: createCoupon + enablePartialDiscounts: false - enableFlattenedCartItems: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin sandbox: true - description: description + description: A test Application attributesSettings: mandatory: campaigns: @@ -16151,74 +23661,88 @@ components: enableCascadingDiscounts: true campaignPriority: universal loyaltyPrograms: - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending + - cardBased: true tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description - id: 6 - title: title + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending - tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program id: 6 - title: title + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection subscribedApplications: - - 1 - - 1 - name: name + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program + id: 6 + name: My Application exclusiveCampaignsStrategy: listOrder - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z defaultDiscountScope: sessionTotal - currency: currency + currency: EUR attributes: '{}' + defaultDiscountAdditionalCostPerItemScope: price id: 6 limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action + limit: 1000.0 + action: createCoupon + enablePartialDiscounts: false totalResultSize: 0 properties: totalResultSize: @@ -16233,127 +23757,141 @@ components: inline_response_200_2: example: data: - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 8 - discountCount: 7.143538047012306 - description: description + - callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions templateId: 3 + customEffectCount: 0 features: - coupons - - coupons - createdLoyaltyPointsCount: 4.652396432933246 + - referrals + createdLoyaltyPointsCount: 9.0 couponSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters - startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + - A + - B + - C + - D + - E + - "2" + - "0" + startTime: 2021-07-20T22:00:00Z + id: 3 state: enabled limits: - - period: daily + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - - period: daily + limit: 1000.0 + action: createCoupon + - period: yearly entities: - Coupon - - Coupon - limit: 0.5944895607614016 - action: action - activeRulesetId: 6 - updatedBy: updatedBy + limit: 1000.0 + action: createCoupon + activeRulesetId: 4 + updatedBy: Jane Doe created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 6 - couponRedemptionCount: 3 - userId: 6 - couponCreationCount: 7 + referralCreationCount: 8 + couponRedemptionCount: 163 + userId: 2 + couponCreationCount: 16 campaignGroups: - - 6 - - 6 + - 1 + - 3 tags: - - tags - - tags - - tags - - tags - - tags - awardedGiveawaysCount: 0 - redeemedLoyaltyPointsEffectCount: 3 - discountEffectCount: 0 - createdBy: createdBy - redeemedLoyaltyPointsCount: 7.740351818741173 - name: name + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + discountEffectCount: 343 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions referralSettings: - couponPattern: couponPattern + couponPattern: SUMMER-####-#### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - "2" + - "0" attributes: '{}' - lastActivity: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z applicationId: 322 referralRedemptionCount: 3 updated: 2000-01-23T04:56:07.000+00:00 @@ -16371,121 +23909,175 @@ components: inline_response_200_3: example: data: - - rbVersion: rbVersion - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 1 - bindings: - - expression: - - '{}' - - '{}' - name: name - type: type - - expression: - - '{}' - - '{}' - name: name - type: type + - headers: + - headers + - headers + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + id: 6 + applicationId: 322 + url: url + - headers: + - headers + - headers + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + id: 6 + applicationId: 322 + url: url + totalResultSize: 0 + properties: + totalResultSize: + type: integer + data: + items: + $ref: '#/components/schemas/NotificationWebhook' + type: array + required: + - data + - totalResultSize + inline_response_200_4: + example: + data: + - rbVersion: v2 + created: 2020-06-10T09:05:27.993483Z + campaignId: 320 + bindings: [] activatedAt: 2000-01-23T04:56:07.000+00:00 activate: true rules: - condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon - condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon id: 6 - templateId: 5 + templateId: 3 userId: 6 - - rbVersion: rbVersion - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 1 - bindings: - - expression: - - '{}' - - '{}' - name: name - type: type - - expression: - - '{}' - - '{}' - name: name - type: type + - rbVersion: v2 + created: 2020-06-10T09:05:27.993483Z + campaignId: 320 + bindings: [] activatedAt: 2000-01-23T04:56:07.000+00:00 activate: true rules: - condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon - condition: - - '{}' - - '{}' + - and + - - couponValid effects: - - '{}' - - '{}' + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 bindings: - expression: - '{}' - '{}' - name: name - type: type + valueType: string + name: my property + type: templateParameter - expression: - '{}' - '{}' - name: name - type: type - description: description - title: title + valueType: string + name: my property + type: templateParameter + description: Creates a discount when a coupon is valid + title: Give discount via coupon id: 6 - templateId: 5 + templateId: 3 userId: 6 totalResultSize: 0 properties: @@ -16498,43 +24090,65 @@ components: required: - data - totalResultSize - inline_response_200_4: + inline_response_200_5: example: data: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 totalResultSize: 0 properties: totalResultSize: @@ -16546,157 +24160,303 @@ components: required: - data - totalResultSize - inline_response_200_5: + inline_response_200_6: example: data: - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 - reservation: true + importId: 9 + reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 - - recipientIntegrationId: recipientIntegrationId - created: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + - recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 3.5571952270680973 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 9 + reservation: false + attributes: '{}' + id: 6 + value: XMAS-20-2021 + discountLimit: 30.0 + startDate: 2000-01-23T04:56:07.000+00:00 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 7.061401241503109 + hasMore: true + properties: + hasMore: + type: boolean + data: + items: + $ref: '#/components/schemas/Coupon' + type: array + required: + - data + - hasMore + inline_response_200_7: + example: + data: + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z + importId: 1 + friendProfileIntegrationId: BZGGC2454PA + attributes: '{}' + id: 6 + startDate: 2020-11-10T23:00:00Z + - code: 27G47Y54VH9L + created: 2020-06-10T09:05:27.993483Z + usageLimit: 1 + campaignId: 78 + usageCounter: 1 + batchId: tqyrgahe + advocateProfileIntegrationId: URNGV8294NV + expiryDate: 2021-11-10T23:00:00Z importId: 1 - reservation: true + friendProfileIntegrationId: BZGGC2454PA attributes: '{}' id: 6 - value: XMAS-20-2021 - discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 6.965117697638846 + startDate: 2020-11-10T23:00:00Z + hasMore: true + properties: + hasMore: + type: boolean + data: + items: + $ref: '#/components/schemas/Referral' + type: array + required: + - data + - hasMore + inline_response_200_8: + example: + data: + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection + subscribedApplications: + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program + id: 6 + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection + subscribedApplications: + - 132 + - 97 + accountID: 1 + defaultValidity: unlimited + defaultPending: immediate + allowSubledger: false + name: my_program + id: 6 + totalResultSize: 0 + properties: + totalResultSize: + type: integer + data: + items: + $ref: '#/components/schemas/LoyaltyProgram' + type: array + required: + - data + - totalResultSize + inline_response_200_9: + example: + data: + - accountId: 3886 + createdBy: 134 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 + - accountId: 3886 + createdBy: 134 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: + - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 hasMore: true + totalResultSize: 0 properties: hasMore: type: boolean + totalResultSize: + type: integer data: items: - $ref: '#/components/schemas/Coupon' + $ref: '#/components/schemas/CollectionWithoutPayload' type: array required: - data - - hasMore - inline_response_200_6: + inline_response_200_10: example: data: - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId - attributes: '{}' - id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - created: 2000-01-23T04:56:07.000+00:00 - usageLimit: 668355 - campaignId: 8 - usageCounter: 6 - batchId: batchId - advocateProfileIntegrationId: advocateProfileIntegrationId - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 - friendProfileIntegrationId: friendProfileIntegrationId - attributes: '{}' - id: 6 - startDate: 2000-01-23T04:56:07.000+00:00 + - item: item + - item: item hasMore: true properties: hasMore: type: boolean data: items: - $ref: '#/components/schemas/Referral' + $ref: '#/components/schemas/CollectionItem' type: array required: - data - hasMore - inline_response_200_7: + inline_response_200_11: example: data: - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending - tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description - id: 6 - title: title - subscribedApplications: - - 1 + - accountId: 3886 + createdBy: 134 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: - 1 - - accountID: 5 - defaultValidity: defaultValidity - defaultPending: defaultPending - tiers: - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - - created: 2000-01-23T04:56:07.000+00:00 - name: name - minPoints: 2.302135886934765E7 - id: 6 - programID: 5 - allowSubledger: true - created: 2000-01-23T04:56:07.000+00:00 - timezone: timezone - name: name - description: description + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 id: 6 - title: title - subscribedApplications: - - 1 + applicationId: 1 + - accountId: 3886 + createdBy: 134 + payload: + - KTL-WH-ET-1 + - KTL-BL-ET-1 + created: 2020-06-10T09:05:27.993483Z + campaignId: 7 + subscribedApplicationsIds: - 1 + - 2 + - 3 + name: My collection + modified: 2021-09-12T10:12:42Z + description: My collection of SKUs + modifiedBy: 48 + id: 6 + applicationId: 1 + hasMore: true totalResultSize: 0 properties: + hasMore: + type: boolean totalResultSize: type: integer data: items: - $ref: '#/components/schemas/LoyaltyProgram' + $ref: '#/components/schemas/Collection' type: array required: - data - - totalResultSize - inline_response_200_8: + inline_response_200_12: example: data: - method: method @@ -16724,7 +24484,7 @@ components: required: - data - hasMore - inline_response_200_9: + inline_response_200_13: example: data: - method: method @@ -16752,7 +24512,7 @@ components: required: - data - totalResultSize - inline_response_200_10: + inline_response_200_14: example: data: - date: 2000-01-23T04:56:07.000+00:00 @@ -16816,7 +24576,7 @@ components: required: - data - totalResultSize - inline_response_200_11: + inline_response_200_15: example: data: - accountId: 1 @@ -16827,19 +24587,19 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 - accountId: 1 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 @@ -16848,19 +24608,19 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 hasMore: true totalResultSize: 0 properties: @@ -16874,7 +24634,7 @@ components: type: array required: - data - inline_response_200_12: + inline_response_200_16: example: data: - accountId: 1 @@ -16885,19 +24645,19 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 - accountId: 1 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 @@ -16906,19 +24666,19 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 advocateIntegrationId: advocateIntegrationId audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 hasMore: true properties: hasMore: @@ -16930,10 +24690,10 @@ components: required: - data - hasMore - inline_response_200_13: + inline_response_200_17: example: data: - - accountId: 7 + - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -16941,19 +24701,19 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 - - accountId: 7 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 + - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 integrationId: URNGV8294NV @@ -16961,18 +24721,18 @@ components: Language: english ShippingCountry: DE totalSales: 299.99 - lastActivity: 2000-01-23T04:56:07.000+00:00 + lastActivity: 2020-02-08T14:15:20Z id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 9 + loyaltyProgramId: 323414846 audienceMemberships: - - name: name - id: 3 - - name: name - id: 3 + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 hasMore: true properties: hasMore: @@ -16984,11 +24744,11 @@ components: required: - data - hasMore - inline_response_200_14: + inline_response_200_18: example: data: - couponUseAttempts: 1 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z totalOrdersNoCoupon: 9 integrationId: URNGV8294NV couponRedemptions: 6 @@ -17001,7 +24761,7 @@ components: campaignName: campaignName accruedDiscounts: 5.637376656633329 - couponUseAttempts: 1 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-02-07T08:15:22Z totalOrdersNoCoupon: 9 integrationId: URNGV8294NV couponRedemptions: 6 @@ -17024,87 +24784,113 @@ components: required: - data - hasMore - inline_response_200_15: + inline_response_200_19: example: data: - - coupon: coupon + - coupon: BKDB946 created: 2000-01-23T04:56:07.000+00:00 + totalDiscounts: 100.0 integrationId: URNGV8294NV - profileintegrationid: profileintegrationid - total: 6.027456183070403 - referral: referral + profileintegrationid: 382370BKDB946 + total: 200.0 + referral: BKDB946 discounts: key: 0.8008281904610115 profileId: 138 attributes: '{}' id: 6 - state: open + state: closed applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - coupon: coupon + - coupon: BKDB946 created: 2000-01-23T04:56:07.000+00:00 + totalDiscounts: 100.0 integrationId: URNGV8294NV - profileintegrationid: profileintegrationid - total: 6.027456183070403 - referral: referral + profileintegrationid: 382370BKDB946 + total: 200.0 + referral: BKDB946 discounts: key: 0.8008281904610115 profileId: 138 attributes: '{}' id: 6 - state: open + state: closed applicationId: 322 cartItems: - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 - - quantity: 1 + - remainingQuantity: 1 + quantity: 1 + returnedQuantity: 1 + length: 1.4658129805029452 + weight: 1130.0 + catalogItemID: 5 + additionalCosts: + shipping: + price: 9 price: 99.99 name: Air Glide width: 6.027456183070403 - length: 1.4658129805029452 - weight: 1130.0 attributes: image: 11.jpeg material: leather position: 5.962133916683182 - sku: "124102847" + sku: SKU1241028 category: shoes height: 0.8008281904610115 hasMore: true @@ -17117,13 +24903,13 @@ components: type: array required: - data - inline_response_200_16: + inline_response_200_20: example: data: - effects: - '{}' - '{}' - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: 138 attributes: '{}' id: 6 @@ -17131,25 +24917,25 @@ components: applicationId: 322 type: type ruleFailureReasons: - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue @@ -17158,7 +24944,7 @@ components: - effects: - '{}' - '{}' - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z profileId: 138 attributes: '{}' id: 6 @@ -17166,25 +24952,25 @@ components: applicationId: 322 type: type ruleFailureReasons: - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 5 - ruleIndex: 4 + - rulesetID: 1 + ruleIndex: 1 campaignID: 7 - referralID: 3 + referralID: 1 ruleName: ruleName - conditionIndex: 0 - effectIndex: 6 + conditionIndex: 6 + effectIndex: 7 details: details couponID: 4928 referralValue: referralValue @@ -17201,7 +24987,7 @@ components: required: - data - hasMore - inline_response_200_17: + inline_response_200_21: example: data: - data @@ -17217,21 +25003,27 @@ components: required: - data - totalResultSize - inline_response_200_18: + inline_response_200_22: example: data: - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 - name: mPTravel + created: 2020-06-10T09:05:27.993483Z + name: Travel audience + sandbox: true integration: mparticle - integrationId: URNGV8294NV + description: Travel audience 18-25 + integrationId: 382370BKDB946 id: 6 + createdIn3rdParty: false - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 - name: mPTravel + created: 2020-06-10T09:05:27.993483Z + name: Travel audience + sandbox: true integration: mparticle - integrationId: URNGV8294NV + description: Travel audience 18-25 + integrationId: 382370BKDB946 id: 6 + createdIn3rdParty: false hasMore: true totalResultSize: 0 properties: @@ -17245,7 +25037,7 @@ components: type: array required: - data - inline_response_200_19: + inline_response_200_23: example: data: - friendIntegrationId: friendIntegrationId @@ -17275,17 +25067,26 @@ components: - data - hasMore - totalResultSize - inline_response_200_20: + inline_response_200_24: example: data: - - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + - created: 2020-06-10T09:05:27.993483Z editable: true - name: name subscribedApplicationsIds: - 6 - 6 description: description + restrictedBySuggestions: false + eventType: eventType + title: title + type: string + accountId: 3886 + eventTypeId: 22 + hasAllowedList: false + allowedSubscriptions: + - application + - application + name: name suggestions: - suggestions - suggestions @@ -17293,18 +25094,27 @@ components: - suggestions - suggestions id: 6 - eventType: eventType - title: title - type: string + subscribedCatalogsIds: + - 1 + - 1 entity: Account - - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + - created: 2020-06-10T09:05:27.993483Z editable: true - name: name subscribedApplicationsIds: - 6 - 6 description: description + restrictedBySuggestions: false + eventType: eventType + title: title + type: string + accountId: 3886 + eventTypeId: 22 + hasAllowedList: false + allowedSubscriptions: + - application + - application + name: name suggestions: - suggestions - suggestions @@ -17312,9 +25122,9 @@ components: - suggestions - suggestions id: 6 - eventType: eventType - title: title - type: string + subscribedCatalogsIds: + - 1 + - 1 entity: Account totalResultSize: 0 properties: @@ -17327,11 +25137,11 @@ components: required: - data - totalResultSize - inline_response_200_21: + inline_response_200_25: example: data: - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z name: name subscribedApplicationsIds: - 6 @@ -17339,8 +25149,9 @@ components: description: description id: 6 title: title + type: session - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z name: name subscribedApplicationsIds: - 6 @@ -17348,6 +25159,7 @@ components: description: description id: 6 title: title + type: session totalResultSize: 0 properties: totalResultSize: @@ -17359,16 +25171,16 @@ components: required: - data - totalResultSize - inline_response_200_22: + inline_response_200_26: example: data: - headers: - headers - headers payload: payload - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z verb: POST - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z id: 6 title: title params: @@ -17389,9 +25201,9 @@ components: - headers - headers payload: payload - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z verb: POST - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z id: 6 title: title params: @@ -17419,7 +25231,7 @@ components: required: - data - totalResultSize - inline_response_200_23: + inline_response_200_27: example: data: - webhookId: 6 @@ -17443,7 +25255,7 @@ components: required: - data - totalResultSize - inline_response_200_24: + inline_response_200_28: example: data: - requestTime: 2000-01-23T04:56:07.000+00:00 @@ -17477,37 +25289,19 @@ components: required: - data - totalResultSize - inline_response_200_25: + inline_response_200_29: example: data: - - schema: '{}' - handler: handler - examplePayload: examplePayload - created: 2000-01-23T04:56:07.000+00:00 + - created: 2020-06-10T09:05:27.993483Z name: name description: description id: 6 - mimeType: application/json - handlerLanguage: talang title: title - version: 1 - applicationIds: - - 6 - - 6 - - schema: '{}' - handler: handler - examplePayload: examplePayload - created: 2000-01-23T04:56:07.000+00:00 + - created: 2020-06-10T09:05:27.993483Z name: name description: description id: 6 - mimeType: application/json - handlerLanguage: talang title: title - version: 1 - applicationIds: - - 6 - - 6 totalResultSize: 0 properties: totalResultSize: @@ -17519,39 +25313,39 @@ components: required: - data - totalResultSize - inline_response_200_26: + inline_response_200_30: example: data: - - created: 2000-01-23T04:56:07.000+00:00 + - created: 2020-06-10T09:05:27.993483Z roles: - - 6 - - 6 + - 71 accountId: 3886 applicationNotificationSubscriptions: '{}' - inviteToken: inviteToken - name: name - modified: 2000-01-23T04:56:07.000+00:00 + inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 + name: John Doe + modified: 2021-09-12T10:12:42Z id: 6 state: invited - latestFeedTimestamp: 2000-01-23T04:56:07.000+00:00 - authMethod: authMethod + latestFeedTimestamp: 2020-06-01T00:00:00Z + authMethod: basic_auth email: john.doe@example.com - policy: '{}' - - created: 2000-01-23T04:56:07.000+00:00 + policy: + Role: 127 + - created: 2020-06-10T09:05:27.993483Z roles: - - 6 - - 6 + - 71 accountId: 3886 applicationNotificationSubscriptions: '{}' - inviteToken: inviteToken - name: name - modified: 2000-01-23T04:56:07.000+00:00 + inviteToken: Gy9b8w1irmQtEPo5RmbMmSPheL5h4 + name: John Doe + modified: 2021-09-12T10:12:42Z id: 6 state: invited - latestFeedTimestamp: 2000-01-23T04:56:07.000+00:00 - authMethod: authMethod + latestFeedTimestamp: 2020-06-01T00:00:00Z + authMethod: basic_auth email: john.doe@example.com - policy: '{}' + policy: + Role: 127 totalResultSize: 0 properties: totalResultSize: @@ -17563,23 +25357,41 @@ components: required: - data - totalResultSize - inline_response_200_27: + inline_response_200_31: example: data: - - new: '{}' - created: 2000-01-23T04:56:07.000+00:00 + - new: + applicationId": 359 + attributes": {} + campaignGroups": [] + created": 2022-07-08T13:04:02.972762328Z + description": "" + features": + - referrals + - loyalty + id: 6727 + created: 2020-06-10T09:05:27.993483Z old: '{}' id: 6 - applicationId: 1 + applicationId: 359 userId: 6 - entity: entity - - new: '{}' - created: 2000-01-23T04:56:07.000+00:00 + entity: /v1/applications/359/campaigns/6727 + - new: + applicationId": 359 + attributes": {} + campaignGroups": [] + created": 2022-07-08T13:04:02.972762328Z + description": "" + features": + - referrals + - loyalty + id: 6727 + created: 2020-06-10T09:05:27.993483Z old: '{}' id: 6 - applicationId: 1 + applicationId: 359 userId: 6 - entity: entity + entity: /v1/applications/359/campaigns/6727 hasMore: true totalResultSize: 0 properties: @@ -17593,18 +25405,18 @@ components: type: array required: - data - inline_response_200_28: + inline_response_200_32: example: data: - filter: '{}' accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z id: 6 userId: 6 entity: Coupon - filter: '{}' accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z id: 6 userId: 6 entity: Coupon @@ -17619,28 +25431,28 @@ components: required: - data - totalResultSize - inline_response_200_29: + inline_response_200_33: example: data: - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z campaignGroupID: 6 members: - 1 - 1 name: name - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z description: description id: 6 acl: '{}' - accountId: 3886 - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z campaignGroupID: 6 members: - 1 - 1 name: name - modified: 2000-01-23T04:56:07.000+00:00 + modified: 2021-09-12T10:12:42Z description: description id: 6 acl: '{}' diff --git a/api_integration.go b/api_integration.go index a2431b53..b052e89f 100644 --- a/api_integration.go +++ b/api_integration.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,6 +15,7 @@ import ( _nethttp "net/http" _neturl "net/url" "strings" + "time" ) // Linger please @@ -38,12 +39,20 @@ func (r apiCreateAudienceV2Request) Body(body NewAudience) apiCreateAudienceV2Re /* CreateAudienceV2 Create audience -Create an Audience. -Only use this endpoint to sync existing audiences from other platforms through a 3rd party integration. +Create an audience. The audience can be created directly from scratch or can come from third party platforms. -Once you create your first audience, new audience-specific rule conditions are enabled in the Rule Builder. +To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): +1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. +1. Set `integrationId` to the ID of this audience in a third-party platform. -**Important:** The authentication requires an mParticle API key instead of a Talon.One API key. +To create an audience from an existing audience in another platform: +1. Do not use the `integration` property. +1. Set `integrationId` to the ID of this audience in the 3rd-party platform. + +To create an audience from scratch: +1. Only set the `name` property. + +Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return apiCreateAudienceV2Request @@ -146,6 +155,36 @@ func (r apiCreateAudienceV2Request) Execute() (Audience, *_nethttp.Response, err return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -187,15 +226,20 @@ If a coupon gets created for a specific user, it will automatically show up in t When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data endpoint](/integration-api/#operation/getCustomerInventory). -**Important:** This endpoint doesn't create a **strict** reservation. _Any_ customer -can use a reserved coupon code and proceed to checkout. +**Important:** +- This endpoint creates a **soft** reservation. _Any_ customer + can use a reserved coupon code and proceed to checkout. +- To create a hard reservation, use the + [Create coupons](/management-api/#operation/createCoupons) or + [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints + setting the `recipientsIntegrationId` property. -For example, you can use this endpoint and `List customer data` to create a "coupon wallet" by -reserving coupon codes for a customer, and then displaying their "coupon wallet" +For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by +reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param couponValue The value of a coupon + * @param couponValue The code of the coupon. @return apiCreateCouponReservationRequest */ func (a *IntegrationApiService) CreateCouponReservation(ctx _context.Context, couponValue string) apiCreateCouponReservationRequest { @@ -298,6 +342,36 @@ func (r apiCreateCouponReservationRequest) Execute() (Coupon, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -430,6 +504,26 @@ func (r apiCreateReferralRequest) Execute() (Referral, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -573,6 +667,25 @@ func (r apiCreateReferralsForMultipleAdvocatesRequest) Execute() (InlineResponse newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -598,8 +711,6 @@ type apiDeleteAudienceMembershipsV2Request struct { DeleteAudienceMembershipsV2 Delete audience memberships Remove all members from this audience. -**Important:** The authentication requires an mParticle API key instead of a Talon.One API key. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). @return apiDeleteAudienceMembershipsV2Request @@ -647,7 +758,7 @@ func (r apiDeleteAudienceMembershipsV2Request) Execute() (*_nethttp.Response, er } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -689,6 +800,25 @@ func (r apiDeleteAudienceMembershipsV2Request) Execute() (*_nethttp.Response, er body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -707,8 +837,6 @@ Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. -**Important:** The authentication requires an mParticle API key instead of a Talon.One API key. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). @return apiDeleteAudienceV2Request @@ -756,7 +884,7 @@ func (r apiDeleteAudienceV2Request) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -798,6 +926,35 @@ func (r apiDeleteAudienceV2Request) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -818,10 +975,11 @@ func (r apiDeleteCouponReservationRequest) Body(body CouponReservations) apiDele /* DeleteCouponReservation Delete coupon reservations -Remove all passed customer profiles reservation from this coupon. +Remove all the coupon reservations from the provided customer profile integration IDs and the provided +coupon code. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param couponValue The value of a coupon + * @param couponValue The code of the coupon. @return apiDeleteCouponReservationRequest */ func (a *IntegrationApiService) DeleteCouponReservation(ctx _context.Context, couponValue string) apiDeleteCouponReservationRequest { @@ -871,7 +1029,7 @@ func (r apiDeleteCouponReservationRequest) Execute() (*_nethttp.Response, error) } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -915,6 +1073,35 @@ func (r apiDeleteCouponReservationRequest) Execute() (*_nethttp.Response, error) body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -928,11 +1115,13 @@ type apiDeleteCustomerDataRequest struct { } /* -DeleteCustomerData Delete the personal data of a customer -Delete all attributes on the customer profile and on entities that reference that customer profile. +DeleteCustomerData Delete customer's personal data +Delete all attributes on the customer profile and on entities that reference this customer profile. + +**Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param integrationId The custom identifier for this profile, must be unique within the account. + * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). @return apiDeleteCustomerDataRequest */ func (a *IntegrationApiService) DeleteCustomerData(ctx _context.Context, integrationId string) apiDeleteCustomerDataRequest { @@ -978,7 +1167,7 @@ func (r apiDeleteCustomerDataRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -1020,6 +1209,25 @@ func (r apiDeleteCustomerDataRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -1027,14 +1235,15 @@ func (r apiDeleteCustomerDataRequest) Execute() (*_nethttp.Response, error) { } type apiGetCustomerInventoryRequest struct { - ctx _context.Context - apiService *IntegrationApiService - integrationId string - profile *bool - referrals *bool - coupons *bool - loyalty *bool - giveaways *bool + ctx _context.Context + apiService *IntegrationApiService + integrationId string + profile *bool + referrals *bool + coupons *bool + loyalty *bool + giveaways *bool + loyaltyProjectionEndDate *time.Time } func (r apiGetCustomerInventoryRequest) Profile(profile bool) apiGetCustomerInventoryRequest { @@ -1062,15 +1271,23 @@ func (r apiGetCustomerInventoryRequest) Giveaways(giveaways bool) apiGetCustomer return r } +func (r apiGetCustomerInventoryRequest) LoyaltyProjectionEndDate(loyaltyProjectionEndDate time.Time) apiGetCustomerInventoryRequest { + r.loyaltyProjectionEndDate = &loyaltyProjectionEndDate + return r +} + /* -GetCustomerInventory List data associated with a specific customer profile +GetCustomerInventory List customer data Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points and reserved coupons. Reserved coupons also include redeemed coupons. +You can also use this endpoint to get the projected loyalty balances in order to notify +your customers about points that are about to expire, or to remind them how many points they have. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param integrationId The custom identifier for this profile, must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). + * @param integrationId The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). @return apiGetCustomerInventoryRequest */ func (a *IntegrationApiService) GetCustomerInventory(ctx _context.Context, integrationId string) apiGetCustomerInventoryRequest { @@ -1122,6 +1339,9 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. if r.giveaways != nil { localVarQueryParams.Add("giveaways", parameterToString(*r.giveaways, "")) } + if r.loyaltyProjectionEndDate != nil { + localVarQueryParams.Add("loyaltyProjectionEndDate", parameterToString(*r.loyaltyProjectionEndDate, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -1182,6 +1402,26 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1198,49 +1438,54 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetReservedCustomersRequest struct { - ctx _context.Context - apiService *IntegrationApiService - couponValue string +type apiGetCustomerSessionRequest struct { + ctx _context.Context + apiService *IntegrationApiService + customerSessionId string } /* -GetReservedCustomers List users that have this coupon reserved -Return all users that have this coupon marked as reserved. +GetCustomerSession Get customer session +Get the details of the given customer session. + +You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: + +- [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) +- [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param couponValue The value of a coupon -@return apiGetReservedCustomersRequest + * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). +@return apiGetCustomerSessionRequest */ -func (a *IntegrationApiService) GetReservedCustomers(ctx _context.Context, couponValue string) apiGetReservedCustomersRequest { - return apiGetReservedCustomersRequest{ - apiService: a, - ctx: ctx, - couponValue: couponValue, +func (a *IntegrationApiService) GetCustomerSession(ctx _context.Context, customerSessionId string) apiGetCustomerSessionRequest { + return apiGetCustomerSessionRequest{ + apiService: a, + ctx: ctx, + customerSessionId: customerSessionId, } } /* Execute executes the request - @return InlineResponse200 + @return IntegrationCustomerSessionResponse */ -func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp.Response, error) { +func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse200 + localVarReturnValue IntegrationCustomerSessionResponse ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetReservedCustomers") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetCustomerSession") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/coupon_reservations/customerprofiles/{couponValue}" - localVarPath = strings.Replace(localVarPath, "{"+"couponValue"+"}", _neturl.QueryEscape(parameterToString(r.couponValue, "")), -1) + localVarPath := localBasePath + "/v2/customer_sessions/{customerSessionId}" + localVarPath = strings.Replace(localVarPath, "{"+"customerSessionId"+"}", _neturl.QueryEscape(parameterToString(r.customerSessionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1299,7 +1544,27 @@ func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse200 + var v IntegrationCustomerSessionResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1322,77 +1587,97 @@ func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiTrackEventRequest struct { - ctx _context.Context - apiService *IntegrationApiService - body *NewEvent - dry *bool +type apiGetLoyaltyTransactionsRequest struct { + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + integrationId string + startDate *time.Time + endDate *time.Time + pageSize *int32 + skip *int32 } -func (r apiTrackEventRequest) Body(body NewEvent) apiTrackEventRequest { - r.body = &body +func (r apiGetLoyaltyTransactionsRequest) StartDate(startDate time.Time) apiGetLoyaltyTransactionsRequest { + r.startDate = &startDate return r } -func (r apiTrackEventRequest) Dry(dry bool) apiTrackEventRequest { - r.dry = &dry +func (r apiGetLoyaltyTransactionsRequest) EndDate(endDate time.Time) apiGetLoyaltyTransactionsRequest { + r.endDate = &endDate return r } -/* -TrackEvent Track an Event -Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. - -The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. +func (r apiGetLoyaltyTransactionsRequest) PageSize(pageSize int32) apiGetLoyaltyTransactionsRequest { + r.pageSize = &pageSize + return r +} -As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. +func (r apiGetLoyaltyTransactionsRequest) Skip(skip int32) apiGetLoyaltyTransactionsRequest { + r.skip = &skip + return r +} -Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. +/* +GetLoyaltyTransactions Get loyalty ledger transaction logs +Retrieve paginated loyalty transaction logs for the given Integration ID in the specified loyalty program. +You can filter transactions by date. If no filters are applied, the last 30 loyalty transactions for the given integration ID are returned. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiTrackEventRequest + * @param loyaltyProgramId Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). + * @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. +@return apiGetLoyaltyTransactionsRequest */ -func (a *IntegrationApiService) TrackEvent(ctx _context.Context) apiTrackEventRequest { - return apiTrackEventRequest{ - apiService: a, - ctx: ctx, +func (a *IntegrationApiService) GetLoyaltyTransactions(ctx _context.Context, loyaltyProgramId int32, integrationId string) apiGetLoyaltyTransactionsRequest { + return apiGetLoyaltyTransactionsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, } } /* Execute executes the request - @return IntegrationState + @return LedgerTransactionLogEntryIntegrationApi */ -func (r apiTrackEventRequest) Execute() (IntegrationState, *_nethttp.Response, error) { +func (r apiGetLoyaltyTransactionsRequest) Execute() (LedgerTransactionLogEntryIntegrationApi, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue IntegrationState + localVarReturnValue LedgerTransactionLogEntryIntegrationApi ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.TrackEvent") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyTransactions") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/events" + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.body == nil { - return localVarReturnValue, nil, reportError("body is required and must be specified") + if r.startDate != nil { + localVarQueryParams.Add("startDate", parameterToString(*r.startDate, "")) } - - if r.dry != nil { - localVarQueryParams.Add("dry", parameterToString(*r.dry, "")) + if r.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) + } + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -1408,8 +1693,6 @@ func (r apiTrackEventRequest) Execute() (IntegrationState, *_nethttp.Response, e if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -1445,7 +1728,876 @@ func (r apiTrackEventRequest) Execute() (IntegrationState, *_nethttp.Response, e body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 201 { + if localVarHTTPResponse.StatusCode == 200 { + var v LedgerTransactionLogEntryIntegrationApi + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiGetReservedCustomersRequest struct { + ctx _context.Context + apiService *IntegrationApiService + couponValue string +} + +/* +GetReservedCustomers List customers that have this coupon reserved +Return all customers that have this coupon marked as reserved. + +Coupons are reserved in the following ways: +- To create a soft reservation (any customer can use the coupon), use the [Create coupon reservation](#operation/createCouponReservation) endpoint. +- To create a hard reservation (only the given customer can use the coupon), create a coupon in the Campaign Manager for a given `recipientIntegrationId` or use the [Create coupons](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param couponValue The code of the coupon. +@return apiGetReservedCustomersRequest +*/ +func (a *IntegrationApiService) GetReservedCustomers(ctx _context.Context, couponValue string) apiGetReservedCustomersRequest { + return apiGetReservedCustomersRequest{ + apiService: a, + ctx: ctx, + couponValue: couponValue, + } +} + +/* +Execute executes the request + @return InlineResponse200 +*/ +func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse200 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetReservedCustomers") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/coupon_reservations/customerprofiles/{couponValue}" + localVarPath = strings.Replace(localVarPath, "{"+"couponValue"+"}", _neturl.QueryEscape(parameterToString(r.couponValue, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse200 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiReturnCartItemsRequest struct { + ctx _context.Context + apiService *IntegrationApiService + customerSessionId string + body *ReturnIntegrationRequest + dry *bool +} + +func (r apiReturnCartItemsRequest) Body(body ReturnIntegrationRequest) apiReturnCartItemsRequest { + r.body = &body + return r +} + +func (r apiReturnCartItemsRequest) Dry(dry bool) apiReturnCartItemsRequest { + r.dry = &dry + return r +} + +/* +ReturnCartItems Return cart items +Create a new return request for the specified cart items. + +This endpoint automatically changes the session state from `closed` to `partially_returned`. + +Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) +is enabled for the Application. + +**Note:** This will roll back any effects associated with these cart items. For more information, see +[our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) +and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). +@return apiReturnCartItemsRequest +*/ +func (a *IntegrationApiService) ReturnCartItems(ctx _context.Context, customerSessionId string) apiReturnCartItemsRequest { + return apiReturnCartItemsRequest{ + apiService: a, + ctx: ctx, + customerSessionId: customerSessionId, + } +} + +/* +Execute executes the request + @return IntegrationStateV2 +*/ +func (r apiReturnCartItemsRequest) Execute() (IntegrationStateV2, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue IntegrationStateV2 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.ReturnCartItems") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v2/customer_sessions/{customerSessionId}/returns" + localVarPath = strings.Replace(localVarPath, "{"+"customerSessionId"+"}", _neturl.QueryEscape(parameterToString(r.customerSessionId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.dry != nil { + localVarQueryParams.Add("dry", parameterToString(*r.dry, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v IntegrationStateV2 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiSyncCatalogRequest struct { + ctx _context.Context + apiService *IntegrationApiService + catalogId int32 + body *CatalogSyncRequest +} + +func (r apiSyncCatalogRequest) Body(body CatalogSyncRequest) apiSyncCatalogRequest { + r.body = &body + return r +} + +/* +SyncCatalog Sync cart item catalog +Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: + +- Add an item to the catalog. +- Edit the attributes of an item in the catalog. +- Edit the attributes of more than one item in the catalog. +- Remove an item from the catalog. +- Remove more than one item from the catalog. + +**Note**: For more information, see [our documentation on managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). + +### Filtering cart items + +Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) +to filter items and select the ones you want to edit or delete when editing or deleting more than one item +at a time. + +The `filters` object contains the following properties: + +- `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) + connected to the catalog. It is applied to all items in the catalog. +- `op`: The filtering operator indicating the relationship between the value of each + cart item in the catalog and the value of the `value` property for the attribute selected + in `attr`. + + The value of `op` can be one of the following: + + - `EQ`: Equal to `value` + - `LT`: Less than `value` + - `LE`: Less than or equal to `value` + - `GT`: Greater than `value` + - `GE`: Greater than or equal to `value` + - `IN`: One of the comma-separated values that `value` is set to. + + **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. + +- `value`: The value of the attribute selected in `attr`. + +### Payload examples + +Synchronization actions are sent as `PUT` requests. See the structure for each action: + +
+ Adding an item to the catalog +
+ + ```json + { + "actions": [ + { + "payload": { + "attributes": { + "color": "Navy blue", + "type": "shoe" + }, + "replaceIfExists": true, + "sku": "SKU1241028" + }, + "type": "ADD" + } + ] + } + ``` +
+
+ +
+ Editing the attributes of an item in the catalog +
+ + ```json + { + "actions": [ + { + "payload": { + "attributes": { + "age": 11, + "origin": "germany" + }, + "createIfNotExists": false, + "sku": "SKU1241028" + }, + "type": "PATCH" + } + ] + } + ``` +
+
+ +
+ Editing the attributes of several items at once +
+ + ```json + { + "actions": [ + { + "payload": { + "attributes": { + "color": "red" + }, + "filters": [ + { + "attr": "color", + "op": "EQ", + "value": "blue" + } + ] + }, + "type": "PATCH_MANY" + } + ] + } + ``` + +
+
+ +
+ Removing an item from the catalog +
+ + ```json + { + "actions": [ + { + "payload": { + "sku": "SKU1241028" + }, + "type": "REMOVE" + } + ] + } + ``` + +
+
+ +
+ Removing several items from the catalog at once +
+ + ```json + { + "actions": [ + { + "payload": { + "filters": [ + { + "attr": "color", + "op": "EQ", + "value": "blue" + } + ] + }, + "type": "REMOVE_MANY" + } + ] + } + ``` +
+
+ +
+ Removing shoes of sizes above 45 from the catalog +
+

+ Let's imagine that we have a shoe store and we have decided to stop selling + shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 + with a single action:

+ + ```json + { + "actions": [ + { + "payload": { + "filters": [ + { + "attr": "size", + "op": "GT", + "value": "45" + } + ] + }, + "type": "REMOVE_MANY" + } + ] + } + ``` +
+
+ + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param catalogId +@return apiSyncCatalogRequest +*/ +func (a *IntegrationApiService) SyncCatalog(ctx _context.Context, catalogId int32) apiSyncCatalogRequest { + return apiSyncCatalogRequest{ + apiService: a, + ctx: ctx, + catalogId: catalogId, + } +} + +/* +Execute executes the request + @return Catalog +*/ +func (r apiSyncCatalogRequest) Execute() (Catalog, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Catalog + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.SyncCatalog") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalogs/{catalogId}/sync" + localVarPath = strings.Replace(localVarPath, "{"+"catalogId"+"}", _neturl.QueryEscape(parameterToString(r.catalogId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Catalog + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiTrackEventRequest struct { + ctx _context.Context + apiService *IntegrationApiService + body *NewEvent + dry *bool +} + +func (r apiTrackEventRequest) Body(body NewEvent) apiTrackEventRequest { + r.body = &body + return r +} + +func (r apiTrackEventRequest) Dry(dry bool) apiTrackEventRequest { + r.dry = &dry + return r +} + +/* +TrackEvent Track event +**Important:** This endpoint is **DEPRECATED**. Use [Track Event V2](https://docs.talon.one/integration-api/#tag/Events/operation/trackEventV2) instead. + +
+ Triggers a custom event in a customer session. You can then check this event in your rules. **Important:** Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create a custom event when you can use a built-in event. + For example, use this endpoint to trigger an event when a user updates their payment information. + + Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event). + + An event is always part of a session. If either the profile or the session does not exist, + a new empty profile/session is created. If the specified session already exists, it must belong to the same `profileId` or an error will be returned. +
+ + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiTrackEventRequest +*/ +func (a *IntegrationApiService) TrackEvent(ctx _context.Context) apiTrackEventRequest { + return apiTrackEventRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + @return IntegrationState +*/ +func (r apiTrackEventRequest) Execute() (IntegrationState, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue IntegrationState + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.TrackEvent") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/events" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.dry != nil { + localVarQueryParams.Add("dry", parameterToString(*r.dry, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 201 { var v IntegrationState err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1453,6 +2605,217 @@ func (r apiTrackEventRequest) Execute() (IntegrationState, *_nethttp.Response, e return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v map[string]interface{} + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiTrackEventV2Request struct { + ctx _context.Context + apiService *IntegrationApiService + body *IntegrationEventV2Request + silent *string + dry *bool +} + +func (r apiTrackEventV2Request) Body(body IntegrationEventV2Request) apiTrackEventV2Request { + r.body = &body + return r +} + +func (r apiTrackEventV2Request) Silent(silent string) apiTrackEventV2Request { + r.silent = &silent + return r +} + +func (r apiTrackEventV2Request) Dry(dry bool) apiTrackEventV2Request { + r.dry = &dry + return r +} + +/* +TrackEventV2 Track event V2 +Triggers a custom event. You can then check this event in your rules. + +Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create +a custom event when you can use a built-in event. + +For example, use this endpoint to trigger an event when a customer shares a link to a product. +See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). + +**Important:** +- `profileId` is required. An event V2 is associated with a customer profile. +- Before using this endpoint, create your event as a custom attribute of type `event`. +See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event). + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiTrackEventV2Request +*/ +func (a *IntegrationApiService) TrackEventV2(ctx _context.Context) apiTrackEventV2Request { + return apiTrackEventV2Request{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + @return IntegrationStateV2 +*/ +func (r apiTrackEventV2Request) Execute() (IntegrationStateV2, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue IntegrationStateV2 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.TrackEventV2") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v2/events" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.silent != nil { + localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) + } + if r.dry != nil { + localVarQueryParams.Add("dry", parameterToString(*r.dry, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v IntegrationStateV2 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1483,9 +2846,7 @@ func (r apiUpdateAudienceCustomersAttributesRequest) Body(body map[string]interf /* UpdateAudienceCustomersAttributes Update profile attributes for all customers in audience -Update the specified profile attributes to the provided value for all customers in the specified audience. - -**Important:** The authentication requires an mParticle API key instead of a Talon.One API key. +Update the specified profile attributes to the provided values for all customers in the specified audience. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). @@ -1538,7 +2899,7 @@ func (r apiUpdateAudienceCustomersAttributesRequest) Execute() (*_nethttp.Respon } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -1582,6 +2943,25 @@ func (r apiUpdateAudienceCustomersAttributesRequest) Execute() (*_nethttp.Respon body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -1601,10 +2981,10 @@ func (r apiUpdateAudienceV2Request) Body(body UpdateAudience) apiUpdateAudienceV } /* -UpdateAudienceV2 Update audience -Update an Audience created by a third-party integration. +UpdateAudienceV2 Update audience name +Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the rule engine. -**Important:** The authentication requires an mParticle API key instead of a Talon.One API key. +To update the audience's members, use the [Update customer profile endpoint](#tag/Customer-profiles/operation/updateCustomerProfileV2). * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param audienceId The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). @@ -1710,6 +3090,26 @@ func (r apiUpdateAudienceV2Request) Execute() (Audience, *_nethttp.Response, err return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1739,9 +3139,10 @@ func (r apiUpdateCustomerProfileAudiencesRequest) Body(body CustomerProfileAudie /* UpdateCustomerProfileAudiences Update multiple customer profiles' audiences -Update one or multiple customer profiles with the specified audiences. +Update the specified customer profiles with the specified audiences. Use this endpoint +when customers join or leave audiences. -**Important:** The authentication requires an mParticle API key instead of a Talon.One API key. +The limit of customer profiles per request is 1000. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return apiUpdateCustomerProfileAudiencesRequest @@ -1791,7 +3192,7 @@ func (r apiUpdateCustomerProfileAudiencesRequest) Execute() (*_nethttp.Response, } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -1835,6 +3236,35 @@ func (r apiUpdateCustomerProfileAudiencesRequest) Execute() (*_nethttp.Response, body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -1867,29 +3297,23 @@ func (r apiUpdateCustomerProfileV2Request) Dry(dry bool) apiUpdateCustomerProfil /* UpdateCustomerProfileV2 Update customer profile -Update (or create) a [Customer Profile](/docs/dev/concepts/entities#customer-profile). - -The `integrationId` must be any identifier that remains stable for -the customer. Do not use an ID that the customer can update -themselves. For example, you can use a database ID. - -**Performance tips** +Update or create a [Customer Profile](/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. -Updating a customer profile returns a response with the requested integration state. +You can use this endpoint to: +- Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. +- Modify the audience the customer profile is a member of. -You can use the `responseContent` property to save yourself extra API calls. For example, you can get -the customer profile details directly without extra requests. +
+

Performance tips

-You can also set `runRuleEngine` to `false` to prevent unwanted rule executions. This allows you to -improve response times. + Updating a customer profile returns a response with the requested integration state. -If `runRuleEngine` is set to `true`, the response includes: - -- The effects generated by the triggered campaigns. -- The created coupons and referral objects. + You can use the `responseContent` property to save yourself extra API calls. For example, you can get + the customer profile details directly without extra requests. +
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param integrationId The custom identifier for this profile. Must be unique within the account. + * @param integrationId The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. @return apiUpdateCustomerProfileV2Request */ func (a *IntegrationApiService) UpdateCustomerProfileV2(ctx _context.Context, integrationId string) apiUpdateCustomerProfileV2Request { @@ -1998,6 +3422,36 @@ func (r apiUpdateCustomerProfileV2Request) Execute() (IntegrationStateV2, *_neth return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v map[string]interface{} + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2145,6 +3599,26 @@ func (r apiUpdateCustomerProfilesV2Request) Execute() (MultipleCustomerProfileIn return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2188,7 +3662,7 @@ promotion rules apply. **Note:** The currency for the session and the cart items in the session is the same as the Application that owns this session. -**Session management** +### Session management The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same Application you can either: @@ -2199,33 +3673,26 @@ You should share sessions when application access points share other state, such If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. -See more information and tips about session management in [Entities](/docs/dev/concepts/entities#customer-session). - -**Sessions and customer profiles** +See more information and tips about session management in the [documentation](/docs/dev/concepts/entities#customer-session). -To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. -To track an anonymous session use the empty string (`""`) as the `profileId`. -**Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. - -**Performance tips** +### Sessions and customer profiles -Updating a customer session returns a response with the requested integration state. +- To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. +- While you can create an anonymous session with `profileId=""`, we recommend you use a guest ID instead. -You can use the `responseContent` property to save yourself extra API calls. For example, you can get -the customer profile details directly without extra requests. - -You can also set `runRuleEngine` to `false` to prevent unwanted rule executions. This allows you to -improve response times. +**Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. -If `runRuleEngine` is set to `true`, the response also includes: +
+

Performance tips

-- The effects generated by the triggered campaigns. -- The created coupons and referral objects. + Updating a customer session returns a response with the requested integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get + the customer profile details directly without extra requests. -For more information, see the [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). + For more information, see the [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). +
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param customerSessionId The custom identifier for this session, must be unique within the account. + * @param customerSessionId The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). @return apiUpdateCustomerSessionV2Request */ func (a *IntegrationApiService) UpdateCustomerSessionV2(ctx _context.Context, customerSessionId string) apiUpdateCustomerSessionV2Request { @@ -2331,6 +3798,36 @@ func (r apiUpdateCustomerSessionV2Request) Execute() (IntegrationStateV2, *_neth return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v map[string]interface{} + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/api_management.go b/api_management.go index a1f9e299..445b88ec 100644 --- a/api_management.go +++ b/api_management.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -27,11 +27,11 @@ var ( type ManagementApiService service type apiAddLoyaltyPointsRequest struct { - ctx _context.Context - apiService *ManagementApiService - programID string - integrationID string - body *LoyaltyPoints + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId string + integrationId string + body *LoyaltyPoints } func (r apiAddLoyaltyPointsRequest) Body(body LoyaltyPoints) apiAddLoyaltyPointsRequest { @@ -47,16 +47,16 @@ To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID - * @param integrationID + * @param loyaltyProgramId The identifier for the loyalty program. + * @param integrationId The identifier of the profile. @return apiAddLoyaltyPointsRequest */ -func (a *ManagementApiService) AddLoyaltyPoints(ctx _context.Context, programID string, integrationID string) apiAddLoyaltyPointsRequest { +func (a *ManagementApiService) AddLoyaltyPoints(ctx _context.Context, loyaltyProgramId string, integrationId string) apiAddLoyaltyPointsRequest { return apiAddLoyaltyPointsRequest{ - apiService: a, - ctx: ctx, - programID: programID, - integrationID: integrationID, + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, } } @@ -78,9 +78,9 @@ func (r apiAddLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/profile/{integrationID}/add_points" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationID"+"}", _neturl.QueryEscape(parameterToString(r.integrationID, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -100,7 +100,7 @@ func (r apiAddLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -144,6 +144,35 @@ func (r apiAddLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -164,11 +193,11 @@ func (r apiCopyCampaignToApplicationsRequest) Body(body CampaignCopy) apiCopyCam } /* -CopyCampaignToApplications Copy the campaign into every specified application -Copy the campaign into every specified application. +CopyCampaignToApplications Copy the campaign into the specified application +Copy the campaign into all specified application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. @return apiCopyCampaignToApplicationsRequest */ func (a *ManagementApiService) CopyCampaignToApplications(ctx _context.Context, applicationId int32, campaignId int32) apiCopyCampaignToApplicationsRequest { @@ -289,28 +318,25 @@ func (r apiCopyCampaignToApplicationsRequest) Execute() (InlineResponse2002, *_n return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateAdditionalCostRequest struct { +type apiCreateAccountCollectionRequest struct { ctx _context.Context apiService *ManagementApiService - body *NewAdditionalCost + body *NewCollection } -func (r apiCreateAdditionalCostRequest) Body(body NewAdditionalCost) apiCreateAdditionalCostRequest { +func (r apiCreateAccountCollectionRequest) Body(body NewCollection) apiCreateAccountCollectionRequest { r.body = &body return r } /* -CreateAdditionalCost Define a new additional cost -Defines a new _additional cost_ in this account. - -These additional costs are shared across all applications in your account, and are never required. - +CreateAccountCollection Create account-level collection +Create account-level collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiCreateAdditionalCostRequest +@return apiCreateAccountCollectionRequest */ -func (a *ManagementApiService) CreateAdditionalCost(ctx _context.Context) apiCreateAdditionalCostRequest { - return apiCreateAdditionalCostRequest{ +func (a *ManagementApiService) CreateAccountCollection(ctx _context.Context) apiCreateAccountCollectionRequest { + return apiCreateAccountCollectionRequest{ apiService: a, ctx: ctx, } @@ -318,24 +344,24 @@ func (a *ManagementApiService) CreateAdditionalCost(ctx _context.Context) apiCre /* Execute executes the request - @return AccountAdditionalCost + @return Collection */ -func (r apiCreateAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp.Response, error) { +func (r apiCreateAccountCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue AccountAdditionalCost + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateAdditionalCost") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateAccountCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/additional_costs" + localVarPath := localBasePath + "/v1/collections" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -400,7 +426,37 @@ func (r apiCreateAdditionalCostRequest) Execute() (AccountAdditionalCost, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 201 { - var v AccountAdditionalCost + var v Collection + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -423,34 +479,28 @@ func (r apiCreateAdditionalCostRequest) Execute() (AccountAdditionalCost, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateAttributeRequest struct { +type apiCreateAdditionalCostRequest struct { ctx _context.Context apiService *ManagementApiService - body *NewAttribute + body *NewAdditionalCost } -func (r apiCreateAttributeRequest) Body(body NewAttribute) apiCreateAttributeRequest { +func (r apiCreateAdditionalCostRequest) Body(body NewAdditionalCost) apiCreateAdditionalCostRequest { r.body = &body return r } /* -CreateAttribute Create custom attribute -Create a _custom attribute_ in this account. Custom attributes allow you -to attach new fields to Talon.One domain objects like campaigns, coupons, -customers and so on. - -These attributes can then be given values when creating/updating these objects, and these values can be -used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, -and add a rule to your campaign that only allows certain ZIP codes. +CreateAdditionalCost Create additional cost +Create an [additional cost](/docs/product/account/dev-tools/managing-additional-costs/). -These attributes are shared across all applications in your account, and are never required. +These additional costs are shared across all applications in your account, and are never required. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiCreateAttributeRequest +@return apiCreateAdditionalCostRequest */ -func (a *ManagementApiService) CreateAttribute(ctx _context.Context) apiCreateAttributeRequest { - return apiCreateAttributeRequest{ +func (a *ManagementApiService) CreateAdditionalCost(ctx _context.Context) apiCreateAdditionalCostRequest { + return apiCreateAdditionalCostRequest{ apiService: a, ctx: ctx, } @@ -458,24 +508,24 @@ func (a *ManagementApiService) CreateAttribute(ctx _context.Context) apiCreateAt /* Execute executes the request - @return Attribute + @return AccountAdditionalCost */ -func (r apiCreateAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) { +func (r apiCreateAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Attribute + localVarReturnValue AccountAdditionalCost ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateAttribute") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateAdditionalCost") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/attributes" + localVarPath := localBasePath + "/v1/additional_costs" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -540,7 +590,7 @@ func (r apiCreateAttributeRequest) Execute() (Attribute, *_nethttp.Response, err error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 201 { - var v Attribute + var v AccountAdditionalCost err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -563,55 +613,59 @@ func (r apiCreateAttributeRequest) Execute() (Attribute, *_nethttp.Response, err return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateCampaignRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - body *NewCampaign +type apiCreateAttributeRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *NewAttribute } -func (r apiCreateCampaignRequest) Body(body NewCampaign) apiCreateCampaignRequest { +func (r apiCreateAttributeRequest) Body(body NewAttribute) apiCreateAttributeRequest { r.body = &body return r } /* -CreateCampaign Create campaign -Create a campaign. A campaign is part of an Application and contains a set of promotion rules. +CreateAttribute Create custom attribute +Create a _custom attribute_ in this account. Custom attributes allow you +to attach new fields to Talon.One domain objects like campaigns, coupons, +customers and so on. + +These attributes can then be given values when creating/updating these objects, and these values can be +used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, +and add a rule to your campaign that only allows certain ZIP codes. + +These attributes are shared across all applications in your account, and are never required. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiCreateCampaignRequest +@return apiCreateAttributeRequest */ -func (a *ManagementApiService) CreateCampaign(ctx _context.Context, applicationId int32) apiCreateCampaignRequest { - return apiCreateCampaignRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) CreateAttribute(ctx _context.Context) apiCreateAttributeRequest { + return apiCreateAttributeRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return Campaign + @return Attribute */ -func (r apiCreateCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { +func (r apiCreateAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Campaign + localVarReturnValue Attribute ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCampaign") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateAttribute") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/attributes" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -676,7 +730,7 @@ func (r apiCreateCampaignRequest) Execute() (Campaign, *_nethttp.Response, error error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 201 { - var v Campaign + var v Attribute err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -699,64 +753,59 @@ func (r apiCreateCampaignRequest) Execute() (Campaign, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateCouponsRequest struct { +type apiCreateCampaignFromTemplateRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - campaignId int32 - body *NewCoupons - silent *string + body *CreateTemplateCampaign } -func (r apiCreateCouponsRequest) Body(body NewCoupons) apiCreateCouponsRequest { +func (r apiCreateCampaignFromTemplateRequest) Body(body CreateTemplateCampaign) apiCreateCampaignFromTemplateRequest { r.body = &body return r } -func (r apiCreateCouponsRequest) Silent(silent string) apiCreateCouponsRequest { - r.silent = &silent - return r -} - /* -CreateCoupons Create coupons -Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created. +CreateCampaignFromTemplate Create campaign from campaign template +Use the campaign template referenced in the request body to create +a new campaign in one of the connected Applications. + +If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), +the corresponding collections for the new campaign are created automatically. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiCreateCouponsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiCreateCampaignFromTemplateRequest */ -func (a *ManagementApiService) CreateCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsRequest { - return apiCreateCouponsRequest{ +func (a *ManagementApiService) CreateCampaignFromTemplate(ctx _context.Context, applicationId int32) apiCreateCampaignFromTemplateRequest { + return apiCreateCampaignFromTemplateRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse2004 + @return CreateTemplateCampaignResponse */ -func (r apiCreateCouponsRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { +func (r apiCreateCampaignFromTemplateRequest) Execute() (CreateTemplateCampaignResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2004 + localVarReturnValue CreateTemplateCampaignResponse ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCoupons") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCampaignFromTemplate") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons" + localVarPath := localBasePath + "/v1/applications/{applicationId}/create_campaign_from_template" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -766,9 +815,6 @@ func (r apiCreateCouponsRequest) Execute() (InlineResponse2004, *_nethttp.Respon return localVarReturnValue, nil, reportError("body is required and must be specified") } - if r.silent != nil { - localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -823,15 +869,14 @@ func (r apiCreateCouponsRequest) Execute() (InlineResponse2004, *_nethttp.Respon body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2004 + if localVarHTTPResponse.StatusCode == 201 { + var v CreateTemplateCampaignResponse err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -848,35 +893,29 @@ func (r apiCreateCouponsRequest) Execute() (InlineResponse2004, *_nethttp.Respon return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateCouponsForMultipleRecipientsRequest struct { +type apiCreateCollectionRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - body *NewCouponsForMultipleRecipients - silent *string + body *NewCampaignCollection } -func (r apiCreateCouponsForMultipleRecipientsRequest) Body(body NewCouponsForMultipleRecipients) apiCreateCouponsForMultipleRecipientsRequest { +func (r apiCreateCollectionRequest) Body(body NewCampaignCollection) apiCreateCollectionRequest { r.body = &body return r } -func (r apiCreateCouponsForMultipleRecipientsRequest) Silent(silent string) apiCreateCouponsForMultipleRecipientsRequest { - r.silent = &silent - return r -} - /* -CreateCouponsForMultipleRecipients Create coupons for multiple recipients -Create coupons according to some pattern for up to 1000 recipients. +CreateCollection Create collection +Create a collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiCreateCouponsForMultipleRecipientsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiCreateCollectionRequest */ -func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsForMultipleRecipientsRequest { - return apiCreateCouponsForMultipleRecipientsRequest{ +func (a *ManagementApiService) CreateCollection(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCollectionRequest { + return apiCreateCollectionRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -886,24 +925,24 @@ func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.C /* Execute executes the request - @return InlineResponse2004 + @return Collection */ -func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { +func (r apiCreateCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2004 + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsForMultipleRecipients") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) @@ -915,9 +954,6 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 return localVarReturnValue, nil, reportError("body is required and must be specified") } - if r.silent != nil { - localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -972,15 +1008,14 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2004 + if localVarHTTPResponse.StatusCode == 201 { + var v Collection err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -997,51 +1032,64 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreatePasswordRecoveryEmailRequest struct { - ctx _context.Context - apiService *ManagementApiService - body *NewPasswordEmail +type apiCreateCouponsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + body *NewCoupons + silent *string } -func (r apiCreatePasswordRecoveryEmailRequest) Body(body NewPasswordEmail) apiCreatePasswordRecoveryEmailRequest { +func (r apiCreateCouponsRequest) Body(body NewCoupons) apiCreateCouponsRequest { r.body = &body return r } -/* -CreatePasswordRecoveryEmail Request a password reset -Send an email with a password recovery link to the email address of an existing account. +func (r apiCreateCouponsRequest) Silent(silent string) apiCreateCouponsRequest { + r.silent = &silent + return r +} +/* +CreateCoupons Create coupons +Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiCreatePasswordRecoveryEmailRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiCreateCouponsRequest */ -func (a *ManagementApiService) CreatePasswordRecoveryEmail(ctx _context.Context) apiCreatePasswordRecoveryEmailRequest { - return apiCreatePasswordRecoveryEmailRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) CreateCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsRequest { + return apiCreateCouponsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return NewPasswordEmail + @return InlineResponse2005 */ -func (r apiCreatePasswordRecoveryEmailRequest) Execute() (NewPasswordEmail, *_nethttp.Response, error) { +func (r apiCreateCouponsRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue NewPasswordEmail + localVarReturnValue InlineResponse2005 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreatePasswordRecoveryEmail") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCoupons") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/password_recovery_emails" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1051,6 +1099,9 @@ func (r apiCreatePasswordRecoveryEmailRequest) Execute() (NewPasswordEmail, *_ne return localVarReturnValue, nil, reportError("body is required and must be specified") } + if r.silent != nil { + localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -1105,14 +1156,15 @@ func (r apiCreatePasswordRecoveryEmailRequest) Execute() (NewPasswordEmail, *_ne body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 204 { - var v NewPasswordEmail + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse2005 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1129,29 +1181,29 @@ func (r apiCreatePasswordRecoveryEmailRequest) Execute() (NewPasswordEmail, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateRulesetRequest struct { +type apiCreateCouponsAsyncRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - body *NewRuleset + body *NewCouponCreationJob } -func (r apiCreateRulesetRequest) Body(body NewRuleset) apiCreateRulesetRequest { +func (r apiCreateCouponsAsyncRequest) Body(body NewCouponCreationJob) apiCreateCouponsAsyncRequest { r.body = &body return r } /* -CreateRuleset Create ruleset -Create a set of rules. A ruleset is a revision of all the rules of a campaign. +CreateCouponsAsync Create coupons asynchronously +Create any number of coupons from 20,001 to 5,000,000. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiCreateRulesetRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiCreateCouponsAsyncRequest */ -func (a *ManagementApiService) CreateRuleset(ctx _context.Context, applicationId int32, campaignId int32) apiCreateRulesetRequest { - return apiCreateRulesetRequest{ +func (a *ManagementApiService) CreateCouponsAsync(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsAsyncRequest { + return apiCreateCouponsAsyncRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -1161,24 +1213,24 @@ func (a *ManagementApiService) CreateRuleset(ctx _context.Context, applicationId /* Execute executes the request - @return Ruleset + @return AsyncCouponCreationResponse */ -func (r apiCreateRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { +func (r apiCreateCouponsAsyncRequest) Execute() (AsyncCouponCreationResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Ruleset + localVarReturnValue AsyncCouponCreationResponse ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateRuleset") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsAsync") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) @@ -1244,8 +1296,8 @@ func (r apiCreateRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 201 { - var v Ruleset + if localVarHTTPResponse.StatusCode == 200 { + var v AsyncCouponCreationResponse err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1268,57 +1320,64 @@ func (r apiCreateRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateSessionRequest struct { - ctx _context.Context - apiService *ManagementApiService - body *LoginParams +type apiCreateCouponsForMultipleRecipientsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + body *NewCouponsForMultipleRecipients + silent *string } -func (r apiCreateSessionRequest) Body(body LoginParams) apiCreateSessionRequest { +func (r apiCreateCouponsForMultipleRecipientsRequest) Body(body NewCouponsForMultipleRecipients) apiCreateCouponsForMultipleRecipientsRequest { r.body = &body return r } -/* -CreateSession Create session -Create a session to use the Management API endpoints. -Use the value of the `token` property provided in the response as bearer token in other API calls. - -A token is valid for 3 months. In accordance with best pratices, use your generated token -for all your API requests. Do **not** regenerate a token for each request. - -This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. +func (r apiCreateCouponsForMultipleRecipientsRequest) Silent(silent string) apiCreateCouponsForMultipleRecipientsRequest { + r.silent = &silent + return r +} +/* +CreateCouponsForMultipleRecipients Create coupons for multiple recipients +Create coupons according to some pattern for up to 1000 recipients. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiCreateSessionRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiCreateCouponsForMultipleRecipientsRequest */ -func (a *ManagementApiService) CreateSession(ctx _context.Context) apiCreateSessionRequest { - return apiCreateSessionRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsForMultipleRecipientsRequest { + return apiCreateCouponsForMultipleRecipientsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return Session + @return InlineResponse2005 */ -func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) { +func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Session + localVarReturnValue InlineResponse2005 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateSession") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsForMultipleRecipients") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/sessions" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1328,6 +1387,9 @@ func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) return localVarReturnValue, nil, reportError("body is required and must be specified") } + if r.silent != nil { + localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -1382,14 +1444,15 @@ func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 201 { - var v Session + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse2005 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1406,58 +1469,67 @@ func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) return localVarReturnValue, localVarHTTPResponse, nil } -type apiDeleteCampaignRequest struct { +type apiCreateNotificationWebhookRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - campaignId int32 + body *NewNotificationWebhook +} + +func (r apiCreateNotificationWebhookRequest) Body(body NewNotificationWebhook) apiCreateNotificationWebhookRequest { + r.body = &body + return r } /* -DeleteCampaign Delete campaign -Delete the given campaign. +CreateNotificationWebhook Create notification webhook +Create an outbound notification webhook. An outbound notification webhook is different from regular webhooks +in that it is application-scoped and has a predefined payload (regular webhooks have user-definable payloads). + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiDeleteCampaignRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiCreateNotificationWebhookRequest */ -func (a *ManagementApiService) DeleteCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiDeleteCampaignRequest { - return apiDeleteCampaignRequest{ +func (a *ManagementApiService) CreateNotificationWebhook(ctx _context.Context, applicationId int32) apiCreateNotificationWebhookRequest { + return apiCreateNotificationWebhookRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, } } /* Execute executes the request - + @return NotificationWebhook */ -func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { +func (r apiCreateNotificationWebhookRequest) Execute() (NotificationWebhook, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodDelete + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte + localVarReturnValue NotificationWebhook ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCampaign") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateNotificationWebhook") if err != nil { - return nil, GenericOpenAPIError{error: err.Error()} + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/notification_webhooks" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"application/json"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -1466,13 +1538,15 @@ func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + // body params + localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -1489,18 +1563,18 @@ func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { } req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) if err != nil { - return nil, err + return localVarReturnValue, nil, err } localVarHTTPResponse, err := r.apiService.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarHTTPResponse, err + return localVarReturnValue, localVarHTTPResponse, err } localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() if err != nil { - return localVarHTTPResponse, err + return localVarReturnValue, localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -1508,68 +1582,86 @@ func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } - return localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 201 { + var v NotificationWebhook + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr } - return localVarHTTPResponse, nil + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil } -type apiDeleteCouponRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - couponId string +type apiCreatePasswordRecoveryEmailRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *NewPasswordEmail +} + +func (r apiCreatePasswordRecoveryEmailRequest) Body(body NewPasswordEmail) apiCreatePasswordRecoveryEmailRequest { + r.body = &body + return r } /* -DeleteCoupon Delete coupon -Delete the specified coupon. +CreatePasswordRecoveryEmail Request a password reset +Send an email with a password recovery link to the email address of an existing account. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId - * @param couponId The ID of the coupon code to delete -@return apiDeleteCouponRequest +@return apiCreatePasswordRecoveryEmailRequest */ -func (a *ManagementApiService) DeleteCoupon(ctx _context.Context, applicationId int32, campaignId int32, couponId string) apiDeleteCouponRequest { - return apiDeleteCouponRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, - couponId: couponId, +func (a *ManagementApiService) CreatePasswordRecoveryEmail(ctx _context.Context) apiCreatePasswordRecoveryEmailRequest { + return apiCreatePasswordRecoveryEmailRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - + @return NewPasswordEmail */ -func (r apiDeleteCouponRequest) Execute() (*_nethttp.Response, error) { +func (r apiCreatePasswordRecoveryEmailRequest) Execute() (NewPasswordEmail, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodDelete + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte + localVarReturnValue NewPasswordEmail ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCoupon") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreatePasswordRecoveryEmail") if err != nil { - return nil, GenericOpenAPIError{error: err.Error()} + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"couponId"+"}", _neturl.QueryEscape(parameterToString(r.couponId, "")), -1) + localVarPath := localBasePath + "/v1/password_recovery_emails" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"application/json"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -1578,13 +1670,15 @@ func (r apiDeleteCouponRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + // body params + localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -1601,18 +1695,18 @@ func (r apiDeleteCouponRequest) Execute() (*_nethttp.Response, error) { } req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) if err != nil { - return nil, err + return localVarReturnValue, nil, err } localVarHTTPResponse, err := r.apiService.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarHTTPResponse, err + return localVarReturnValue, localVarHTTPResponse, err } localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() if err != nil { - return localVarHTTPResponse, err + return localVarReturnValue, localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -1620,111 +1714,189 @@ func (r apiDeleteCouponRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } - return localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 204 { + var v NewPasswordEmail + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr } - return localVarHTTPResponse, nil -} + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } -type apiDeleteCouponsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - value *string - createdBefore *time.Time - createdAfter *time.Time - startsAfter *time.Time - startsBefore *time.Time - expiresAfter *time.Time - expiresBefore *time.Time - valid *string - batchId *string - usable *string - referralId *int32 - recipientIntegrationId *string - exactMatch *bool + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiDeleteCouponsRequest) Value(value string) apiDeleteCouponsRequest { - r.value = &value - return r +type apiCreateSessionRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *LoginParams } -func (r apiDeleteCouponsRequest) CreatedBefore(createdBefore time.Time) apiDeleteCouponsRequest { - r.createdBefore = &createdBefore +func (r apiCreateSessionRequest) Body(body LoginParams) apiCreateSessionRequest { + r.body = &body return r } -func (r apiDeleteCouponsRequest) CreatedAfter(createdAfter time.Time) apiDeleteCouponsRequest { - r.createdAfter = &createdAfter - return r -} +/* +CreateSession Create session +Create a session to use the Management API endpoints. +Use the value of the `token` property provided in the response as bearer token in other API calls. -func (r apiDeleteCouponsRequest) StartsAfter(startsAfter time.Time) apiDeleteCouponsRequest { - r.startsAfter = &startsAfter - return r -} +A token is valid for 3 months. In accordance with best pratices, use your generated token +for all your API requests. Do **not** regenerate a token for each request. -func (r apiDeleteCouponsRequest) StartsBefore(startsBefore time.Time) apiDeleteCouponsRequest { - r.startsBefore = &startsBefore - return r -} +This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. -func (r apiDeleteCouponsRequest) ExpiresAfter(expiresAfter time.Time) apiDeleteCouponsRequest { - r.expiresAfter = &expiresAfter - return r -} +**Note:** You can also use your browser's developer's console when you log into the Campaign Manager. +Keep in mind that logging out destroys the token displayed in the console. -func (r apiDeleteCouponsRequest) ExpiresBefore(expiresBefore time.Time) apiDeleteCouponsRequest { - r.expiresBefore = &expiresBefore - return r + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiCreateSessionRequest +*/ +func (a *ManagementApiService) CreateSession(ctx _context.Context) apiCreateSessionRequest { + return apiCreateSessionRequest{ + apiService: a, + ctx: ctx, + } } -func (r apiDeleteCouponsRequest) Valid(valid string) apiDeleteCouponsRequest { - r.valid = &valid - return r -} +/* +Execute executes the request + @return Session +*/ +func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Session + ) -func (r apiDeleteCouponsRequest) BatchId(batchId string) apiDeleteCouponsRequest { - r.batchId = &batchId - return r -} + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateSession") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } -func (r apiDeleteCouponsRequest) Usable(usable string) apiDeleteCouponsRequest { - r.usable = &usable - return r -} + localVarPath := localBasePath + "/v1/sessions" -func (r apiDeleteCouponsRequest) ReferralId(referralId int32) apiDeleteCouponsRequest { - r.referralId = &referralId - return r -} + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} -func (r apiDeleteCouponsRequest) RecipientIntegrationId(recipientIntegrationId string) apiDeleteCouponsRequest { - r.recipientIntegrationId = &recipientIntegrationId - return r + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 201 { + var v Session + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiDeleteCouponsRequest) ExactMatch(exactMatch bool) apiDeleteCouponsRequest { - r.exactMatch = &exactMatch - return r +type apiDeleteAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 } /* -DeleteCoupons Delete coupons -Deletes all the coupons matching the specified criteria. +DeleteAccountCollection Delete account-level collection +Delete the given account-level collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiDeleteCouponsRequest + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiDeleteAccountCollectionRequest */ -func (a *ManagementApiService) DeleteCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiDeleteCouponsRequest { - return apiDeleteCouponsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) DeleteAccountCollection(ctx _context.Context, collectionId int32) apiDeleteAccountCollectionRequest { + return apiDeleteAccountCollectionRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, } } @@ -1732,7 +1904,7 @@ func (a *ManagementApiService) DeleteCoupons(ctx _context.Context, applicationId Execute executes the request */ -func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeleteAccountCollectionRequest) Execute() (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} @@ -1741,58 +1913,18 @@ func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { localVarFileBytes []byte ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCoupons") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteAccountCollection") if err != nil { return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath := localBasePath + "/v1/collections/{collectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.value != nil { - localVarQueryParams.Add("value", parameterToString(*r.value, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.startsAfter != nil { - localVarQueryParams.Add("startsAfter", parameterToString(*r.startsAfter, "")) - } - if r.startsBefore != nil { - localVarQueryParams.Add("startsBefore", parameterToString(*r.startsBefore, "")) - } - if r.expiresAfter != nil { - localVarQueryParams.Add("expiresAfter", parameterToString(*r.expiresAfter, "")) - } - if r.expiresBefore != nil { - localVarQueryParams.Add("expiresBefore", parameterToString(*r.expiresBefore, "")) - } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) - } - if r.batchId != nil { - localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) - } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) - } - if r.referralId != nil { - localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) - } - if r.recipientIntegrationId != nil { - localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) - } - if r.exactMatch != nil { - localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -1803,7 +1935,7 @@ func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -1845,36 +1977,42 @@ func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } return localVarHTTPResponse, nil } -type apiDeleteReferralRequest struct { +type apiDeleteCampaignRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - referralId string } /* -DeleteReferral Delete referral -Delete the specified referral. +DeleteCampaign Delete campaign +Delete the given campaign. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId - * @param referralId The ID of the referral code to delete -@return apiDeleteReferralRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiDeleteCampaignRequest */ -func (a *ManagementApiService) DeleteReferral(ctx _context.Context, applicationId int32, campaignId int32, referralId string) apiDeleteReferralRequest { - return apiDeleteReferralRequest{ +func (a *ManagementApiService) DeleteCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiDeleteCampaignRequest { + return apiDeleteCampaignRequest{ apiService: a, ctx: ctx, applicationId: applicationId, campaignId: campaignId, - referralId: referralId, } } @@ -1882,7 +2020,7 @@ func (a *ManagementApiService) DeleteReferral(ctx _context.Context, applicationI Execute executes the request */ -func (r apiDeleteReferralRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} @@ -1891,15 +2029,14 @@ func (r apiDeleteReferralRequest) Execute() (*_nethttp.Response, error) { localVarFileBytes []byte ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteReferral") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCampaign") if err != nil { return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"referralId"+"}", _neturl.QueryEscape(parameterToString(r.referralId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1963,21 +2100,30 @@ func (r apiDeleteReferralRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } -type apiDestroySessionRequest struct { - ctx _context.Context - apiService *ManagementApiService +type apiDeleteCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 } /* -DestroySession Destroy session -Destroys the session. +DeleteCollection Delete collection +Delete the given collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiDestroySessionRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiDeleteCollectionRequest */ -func (a *ManagementApiService) DestroySession(ctx _context.Context) apiDestroySessionRequest { - return apiDestroySessionRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) DeleteCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiDeleteCollectionRequest { + return apiDeleteCollectionRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + collectionId: collectionId, } } @@ -1985,7 +2131,7 @@ func (a *ManagementApiService) DestroySession(ctx _context.Context) apiDestroySe Execute executes the request */ -func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeleteCollectionRequest) Execute() (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} @@ -1994,12 +2140,15 @@ func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { localVarFileBytes []byte ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DestroySession") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCollection") if err != nil { return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/sessions" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2015,7 +2164,7 @@ func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2057,176 +2206,2659 @@ func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } return localVarHTTPResponse, nil } -type apiExportCouponsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId *float32 - sort *string +type apiDeleteCouponRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + couponId string +} + +/* +DeleteCoupon Delete coupon +Delete the specified coupon. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param couponId The ID of the coupon code to update +@return apiDeleteCouponRequest +*/ +func (a *ManagementApiService) DeleteCoupon(ctx _context.Context, applicationId int32, campaignId int32, couponId string) apiDeleteCouponRequest { + return apiDeleteCouponRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + couponId: couponId, + } +} + +/* +Execute executes the request + +*/ +func (r apiDeleteCouponRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCoupon") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"couponId"+"}", _neturl.QueryEscape(parameterToString(r.couponId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiDeleteCouponsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 value *string createdBefore *time.Time createdAfter *time.Time + startsAfter *time.Time + startsBefore *time.Time + expiresAfter *time.Time + expiresBefore *time.Time valid *string + batchId *string usable *string referralId *int32 recipientIntegrationId *string - batchId *string exactMatch *bool - dateFormat *string - campaignState *string } -func (r apiExportCouponsRequest) CampaignId(campaignId float32) apiExportCouponsRequest { - r.campaignId = &campaignId +func (r apiDeleteCouponsRequest) Value(value string) apiDeleteCouponsRequest { + r.value = &value return r } -func (r apiExportCouponsRequest) Sort(sort string) apiExportCouponsRequest { - r.sort = &sort +func (r apiDeleteCouponsRequest) CreatedBefore(createdBefore time.Time) apiDeleteCouponsRequest { + r.createdBefore = &createdBefore return r } -func (r apiExportCouponsRequest) Value(value string) apiExportCouponsRequest { - r.value = &value +func (r apiDeleteCouponsRequest) CreatedAfter(createdAfter time.Time) apiDeleteCouponsRequest { + r.createdAfter = &createdAfter return r } -func (r apiExportCouponsRequest) CreatedBefore(createdBefore time.Time) apiExportCouponsRequest { - r.createdBefore = &createdBefore +func (r apiDeleteCouponsRequest) StartsAfter(startsAfter time.Time) apiDeleteCouponsRequest { + r.startsAfter = &startsAfter return r } -func (r apiExportCouponsRequest) CreatedAfter(createdAfter time.Time) apiExportCouponsRequest { - r.createdAfter = &createdAfter +func (r apiDeleteCouponsRequest) StartsBefore(startsBefore time.Time) apiDeleteCouponsRequest { + r.startsBefore = &startsBefore return r } -func (r apiExportCouponsRequest) Valid(valid string) apiExportCouponsRequest { +func (r apiDeleteCouponsRequest) ExpiresAfter(expiresAfter time.Time) apiDeleteCouponsRequest { + r.expiresAfter = &expiresAfter + return r +} + +func (r apiDeleteCouponsRequest) ExpiresBefore(expiresBefore time.Time) apiDeleteCouponsRequest { + r.expiresBefore = &expiresBefore + return r +} + +func (r apiDeleteCouponsRequest) Valid(valid string) apiDeleteCouponsRequest { r.valid = &valid return r } -func (r apiExportCouponsRequest) Usable(usable string) apiExportCouponsRequest { +func (r apiDeleteCouponsRequest) BatchId(batchId string) apiDeleteCouponsRequest { + r.batchId = &batchId + return r +} + +func (r apiDeleteCouponsRequest) Usable(usable string) apiDeleteCouponsRequest { r.usable = &usable return r } -func (r apiExportCouponsRequest) ReferralId(referralId int32) apiExportCouponsRequest { +func (r apiDeleteCouponsRequest) ReferralId(referralId int32) apiDeleteCouponsRequest { r.referralId = &referralId return r } -func (r apiExportCouponsRequest) RecipientIntegrationId(recipientIntegrationId string) apiExportCouponsRequest { +func (r apiDeleteCouponsRequest) RecipientIntegrationId(recipientIntegrationId string) apiDeleteCouponsRequest { r.recipientIntegrationId = &recipientIntegrationId return r } -func (r apiExportCouponsRequest) BatchId(batchId string) apiExportCouponsRequest { - r.batchId = &batchId +func (r apiDeleteCouponsRequest) ExactMatch(exactMatch bool) apiDeleteCouponsRequest { + r.exactMatch = &exactMatch return r } -func (r apiExportCouponsRequest) ExactMatch(exactMatch bool) apiExportCouponsRequest { - r.exactMatch = &exactMatch - return r +/* +DeleteCoupons Delete coupons +Deletes all the coupons matching the specified criteria. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiDeleteCouponsRequest +*/ +func (a *ManagementApiService) DeleteCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiDeleteCouponsRequest { + return apiDeleteCouponsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + } } -func (r apiExportCouponsRequest) DateFormat(dateFormat string) apiExportCouponsRequest { - r.dateFormat = &dateFormat - return r +/* +Execute executes the request + +*/ +func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCoupons") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.value != nil { + localVarQueryParams.Add("value", parameterToString(*r.value, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.startsAfter != nil { + localVarQueryParams.Add("startsAfter", parameterToString(*r.startsAfter, "")) + } + if r.startsBefore != nil { + localVarQueryParams.Add("startsBefore", parameterToString(*r.startsBefore, "")) + } + if r.expiresAfter != nil { + localVarQueryParams.Add("expiresAfter", parameterToString(*r.expiresAfter, "")) + } + if r.expiresBefore != nil { + localVarQueryParams.Add("expiresBefore", parameterToString(*r.expiresBefore, "")) + } + if r.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + } + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + } + if r.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + } + if r.referralId != nil { + localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) + } + if r.recipientIntegrationId != nil { + localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) + } + if r.exactMatch != nil { + localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiDeleteNotificationWebhookRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + notificationWebhookId int32 +} + +/* +DeleteNotificationWebhook Delete notification webhook +Remove the given existing outbound notification webhook. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param notificationWebhookId +@return apiDeleteNotificationWebhookRequest +*/ +func (a *ManagementApiService) DeleteNotificationWebhook(ctx _context.Context, applicationId int32, notificationWebhookId int32) apiDeleteNotificationWebhookRequest { + return apiDeleteNotificationWebhookRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + notificationWebhookId: notificationWebhookId, + } +} + +/* +Execute executes the request + +*/ +func (r apiDeleteNotificationWebhookRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteNotificationWebhook") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"notificationWebhookId"+"}", _neturl.QueryEscape(parameterToString(r.notificationWebhookId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiDeleteReferralRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + referralId string +} + +/* +DeleteReferral Delete referral +Delete the specified referral. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param referralId The ID of the referral code to delete +@return apiDeleteReferralRequest +*/ +func (a *ManagementApiService) DeleteReferral(ctx _context.Context, applicationId int32, campaignId int32, referralId string) apiDeleteReferralRequest { + return apiDeleteReferralRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + referralId: referralId, + } +} + +/* +Execute executes the request + +*/ +func (r apiDeleteReferralRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteReferral") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"referralId"+"}", _neturl.QueryEscape(parameterToString(r.referralId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiDestroySessionRequest struct { + ctx _context.Context + apiService *ManagementApiService +} + +/* +DestroySession Destroy session +Destroys the session. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiDestroySessionRequest +*/ +func (a *ManagementApiService) DestroySession(ctx _context.Context) apiDestroySessionRequest { + return apiDestroySessionRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + +*/ +func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DestroySession") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/sessions" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiExportAccountCollectionItemsRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 +} + +/* +ExportAccountCollectionItems Export account-level collection's items +Download a CSV file containing items from an account-level collection. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiExportAccountCollectionItemsRequest +*/ +func (a *ManagementApiService) ExportAccountCollectionItems(ctx _context.Context, collectionId int32) apiExportAccountCollectionItemsRequest { + return apiExportAccountCollectionItemsRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportAccountCollectionItems") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/collections/{collectionId}/export" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportCollectionItemsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 +} + +/* +ExportCollectionItems Export a collection's items +Download a CSV file containing a collection's items. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiExportCollectionItemsRequest +*/ +func (a *ManagementApiService) ExportCollectionItems(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiExportCollectionItemsRequest { + return apiExportCollectionItemsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + collectionId: collectionId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCollectionItems") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportCouponsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId *float32 + sort *string + value *string + createdBefore *time.Time + createdAfter *time.Time + valid *string + usable *string + referralId *int32 + recipientIntegrationId *string + batchId *string + exactMatch *bool + dateFormat *string + campaignState *string +} + +func (r apiExportCouponsRequest) CampaignId(campaignId float32) apiExportCouponsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiExportCouponsRequest) Sort(sort string) apiExportCouponsRequest { + r.sort = &sort + return r +} + +func (r apiExportCouponsRequest) Value(value string) apiExportCouponsRequest { + r.value = &value + return r +} + +func (r apiExportCouponsRequest) CreatedBefore(createdBefore time.Time) apiExportCouponsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiExportCouponsRequest) CreatedAfter(createdAfter time.Time) apiExportCouponsRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiExportCouponsRequest) Valid(valid string) apiExportCouponsRequest { + r.valid = &valid + return r +} + +func (r apiExportCouponsRequest) Usable(usable string) apiExportCouponsRequest { + r.usable = &usable + return r +} + +func (r apiExportCouponsRequest) ReferralId(referralId int32) apiExportCouponsRequest { + r.referralId = &referralId + return r +} + +func (r apiExportCouponsRequest) RecipientIntegrationId(recipientIntegrationId string) apiExportCouponsRequest { + r.recipientIntegrationId = &recipientIntegrationId + return r +} + +func (r apiExportCouponsRequest) BatchId(batchId string) apiExportCouponsRequest { + r.batchId = &batchId + return r +} + +func (r apiExportCouponsRequest) ExactMatch(exactMatch bool) apiExportCouponsRequest { + r.exactMatch = &exactMatch + return r +} + +func (r apiExportCouponsRequest) DateFormat(dateFormat string) apiExportCouponsRequest { + r.dateFormat = &dateFormat + return r +} + +func (r apiExportCouponsRequest) CampaignState(campaignState string) apiExportCouponsRequest { + r.campaignState = &campaignState + return r +} + +/* +ExportCoupons Export coupons +Download a CSV file containing the coupons that match the given properties. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiExportCouponsRequest +*/ +func (a *ManagementApiService) ExportCoupons(ctx _context.Context, applicationId int32) apiExportCouponsRequest { + return apiExportCouponsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportCouponsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCoupons") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/export_coupons" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.campaignId != nil { + localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.value != nil { + localVarQueryParams.Add("value", parameterToString(*r.value, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + } + if r.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + } + if r.referralId != nil { + localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) + } + if r.recipientIntegrationId != nil { + localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) + } + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + } + if r.exactMatch != nil { + localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) + } + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + } + if r.campaignState != nil { + localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportCustomerSessionsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + createdBefore *time.Time + createdAfter *time.Time + profileIntegrationId *string + dateFormat *string + customerSessionState *string +} + +func (r apiExportCustomerSessionsRequest) CreatedBefore(createdBefore time.Time) apiExportCustomerSessionsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiExportCustomerSessionsRequest) CreatedAfter(createdAfter time.Time) apiExportCustomerSessionsRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiExportCustomerSessionsRequest) ProfileIntegrationId(profileIntegrationId string) apiExportCustomerSessionsRequest { + r.profileIntegrationId = &profileIntegrationId + return r +} + +func (r apiExportCustomerSessionsRequest) DateFormat(dateFormat string) apiExportCustomerSessionsRequest { + r.dateFormat = &dateFormat + return r +} + +func (r apiExportCustomerSessionsRequest) CustomerSessionState(customerSessionState string) apiExportCustomerSessionsRequest { + r.customerSessionState = &customerSessionState + return r +} + +/* +ExportCustomerSessions Export customer sessions +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/product/server-infrastructure-and-data-retention#data-retention-policy). + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiExportCustomerSessionsRequest +*/ +func (a *ManagementApiService) ExportCustomerSessions(ctx _context.Context, applicationId int32) apiExportCustomerSessionsRequest { + return apiExportCustomerSessionsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportCustomerSessionsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCustomerSessions") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/export_customer_sessions" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.profileIntegrationId != nil { + localVarQueryParams.Add("profileIntegrationId", parameterToString(*r.profileIntegrationId, "")) + } + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + } + if r.customerSessionState != nil { + localVarQueryParams.Add("customerSessionState", parameterToString(*r.customerSessionState, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportEffectsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId *float32 + createdBefore *time.Time + createdAfter *time.Time + dateFormat *string +} + +func (r apiExportEffectsRequest) CampaignId(campaignId float32) apiExportEffectsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiExportEffectsRequest) CreatedBefore(createdBefore time.Time) apiExportEffectsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiExportEffectsRequest) CreatedAfter(createdAfter time.Time) apiExportEffectsRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiExportEffectsRequest) DateFormat(dateFormat string) apiExportEffectsRequest { + r.dateFormat = &dateFormat + return r +} + +/* +ExportEffects Export triggered effects +Download a CSV file containing the triggered effects that match the given attributes. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiExportEffectsRequest +*/ +func (a *ManagementApiService) ExportEffects(ctx _context.Context, applicationId int32) apiExportEffectsRequest { + return apiExportEffectsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportEffectsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportEffects") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/export_effects" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.campaignId != nil { + localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportLoyaltyBalanceRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId string +} + +/* +ExportLoyaltyBalance Export customer loyalty balance to a CSV file +Download a CSV file containing the balance of each customer in the loyalty program. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param loyaltyProgramId The identifier for the loyalty program. +@return apiExportLoyaltyBalanceRequest +*/ +func (a *ManagementApiService) ExportLoyaltyBalance(ctx _context.Context, loyaltyProgramId string) apiExportLoyaltyBalanceRequest { + return apiExportLoyaltyBalanceRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyBalance") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportLoyaltyLedgerRequest struct { + ctx _context.Context + apiService *ManagementApiService + rangeStart *time.Time + rangeEnd *time.Time + loyaltyProgramId string + integrationId string + dateFormat *string +} + +func (r apiExportLoyaltyLedgerRequest) RangeStart(rangeStart time.Time) apiExportLoyaltyLedgerRequest { + r.rangeStart = &rangeStart + return r +} + +func (r apiExportLoyaltyLedgerRequest) RangeEnd(rangeEnd time.Time) apiExportLoyaltyLedgerRequest { + r.rangeEnd = &rangeEnd + return r +} + +func (r apiExportLoyaltyLedgerRequest) DateFormat(dateFormat string) apiExportLoyaltyLedgerRequest { + r.dateFormat = &dateFormat + return r +} + +/* +ExportLoyaltyLedger Export a customer's loyalty ledger log +Download a CSV file containing a customer's ledger log in the loyalty program + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param loyaltyProgramId The identifier for the loyalty program. + * @param integrationId The identifier of the profile. +@return apiExportLoyaltyLedgerRequest +*/ +func (a *ManagementApiService) ExportLoyaltyLedger(ctx _context.Context, loyaltyProgramId string, integrationId string) apiExportLoyaltyLedgerRequest { + return apiExportLoyaltyLedgerRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyLedger") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") + } + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") + } + + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportReferralsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId *float32 + createdBefore *time.Time + createdAfter *time.Time + valid *string + usable *string + batchId *string + dateFormat *string +} + +func (r apiExportReferralsRequest) CampaignId(campaignId float32) apiExportReferralsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiExportReferralsRequest) CreatedBefore(createdBefore time.Time) apiExportReferralsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiExportReferralsRequest) CreatedAfter(createdAfter time.Time) apiExportReferralsRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiExportReferralsRequest) Valid(valid string) apiExportReferralsRequest { + r.valid = &valid + return r +} + +func (r apiExportReferralsRequest) Usable(usable string) apiExportReferralsRequest { + r.usable = &usable + return r +} + +func (r apiExportReferralsRequest) BatchId(batchId string) apiExportReferralsRequest { + r.batchId = &batchId + return r +} + +func (r apiExportReferralsRequest) DateFormat(dateFormat string) apiExportReferralsRequest { + r.dateFormat = &dateFormat + return r +} + +/* +ExportReferrals Export referrals +Download a CSV file containing the referrals that match the given parameters. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiExportReferralsRequest +*/ +func (a *ManagementApiService) ExportReferrals(ctx _context.Context, applicationId int32) apiExportReferralsRequest { + return apiExportReferralsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + } +} + +/* +Execute executes the request + @return string +*/ +func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportReferrals") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/export_referrals" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.campaignId != nil { + localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + } + if r.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + } + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + } + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiGetAccessLogsWithoutTotalCountRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + rangeStart *time.Time + rangeEnd *time.Time + path *string + method *string + status *string + pageSize *int32 + skip *int32 + sort *string +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) RangeStart(rangeStart time.Time) apiGetAccessLogsWithoutTotalCountRequest { + r.rangeStart = &rangeStart + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) RangeEnd(rangeEnd time.Time) apiGetAccessLogsWithoutTotalCountRequest { + r.rangeEnd = &rangeEnd + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) Path(path string) apiGetAccessLogsWithoutTotalCountRequest { + r.path = &path + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) Method(method string) apiGetAccessLogsWithoutTotalCountRequest { + r.method = &method + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) Status(status string) apiGetAccessLogsWithoutTotalCountRequest { + r.status = &status + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetAccessLogsWithoutTotalCountRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) Skip(skip int32) apiGetAccessLogsWithoutTotalCountRequest { + r.skip = &skip + return r +} + +func (r apiGetAccessLogsWithoutTotalCountRequest) Sort(sort string) apiGetAccessLogsWithoutTotalCountRequest { + r.sort = &sort + return r +} + +/* +GetAccessLogsWithoutTotalCount Get access logs for Application +Retrieve the list of API calls to this Application matching the specified criteria. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetAccessLogsWithoutTotalCountRequest +*/ +func (a *ManagementApiService) GetAccessLogsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetAccessLogsWithoutTotalCountRequest { + return apiGetAccessLogsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + } +} + +/* +Execute executes the request + @return InlineResponse20012 +*/ +func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse20012 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccessLogsWithoutTotalCount") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/access_logs/no_total" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") + } + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") + } + + if r.path != nil { + localVarQueryParams.Add("path", parameterToString(*r.path, "")) + } + if r.method != nil { + localVarQueryParams.Add("method", parameterToString(*r.method, "")) + } + if r.status != nil { + localVarQueryParams.Add("status", parameterToString(*r.status, "")) + } + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse20012 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiGetAccountRequest struct { + ctx _context.Context + apiService *ManagementApiService + accountId int32 +} + +/* +GetAccount Get account details +Return the details of your companies Talon.One account. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param accountId The identifier of the account. Retrieve it via the [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` property. +@return apiGetAccountRequest +*/ +func (a *ManagementApiService) GetAccount(ctx _context.Context, accountId int32) apiGetAccountRequest { + return apiGetAccountRequest{ + apiService: a, + ctx: ctx, + accountId: accountId, + } +} + +/* +Execute executes the request + @return Account +*/ +func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Account + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccount") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/accounts/{accountId}" + localVarPath = strings.Replace(localVarPath, "{"+"accountId"+"}", _neturl.QueryEscape(parameterToString(r.accountId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Account + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiGetAccountAnalyticsRequest struct { + ctx _context.Context + apiService *ManagementApiService + accountId int32 +} + +/* +GetAccountAnalytics Get account analytics +Return the analytics of your Talon.One account. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param accountId The identifier of the account. Retrieve it via the [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` property. +@return apiGetAccountAnalyticsRequest +*/ +func (a *ManagementApiService) GetAccountAnalytics(ctx _context.Context, accountId int32) apiGetAccountAnalyticsRequest { + return apiGetAccountAnalyticsRequest{ + apiService: a, + ctx: ctx, + accountId: accountId, + } +} + +/* +Execute executes the request + @return AccountAnalytics +*/ +func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue AccountAnalytics + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountAnalytics") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/accounts/{accountId}/analytics" + localVarPath = strings.Replace(localVarPath, "{"+"accountId"+"}", _neturl.QueryEscape(parameterToString(r.accountId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v AccountAnalytics + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiExportCouponsRequest) CampaignState(campaignState string) apiExportCouponsRequest { - r.campaignState = &campaignState - return r +type apiGetAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 } /* -ExportCoupons Export coupons to CSV file -Download a file containing the coupons that match the given properties. +GetAccountCollection Get account-level collection +Retrieve a given account-level collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiExportCouponsRequest + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiGetAccountCollectionRequest */ -func (a *ManagementApiService) ExportCoupons(ctx _context.Context, applicationId int32) apiExportCouponsRequest { - return apiExportCouponsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetAccountCollection(ctx _context.Context, collectionId int32) apiGetAccountCollectionRequest { + return apiGetAccountCollectionRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, } } /* Execute executes the request - @return string + @return Collection */ -func (r apiExportCouponsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiGetAccountCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCoupons") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/export_coupons" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/collections/{collectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.campaignId != nil { - localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.value != nil { - localVarQueryParams.Add("value", parameterToString(*r.value, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err } - if r.referralId != nil { - localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err } - if r.recipientIntegrationId != nil { - localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err } - if r.batchId != nil { - localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Collection + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr } - if r.exactMatch != nil { - localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr } - if r.dateFormat != nil { - localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiGetAdditionalCostRequest struct { + ctx _context.Context + apiService *ManagementApiService + additionalCostId int32 +} + +/* +GetAdditionalCost Get additional cost +Returns the additional cost. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param additionalCostId +@return apiGetAdditionalCostRequest +*/ +func (a *ManagementApiService) GetAdditionalCost(ctx _context.Context, additionalCostId int32) apiGetAdditionalCostRequest { + return apiGetAdditionalCostRequest{ + apiService: a, + ctx: ctx, + additionalCostId: additionalCostId, } - if r.campaignState != nil { - localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) +} + +/* +Execute executes the request + @return AccountAdditionalCost +*/ +func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue AccountAdditionalCost + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCost") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } + + localVarPath := localBasePath + "/v1/additional_costs/{additionalCostId}" + localVarPath = strings.Replace(localVarPath, "{"+"additionalCostId"+"}", _neturl.QueryEscape(parameterToString(r.additionalCostId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -2237,7 +4869,7 @@ func (r apiExportCouponsRequest) Execute() (string, *_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2280,7 +4912,7 @@ func (r apiExportCouponsRequest) Execute() (string, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v string + var v AccountAdditionalCost err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -2303,97 +4935,76 @@ func (r apiExportCouponsRequest) Execute() (string, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportCustomerSessionsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - createdBefore *time.Time - createdAfter *time.Time - profileIntegrationId *string - dateFormat *string - customerSessionState *string -} - -func (r apiExportCustomerSessionsRequest) CreatedBefore(createdBefore time.Time) apiExportCustomerSessionsRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiExportCustomerSessionsRequest) CreatedAfter(createdAfter time.Time) apiExportCustomerSessionsRequest { - r.createdAfter = &createdAfter - return r +type apiGetAdditionalCostsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string } -func (r apiExportCustomerSessionsRequest) ProfileIntegrationId(profileIntegrationId string) apiExportCustomerSessionsRequest { - r.profileIntegrationId = &profileIntegrationId +func (r apiGetAdditionalCostsRequest) PageSize(pageSize int32) apiGetAdditionalCostsRequest { + r.pageSize = &pageSize return r } -func (r apiExportCustomerSessionsRequest) DateFormat(dateFormat string) apiExportCustomerSessionsRequest { - r.dateFormat = &dateFormat +func (r apiGetAdditionalCostsRequest) Skip(skip int32) apiGetAdditionalCostsRequest { + r.skip = &skip return r } -func (r apiExportCustomerSessionsRequest) CustomerSessionState(customerSessionState string) apiExportCustomerSessionsRequest { - r.customerSessionState = &customerSessionState +func (r apiGetAdditionalCostsRequest) Sort(sort string) apiGetAdditionalCostsRequest { + r.sort = &sort return r } /* -ExportCustomerSessions Export customer sessions to CSV file -Download a file containing the customer sessions that match the request. +GetAdditionalCosts List additional costs +Returns all the defined additional costs for the account. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiExportCustomerSessionsRequest +@return apiGetAdditionalCostsRequest */ -func (a *ManagementApiService) ExportCustomerSessions(ctx _context.Context, applicationId int32) apiExportCustomerSessionsRequest { - return apiExportCustomerSessionsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetAdditionalCosts(ctx _context.Context) apiGetAdditionalCostsRequest { + return apiGetAdditionalCostsRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return string + @return InlineResponse20025 */ -func (r apiExportCustomerSessionsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20025, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string + localVarReturnValue InlineResponse20025 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCustomerSessions") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCosts") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/export_customer_sessions" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/additional_costs" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.profileIntegrationId != nil { - localVarQueryParams.Add("profileIntegrationId", parameterToString(*r.profileIntegrationId, "")) + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } - if r.dateFormat != nil { - localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - if r.customerSessionState != nil { - localVarQueryParams.Add("customerSessionState", parameterToString(*r.customerSessionState, "")) + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -2405,7 +5016,7 @@ func (r apiExportCustomerSessionsRequest) Execute() (string, *_nethttp.Response, } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2448,7 +5059,7 @@ func (r apiExportCustomerSessionsRequest) Execute() (string, *_nethttp.Response, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v string + var v InlineResponse20025 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -2471,88 +5082,125 @@ func (r apiExportCustomerSessionsRequest) Execute() (string, *_nethttp.Response, return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportEffectsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId *float32 - createdBefore *time.Time - createdAfter *time.Time - dateFormat *string +type apiGetAllAccessLogsRequest struct { + ctx _context.Context + apiService *ManagementApiService + rangeStart *time.Time + rangeEnd *time.Time + path *string + method *string + status *string + pageSize *int32 + skip *int32 + sort *string } -func (r apiExportEffectsRequest) CampaignId(campaignId float32) apiExportEffectsRequest { - r.campaignId = &campaignId +func (r apiGetAllAccessLogsRequest) RangeStart(rangeStart time.Time) apiGetAllAccessLogsRequest { + r.rangeStart = &rangeStart return r } -func (r apiExportEffectsRequest) CreatedBefore(createdBefore time.Time) apiExportEffectsRequest { - r.createdBefore = &createdBefore +func (r apiGetAllAccessLogsRequest) RangeEnd(rangeEnd time.Time) apiGetAllAccessLogsRequest { + r.rangeEnd = &rangeEnd return r } -func (r apiExportEffectsRequest) CreatedAfter(createdAfter time.Time) apiExportEffectsRequest { - r.createdAfter = &createdAfter +func (r apiGetAllAccessLogsRequest) Path(path string) apiGetAllAccessLogsRequest { + r.path = &path return r } -func (r apiExportEffectsRequest) DateFormat(dateFormat string) apiExportEffectsRequest { - r.dateFormat = &dateFormat +func (r apiGetAllAccessLogsRequest) Method(method string) apiGetAllAccessLogsRequest { + r.method = &method + return r +} + +func (r apiGetAllAccessLogsRequest) Status(status string) apiGetAllAccessLogsRequest { + r.status = &status + return r +} + +func (r apiGetAllAccessLogsRequest) PageSize(pageSize int32) apiGetAllAccessLogsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetAllAccessLogsRequest) Skip(skip int32) apiGetAllAccessLogsRequest { + r.skip = &skip + return r +} + +func (r apiGetAllAccessLogsRequest) Sort(sort string) apiGetAllAccessLogsRequest { + r.sort = &sort return r } /* -ExportEffects Export triggered effects to CSV file -Download a file containing the triggered effects that match the given attributes. +GetAllAccessLogs List access logs +Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiExportEffectsRequest +@return apiGetAllAccessLogsRequest */ -func (a *ManagementApiService) ExportEffects(ctx _context.Context, applicationId int32) apiExportEffectsRequest { - return apiExportEffectsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetAllAccessLogs(ctx _context.Context) apiGetAllAccessLogsRequest { + return apiGetAllAccessLogsRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return string + @return InlineResponse20013 */ -func (r apiExportEffectsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string + localVarReturnValue InlineResponse20013 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportEffects") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllAccessLogs") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/export_effects" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/access_logs" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.campaignId != nil { - localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.path != nil { + localVarQueryParams.Add("path", parameterToString(*r.path, "")) } - if r.dateFormat != nil { - localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + if r.method != nil { + localVarQueryParams.Add("method", parameterToString(*r.method, "")) + } + if r.status != nil { + localVarQueryParams.Add("status", parameterToString(*r.status, "")) + } + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -2564,7 +5212,7 @@ func (r apiExportEffectsRequest) Execute() (string, *_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2607,7 +5255,7 @@ func (r apiExportEffectsRequest) Execute() (string, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v string + var v InlineResponse20013 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -2630,48 +5278,44 @@ func (r apiExportEffectsRequest) Execute() (string, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportLoyaltyBalanceRequest struct { +type apiGetAllRolesRequest struct { ctx _context.Context apiService *ManagementApiService - programID string } /* -ExportLoyaltyBalance Export customer loyalty balance to a CSV file -Download a file with the balance of each customer in the loyalty program +GetAllRoles List roles +List all roles. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID -@return apiExportLoyaltyBalanceRequest +@return apiGetAllRolesRequest */ -func (a *ManagementApiService) ExportLoyaltyBalance(ctx _context.Context, programID string) apiExportLoyaltyBalanceRequest { - return apiExportLoyaltyBalanceRequest{ +func (a *ManagementApiService) GetAllRoles(ctx _context.Context) apiGetAllRolesRequest { + return apiGetAllRolesRequest{ apiService: a, ctx: ctx, - programID: programID, } } /* Execute executes the request - @return string + @return InlineResponse20033 */ -func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiGetAllRolesRequest) Execute() (InlineResponse20033, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string + localVarReturnValue InlineResponse20033 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyBalance") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllRoles") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/export_customer_balance" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + localVarPath := localBasePath + "/v1/roles" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2687,7 +5331,7 @@ func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, e } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2730,7 +5374,7 @@ func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, e error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v string + var v InlineResponse20033 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -2753,88 +5397,53 @@ func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, e return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportLoyaltyLedgerRequest struct { +type apiGetApplicationRequest struct { ctx _context.Context apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time - programID string - integrationID string - dateFormat *string -} - -func (r apiExportLoyaltyLedgerRequest) RangeStart(rangeStart time.Time) apiExportLoyaltyLedgerRequest { - r.rangeStart = &rangeStart - return r -} - -func (r apiExportLoyaltyLedgerRequest) RangeEnd(rangeEnd time.Time) apiExportLoyaltyLedgerRequest { - r.rangeEnd = &rangeEnd - return r -} - -func (r apiExportLoyaltyLedgerRequest) DateFormat(dateFormat string) apiExportLoyaltyLedgerRequest { - r.dateFormat = &dateFormat - return r + applicationId int32 } /* -ExportLoyaltyLedger Export a customer's loyalty ledger log to CSV file -Download a file with a customer's ledger log in the loyalty program +GetApplication Get application +Get the application specified by the ID. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID - * @param integrationID -@return apiExportLoyaltyLedgerRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationRequest */ -func (a *ManagementApiService) ExportLoyaltyLedger(ctx _context.Context, programID string, integrationID string) apiExportLoyaltyLedgerRequest { - return apiExportLoyaltyLedgerRequest{ +func (a *ManagementApiService) GetApplication(ctx _context.Context, applicationId int32) apiGetApplicationRequest { + return apiGetApplicationRequest{ apiService: a, ctx: ctx, - programID: programID, - integrationID: integrationID, + applicationId: applicationId, } } /* Execute executes the request - @return string + @return Application */ -func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string + localVarReturnValue Application ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyLedger") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplication") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/profile/{integrationID}/export_log" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationID"+"}", _neturl.QueryEscape(parameterToString(r.integrationID, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.rangeStart == nil { - return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") - } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") - } - - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.dateFormat != nil { - localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -2845,7 +5454,7 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2883,91 +5492,51 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er } if localVarHTTPResponse.StatusCode >= 300 { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type apiExportReferralsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId *float32 - createdBefore *time.Time - createdAfter *time.Time - valid *string - usable *string - batchId *string - dateFormat *string -} - -func (r apiExportReferralsRequest) CampaignId(campaignId float32) apiExportReferralsRequest { - r.campaignId = &campaignId - return r -} - -func (r apiExportReferralsRequest) CreatedBefore(createdBefore time.Time) apiExportReferralsRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiExportReferralsRequest) CreatedAfter(createdAfter time.Time) apiExportReferralsRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiExportReferralsRequest) Valid(valid string) apiExportReferralsRequest { - r.valid = &valid - return r -} + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Application + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } -func (r apiExportReferralsRequest) Usable(usable string) apiExportReferralsRequest { - r.usable = &usable - return r -} + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } -func (r apiExportReferralsRequest) BatchId(batchId string) apiExportReferralsRequest { - r.batchId = &batchId - return r + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiExportReferralsRequest) DateFormat(dateFormat string) apiExportReferralsRequest { - r.dateFormat = &dateFormat - return r +type apiGetApplicationApiHealthRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 } /* -ExportReferrals Export referrals to CSV file -Download a file containing the referrals that match the given parameters. +GetApplicationApiHealth Get report of health of application API +Display the health of the application and show the last time the Application +was used. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiExportReferralsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationApiHealthRequest */ -func (a *ManagementApiService) ExportReferrals(ctx _context.Context, applicationId int32) apiExportReferralsRequest { - return apiExportReferralsRequest{ +func (a *ManagementApiService) GetApplicationApiHealth(ctx _context.Context, applicationId int32) apiGetApplicationApiHealthRequest { + return apiGetApplicationApiHealthRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -2976,51 +5545,30 @@ func (a *ManagementApiService) ExportReferrals(ctx _context.Context, application /* Execute executes the request - @return string + @return ApplicationApiHealth */ -func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string + localVarReturnValue ApplicationApiHealth ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportReferrals") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationApiHealth") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/export_referrals" + localVarPath := localBasePath + "/v1/applications/{applicationId}/health_report" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.campaignId != nil { - localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) - } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) - } - if r.batchId != nil { - localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) - } - if r.dateFormat != nil { - localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -3031,7 +5579,7 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -3074,7 +5622,7 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v string + var v ApplicationApiHealth err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3097,130 +5645,58 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAccessLogsWithoutTotalCountRequest struct { +type apiGetApplicationCustomerRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - rangeStart *time.Time - rangeEnd *time.Time - path *string - method *string - status *string - pageSize *int32 - skip *int32 - sort *string -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) RangeStart(rangeStart time.Time) apiGetAccessLogsWithoutTotalCountRequest { - r.rangeStart = &rangeStart - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) RangeEnd(rangeEnd time.Time) apiGetAccessLogsWithoutTotalCountRequest { - r.rangeEnd = &rangeEnd - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) Path(path string) apiGetAccessLogsWithoutTotalCountRequest { - r.path = &path - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) Method(method string) apiGetAccessLogsWithoutTotalCountRequest { - r.method = &method - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) Status(status string) apiGetAccessLogsWithoutTotalCountRequest { - r.status = &status - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetAccessLogsWithoutTotalCountRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) Skip(skip int32) apiGetAccessLogsWithoutTotalCountRequest { - r.skip = &skip - return r -} - -func (r apiGetAccessLogsWithoutTotalCountRequest) Sort(sort string) apiGetAccessLogsWithoutTotalCountRequest { - r.sort = &sort - return r + customerId int32 } /* -GetAccessLogsWithoutTotalCount Get access logs for Application -Retrieve the list of API calls to this Application matching the specified criteria. +GetApplicationCustomer Get application's customer +Retrieve the customers of the specified application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetAccessLogsWithoutTotalCountRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. +@return apiGetApplicationCustomerRequest */ -func (a *ManagementApiService) GetAccessLogsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetAccessLogsWithoutTotalCountRequest { - return apiGetAccessLogsWithoutTotalCountRequest{ +func (a *ManagementApiService) GetApplicationCustomer(ctx _context.Context, applicationId int32, customerId int32) apiGetApplicationCustomerRequest { + return apiGetApplicationCustomerRequest{ apiService: a, ctx: ctx, applicationId: applicationId, + customerId: customerId, } } /* Execute executes the request - @return InlineResponse2008 + @return ApplicationCustomer */ -func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { +func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2008 + localVarReturnValue ApplicationCustomer ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccessLogsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomer") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/access_logs/no_total" + localVarPath := localBasePath + "/v1/applications/{applicationId}/customers/{customerId}" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.rangeStart == nil { - return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") - } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") - } - - if r.path != nil { - localVarQueryParams.Add("path", parameterToString(*r.path, "")) - } - if r.method != nil { - localVarQueryParams.Add("method", parameterToString(*r.method, "")) - } - if r.status != nil { - localVarQueryParams.Add("status", parameterToString(*r.status, "")) - } - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -3274,7 +5750,7 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse2008, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2008 + var v ApplicationCustomer err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3297,54 +5773,94 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse2008, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAccountRequest struct { - ctx _context.Context - apiService *ManagementApiService - accountId int32 +type apiGetApplicationCustomerFriendsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + integrationId string + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool +} + +func (r apiGetApplicationCustomerFriendsRequest) PageSize(pageSize int32) apiGetApplicationCustomerFriendsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetApplicationCustomerFriendsRequest) Skip(skip int32) apiGetApplicationCustomerFriendsRequest { + r.skip = &skip + return r +} + +func (r apiGetApplicationCustomerFriendsRequest) Sort(sort string) apiGetApplicationCustomerFriendsRequest { + r.sort = &sort + return r +} + +func (r apiGetApplicationCustomerFriendsRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomerFriendsRequest { + r.withTotalResultSize = &withTotalResultSize + return r } /* -GetAccount Get account details -Return the details of your companies Talon.One account. +GetApplicationCustomerFriends List friends referred by customer profile +List the friends referred by the specified customer profile in this Application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param accountId -@return apiGetAccountRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param integrationId The Integration ID of the Advocate's Profile. +@return apiGetApplicationCustomerFriendsRequest */ -func (a *ManagementApiService) GetAccount(ctx _context.Context, accountId int32) apiGetAccountRequest { - return apiGetAccountRequest{ - apiService: a, - ctx: ctx, - accountId: accountId, +func (a *ManagementApiService) GetApplicationCustomerFriends(ctx _context.Context, applicationId int32, integrationId string) apiGetApplicationCustomerFriendsRequest { + return apiGetApplicationCustomerFriendsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + integrationId: integrationId, } } /* Execute executes the request - @return Account + @return InlineResponse20023 */ -func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { +func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20023, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Account + localVarReturnValue InlineResponse20023 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomerFriends") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/accounts/{accountId}" - localVarPath = strings.Replace(localVarPath, "{"+"accountId"+"}", _neturl.QueryEscape(parameterToString(r.accountId, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/profile/{integrationId}/friends" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -3398,7 +5914,7 @@ func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Account + var v InlineResponse20023 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3421,54 +5937,89 @@ func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAccountAnalyticsRequest struct { - ctx _context.Context - apiService *ManagementApiService - accountId int32 +type apiGetApplicationCustomersRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + integrationId *string + pageSize *int32 + skip *int32 + withTotalResultSize *bool } -/* -GetAccountAnalytics Get account analytics -Return the analytics of your companies Talon.One account. +func (r apiGetApplicationCustomersRequest) IntegrationId(integrationId string) apiGetApplicationCustomersRequest { + r.integrationId = &integrationId + return r +} + +func (r apiGetApplicationCustomersRequest) PageSize(pageSize int32) apiGetApplicationCustomersRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetApplicationCustomersRequest) Skip(skip int32) apiGetApplicationCustomersRequest { + r.skip = &skip + return r +} + +func (r apiGetApplicationCustomersRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} +/* +GetApplicationCustomers List application's customers +List all the customers of the specified application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param accountId -@return apiGetAccountAnalyticsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationCustomersRequest */ -func (a *ManagementApiService) GetAccountAnalytics(ctx _context.Context, accountId int32) apiGetAccountAnalyticsRequest { - return apiGetAccountAnalyticsRequest{ - apiService: a, - ctx: ctx, - accountId: accountId, +func (a *ManagementApiService) GetApplicationCustomers(ctx _context.Context, applicationId int32) apiGetApplicationCustomersRequest { + return apiGetApplicationCustomersRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return AccountAnalytics + @return InlineResponse20015 */ -func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Response, error) { +func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20015, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue AccountAnalytics + localVarReturnValue InlineResponse20015 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountAnalytics") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomers") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/accounts/{accountId}/analytics" - localVarPath = strings.Replace(localVarPath, "{"+"accountId"+"}", _neturl.QueryEscape(parameterToString(r.accountId, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/customers" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.integrationId != nil { + localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) + } + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -3522,7 +6073,7 @@ func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Re error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v AccountAnalytics + var v InlineResponse20015 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3545,56 +6096,95 @@ func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Re return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAdditionalCostRequest struct { - ctx _context.Context - apiService *ManagementApiService - additionalCostId int32 +type apiGetApplicationCustomersByAttributesRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + body *CustomerProfileSearchQuery + pageSize *int32 + skip *int32 + withTotalResultSize *bool +} + +func (r apiGetApplicationCustomersByAttributesRequest) Body(body CustomerProfileSearchQuery) apiGetApplicationCustomersByAttributesRequest { + r.body = &body + return r +} + +func (r apiGetApplicationCustomersByAttributesRequest) PageSize(pageSize int32) apiGetApplicationCustomersByAttributesRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetApplicationCustomersByAttributesRequest) Skip(skip int32) apiGetApplicationCustomersByAttributesRequest { + r.skip = &skip + return r +} + +func (r apiGetApplicationCustomersByAttributesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersByAttributesRequest { + r.withTotalResultSize = &withTotalResultSize + return r } /* -GetAdditionalCost Get an additional cost -Returns additional cost for the account by its id. +GetApplicationCustomersByAttributes List application customers matching the given attributes +Get a list of the application customers matching the provided criteria. + +The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param additionalCostId -@return apiGetAdditionalCostRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationCustomersByAttributesRequest */ -func (a *ManagementApiService) GetAdditionalCost(ctx _context.Context, additionalCostId int32) apiGetAdditionalCostRequest { - return apiGetAdditionalCostRequest{ - apiService: a, - ctx: ctx, - additionalCostId: additionalCostId, +func (a *ManagementApiService) GetApplicationCustomersByAttributes(ctx _context.Context, applicationId int32) apiGetApplicationCustomersByAttributesRequest { + return apiGetApplicationCustomersByAttributesRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return AccountAdditionalCost + @return InlineResponse20016 */ -func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp.Response, error) { +func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse20016, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue AccountAdditionalCost + localVarReturnValue InlineResponse20016 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCost") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomersByAttributes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/additional_costs/{additionalCostId}" - localVarPath = strings.Replace(localVarPath, "{"+"additionalCostId"+"}", _neturl.QueryEscape(parameterToString(r.additionalCostId, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_search" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"application/json"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -3610,6 +6200,8 @@ func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + // body params + localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -3646,7 +6238,7 @@ func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v AccountAdditionalCost + var v InlineResponse20016 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3669,40 +6261,45 @@ func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAdditionalCostsRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string +type apiGetApplicationEventTypesRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + pageSize *int32 + skip *int32 + sort *string } -func (r apiGetAdditionalCostsRequest) PageSize(pageSize int32) apiGetAdditionalCostsRequest { +func (r apiGetApplicationEventTypesRequest) PageSize(pageSize int32) apiGetApplicationEventTypesRequest { r.pageSize = &pageSize return r } -func (r apiGetAdditionalCostsRequest) Skip(skip int32) apiGetAdditionalCostsRequest { +func (r apiGetApplicationEventTypesRequest) Skip(skip int32) apiGetApplicationEventTypesRequest { r.skip = &skip return r } -func (r apiGetAdditionalCostsRequest) Sort(sort string) apiGetAdditionalCostsRequest { +func (r apiGetApplicationEventTypesRequest) Sort(sort string) apiGetApplicationEventTypesRequest { r.sort = &sort return r } /* -GetAdditionalCosts List additional costs -Returns all the defined additional costs for the account. +GetApplicationEventTypes List Applications event types +Get all of the distinct values of the Event `type` property for events recorded in the application. + +See also: [Track an event](/integration-api/#operation/trackEvent) * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetAdditionalCostsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationEventTypesRequest */ -func (a *ManagementApiService) GetAdditionalCosts(ctx _context.Context) apiGetAdditionalCostsRequest { - return apiGetAdditionalCostsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetApplicationEventTypes(ctx _context.Context, applicationId int32) apiGetApplicationEventTypesRequest { + return apiGetApplicationEventTypesRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } @@ -3710,7 +6307,7 @@ func (a *ManagementApiService) GetAdditionalCosts(ctx _context.Context) apiGetAd Execute executes the request @return InlineResponse20021 */ -func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20021, *_nethttp.Response, error) { +func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20021, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} @@ -3720,12 +6317,13 @@ func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20021, *_nethttp. localVarReturnValue InlineResponse20021 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCosts") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventTypes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/additional_costs" + localVarPath := localBasePath + "/v1/applications/{applicationId}/event_types" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3816,117 +6414,138 @@ func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20021, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAllAccessLogsRequest struct { - ctx _context.Context - apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time - path *string - method *string - status *string - pageSize *int32 - skip *int32 - sort *string +type apiGetApplicationEventsWithoutTotalCountRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + pageSize *int32 + skip *int32 + sort *string + type_ *string + createdBefore *time.Time + createdAfter *time.Time + session *string + profile *string + customerName *string + customerEmail *string + couponCode *string + referralCode *string + ruleQuery *string + campaignQuery *string +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetApplicationEventsWithoutTotalCountRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) Skip(skip int32) apiGetApplicationEventsWithoutTotalCountRequest { + r.skip = &skip + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) Sort(sort string) apiGetApplicationEventsWithoutTotalCountRequest { + r.sort = &sort + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) Type_(type_ string) apiGetApplicationEventsWithoutTotalCountRequest { + r.type_ = &type_ + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationEventsWithoutTotalCountRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationEventsWithoutTotalCountRequest { + r.createdAfter = &createdAfter + return r } -func (r apiGetAllAccessLogsRequest) RangeStart(rangeStart time.Time) apiGetAllAccessLogsRequest { - r.rangeStart = &rangeStart +func (r apiGetApplicationEventsWithoutTotalCountRequest) Session(session string) apiGetApplicationEventsWithoutTotalCountRequest { + r.session = &session return r } -func (r apiGetAllAccessLogsRequest) RangeEnd(rangeEnd time.Time) apiGetAllAccessLogsRequest { - r.rangeEnd = &rangeEnd +func (r apiGetApplicationEventsWithoutTotalCountRequest) Profile(profile string) apiGetApplicationEventsWithoutTotalCountRequest { + r.profile = &profile return r } -func (r apiGetAllAccessLogsRequest) Path(path string) apiGetAllAccessLogsRequest { - r.path = &path +func (r apiGetApplicationEventsWithoutTotalCountRequest) CustomerName(customerName string) apiGetApplicationEventsWithoutTotalCountRequest { + r.customerName = &customerName return r } -func (r apiGetAllAccessLogsRequest) Method(method string) apiGetAllAccessLogsRequest { - r.method = &method +func (r apiGetApplicationEventsWithoutTotalCountRequest) CustomerEmail(customerEmail string) apiGetApplicationEventsWithoutTotalCountRequest { + r.customerEmail = &customerEmail return r } -func (r apiGetAllAccessLogsRequest) Status(status string) apiGetAllAccessLogsRequest { - r.status = &status +func (r apiGetApplicationEventsWithoutTotalCountRequest) CouponCode(couponCode string) apiGetApplicationEventsWithoutTotalCountRequest { + r.couponCode = &couponCode return r } -func (r apiGetAllAccessLogsRequest) PageSize(pageSize int32) apiGetAllAccessLogsRequest { - r.pageSize = &pageSize +func (r apiGetApplicationEventsWithoutTotalCountRequest) ReferralCode(referralCode string) apiGetApplicationEventsWithoutTotalCountRequest { + r.referralCode = &referralCode return r } -func (r apiGetAllAccessLogsRequest) Skip(skip int32) apiGetAllAccessLogsRequest { - r.skip = &skip +func (r apiGetApplicationEventsWithoutTotalCountRequest) RuleQuery(ruleQuery string) apiGetApplicationEventsWithoutTotalCountRequest { + r.ruleQuery = &ruleQuery return r } -func (r apiGetAllAccessLogsRequest) Sort(sort string) apiGetAllAccessLogsRequest { - r.sort = &sort +func (r apiGetApplicationEventsWithoutTotalCountRequest) CampaignQuery(campaignQuery string) apiGetApplicationEventsWithoutTotalCountRequest { + r.campaignQuery = &campaignQuery return r } /* -GetAllAccessLogs List access logs -Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. +GetApplicationEventsWithoutTotalCount List Applications events +Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetAllAccessLogsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationEventsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetAllAccessLogs(ctx _context.Context) apiGetAllAccessLogsRequest { - return apiGetAllAccessLogsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetApplicationEventsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetApplicationEventsWithoutTotalCountRequest { + return apiGetApplicationEventsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return InlineResponse2009 + @return InlineResponse20020 */ -func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { +func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineResponse20020, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2009 + localVarReturnValue InlineResponse20020 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllAccessLogs") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/access_logs" + localVarPath := localBasePath + "/v1/applications/{applicationId}/events/no_total" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.rangeStart == nil { - return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") - } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") - } - - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.path != nil { - localVarQueryParams.Add("path", parameterToString(*r.path, "")) - } - if r.method != nil { - localVarQueryParams.Add("method", parameterToString(*r.method, "")) - } - if r.status != nil { - localVarQueryParams.Add("status", parameterToString(*r.status, "")) - } if r.pageSize != nil { localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } @@ -3936,6 +6555,39 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Res if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } + if r.type_ != nil { + localVarQueryParams.Add("type", parameterToString(*r.type_, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.session != nil { + localVarQueryParams.Add("session", parameterToString(*r.session, "")) + } + if r.profile != nil { + localVarQueryParams.Add("profile", parameterToString(*r.profile, "")) + } + if r.customerName != nil { + localVarQueryParams.Add("customerName", parameterToString(*r.customerName, "")) + } + if r.customerEmail != nil { + localVarQueryParams.Add("customerEmail", parameterToString(*r.customerEmail, "")) + } + if r.couponCode != nil { + localVarQueryParams.Add("couponCode", parameterToString(*r.couponCode, "")) + } + if r.referralCode != nil { + localVarQueryParams.Add("referralCode", parameterToString(*r.referralCode, "")) + } + if r.ruleQuery != nil { + localVarQueryParams.Add("ruleQuery", parameterToString(*r.ruleQuery, "")) + } + if r.campaignQuery != nil { + localVarQueryParams.Add("campaignQuery", parameterToString(*r.campaignQuery, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -3989,7 +6641,7 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Res error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2009 + var v InlineResponse20020 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4012,44 +6664,54 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Res return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAllRolesRequest struct { - ctx _context.Context - apiService *ManagementApiService +type apiGetApplicationSessionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + sessionId int32 } /* -GetAllRoles List roles -List all roles. +GetApplicationSession Get Application session +Get the details of the given session. +You can list the sessions with the [List Application sessions](/#tag/Customer-data/operation/getApplicationSession) endpoint. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetAllRolesRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param sessionId The **internal** ID of the session. You can get the ID with the [List Application sessions endpoint](/#tag/Customer-data/operation/getApplicationSession). +@return apiGetApplicationSessionRequest */ -func (a *ManagementApiService) GetAllRoles(ctx _context.Context) apiGetAllRolesRequest { - return apiGetAllRolesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetApplicationSession(ctx _context.Context, applicationId int32, sessionId int32) apiGetApplicationSessionRequest { + return apiGetApplicationSessionRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + sessionId: sessionId, } } /* Execute executes the request - @return InlineResponse20029 + @return ApplicationSession */ -func (r apiGetAllRolesRequest) Execute() (InlineResponse20029, *_nethttp.Response, error) { +func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20029 + localVarReturnValue ApplicationSession ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllRoles") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSession") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/roles" + localVarPath := localBasePath + "/v1/applications/{applicationId}/sessions/{sessionId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"sessionId"+"}", _neturl.QueryEscape(parameterToString(r.sessionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4108,7 +6770,7 @@ func (r apiGetAllRolesRequest) Execute() (InlineResponse20029, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20029 + var v ApplicationSession err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4131,146 +6793,82 @@ func (r apiGetAllRolesRequest) Execute() (InlineResponse20029, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationRequest struct { +type apiGetApplicationSessionsRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 + pageSize *int32 + skip *int32 + sort *string + profile *string + state *string + createdBefore *time.Time + createdAfter *time.Time + coupon *string + referral *string + integrationId *string } -/* -GetApplication Get Application -Get the application specified by the ID. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationRequest -*/ -func (a *ManagementApiService) GetApplication(ctx _context.Context, applicationId int32) apiGetApplicationRequest { - return apiGetApplicationRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - } +func (r apiGetApplicationSessionsRequest) PageSize(pageSize int32) apiGetApplicationSessionsRequest { + r.pageSize = &pageSize + return r } -/* -Execute executes the request - @return Application -*/ -func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodGet - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue Application - ) - - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplication") - if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/applications/{applicationId}" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := _neturl.Values{} - localVarFormParams := _neturl.Values{} - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } +func (r apiGetApplicationSessionsRequest) Skip(skip int32) apiGetApplicationSessionsRequest { + r.skip = &skip + return r +} - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} +func (r apiGetApplicationSessionsRequest) Sort(sort string) apiGetApplicationSessionsRequest { + r.sort = &sort + return r +} - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if auth, ok := auth["Authorization"]; ok { - var key string - if auth.Prefix != "" { - key = auth.Prefix + " " + auth.Key - } else { - key = auth.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) - if err != nil { - return localVarReturnValue, nil, err - } +func (r apiGetApplicationSessionsRequest) Profile(profile string) apiGetApplicationSessionsRequest { + r.profile = &profile + return r +} - localVarHTTPResponse, err := r.apiService.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } +func (r apiGetApplicationSessionsRequest) State(state string) apiGetApplicationSessionsRequest { + r.state = &state + return r +} - localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } +func (r apiGetApplicationSessionsRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationSessionsRequest { + r.createdBefore = &createdBefore + return r +} - if localVarHTTPResponse.StatusCode >= 300 { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - if localVarHTTPResponse.StatusCode == 200 { - var v Application - err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } - return localVarReturnValue, localVarHTTPResponse, newErr - } +func (r apiGetApplicationSessionsRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationSessionsRequest { + r.createdAfter = &createdAfter + return r +} - err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } +func (r apiGetApplicationSessionsRequest) Coupon(coupon string) apiGetApplicationSessionsRequest { + r.coupon = &coupon + return r +} - return localVarReturnValue, localVarHTTPResponse, nil +func (r apiGetApplicationSessionsRequest) Referral(referral string) apiGetApplicationSessionsRequest { + r.referral = &referral + return r } -type apiGetApplicationApiHealthRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 +func (r apiGetApplicationSessionsRequest) IntegrationId(integrationId string) apiGetApplicationSessionsRequest { + r.integrationId = &integrationId + return r } /* -GetApplicationApiHealth Get report of health of application API -Display the health of the application and show the last time the Application -was used. +GetApplicationSessions List Application sessions +List all the sessions of the specified Application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationApiHealthRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetApplicationSessionsRequest */ -func (a *ManagementApiService) GetApplicationApiHealth(ctx _context.Context, applicationId int32) apiGetApplicationApiHealthRequest { - return apiGetApplicationApiHealthRequest{ +func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, applicationId int32) apiGetApplicationSessionsRequest { + return apiGetApplicationSessionsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -4279,30 +6877,60 @@ func (a *ManagementApiService) GetApplicationApiHealth(ctx _context.Context, app /* Execute executes the request - @return ApplicationApiHealth + @return InlineResponse20019 */ -func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_nethttp.Response, error) { +func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20019, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue ApplicationApiHealth + localVarReturnValue InlineResponse20019 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationApiHealth") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSessions") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/health_report" + localVarPath := localBasePath + "/v1/applications/{applicationId}/sessions" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.profile != nil { + localVarQueryParams.Add("profile", parameterToString(*r.profile, "")) + } + if r.state != nil { + localVarQueryParams.Add("state", parameterToString(*r.state, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.coupon != nil { + localVarQueryParams.Add("coupon", parameterToString(*r.coupon, "")) + } + if r.referral != nil { + localVarQueryParams.Add("referral", parameterToString(*r.referral, "")) + } + if r.integrationId != nil { + localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4356,7 +6984,7 @@ func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v ApplicationApiHealth + var v InlineResponse20019 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4379,61 +7007,76 @@ func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationCustomerRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - customerId int32 +type apiGetApplicationsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string } -/* -GetApplicationCustomer Get application's customer -Retrieve the customers of the specified application. +func (r apiGetApplicationsRequest) PageSize(pageSize int32) apiGetApplicationsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetApplicationsRequest) Skip(skip int32) apiGetApplicationsRequest { + r.skip = &skip + return r +} -The `customerId` parameter is the value of the `id` property of a customer profile. -Get it with the [List application's customers](#operation/getApplicationCustomers) endpoint. +func (r apiGetApplicationsRequest) Sort(sort string) apiGetApplicationsRequest { + r.sort = &sort + return r +} +/* +GetApplications List applications +List all applications in the current account. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param customerId -@return apiGetApplicationCustomerRequest +@return apiGetApplicationsRequest */ -func (a *ManagementApiService) GetApplicationCustomer(ctx _context.Context, applicationId int32, customerId int32) apiGetApplicationCustomerRequest { - return apiGetApplicationCustomerRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - customerId: customerId, +func (a *ManagementApiService) GetApplications(ctx _context.Context) apiGetApplicationsRequest { + return apiGetApplicationsRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return ApplicationCustomer + @return InlineResponse2001 */ -func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_nethttp.Response, error) { +func (r apiGetApplicationsRequest) Execute() (InlineResponse2001, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue ApplicationCustomer + localVarReturnValue InlineResponse2001 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomer") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplications") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/customers/{customerId}" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) + localVarPath := localBasePath + "/v1/applications" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4487,7 +7130,7 @@ func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v ApplicationCustomer + var v InlineResponse2001 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4510,94 +7153,54 @@ func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationCustomerFriendsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - integrationId string - pageSize *int32 - skip *int32 - sort *string - withTotalResultSize *bool -} - -func (r apiGetApplicationCustomerFriendsRequest) PageSize(pageSize int32) apiGetApplicationCustomerFriendsRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetApplicationCustomerFriendsRequest) Skip(skip int32) apiGetApplicationCustomerFriendsRequest { - r.skip = &skip - return r -} - -func (r apiGetApplicationCustomerFriendsRequest) Sort(sort string) apiGetApplicationCustomerFriendsRequest { - r.sort = &sort - return r -} - -func (r apiGetApplicationCustomerFriendsRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomerFriendsRequest { - r.withTotalResultSize = &withTotalResultSize - return r +type apiGetAttributeRequest struct { + ctx _context.Context + apiService *ManagementApiService + attributeId int32 } /* -GetApplicationCustomerFriends List friends referred by customer profile -List the friends referred by the specified customer profile in this Application. +GetAttribute Get custom attribute +Returns custom attribute for the account by its id. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param integrationId The Integration ID of the Advocate's Profile. -@return apiGetApplicationCustomerFriendsRequest + * @param attributeId +@return apiGetAttributeRequest */ -func (a *ManagementApiService) GetApplicationCustomerFriends(ctx _context.Context, applicationId int32, integrationId string) apiGetApplicationCustomerFriendsRequest { - return apiGetApplicationCustomerFriendsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - integrationId: integrationId, +func (a *ManagementApiService) GetAttribute(ctx _context.Context, attributeId int32) apiGetAttributeRequest { + return apiGetAttributeRequest{ + apiService: a, + ctx: ctx, + attributeId: attributeId, } } /* Execute executes the request - @return InlineResponse20019 + @return Attribute */ -func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20019, *_nethttp.Response, error) { +func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20019 + localVarReturnValue Attribute ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomerFriends") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttribute") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/profile/{integrationId}/friends" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + localVarPath := localBasePath + "/v1/attributes/{attributeId}" + localVarPath = strings.Replace(localVarPath, "{"+"attributeId"+"}", _neturl.QueryEscape(parameterToString(r.attributeId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.withTotalResultSize != nil { - localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4651,7 +7254,7 @@ func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20019, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20019 + var v Attribute err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4670,92 +7273,89 @@ func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20019, } return localVarReturnValue, localVarHTTPResponse, newErr } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type apiGetApplicationCustomersRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - integrationId *string - pageSize *int32 - skip *int32 - withTotalResultSize *bool + + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiGetApplicationCustomersRequest) IntegrationId(integrationId string) apiGetApplicationCustomersRequest { - r.integrationId = &integrationId - return r +type apiGetAttributesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + entity *string } -func (r apiGetApplicationCustomersRequest) PageSize(pageSize int32) apiGetApplicationCustomersRequest { +func (r apiGetAttributesRequest) PageSize(pageSize int32) apiGetAttributesRequest { r.pageSize = &pageSize return r } -func (r apiGetApplicationCustomersRequest) Skip(skip int32) apiGetApplicationCustomersRequest { +func (r apiGetAttributesRequest) Skip(skip int32) apiGetAttributesRequest { r.skip = &skip return r } -func (r apiGetApplicationCustomersRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersRequest { - r.withTotalResultSize = &withTotalResultSize +func (r apiGetAttributesRequest) Sort(sort string) apiGetAttributesRequest { + r.sort = &sort + return r +} + +func (r apiGetAttributesRequest) Entity(entity string) apiGetAttributesRequest { + r.entity = &entity return r } /* -GetApplicationCustomers List application's customers -List all the customers of the specified application. +GetAttributes List custom attributes +Returns all the defined custom attributes for the account. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationCustomersRequest +@return apiGetAttributesRequest */ -func (a *ManagementApiService) GetApplicationCustomers(ctx _context.Context, applicationId int32) apiGetApplicationCustomersRequest { - return apiGetApplicationCustomersRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetAttributes(ctx _context.Context) apiGetAttributesRequest { + return apiGetAttributesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse20011 + @return InlineResponse20024 */ -func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { +func (r apiGetAttributesRequest) Execute() (InlineResponse20024, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20011 + localVarReturnValue InlineResponse20024 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomers") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttributes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/customers" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/attributes" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.integrationId != nil { - localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) - } if r.pageSize != nil { localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - if r.withTotalResultSize != nil { - localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.entity != nil { + localVarQueryParams.Add("entity", parameterToString(*r.entity, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4810,7 +7410,7 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20011, *_net error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20011 + var v InlineResponse20024 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4833,95 +7433,88 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20011, *_net return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationCustomersByAttributesRequest struct { +type apiGetAudiencesRequest struct { ctx _context.Context apiService *ManagementApiService - applicationId int32 - body *CustomerProfileSearchQuery pageSize *int32 skip *int32 + sort *string withTotalResultSize *bool } -func (r apiGetApplicationCustomersByAttributesRequest) Body(body CustomerProfileSearchQuery) apiGetApplicationCustomersByAttributesRequest { - r.body = &body +func (r apiGetAudiencesRequest) PageSize(pageSize int32) apiGetAudiencesRequest { + r.pageSize = &pageSize return r } -func (r apiGetApplicationCustomersByAttributesRequest) PageSize(pageSize int32) apiGetApplicationCustomersByAttributesRequest { - r.pageSize = &pageSize +func (r apiGetAudiencesRequest) Skip(skip int32) apiGetAudiencesRequest { + r.skip = &skip return r } -func (r apiGetApplicationCustomersByAttributesRequest) Skip(skip int32) apiGetApplicationCustomersByAttributesRequest { - r.skip = &skip +func (r apiGetAudiencesRequest) Sort(sort string) apiGetAudiencesRequest { + r.sort = &sort return r } -func (r apiGetApplicationCustomersByAttributesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersByAttributesRequest { +func (r apiGetAudiencesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetAudiencesRequest { r.withTotalResultSize = &withTotalResultSize return r } /* -GetApplicationCustomersByAttributes List application customers matching the given attributes -Get a list of the application customers matching the provided criteria. - -The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. +GetAudiences List audiences +Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2). * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationCustomersByAttributesRequest +@return apiGetAudiencesRequest */ -func (a *ManagementApiService) GetApplicationCustomersByAttributes(ctx _context.Context, applicationId int32) apiGetApplicationCustomersByAttributesRequest { - return apiGetApplicationCustomersByAttributesRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetAudiences(ctx _context.Context) apiGetAudiencesRequest { + return apiGetAudiencesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse20012 + @return InlineResponse20022 */ -func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { +func (r apiGetAudiencesRequest) Execute() (InlineResponse20022, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20012 + localVarReturnValue InlineResponse20022 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomersByAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAudiences") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_search" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/audiences" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.body == nil { - return localVarReturnValue, nil, reportError("body is required and must be specified") - } - if r.pageSize != nil { localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } if r.withTotalResultSize != nil { localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -4937,8 +7530,6 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -4975,7 +7566,7 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20012 + var v InlineResponse20022 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4998,83 +7589,57 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationEventTypesRequest struct { +type apiGetCampaignRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - pageSize *int32 - skip *int32 - sort *string -} - -func (r apiGetApplicationEventTypesRequest) PageSize(pageSize int32) apiGetApplicationEventTypesRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetApplicationEventTypesRequest) Skip(skip int32) apiGetApplicationEventTypesRequest { - r.skip = &skip - return r -} - -func (r apiGetApplicationEventTypesRequest) Sort(sort string) apiGetApplicationEventTypesRequest { - r.sort = &sort - return r + campaignId int32 } /* -GetApplicationEventTypes List Applications event types -Get all of the distinct values of the Event `type` property for events recorded in the application. - -See also: [Track an event](/integration-api/#operation/trackEvent) - +GetCampaign Get campaign +Retrieve the given campaign. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationEventTypesRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiGetCampaignRequest */ -func (a *ManagementApiService) GetApplicationEventTypes(ctx _context.Context, applicationId int32) apiGetApplicationEventTypesRequest { - return apiGetApplicationEventTypesRequest{ +func (a *ManagementApiService) GetCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiGetCampaignRequest { + return apiGetCampaignRequest{ apiService: a, ctx: ctx, applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse20017 + @return Campaign */ -func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { +func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20017 + localVarReturnValue Campaign ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventTypes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaign") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/event_types" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -5128,7 +7693,7 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20017, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20017 + var v Campaign err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5151,179 +7716,87 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20017, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationEventsWithoutTotalCountRequest struct { +type apiGetCampaignAnalyticsRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - pageSize *int32 - skip *int32 - sort *string - type_ *string - createdBefore *time.Time - createdAfter *time.Time - session *string - profile *string - customerName *string - customerEmail *string - couponCode *string - referralCode *string - ruleQuery *string - campaignQuery *string -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetApplicationEventsWithoutTotalCountRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) Skip(skip int32) apiGetApplicationEventsWithoutTotalCountRequest { - r.skip = &skip - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) Sort(sort string) apiGetApplicationEventsWithoutTotalCountRequest { - r.sort = &sort - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) Type_(type_ string) apiGetApplicationEventsWithoutTotalCountRequest { - r.type_ = &type_ - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationEventsWithoutTotalCountRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationEventsWithoutTotalCountRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) Session(session string) apiGetApplicationEventsWithoutTotalCountRequest { - r.session = &session - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) Profile(profile string) apiGetApplicationEventsWithoutTotalCountRequest { - r.profile = &profile - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) CustomerName(customerName string) apiGetApplicationEventsWithoutTotalCountRequest { - r.customerName = &customerName - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) CustomerEmail(customerEmail string) apiGetApplicationEventsWithoutTotalCountRequest { - r.customerEmail = &customerEmail - return r -} - -func (r apiGetApplicationEventsWithoutTotalCountRequest) CouponCode(couponCode string) apiGetApplicationEventsWithoutTotalCountRequest { - r.couponCode = &couponCode - return r + campaignId int32 + rangeStart *time.Time + rangeEnd *time.Time + granularity *string } -func (r apiGetApplicationEventsWithoutTotalCountRequest) ReferralCode(referralCode string) apiGetApplicationEventsWithoutTotalCountRequest { - r.referralCode = &referralCode +func (r apiGetCampaignAnalyticsRequest) RangeStart(rangeStart time.Time) apiGetCampaignAnalyticsRequest { + r.rangeStart = &rangeStart return r } -func (r apiGetApplicationEventsWithoutTotalCountRequest) RuleQuery(ruleQuery string) apiGetApplicationEventsWithoutTotalCountRequest { - r.ruleQuery = &ruleQuery +func (r apiGetCampaignAnalyticsRequest) RangeEnd(rangeEnd time.Time) apiGetCampaignAnalyticsRequest { + r.rangeEnd = &rangeEnd return r } -func (r apiGetApplicationEventsWithoutTotalCountRequest) CampaignQuery(campaignQuery string) apiGetApplicationEventsWithoutTotalCountRequest { - r.campaignQuery = &campaignQuery +func (r apiGetCampaignAnalyticsRequest) Granularity(granularity string) apiGetCampaignAnalyticsRequest { + r.granularity = &granularity return r } /* -GetApplicationEventsWithoutTotalCount List Applications events -Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results. - +GetCampaignAnalytics Get analytics of campaigns +Retrieve statistical data about the performance of the given campaign. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationEventsWithoutTotalCountRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiGetCampaignAnalyticsRequest */ -func (a *ManagementApiService) GetApplicationEventsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetApplicationEventsWithoutTotalCountRequest { - return apiGetApplicationEventsWithoutTotalCountRequest{ +func (a *ManagementApiService) GetCampaignAnalytics(ctx _context.Context, applicationId int32, campaignId int32) apiGetCampaignAnalyticsRequest { + return apiGetCampaignAnalyticsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse20016 + @return InlineResponse20014 */ -func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineResponse20016, *_nethttp.Response, error) { +func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20014, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20016 + localVarReturnValue InlineResponse20014 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignAnalytics") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/events/no_total" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/analytics" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.type_ != nil { - localVarQueryParams.Add("type", parameterToString(*r.type_, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.session != nil { - localVarQueryParams.Add("session", parameterToString(*r.session, "")) - } - if r.profile != nil { - localVarQueryParams.Add("profile", parameterToString(*r.profile, "")) - } - if r.customerName != nil { - localVarQueryParams.Add("customerName", parameterToString(*r.customerName, "")) - } - if r.customerEmail != nil { - localVarQueryParams.Add("customerEmail", parameterToString(*r.customerEmail, "")) - } - if r.couponCode != nil { - localVarQueryParams.Add("couponCode", parameterToString(*r.couponCode, "")) - } - if r.referralCode != nil { - localVarQueryParams.Add("referralCode", parameterToString(*r.referralCode, "")) + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") } - if r.ruleQuery != nil { - localVarQueryParams.Add("ruleQuery", parameterToString(*r.ruleQuery, "")) + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") } - if r.campaignQuery != nil { - localVarQueryParams.Add("campaignQuery", parameterToString(*r.campaignQuery, "")) + + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.granularity != nil { + localVarQueryParams.Add("granularity", parameterToString(*r.granularity, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -5378,7 +7851,7 @@ func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineRespon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20016 + var v InlineResponse20014 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5401,61 +7874,102 @@ func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineRespon return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationSessionRequest struct { +type apiGetCampaignByAttributesRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - sessionId int32 + body *CampaignSearch + pageSize *int32 + skip *int32 + sort *string + campaignState *string +} + +func (r apiGetCampaignByAttributesRequest) Body(body CampaignSearch) apiGetCampaignByAttributesRequest { + r.body = &body + return r +} + +func (r apiGetCampaignByAttributesRequest) PageSize(pageSize int32) apiGetCampaignByAttributesRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetCampaignByAttributesRequest) Skip(skip int32) apiGetCampaignByAttributesRequest { + r.skip = &skip + return r +} + +func (r apiGetCampaignByAttributesRequest) Sort(sort string) apiGetCampaignByAttributesRequest { + r.sort = &sort + return r +} + +func (r apiGetCampaignByAttributesRequest) CampaignState(campaignState string) apiGetCampaignByAttributesRequest { + r.campaignState = &campaignState + return r } /* -GetApplicationSession Get Application session -Get the details of the given session. -You can list the sessions with the [List application sessions](#operation/getApplicationSessions) endpoint. +GetCampaignByAttributes List campaigns that match the given attributes +Get a list of all the campaigns that match a set of attributes. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param sessionId -@return apiGetApplicationSessionRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetCampaignByAttributesRequest */ -func (a *ManagementApiService) GetApplicationSession(ctx _context.Context, applicationId int32, sessionId int32) apiGetApplicationSessionRequest { - return apiGetApplicationSessionRequest{ +func (a *ManagementApiService) GetCampaignByAttributes(ctx _context.Context, applicationId int32) apiGetCampaignByAttributesRequest { + return apiGetCampaignByAttributesRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - sessionId: sessionId, } } /* Execute executes the request - @return ApplicationSession + @return InlineResponse2002 */ -func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethttp.Response, error) { +func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue ApplicationSession + localVarReturnValue InlineResponse2002 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSession") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignByAttributes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/sessions/{sessionId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns_search" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"sessionId"+"}", _neturl.QueryEscape(parameterToString(r.sessionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.campaignState != nil { + localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) + } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"application/json"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -5471,6 +7985,8 @@ func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethtt if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + // body params + localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -5507,7 +8023,7 @@ func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethtt error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v ApplicationSession + var v InlineResponse2002 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5530,82 +8046,82 @@ func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethtt return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationSessionsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - pageSize *int32 - skip *int32 - sort *string - profile *string - state *string - createdBefore *time.Time - createdAfter *time.Time - coupon *string - referral *string - integrationId *string +type apiGetCampaignsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + pageSize *int32 + skip *int32 + sort *string + campaignState *string + name *string + tags *string + createdBefore *time.Time + createdAfter *time.Time + campaignGroupId *int32 + templateId *int32 } -func (r apiGetApplicationSessionsRequest) PageSize(pageSize int32) apiGetApplicationSessionsRequest { +func (r apiGetCampaignsRequest) PageSize(pageSize int32) apiGetCampaignsRequest { r.pageSize = &pageSize return r } -func (r apiGetApplicationSessionsRequest) Skip(skip int32) apiGetApplicationSessionsRequest { +func (r apiGetCampaignsRequest) Skip(skip int32) apiGetCampaignsRequest { r.skip = &skip return r } -func (r apiGetApplicationSessionsRequest) Sort(sort string) apiGetApplicationSessionsRequest { +func (r apiGetCampaignsRequest) Sort(sort string) apiGetCampaignsRequest { r.sort = &sort return r } -func (r apiGetApplicationSessionsRequest) Profile(profile string) apiGetApplicationSessionsRequest { - r.profile = &profile +func (r apiGetCampaignsRequest) CampaignState(campaignState string) apiGetCampaignsRequest { + r.campaignState = &campaignState return r } -func (r apiGetApplicationSessionsRequest) State(state string) apiGetApplicationSessionsRequest { - r.state = &state +func (r apiGetCampaignsRequest) Name(name string) apiGetCampaignsRequest { + r.name = &name return r } -func (r apiGetApplicationSessionsRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationSessionsRequest { - r.createdBefore = &createdBefore +func (r apiGetCampaignsRequest) Tags(tags string) apiGetCampaignsRequest { + r.tags = &tags return r } -func (r apiGetApplicationSessionsRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationSessionsRequest { - r.createdAfter = &createdAfter +func (r apiGetCampaignsRequest) CreatedBefore(createdBefore time.Time) apiGetCampaignsRequest { + r.createdBefore = &createdBefore return r } -func (r apiGetApplicationSessionsRequest) Coupon(coupon string) apiGetApplicationSessionsRequest { - r.coupon = &coupon +func (r apiGetCampaignsRequest) CreatedAfter(createdAfter time.Time) apiGetCampaignsRequest { + r.createdAfter = &createdAfter return r } -func (r apiGetApplicationSessionsRequest) Referral(referral string) apiGetApplicationSessionsRequest { - r.referral = &referral +func (r apiGetCampaignsRequest) CampaignGroupId(campaignGroupId int32) apiGetCampaignsRequest { + r.campaignGroupId = &campaignGroupId return r } -func (r apiGetApplicationSessionsRequest) IntegrationId(integrationId string) apiGetApplicationSessionsRequest { - r.integrationId = &integrationId +func (r apiGetCampaignsRequest) TemplateId(templateId int32) apiGetCampaignsRequest { + r.templateId = &templateId return r } /* -GetApplicationSessions List Application sessions -List all the sessions of the specified Application. +GetCampaigns List campaigns +List the campaigns of the specified application that match your filter criteria. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetApplicationSessionsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetCampaignsRequest */ -func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, applicationId int32) apiGetApplicationSessionsRequest { - return apiGetApplicationSessionsRequest{ +func (a *ManagementApiService) GetCampaigns(ctx _context.Context, applicationId int32) apiGetCampaignsRequest { + return apiGetCampaignsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -5614,24 +8130,24 @@ func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, appl /* Execute executes the request - @return InlineResponse20015 + @return InlineResponse2002 */ -func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20015, *_nethttp.Response, error) { +func (r apiGetCampaignsRequest) Execute() (InlineResponse2002, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20015 + localVarReturnValue InlineResponse2002 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSessions") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaigns") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/sessions" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) @@ -5647,11 +8163,14 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20015, *_neth if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.profile != nil { - localVarQueryParams.Add("profile", parameterToString(*r.profile, "")) + if r.campaignState != nil { + localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) } - if r.state != nil { - localVarQueryParams.Add("state", parameterToString(*r.state, "")) + if r.name != nil { + localVarQueryParams.Add("name", parameterToString(*r.name, "")) + } + if r.tags != nil { + localVarQueryParams.Add("tags", parameterToString(*r.tags, "")) } if r.createdBefore != nil { localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) @@ -5659,14 +8178,11 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20015, *_neth if r.createdAfter != nil { localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) } - if r.coupon != nil { - localVarQueryParams.Add("coupon", parameterToString(*r.coupon, "")) - } - if r.referral != nil { - localVarQueryParams.Add("referral", parameterToString(*r.referral, "")) + if r.campaignGroupId != nil { + localVarQueryParams.Add("campaignGroupId", parameterToString(*r.campaignGroupId, "")) } - if r.integrationId != nil { - localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) + if r.templateId != nil { + localVarQueryParams.Add("templateId", parameterToString(*r.templateId, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -5721,7 +8237,17 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20015, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20015 + var v InlineResponse2002 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5744,37 +8270,80 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20015, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationsRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string +type apiGetChangesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + applicationId *float32 + entityPath *string + userId *int32 + createdBefore *time.Time + createdAfter *time.Time + withTotalResultSize *bool + includeOld *bool } -func (r apiGetApplicationsRequest) PageSize(pageSize int32) apiGetApplicationsRequest { +func (r apiGetChangesRequest) PageSize(pageSize int32) apiGetChangesRequest { r.pageSize = &pageSize return r } -func (r apiGetApplicationsRequest) Skip(skip int32) apiGetApplicationsRequest { +func (r apiGetChangesRequest) Skip(skip int32) apiGetChangesRequest { r.skip = &skip return r } -func (r apiGetApplicationsRequest) Sort(sort string) apiGetApplicationsRequest { +func (r apiGetChangesRequest) Sort(sort string) apiGetChangesRequest { r.sort = &sort return r } +func (r apiGetChangesRequest) ApplicationId(applicationId float32) apiGetChangesRequest { + r.applicationId = &applicationId + return r +} + +func (r apiGetChangesRequest) EntityPath(entityPath string) apiGetChangesRequest { + r.entityPath = &entityPath + return r +} + +func (r apiGetChangesRequest) UserId(userId int32) apiGetChangesRequest { + r.userId = &userId + return r +} + +func (r apiGetChangesRequest) CreatedBefore(createdBefore time.Time) apiGetChangesRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetChangesRequest) CreatedAfter(createdAfter time.Time) apiGetChangesRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiGetChangesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetChangesRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} + +func (r apiGetChangesRequest) IncludeOld(includeOld bool) apiGetChangesRequest { + r.includeOld = &includeOld + return r +} + /* -GetApplications List Applications -List all application in the current account. +GetChanges Get audit logs for an account +Export the audit logs displayed in **Accounts > Audit logs**. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetApplicationsRequest +@return apiGetChangesRequest */ -func (a *ManagementApiService) GetApplications(ctx _context.Context) apiGetApplicationsRequest { - return apiGetApplicationsRequest{ +func (a *ManagementApiService) GetChanges(ctx _context.Context) apiGetChangesRequest { + return apiGetChangesRequest{ apiService: a, ctx: ctx, } @@ -5782,24 +8351,24 @@ func (a *ManagementApiService) GetApplications(ctx _context.Context) apiGetAppli /* Execute executes the request - @return InlineResponse2001 + @return InlineResponse20031 */ -func (r apiGetApplicationsRequest) Execute() (InlineResponse2001, *_nethttp.Response, error) { +func (r apiGetChangesRequest) Execute() (InlineResponse20031, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2001 + localVarReturnValue InlineResponse20031 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplications") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetChanges") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications" + localVarPath := localBasePath + "/v1/changes" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5814,6 +8383,27 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2001, *_nethttp.Resp if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } + if r.applicationId != nil { + localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) + } + if r.entityPath != nil { + localVarQueryParams.Add("entityPath", parameterToString(*r.entityPath, "")) + } + if r.userId != nil { + localVarQueryParams.Add("userId", parameterToString(*r.userId, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } + if r.includeOld != nil { + localVarQueryParams.Add("includeOld", parameterToString(*r.includeOld, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -5867,7 +8457,7 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2001, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2001 + var v InlineResponse20031 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5890,49 +8480,56 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2001, *_nethttp.Resp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAttributeRequest struct { - ctx _context.Context - apiService *ManagementApiService - attributeId int32 +type apiGetCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 } /* -GetAttribute Get a custom attribute -Returns custom attribute for the account by its id. - +GetCollection Get collection +Retrieve a given collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param attributeId -@return apiGetAttributeRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiGetCollectionRequest */ -func (a *ManagementApiService) GetAttribute(ctx _context.Context, attributeId int32) apiGetAttributeRequest { - return apiGetAttributeRequest{ - apiService: a, - ctx: ctx, - attributeId: attributeId, +func (a *ManagementApiService) GetCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiGetCollectionRequest { + return apiGetCollectionRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + collectionId: collectionId, } } /* Execute executes the request - @return Attribute + @return Collection */ -func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) { +func (r apiGetCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Attribute + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttribute") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/attributes/{attributeId}" - localVarPath = strings.Replace(localVarPath, "{"+"attributeId"+"}", _neturl.QueryEscape(parameterToString(r.attributeId, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5991,7 +8588,17 @@ func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Attribute + var v Collection + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6014,69 +8621,60 @@ func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAttributesRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string - entity *string +type apiGetCollectionItemsRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 + pageSize *int32 + skip *int32 } -func (r apiGetAttributesRequest) PageSize(pageSize int32) apiGetAttributesRequest { +func (r apiGetCollectionItemsRequest) PageSize(pageSize int32) apiGetCollectionItemsRequest { r.pageSize = &pageSize return r } -func (r apiGetAttributesRequest) Skip(skip int32) apiGetAttributesRequest { +func (r apiGetCollectionItemsRequest) Skip(skip int32) apiGetCollectionItemsRequest { r.skip = &skip return r } -func (r apiGetAttributesRequest) Sort(sort string) apiGetAttributesRequest { - r.sort = &sort - return r -} - -func (r apiGetAttributesRequest) Entity(entity string) apiGetAttributesRequest { - r.entity = &entity - return r -} - /* -GetAttributes List custom attributes -Returns all the defined custom attributes for the account. - +GetCollectionItems Get collection items +Retrieve the items from the given collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetAttributesRequest + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiGetCollectionItemsRequest */ -func (a *ManagementApiService) GetAttributes(ctx _context.Context) apiGetAttributesRequest { - return apiGetAttributesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetCollectionItems(ctx _context.Context, collectionId int32) apiGetCollectionItemsRequest { + return apiGetCollectionItemsRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, } } /* Execute executes the request - @return InlineResponse20020 + @return InlineResponse20010 */ -func (r apiGetAttributesRequest) Execute() (InlineResponse20020, *_nethttp.Response, error) { +func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20010, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20020 + localVarReturnValue InlineResponse20010 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCollectionItems") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/attributes" + localVarPath := localBasePath + "/v1/collections/{collectionId}/items" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -6088,12 +8686,6 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20020, *_nethttp.Respo if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.entity != nil { - localVarQueryParams.Add("entity", parameterToString(*r.entity, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6147,92 +8739,158 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20020, *_nethttp.Respo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20020 + var v InlineResponse20010 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), } return localVarReturnValue, localVarHTTPResponse, newErr } - err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiGetCouponsWithoutTotalCountRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + pageSize *int32 + skip *int32 + sort *string + value *string + createdBefore *time.Time + createdAfter *time.Time + valid *string + usable *string + referralId *int32 + recipientIntegrationId *string + batchId *string + exactMatch *bool +} + +func (r apiGetCouponsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCouponsWithoutTotalCountRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) Skip(skip int32) apiGetCouponsWithoutTotalCountRequest { + r.skip = &skip + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) Sort(sort string) apiGetCouponsWithoutTotalCountRequest { + r.sort = &sort + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) Value(value string) apiGetCouponsWithoutTotalCountRequest { + r.value = &value + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetCouponsWithoutTotalCountRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetCouponsWithoutTotalCountRequest { + r.createdAfter = &createdAfter + return r +} - return localVarReturnValue, localVarHTTPResponse, nil +func (r apiGetCouponsWithoutTotalCountRequest) Valid(valid string) apiGetCouponsWithoutTotalCountRequest { + r.valid = &valid + return r } -type apiGetAudiencesRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string - withTotalResultSize *bool +func (r apiGetCouponsWithoutTotalCountRequest) Usable(usable string) apiGetCouponsWithoutTotalCountRequest { + r.usable = &usable + return r } -func (r apiGetAudiencesRequest) PageSize(pageSize int32) apiGetAudiencesRequest { - r.pageSize = &pageSize +func (r apiGetCouponsWithoutTotalCountRequest) ReferralId(referralId int32) apiGetCouponsWithoutTotalCountRequest { + r.referralId = &referralId return r } -func (r apiGetAudiencesRequest) Skip(skip int32) apiGetAudiencesRequest { - r.skip = &skip +func (r apiGetCouponsWithoutTotalCountRequest) RecipientIntegrationId(recipientIntegrationId string) apiGetCouponsWithoutTotalCountRequest { + r.recipientIntegrationId = &recipientIntegrationId return r } -func (r apiGetAudiencesRequest) Sort(sort string) apiGetAudiencesRequest { - r.sort = &sort +func (r apiGetCouponsWithoutTotalCountRequest) BatchId(batchId string) apiGetCouponsWithoutTotalCountRequest { + r.batchId = &batchId return r } -func (r apiGetAudiencesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetAudiencesRequest { - r.withTotalResultSize = &withTotalResultSize +func (r apiGetCouponsWithoutTotalCountRequest) ExactMatch(exactMatch bool) apiGetCouponsWithoutTotalCountRequest { + r.exactMatch = &exactMatch return r } /* -GetAudiences List audiences -Get All audiences created in the account. +GetCouponsWithoutTotalCount List coupons +List all the coupons matching the specified criteria. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetAudiencesRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiGetCouponsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetAudiences(ctx _context.Context) apiGetAudiencesRequest { - return apiGetAudiencesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetCouponsWithoutTotalCount(ctx _context.Context, applicationId int32, campaignId int32) apiGetCouponsWithoutTotalCountRequest { + return apiGetCouponsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse20018 + @return InlineResponse2006 */ -func (r apiGetAudiencesRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { +func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20018 + localVarReturnValue InlineResponse2006 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAudiences") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCouponsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/audiences" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -6247,8 +8905,32 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20018, *_nethttp.Respon if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.withTotalResultSize != nil { - localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + if r.value != nil { + localVarQueryParams.Add("value", parameterToString(*r.value, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + } + if r.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + } + if r.referralId != nil { + localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) + } + if r.recipientIntegrationId != nil { + localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) + } + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + } + if r.exactMatch != nil { + localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6303,7 +8985,7 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20018, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20018 + var v InlineResponse2006 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6326,57 +9008,97 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20018, *_nethttp.Respon return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignRequest struct { +type apiGetCustomerActivityReportRequest struct { ctx _context.Context apiService *ManagementApiService + rangeStart *time.Time + rangeEnd *time.Time applicationId int32 - campaignId int32 + customerId int32 + pageSize *int32 + skip *int32 +} + +func (r apiGetCustomerActivityReportRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportRequest { + r.rangeStart = &rangeStart + return r +} + +func (r apiGetCustomerActivityReportRequest) RangeEnd(rangeEnd time.Time) apiGetCustomerActivityReportRequest { + r.rangeEnd = &rangeEnd + return r +} + +func (r apiGetCustomerActivityReportRequest) PageSize(pageSize int32) apiGetCustomerActivityReportRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetCustomerActivityReportRequest) Skip(skip int32) apiGetCustomerActivityReportRequest { + r.skip = &skip + return r } /* -GetCampaign Get campaign -Retrieve the given campaign. +GetCustomerActivityReport Get customer's activity report +Fetch the summary report of a given customer in the given application, in a time range. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiGetCampaignRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. +@return apiGetCustomerActivityReportRequest */ -func (a *ManagementApiService) GetCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiGetCampaignRequest { - return apiGetCampaignRequest{ +func (a *ManagementApiService) GetCustomerActivityReport(ctx _context.Context, applicationId int32, customerId int32) apiGetCustomerActivityReportRequest { + return apiGetCustomerActivityReportRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, + customerId: customerId, } } /* Execute executes the request - @return Campaign + @return CustomerActivityReport */ -func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { +func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Campaign + localVarReturnValue CustomerActivityReport ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaign") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReport") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_activity_reports/{customerId}" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") + } + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") + } + + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6430,7 +9152,7 @@ func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Campaign + var v CustomerActivityReport err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6453,70 +9175,104 @@ func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignAnalyticsRequest struct { +type apiGetCustomerActivityReportsWithoutTotalCountRequest struct { ctx _context.Context apiService *ManagementApiService - applicationId int32 - campaignId int32 rangeStart *time.Time rangeEnd *time.Time - granularity *string + applicationId int32 + pageSize *int32 + skip *int32 + sort *string + name *string + integrationId *string + campaignName *string + advocateName *string } -func (r apiGetCampaignAnalyticsRequest) RangeStart(rangeStart time.Time) apiGetCampaignAnalyticsRequest { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportsWithoutTotalCountRequest { r.rangeStart = &rangeStart return r } -func (r apiGetCampaignAnalyticsRequest) RangeEnd(rangeEnd time.Time) apiGetCampaignAnalyticsRequest { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) RangeEnd(rangeEnd time.Time) apiGetCustomerActivityReportsWithoutTotalCountRequest { r.rangeEnd = &rangeEnd return r } -func (r apiGetCampaignAnalyticsRequest) Granularity(granularity string) apiGetCampaignAnalyticsRequest { - r.granularity = &granularity +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Skip(skip int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.skip = &skip + return r +} + +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Sort(sort string) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.sort = &sort + return r +} + +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Name(name string) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.name = &name + return r +} + +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) IntegrationId(integrationId string) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.integrationId = &integrationId + return r +} + +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) CampaignName(campaignName string) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.campaignName = &campaignName + return r +} + +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) AdvocateName(advocateName string) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.advocateName = &advocateName return r } /* -GetCampaignAnalytics Get analytics of campaigns -Retrieve statistical data about the performance of the given campaign. +GetCustomerActivityReportsWithoutTotalCount Get Activity Reports for Application Customers +Fetch summary reports for all application customers based on a time range. Instead of having the total number of results +in the response, this endpoint only mentions whether there are more results. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiGetCampaignAnalyticsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetCustomerActivityReportsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetCampaignAnalytics(ctx _context.Context, applicationId int32, campaignId int32) apiGetCampaignAnalyticsRequest { - return apiGetCampaignAnalyticsRequest{ +func (a *ManagementApiService) GetCustomerActivityReportsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { + return apiGetCustomerActivityReportsWithoutTotalCountRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse20010 + @return InlineResponse20018 */ -func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20010, *_nethttp.Response, error) { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20010 + localVarReturnValue InlineResponse20018 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignAnalytics") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReportsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/analytics" + localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_activity_reports/no_total" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -6529,11 +9285,29 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20010, *_nethtt if r.rangeEnd == nil { return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") } - - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.granularity != nil { - localVarQueryParams.Add("granularity", parameterToString(*r.granularity, "")) + + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.name != nil { + localVarQueryParams.Add("name", parameterToString(*r.name, "")) + } + if r.integrationId != nil { + localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) + } + if r.campaignName != nil { + localVarQueryParams.Add("campaignName", parameterToString(*r.campaignName, "")) + } + if r.advocateName != nil { + localVarQueryParams.Add("advocateName", parameterToString(*r.advocateName, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6588,7 +9362,7 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20010, *_nethtt error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20010 + var v InlineResponse20018 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6611,88 +9385,75 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20010, *_nethtt return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignByAttributesRequest struct { +type apiGetCustomerAnalyticsRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - body *CampaignSearch + customerId int32 pageSize *int32 skip *int32 sort *string - campaignState *string -} - -func (r apiGetCampaignByAttributesRequest) Body(body CampaignSearch) apiGetCampaignByAttributesRequest { - r.body = &body - return r } -func (r apiGetCampaignByAttributesRequest) PageSize(pageSize int32) apiGetCampaignByAttributesRequest { +func (r apiGetCustomerAnalyticsRequest) PageSize(pageSize int32) apiGetCustomerAnalyticsRequest { r.pageSize = &pageSize return r } -func (r apiGetCampaignByAttributesRequest) Skip(skip int32) apiGetCampaignByAttributesRequest { +func (r apiGetCustomerAnalyticsRequest) Skip(skip int32) apiGetCustomerAnalyticsRequest { r.skip = &skip return r } -func (r apiGetCampaignByAttributesRequest) Sort(sort string) apiGetCampaignByAttributesRequest { +func (r apiGetCustomerAnalyticsRequest) Sort(sort string) apiGetCustomerAnalyticsRequest { r.sort = &sort return r } -func (r apiGetCampaignByAttributesRequest) CampaignState(campaignState string) apiGetCampaignByAttributesRequest { - r.campaignState = &campaignState - return r -} - /* -GetCampaignByAttributes List campaigns that match the given attributes -Get a list of all the campaigns that match a set of attributes. - +GetCustomerAnalytics Get customer's analytics report +Fetch analytics for a given customer in the given application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetCampaignByAttributesRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. +@return apiGetCustomerAnalyticsRequest */ -func (a *ManagementApiService) GetCampaignByAttributes(ctx _context.Context, applicationId int32) apiGetCampaignByAttributesRequest { - return apiGetCampaignByAttributesRequest{ +func (a *ManagementApiService) GetCustomerAnalytics(ctx _context.Context, applicationId int32, customerId int32) apiGetCustomerAnalyticsRequest { + return apiGetCustomerAnalyticsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, + customerId: customerId, } } /* Execute executes the request - @return InlineResponse2002 + @return CustomerAnalytics */ -func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_nethttp.Response, error) { +func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2002 + localVarReturnValue CustomerAnalytics ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignByAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerAnalytics") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns_search" + localVarPath := localBasePath + "/v1/applications/{applicationId}/customers/{customerId}/analytics" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.body == nil { - return localVarReturnValue, nil, reportError("body is required and must be specified") - } - if r.pageSize != nil { localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } @@ -6702,11 +9463,8 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_neth if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.campaignState != nil { - localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) - } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -6722,8 +9480,6 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_neth if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -6760,7 +9516,7 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2002 + var v CustomerAnalytics err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6783,144 +9539,64 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - pageSize *int32 - skip *int32 - sort *string - campaignState *string - name *string - tags *string - createdBefore *time.Time - createdAfter *time.Time - campaignGroupId *int32 - templateId *int32 -} - -func (r apiGetCampaignsRequest) PageSize(pageSize int32) apiGetCampaignsRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetCampaignsRequest) Skip(skip int32) apiGetCampaignsRequest { - r.skip = &skip - return r -} - -func (r apiGetCampaignsRequest) Sort(sort string) apiGetCampaignsRequest { - r.sort = &sort - return r -} - -func (r apiGetCampaignsRequest) CampaignState(campaignState string) apiGetCampaignsRequest { - r.campaignState = &campaignState - return r -} - -func (r apiGetCampaignsRequest) Name(name string) apiGetCampaignsRequest { - r.name = &name - return r -} - -func (r apiGetCampaignsRequest) Tags(tags string) apiGetCampaignsRequest { - r.tags = &tags - return r -} - -func (r apiGetCampaignsRequest) CreatedBefore(createdBefore time.Time) apiGetCampaignsRequest { - r.createdBefore = &createdBefore - return r +type apiGetCustomerProfileRequest struct { + ctx _context.Context + apiService *ManagementApiService + customerId int32 } -func (r apiGetCampaignsRequest) CreatedAfter(createdAfter time.Time) apiGetCampaignsRequest { - r.createdAfter = &createdAfter - return r -} +/* +GetCustomerProfile Get customer profile +Return the details of the specified customer profile. -func (r apiGetCampaignsRequest) CampaignGroupId(campaignGroupId int32) apiGetCampaignsRequest { - r.campaignGroupId = &campaignGroupId - return r -} +
+

Performance tips

-func (r apiGetCampaignsRequest) TemplateId(templateId int32) apiGetCampaignsRequest { - r.templateId = &templateId - return r -} + You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: -/* -GetCampaigns List campaigns -List the campaigns of the specified application that match your filter criteria. + - Request the customer profile to be part of the response content using + [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). + - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. +
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetCampaignsRequest + * @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. +@return apiGetCustomerProfileRequest */ -func (a *ManagementApiService) GetCampaigns(ctx _context.Context, applicationId int32) apiGetCampaignsRequest { - return apiGetCampaignsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetCustomerProfile(ctx _context.Context, customerId int32) apiGetCustomerProfileRequest { + return apiGetCustomerProfileRequest{ + apiService: a, + ctx: ctx, + customerId: customerId, } } /* Execute executes the request - @return InlineResponse2002 + @return CustomerProfile */ -func (r apiGetCampaignsRequest) Execute() (InlineResponse2002, *_nethttp.Response, error) { +func (r apiGetCustomerProfileRequest) Execute() (CustomerProfile, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2002 + localVarReturnValue CustomerProfile ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaigns") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfile") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/customers/{customerId}" + localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.campaignState != nil { - localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) - } - if r.name != nil { - localVarQueryParams.Add("name", parameterToString(*r.name, "")) - } - if r.tags != nil { - localVarQueryParams.Add("tags", parameterToString(*r.tags, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.campaignGroupId != nil { - localVarQueryParams.Add("campaignGroupId", parameterToString(*r.campaignGroupId, "")) - } - if r.templateId != nil { - localVarQueryParams.Add("templateId", parameterToString(*r.templateId, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6974,7 +9650,7 @@ func (r apiGetCampaignsRequest) Execute() (InlineResponse2002, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2002 + var v CustomerProfile err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6997,79 +9673,31 @@ func (r apiGetCampaignsRequest) Execute() (InlineResponse2002, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetChangesRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string - applicationId *int32 - entityPath *string - userId *int32 - createdBefore *time.Time - createdAfter *time.Time - withTotalResultSize *bool - includeOld *bool -} - -func (r apiGetChangesRequest) PageSize(pageSize int32) apiGetChangesRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetChangesRequest) Skip(skip int32) apiGetChangesRequest { - r.skip = &skip - return r -} - -func (r apiGetChangesRequest) Sort(sort string) apiGetChangesRequest { - r.sort = &sort - return r -} - -func (r apiGetChangesRequest) ApplicationId(applicationId int32) apiGetChangesRequest { - r.applicationId = &applicationId - return r -} - -func (r apiGetChangesRequest) EntityPath(entityPath string) apiGetChangesRequest { - r.entityPath = &entityPath - return r -} - -func (r apiGetChangesRequest) UserId(userId int32) apiGetChangesRequest { - r.userId = &userId - return r -} - -func (r apiGetChangesRequest) CreatedBefore(createdBefore time.Time) apiGetChangesRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiGetChangesRequest) CreatedAfter(createdAfter time.Time) apiGetChangesRequest { - r.createdAfter = &createdAfter - return r +type apiGetCustomerProfilesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 } -func (r apiGetChangesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetChangesRequest { - r.withTotalResultSize = &withTotalResultSize +func (r apiGetCustomerProfilesRequest) PageSize(pageSize int32) apiGetCustomerProfilesRequest { + r.pageSize = &pageSize return r } -func (r apiGetChangesRequest) IncludeOld(includeOld bool) apiGetChangesRequest { - r.includeOld = &includeOld +func (r apiGetCustomerProfilesRequest) Skip(skip int32) apiGetCustomerProfilesRequest { + r.skip = &skip return r } /* -GetChanges Get audit log for an account -Get list of changes caused by API calls for an account. Only accessible for admins. +GetCustomerProfiles List customer profiles +List all customer profiles. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetChangesRequest +@return apiGetCustomerProfilesRequest */ -func (a *ManagementApiService) GetChanges(ctx _context.Context) apiGetChangesRequest { - return apiGetChangesRequest{ +func (a *ManagementApiService) GetCustomerProfiles(ctx _context.Context) apiGetCustomerProfilesRequest { + return apiGetCustomerProfilesRequest{ apiService: a, ctx: ctx, } @@ -7077,24 +9705,24 @@ func (a *ManagementApiService) GetChanges(ctx _context.Context) apiGetChangesReq /* Execute executes the request - @return InlineResponse20027 + @return InlineResponse20017 */ -func (r apiGetChangesRequest) Execute() (InlineResponse20027, *_nethttp.Response, error) { +func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20027 + localVarReturnValue InlineResponse20017 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetChanges") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfiles") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/changes" + localVarPath := localBasePath + "/v1/customers/no_total" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -7106,30 +9734,6 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20027, *_nethttp.Response if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.applicationId != nil { - localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) - } - if r.entityPath != nil { - localVarQueryParams.Add("entityPath", parameterToString(*r.entityPath, "")) - } - if r.userId != nil { - localVarQueryParams.Add("userId", parameterToString(*r.userId, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.withTotalResultSize != nil { - localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) - } - if r.includeOld != nil { - localVarQueryParams.Add("includeOld", parameterToString(*r.includeOld, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -7183,7 +9787,7 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20027, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20027 + var v InlineResponse20017 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7206,133 +9810,65 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20027, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCouponsByAttributesRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - body *CouponSearch - pageSize *int32 - skip *int32 - sort *string - value *string - createdBefore *time.Time - createdAfter *time.Time - valid *string - usable *string - referralId *int32 - recipientIntegrationId *string - exactMatch *bool - batchId *string +type apiGetCustomersByAttributesRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *CustomerProfileSearchQuery + pageSize *int32 + skip *int32 } -func (r apiGetCouponsByAttributesRequest) Body(body CouponSearch) apiGetCouponsByAttributesRequest { +func (r apiGetCustomersByAttributesRequest) Body(body CustomerProfileSearchQuery) apiGetCustomersByAttributesRequest { r.body = &body return r } -func (r apiGetCouponsByAttributesRequest) PageSize(pageSize int32) apiGetCouponsByAttributesRequest { +func (r apiGetCustomersByAttributesRequest) PageSize(pageSize int32) apiGetCustomersByAttributesRequest { r.pageSize = &pageSize return r } -func (r apiGetCouponsByAttributesRequest) Skip(skip int32) apiGetCouponsByAttributesRequest { +func (r apiGetCustomersByAttributesRequest) Skip(skip int32) apiGetCustomersByAttributesRequest { r.skip = &skip return r } -func (r apiGetCouponsByAttributesRequest) Sort(sort string) apiGetCouponsByAttributesRequest { - r.sort = &sort - return r -} - -func (r apiGetCouponsByAttributesRequest) Value(value string) apiGetCouponsByAttributesRequest { - r.value = &value - return r -} - -func (r apiGetCouponsByAttributesRequest) CreatedBefore(createdBefore time.Time) apiGetCouponsByAttributesRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiGetCouponsByAttributesRequest) CreatedAfter(createdAfter time.Time) apiGetCouponsByAttributesRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiGetCouponsByAttributesRequest) Valid(valid string) apiGetCouponsByAttributesRequest { - r.valid = &valid - return r -} - -func (r apiGetCouponsByAttributesRequest) Usable(usable string) apiGetCouponsByAttributesRequest { - r.usable = &usable - return r -} - -func (r apiGetCouponsByAttributesRequest) ReferralId(referralId int32) apiGetCouponsByAttributesRequest { - r.referralId = &referralId - return r -} - -func (r apiGetCouponsByAttributesRequest) RecipientIntegrationId(recipientIntegrationId string) apiGetCouponsByAttributesRequest { - r.recipientIntegrationId = &recipientIntegrationId - return r -} - -func (r apiGetCouponsByAttributesRequest) ExactMatch(exactMatch bool) apiGetCouponsByAttributesRequest { - r.exactMatch = &exactMatch - return r -} - -func (r apiGetCouponsByAttributesRequest) BatchId(batchId string) apiGetCouponsByAttributesRequest { - r.batchId = &batchId - return r -} - /* -GetCouponsByAttributes List coupons that match the given attributes -Get a list of all the coupons that exactly match a set of attributes. +GetCustomersByAttributes List customer profiles matching the given attributes +Get a list of the customer profiles matching the provided criteria. -The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. +The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiGetCouponsByAttributesRequest +@return apiGetCustomersByAttributesRequest */ -func (a *ManagementApiService) GetCouponsByAttributes(ctx _context.Context, applicationId int32, campaignId int32) apiGetCouponsByAttributesRequest { - return apiGetCouponsByAttributesRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) GetCustomersByAttributes(ctx _context.Context) apiGetCustomersByAttributesRequest { + return apiGetCustomersByAttributesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse2004 + @return InlineResponse20017 */ -func (r apiGetCouponsByAttributesRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { +func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2004 + localVarReturnValue InlineResponse20017 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCouponsByAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomersByAttributes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath := localBasePath + "/v1/customer_search/no_total" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -7348,36 +9884,6 @@ func (r apiGetCouponsByAttributesRequest) Execute() (InlineResponse2004, *_netht if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.value != nil { - localVarQueryParams.Add("value", parameterToString(*r.value, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) - } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) - } - if r.referralId != nil { - localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) - } - if r.recipientIntegrationId != nil { - localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) - } - if r.exactMatch != nil { - localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) - } - if r.batchId != nil { - localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -7433,7 +9939,7 @@ func (r apiGetCouponsByAttributesRequest) Execute() (InlineResponse2004, *_netht error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2004 + var v InlineResponse20017 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7456,130 +9962,86 @@ func (r apiGetCouponsByAttributesRequest) Execute() (InlineResponse2004, *_netht return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCouponsWithoutTotalCountRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - pageSize *int32 - skip *int32 - sort *string - value *string - createdBefore *time.Time - createdAfter *time.Time - valid *string - usable *string - referralId *int32 - recipientIntegrationId *string - batchId *string - exactMatch *bool -} - -func (r apiGetCouponsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCouponsWithoutTotalCountRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetCouponsWithoutTotalCountRequest) Skip(skip int32) apiGetCouponsWithoutTotalCountRequest { - r.skip = &skip - return r -} - -func (r apiGetCouponsWithoutTotalCountRequest) Sort(sort string) apiGetCouponsWithoutTotalCountRequest { - r.sort = &sort - return r -} - -func (r apiGetCouponsWithoutTotalCountRequest) Value(value string) apiGetCouponsWithoutTotalCountRequest { - r.value = &value - return r -} - -func (r apiGetCouponsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetCouponsWithoutTotalCountRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiGetCouponsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetCouponsWithoutTotalCountRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiGetCouponsWithoutTotalCountRequest) Valid(valid string) apiGetCouponsWithoutTotalCountRequest { - r.valid = &valid - return r +type apiGetEventTypesRequest struct { + ctx _context.Context + apiService *ManagementApiService + name *string + includeOldVersions *bool + pageSize *int32 + skip *int32 + sort *string } -func (r apiGetCouponsWithoutTotalCountRequest) Usable(usable string) apiGetCouponsWithoutTotalCountRequest { - r.usable = &usable +func (r apiGetEventTypesRequest) Name(name string) apiGetEventTypesRequest { + r.name = &name return r } -func (r apiGetCouponsWithoutTotalCountRequest) ReferralId(referralId int32) apiGetCouponsWithoutTotalCountRequest { - r.referralId = &referralId +func (r apiGetEventTypesRequest) IncludeOldVersions(includeOldVersions bool) apiGetEventTypesRequest { + r.includeOldVersions = &includeOldVersions return r } -func (r apiGetCouponsWithoutTotalCountRequest) RecipientIntegrationId(recipientIntegrationId string) apiGetCouponsWithoutTotalCountRequest { - r.recipientIntegrationId = &recipientIntegrationId +func (r apiGetEventTypesRequest) PageSize(pageSize int32) apiGetEventTypesRequest { + r.pageSize = &pageSize return r } -func (r apiGetCouponsWithoutTotalCountRequest) BatchId(batchId string) apiGetCouponsWithoutTotalCountRequest { - r.batchId = &batchId +func (r apiGetEventTypesRequest) Skip(skip int32) apiGetEventTypesRequest { + r.skip = &skip return r } -func (r apiGetCouponsWithoutTotalCountRequest) ExactMatch(exactMatch bool) apiGetCouponsWithoutTotalCountRequest { - r.exactMatch = &exactMatch +func (r apiGetEventTypesRequest) Sort(sort string) apiGetEventTypesRequest { + r.sort = &sort return r } /* -GetCouponsWithoutTotalCount List coupons -List all the coupons matching the specified criteria. +GetEventTypes List event types +Fetch all event type definitions for your account. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiGetCouponsWithoutTotalCountRequest -*/ -func (a *ManagementApiService) GetCouponsWithoutTotalCount(ctx _context.Context, applicationId int32, campaignId int32) apiGetCouponsWithoutTotalCountRequest { - return apiGetCouponsWithoutTotalCountRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +@return apiGetEventTypesRequest +*/ +func (a *ManagementApiService) GetEventTypes(ctx _context.Context) apiGetEventTypesRequest { + return apiGetEventTypesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse2005 + @return InlineResponse20029 */ -func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { +func (r apiGetEventTypesRequest) Execute() (InlineResponse20029, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2005 + localVarReturnValue InlineResponse20029 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCouponsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetEventTypes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath := localBasePath + "/v1/event_types" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.name != nil { + localVarQueryParams.Add("name", parameterToString(*r.name, "")) + } + if r.includeOldVersions != nil { + localVarQueryParams.Add("includeOldVersions", parameterToString(*r.includeOldVersions, "")) + } if r.pageSize != nil { localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } @@ -7589,33 +10051,6 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2005, *_ if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.value != nil { - localVarQueryParams.Add("value", parameterToString(*r.value, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) - } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) - } - if r.referralId != nil { - localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) - } - if r.recipientIntegrationId != nil { - localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) - } - if r.batchId != nil { - localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) - } - if r.exactMatch != nil { - localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -7669,7 +10104,7 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2005, *_ error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2005 + var v InlineResponse20029 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7692,97 +10127,95 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2005, *_ return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerActivityReportRequest struct { +type apiGetExportsRequest struct { ctx _context.Context apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time - applicationId int32 - customerId int32 pageSize *int32 skip *int32 + applicationId *float32 + campaignId *int32 + entity *string } -func (r apiGetCustomerActivityReportRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportRequest { - r.rangeStart = &rangeStart +func (r apiGetExportsRequest) PageSize(pageSize int32) apiGetExportsRequest { + r.pageSize = &pageSize return r } -func (r apiGetCustomerActivityReportRequest) RangeEnd(rangeEnd time.Time) apiGetCustomerActivityReportRequest { - r.rangeEnd = &rangeEnd +func (r apiGetExportsRequest) Skip(skip int32) apiGetExportsRequest { + r.skip = &skip return r } -func (r apiGetCustomerActivityReportRequest) PageSize(pageSize int32) apiGetCustomerActivityReportRequest { - r.pageSize = &pageSize +func (r apiGetExportsRequest) ApplicationId(applicationId float32) apiGetExportsRequest { + r.applicationId = &applicationId return r } -func (r apiGetCustomerActivityReportRequest) Skip(skip int32) apiGetCustomerActivityReportRequest { - r.skip = &skip +func (r apiGetExportsRequest) CampaignId(campaignId int32) apiGetExportsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiGetExportsRequest) Entity(entity string) apiGetExportsRequest { + r.entity = &entity return r } /* -GetCustomerActivityReport Get customer's activity report -Fetch the summary report of a given customer in the given application, in a time range. +GetExports Get exports +List all past exports + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param customerId -@return apiGetCustomerActivityReportRequest +@return apiGetExportsRequest */ -func (a *ManagementApiService) GetCustomerActivityReport(ctx _context.Context, applicationId int32, customerId int32) apiGetCustomerActivityReportRequest { - return apiGetCustomerActivityReportRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - customerId: customerId, +func (a *ManagementApiService) GetExports(ctx _context.Context) apiGetExportsRequest { + return apiGetExportsRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return CustomerActivityReport + @return InlineResponse20032 */ -func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, *_nethttp.Response, error) { +func (r apiGetExportsRequest) Execute() (InlineResponse20032, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerActivityReport + localVarReturnValue InlineResponse20032 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReport") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetExports") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_activity_reports/{customerId}" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) + localVarPath := localBasePath + "/v1/exports" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.rangeStart == nil { - return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") - } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") - } - if r.pageSize != nil { localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.applicationId != nil { + localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) + } + if r.campaignId != nil { + localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + } + if r.entity != nil { + localVarQueryParams.Add("entity", parameterToString(*r.entity, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -7836,7 +10269,7 @@ func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerActivityReport + var v InlineResponse20032 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7859,138 +10292,61 @@ func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerActivityReportsWithoutTotalCountRequest struct { - ctx _context.Context - apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time - applicationId int32 - pageSize *int32 - skip *int32 - sort *string - name *string - integrationId *string - campaignName *string - advocateName *string -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.rangeStart = &rangeStart - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) RangeEnd(rangeEnd time.Time) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.rangeEnd = &rangeEnd - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Skip(skip int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.skip = &skip - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Sort(sort string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.sort = &sort - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Name(name string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.name = &name - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) IntegrationId(integrationId string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.integrationId = &integrationId - return r +type apiGetLoyaltyPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId string + integrationId string } -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) CampaignName(campaignName string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.campaignName = &campaignName - return r -} +/* +GetLoyaltyPoints Get the Loyalty Ledger for this integrationID +Get the loyalty ledger for this profile integration ID. -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) AdvocateName(advocateName string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.advocateName = &advocateName - return r -} +To get the `integrationId` of the profile from a `sessionId`, use the +[Update customer session](/integration-api/#operation/updateCustomerSessionV2). -/* -GetCustomerActivityReportsWithoutTotalCount Get Activity Reports for Application Customers -Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only if there are more results. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId -@return apiGetCustomerActivityReportsWithoutTotalCountRequest + * @param loyaltyProgramId The identifier for the loyalty program. + * @param integrationId The identifier of the profile. +@return apiGetLoyaltyPointsRequest */ -func (a *ManagementApiService) GetCustomerActivityReportsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { - return apiGetCustomerActivityReportsWithoutTotalCountRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetLoyaltyPoints(ctx _context.Context, loyaltyProgramId string, integrationId string) apiGetLoyaltyPointsRequest { + return apiGetLoyaltyPointsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, } } -/* -Execute executes the request - @return InlineResponse20014 -*/ -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (InlineResponse20014, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodGet - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue InlineResponse20014 - ) - - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReportsWithoutTotalCount") - if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_activity_reports/no_total" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := _neturl.Values{} - localVarFormParams := _neturl.Values{} - - if r.rangeStart == nil { - return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") - } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") - } - - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.name != nil { - localVarQueryParams.Add("name", parameterToString(*r.name, "")) - } - if r.integrationId != nil { - localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) - } - if r.campaignName != nil { - localVarQueryParams.Add("campaignName", parameterToString(*r.campaignName, "")) - } - if r.advocateName != nil { - localVarQueryParams.Add("advocateName", parameterToString(*r.advocateName, "")) +/* +Execute executes the request + @return LoyaltyLedger +*/ +func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyLedger + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPoints") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -8044,7 +10400,7 @@ func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (Inline error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20014 + var v LoyaltyLedger err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8067,84 +10423,58 @@ func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (Inline return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerAnalyticsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - customerId int32 - pageSize *int32 - skip *int32 - sort *string -} - -func (r apiGetCustomerAnalyticsRequest) PageSize(pageSize int32) apiGetCustomerAnalyticsRequest { - r.pageSize = &pageSize - return r +type apiGetLoyaltyProgramRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 } -func (r apiGetCustomerAnalyticsRequest) Skip(skip int32) apiGetCustomerAnalyticsRequest { - r.skip = &skip - return r -} +/* +GetLoyaltyProgram Get loyalty program +Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). +To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). -func (r apiGetCustomerAnalyticsRequest) Sort(sort string) apiGetCustomerAnalyticsRequest { - r.sort = &sort - return r -} +To list the loyalty programs that a customer profile is part of, use the +[List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory) -/* -GetCustomerAnalytics Get customer's analytics report -Fetch analytics for a given customer in the given application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param customerId -@return apiGetCustomerAnalyticsRequest + * @param loyaltyProgramId Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). +@return apiGetLoyaltyProgramRequest */ -func (a *ManagementApiService) GetCustomerAnalytics(ctx _context.Context, applicationId int32, customerId int32) apiGetCustomerAnalyticsRequest { - return apiGetCustomerAnalyticsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - customerId: customerId, +func (a *ManagementApiService) GetLoyaltyProgram(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyProgramRequest { + return apiGetLoyaltyProgramRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return CustomerAnalytics + @return LoyaltyProgram */ -func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerAnalytics + localVarReturnValue LoyaltyProgram ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerAnalytics") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyProgram") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/customers/{customerId}/analytics" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -8198,7 +10528,7 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerAnalytics + var v LoyaltyProgram err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8221,55 +10551,44 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerProfileRequest struct { +type apiGetLoyaltyProgramsRequest struct { ctx _context.Context apiService *ManagementApiService - customerId int32 } /* -GetCustomerProfile Get customer profile -Return the details of the specified customer profile. - -**Performance tip:** You can retrieve the same information via the Integration API, which can save you -extra API requests. Consider these options: -- Request the customer profile to be part of the response content using - [Update Customer Session](/integration-api/operation#updateCustomerSessionV2). -- Send an empty update with the [Update Customer Profile](/integration-api/#operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. - +GetLoyaltyPrograms List loyalty programs +List the loyalty programs of the account. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param customerId -@return apiGetCustomerProfileRequest +@return apiGetLoyaltyProgramsRequest */ -func (a *ManagementApiService) GetCustomerProfile(ctx _context.Context, customerId int32) apiGetCustomerProfileRequest { - return apiGetCustomerProfileRequest{ +func (a *ManagementApiService) GetLoyaltyPrograms(ctx _context.Context) apiGetLoyaltyProgramsRequest { + return apiGetLoyaltyProgramsRequest{ apiService: a, ctx: ctx, - customerId: customerId, } } /* Execute executes the request - @return CustomerProfile + @return InlineResponse2008 */ -func (r apiGetCustomerProfileRequest) Execute() (CustomerProfile, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerProfile + localVarReturnValue InlineResponse2008 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfile") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPrograms") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/customers/{customerId}" - localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -8328,7 +10647,7 @@ func (r apiGetCustomerProfileRequest) Execute() (CustomerProfile, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerProfile + var v InlineResponse2008 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8351,67 +10670,55 @@ func (r apiGetCustomerProfileRequest) Execute() (CustomerProfile, *_nethttp.Resp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerProfilesRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 -} - -func (r apiGetCustomerProfilesRequest) PageSize(pageSize int32) apiGetCustomerProfilesRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetCustomerProfilesRequest) Skip(skip int32) apiGetCustomerProfilesRequest { - r.skip = &skip - return r +type apiGetLoyaltyStatisticsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 } /* -GetCustomerProfiles List customer profiles -List all customer profiles. +GetLoyaltyStatistics Get loyalty program statistics by loyalty program ID +Retrieve the statistics of the specified loyalty program such as the +total active points, pending points, spent points and expired points. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetCustomerProfilesRequest + * @param loyaltyProgramId Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). +@return apiGetLoyaltyStatisticsRequest */ -func (a *ManagementApiService) GetCustomerProfiles(ctx _context.Context) apiGetCustomerProfilesRequest { - return apiGetCustomerProfilesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetLoyaltyStatistics(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyStatisticsRequest { + return apiGetLoyaltyStatisticsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return InlineResponse20013 + @return LoyaltyStatistics */ -func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { +func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20013 + localVarReturnValue LoyaltyStatistics ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfiles") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyStatistics") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/customers/no_total" + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/statistics" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -8465,7 +10772,7 @@ func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20013, *_nethttp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20013 + var v LoyaltyStatistics err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8488,82 +10795,59 @@ func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20013, *_nethttp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomersByAttributesRequest struct { - ctx _context.Context - apiService *ManagementApiService - body *CustomerProfileSearchQuery - pageSize *int32 - skip *int32 -} - -func (r apiGetCustomersByAttributesRequest) Body(body CustomerProfileSearchQuery) apiGetCustomersByAttributesRequest { - r.body = &body - return r -} - -func (r apiGetCustomersByAttributesRequest) PageSize(pageSize int32) apiGetCustomersByAttributesRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetCustomersByAttributesRequest) Skip(skip int32) apiGetCustomersByAttributesRequest { - r.skip = &skip - return r +type apiGetNotificationWebhookRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + notificationWebhookId int32 } /* -GetCustomersByAttributes List customer profiles matching the given attributes -Get a list of the customer profiles matching the provided criteria. - -The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. - +GetNotificationWebhook Get notification webhook +Return the given outbound notification webhook. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetCustomersByAttributesRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param notificationWebhookId +@return apiGetNotificationWebhookRequest */ -func (a *ManagementApiService) GetCustomersByAttributes(ctx _context.Context) apiGetCustomersByAttributesRequest { - return apiGetCustomersByAttributesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetNotificationWebhook(ctx _context.Context, applicationId int32, notificationWebhookId int32) apiGetNotificationWebhookRequest { + return apiGetNotificationWebhookRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + notificationWebhookId: notificationWebhookId, } } /* Execute executes the request - @return InlineResponse20013 + @return NotificationWebhook */ -func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { +func (r apiGetNotificationWebhookRequest) Execute() (NotificationWebhook, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20013 + localVarReturnValue NotificationWebhook ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomersByAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetNotificationWebhook") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/customer_search/no_total" + localVarPath := localBasePath + "/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"notificationWebhookId"+"}", _neturl.QueryEscape(parameterToString(r.notificationWebhookId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.body == nil { - return localVarReturnValue, nil, reportError("body is required and must be specified") - } - - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -8579,8 +10863,6 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20013, *_ne if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -8617,7 +10899,7 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20013, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20013 + var v NotificationWebhook err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8640,104 +10922,53 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20013, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetEventTypesRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationIds *string - name *string - includeOldVersions *bool - pageSize *int32 - skip *int32 - sort *string -} - -func (r apiGetEventTypesRequest) ApplicationIds(applicationIds string) apiGetEventTypesRequest { - r.applicationIds = &applicationIds - return r -} - -func (r apiGetEventTypesRequest) Name(name string) apiGetEventTypesRequest { - r.name = &name - return r -} - -func (r apiGetEventTypesRequest) IncludeOldVersions(includeOldVersions bool) apiGetEventTypesRequest { - r.includeOldVersions = &includeOldVersions - return r -} - -func (r apiGetEventTypesRequest) PageSize(pageSize int32) apiGetEventTypesRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetEventTypesRequest) Skip(skip int32) apiGetEventTypesRequest { - r.skip = &skip - return r -} - -func (r apiGetEventTypesRequest) Sort(sort string) apiGetEventTypesRequest { - r.sort = &sort - return r +type apiGetNotificationWebhooksRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 } /* -GetEventTypes List Event Types -Fetch all event type definitions for your account. - +GetNotificationWebhooks List notification webhooks +List all outbound notification webhooks for this application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetEventTypesRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiGetNotificationWebhooksRequest */ -func (a *ManagementApiService) GetEventTypes(ctx _context.Context) apiGetEventTypesRequest { - return apiGetEventTypesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetNotificationWebhooks(ctx _context.Context, applicationId int32) apiGetNotificationWebhooksRequest { + return apiGetNotificationWebhooksRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return InlineResponse20025 + @return InlineResponse2003 */ -func (r apiGetEventTypesRequest) Execute() (InlineResponse20025, *_nethttp.Response, error) { +func (r apiGetNotificationWebhooksRequest) Execute() (InlineResponse2003, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20025 + localVarReturnValue InlineResponse2003 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetEventTypes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetNotificationWebhooks") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/event_types" + localVarPath := localBasePath + "/v1/applications/{applicationId}/notification_webhooks" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.applicationIds != nil { - localVarQueryParams.Add("applicationIds", parameterToString(*r.applicationIds, "")) - } - if r.name != nil { - localVarQueryParams.Add("name", parameterToString(*r.name, "")) - } - if r.includeOldVersions != nil { - localVarQueryParams.Add("includeOldVersions", parameterToString(*r.includeOldVersions, "")) - } - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -8791,7 +11022,7 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20025, *_nethttp.Respo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20025 + var v InlineResponse2003 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8814,75 +11045,106 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20025, *_nethttp.Respo return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetExportsRequest struct { +type apiGetReferralsWithoutTotalCountRequest struct { ctx _context.Context apiService *ManagementApiService + applicationId int32 + campaignId int32 pageSize *int32 skip *int32 - applicationId *int32 - campaignId *int32 - entity *string + sort *string + code *string + createdBefore *time.Time + createdAfter *time.Time + valid *string + usable *string + advocate *string } -func (r apiGetExportsRequest) PageSize(pageSize int32) apiGetExportsRequest { +func (r apiGetReferralsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetReferralsWithoutTotalCountRequest { r.pageSize = &pageSize return r } -func (r apiGetExportsRequest) Skip(skip int32) apiGetExportsRequest { +func (r apiGetReferralsWithoutTotalCountRequest) Skip(skip int32) apiGetReferralsWithoutTotalCountRequest { r.skip = &skip return r } -func (r apiGetExportsRequest) ApplicationId(applicationId int32) apiGetExportsRequest { - r.applicationId = &applicationId +func (r apiGetReferralsWithoutTotalCountRequest) Sort(sort string) apiGetReferralsWithoutTotalCountRequest { + r.sort = &sort return r } -func (r apiGetExportsRequest) CampaignId(campaignId int32) apiGetExportsRequest { - r.campaignId = &campaignId +func (r apiGetReferralsWithoutTotalCountRequest) Code(code string) apiGetReferralsWithoutTotalCountRequest { + r.code = &code return r } -func (r apiGetExportsRequest) Entity(entity string) apiGetExportsRequest { - r.entity = &entity +func (r apiGetReferralsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetReferralsWithoutTotalCountRequest { + r.createdBefore = &createdBefore return r } -/* -GetExports Get Exports -List all past exports +func (r apiGetReferralsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetReferralsWithoutTotalCountRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiGetReferralsWithoutTotalCountRequest) Valid(valid string) apiGetReferralsWithoutTotalCountRequest { + r.valid = &valid + return r +} + +func (r apiGetReferralsWithoutTotalCountRequest) Usable(usable string) apiGetReferralsWithoutTotalCountRequest { + r.usable = &usable + return r +} + +func (r apiGetReferralsWithoutTotalCountRequest) Advocate(advocate string) apiGetReferralsWithoutTotalCountRequest { + r.advocate = &advocate + return r +} +/* +GetReferralsWithoutTotalCount List referrals +List all referrals of the specified campaign. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetExportsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiGetReferralsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetExports(ctx _context.Context) apiGetExportsRequest { - return apiGetExportsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetReferralsWithoutTotalCount(ctx _context.Context, applicationId int32, campaignId int32) apiGetReferralsWithoutTotalCountRequest { + return apiGetReferralsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse20028 + @return InlineResponse2007 */ -func (r apiGetExportsRequest) Execute() (InlineResponse20028, *_nethttp.Response, error) { +func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20028 + localVarReturnValue InlineResponse2007 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetExports") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetReferralsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/exports" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -8894,14 +11156,26 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20028, *_nethttp.Response if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - if r.applicationId != nil { - localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.campaignId != nil { - localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + if r.code != nil { + localVarQueryParams.Add("code", parameterToString(*r.code, "")) } - if r.entity != nil { - localVarQueryParams.Add("entity", parameterToString(*r.entity, "")) + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + } + if r.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + } + if r.advocate != nil { + localVarQueryParams.Add("advocate", parameterToString(*r.advocate, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -8956,7 +11230,7 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20028, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20028 + var v InlineResponse2007 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8979,56 +11253,49 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20028, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyPointsRequest struct { - ctx _context.Context - apiService *ManagementApiService - programID string - integrationID string +type apiGetRoleRequest struct { + ctx _context.Context + apiService *ManagementApiService + roleId int32 } /* -GetLoyaltyPoints Get the Loyalty Ledger for this integrationID -Get the loyalty ledger for this profile integration ID. - -To get the `integrationId` of the profile from a `sessionId`, use the -[Update customer session](/integration-api/#operation/updateCustomerSessionV2). +GetRole Get role +Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles). * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID The identifier for the application, must be unique within the account. - * @param integrationID The identifier for the application, must be unique within the account. -@return apiGetLoyaltyPointsRequest + * @param roleId The Id of role. +@return apiGetRoleRequest */ -func (a *ManagementApiService) GetLoyaltyPoints(ctx _context.Context, programID string, integrationID string) apiGetLoyaltyPointsRequest { - return apiGetLoyaltyPointsRequest{ - apiService: a, - ctx: ctx, - programID: programID, - integrationID: integrationID, +func (a *ManagementApiService) GetRole(ctx _context.Context, roleId int32) apiGetRoleRequest { + return apiGetRoleRequest{ + apiService: a, + ctx: ctx, + roleId: roleId, } } /* Execute executes the request - @return LoyaltyLedger + @return Role */ -func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response, error) { +func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyLedger + localVarReturnValue Role ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPoints") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRole") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/profile/{integrationID}" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationID"+"}", _neturl.QueryEscape(parameterToString(r.integrationID, "")), -1) + localVarPath := localBasePath + "/v1/roles/{roleId}" + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(r.roleId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -9087,7 +11354,7 @@ func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyLedger + var v Role err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9110,50 +11377,56 @@ func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyProgramRequest struct { - ctx _context.Context - apiService *ManagementApiService - programID int32 +type apiGetRulesetRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + rulesetId int32 } /* -GetLoyaltyProgram Get loyalty program -Get the specified [loyalty program](https://www.talon.one/glossary/loyalty). -To list all loyalty programs, use [List loyalty programs](#operation/getLoyaltyPrograms). - +GetRuleset Get ruleset +Retrieve the specified ruleset. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID -@return apiGetLoyaltyProgramRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param rulesetId +@return apiGetRulesetRequest */ -func (a *ManagementApiService) GetLoyaltyProgram(ctx _context.Context, programID int32) apiGetLoyaltyProgramRequest { - return apiGetLoyaltyProgramRequest{ - apiService: a, - ctx: ctx, - programID: programID, +func (a *ManagementApiService) GetRuleset(ctx _context.Context, applicationId int32, campaignId int32, rulesetId int32) apiGetRulesetRequest { + return apiGetRulesetRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + rulesetId: rulesetId, } } /* Execute executes the request - @return LoyaltyProgram + @return Ruleset */ -func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Response, error) { +func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyProgram + localVarReturnValue Ruleset ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyProgram") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRuleset") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"rulesetId"+"}", _neturl.QueryEscape(parameterToString(r.rulesetId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -9212,7 +11485,7 @@ func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyProgram + var v Ruleset err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9235,49 +11508,87 @@ func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Respon return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyProgramsRequest struct { - ctx _context.Context - apiService *ManagementApiService +type apiGetRulesetsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + pageSize *int32 + skip *int32 + sort *string +} + +func (r apiGetRulesetsRequest) PageSize(pageSize int32) apiGetRulesetsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetRulesetsRequest) Skip(skip int32) apiGetRulesetsRequest { + r.skip = &skip + return r +} + +func (r apiGetRulesetsRequest) Sort(sort string) apiGetRulesetsRequest { + r.sort = &sort + return r } /* -GetLoyaltyPrograms List loyalty programs -List the loyalty programs of the account. +GetRulesets List campaign rulesets +List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. +**Important:** The response also includes deleted rules. +You should only consider the latest revision of the returned rulesets. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetLoyaltyProgramsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiGetRulesetsRequest */ -func (a *ManagementApiService) GetLoyaltyPrograms(ctx _context.Context) apiGetLoyaltyProgramsRequest { - return apiGetLoyaltyProgramsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetRulesets(ctx _context.Context, applicationId int32, campaignId int32) apiGetRulesetsRequest { + return apiGetRulesetsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse2007 + @return InlineResponse2004 */ -func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { +func (r apiGetRulesetsRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2007 + localVarReturnValue InlineResponse2004 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPrograms") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRulesets") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9331,7 +11642,7 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2007, *_nethttp.R error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2007 + var v InlineResponse2004 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9354,50 +11665,49 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2007, *_nethttp.R return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyStatisticsRequest struct { +type apiGetUserRequest struct { ctx _context.Context apiService *ManagementApiService - programID int32 + userId int32 } /* -GetLoyaltyStatistics Get loyalty program statistics by loyalty program ID -Retrieve the statistics of the specified loyalty program such as the -total active points, pending points, spent points and expired points. +GetUser Get user +Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID -@return apiGetLoyaltyStatisticsRequest + * @param userId The ID of the user. +@return apiGetUserRequest */ -func (a *ManagementApiService) GetLoyaltyStatistics(ctx _context.Context, programID int32) apiGetLoyaltyStatisticsRequest { - return apiGetLoyaltyStatisticsRequest{ +func (a *ManagementApiService) GetUser(ctx _context.Context, userId int32) apiGetUserRequest { + return apiGetUserRequest{ apiService: a, ctx: ctx, - programID: programID, + userId: userId, } } /* Execute executes the request - @return LoyaltyStatistics + @return User */ -func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp.Response, error) { +func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyStatistics + localVarReturnValue User ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyStatistics") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUser") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/statistics" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + localVarPath := localBasePath + "/v1/users/{userId}" + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(r.userId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -9456,7 +11766,7 @@ func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyStatistics + var v User err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9479,106 +11789,63 @@ func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetReferralsWithoutTotalCountRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - pageSize *int32 - skip *int32 - sort *string - code *string - createdBefore *time.Time - createdAfter *time.Time - valid *string - usable *string - advocate *string +type apiGetUsersRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string } -func (r apiGetReferralsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetReferralsWithoutTotalCountRequest { +func (r apiGetUsersRequest) PageSize(pageSize int32) apiGetUsersRequest { r.pageSize = &pageSize return r } -func (r apiGetReferralsWithoutTotalCountRequest) Skip(skip int32) apiGetReferralsWithoutTotalCountRequest { +func (r apiGetUsersRequest) Skip(skip int32) apiGetUsersRequest { r.skip = &skip return r } -func (r apiGetReferralsWithoutTotalCountRequest) Sort(sort string) apiGetReferralsWithoutTotalCountRequest { +func (r apiGetUsersRequest) Sort(sort string) apiGetUsersRequest { r.sort = &sort return r } -func (r apiGetReferralsWithoutTotalCountRequest) Code(code string) apiGetReferralsWithoutTotalCountRequest { - r.code = &code - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetReferralsWithoutTotalCountRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetReferralsWithoutTotalCountRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) Valid(valid string) apiGetReferralsWithoutTotalCountRequest { - r.valid = &valid - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) Usable(usable string) apiGetReferralsWithoutTotalCountRequest { - r.usable = &usable - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) Advocate(advocate string) apiGetReferralsWithoutTotalCountRequest { - r.advocate = &advocate - return r -} - /* -GetReferralsWithoutTotalCount List referrals -List all referrals of the specified campaign. +GetUsers List users in account +Retrieve all users in your account. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiGetReferralsWithoutTotalCountRequest +@return apiGetUsersRequest */ -func (a *ManagementApiService) GetReferralsWithoutTotalCount(ctx _context.Context, applicationId int32, campaignId int32) apiGetReferralsWithoutTotalCountRequest { - return apiGetReferralsWithoutTotalCountRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) GetUsers(ctx _context.Context) apiGetUsersRequest { + return apiGetUsersRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse2006 + @return InlineResponse20030 */ -func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { +func (r apiGetUsersRequest) Execute() (InlineResponse20030, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2006 + localVarReturnValue InlineResponse20030 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetReferralsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUsers") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath := localBasePath + "/v1/users" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -9593,24 +11860,6 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2006, if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.code != nil { - localVarQueryParams.Add("code", parameterToString(*r.code, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) - } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) - } - if r.advocate != nil { - localVarQueryParams.Add("advocate", parameterToString(*r.advocate, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9664,7 +11913,7 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2006, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2006 + var v InlineResponse20030 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9687,49 +11936,48 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2006, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetRoleRequest struct { +type apiGetWebhookRequest struct { ctx _context.Context apiService *ManagementApiService - roleId int32 + webhookId int32 } /* -GetRole Get role -Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles). - +GetWebhook Get webhook +Returns a webhook by its id. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param roleId -@return apiGetRoleRequest + * @param webhookId +@return apiGetWebhookRequest */ -func (a *ManagementApiService) GetRole(ctx _context.Context, roleId int32) apiGetRoleRequest { - return apiGetRoleRequest{ +func (a *ManagementApiService) GetWebhook(ctx _context.Context, webhookId int32) apiGetWebhookRequest { + return apiGetWebhookRequest{ apiService: a, ctx: ctx, - roleId: roleId, + webhookId: webhookId, } } /* Execute executes the request - @return Role + @return Webhook */ -func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { +func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Role + localVarReturnValue Webhook ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRole") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhook") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/roles/{roleId}" - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(r.roleId, "")), -1) + localVarPath := localBasePath + "/v1/webhooks/{webhookId}" + localVarPath = strings.Replace(localVarPath, "{"+"webhookId"+"}", _neturl.QueryEscape(parameterToString(r.webhookId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -9788,7 +12036,7 @@ func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Role + var v Webhook err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9811,61 +12059,130 @@ func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetRulesetRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - rulesetId int32 +type apiGetWebhookActivationLogsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + integrationRequestUuid *string + webhookId *float32 + applicationId *float32 + campaignId *float32 + createdBefore *time.Time + createdAfter *time.Time +} + +func (r apiGetWebhookActivationLogsRequest) PageSize(pageSize int32) apiGetWebhookActivationLogsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetWebhookActivationLogsRequest) Skip(skip int32) apiGetWebhookActivationLogsRequest { + r.skip = &skip + return r +} + +func (r apiGetWebhookActivationLogsRequest) Sort(sort string) apiGetWebhookActivationLogsRequest { + r.sort = &sort + return r +} + +func (r apiGetWebhookActivationLogsRequest) IntegrationRequestUuid(integrationRequestUuid string) apiGetWebhookActivationLogsRequest { + r.integrationRequestUuid = &integrationRequestUuid + return r +} + +func (r apiGetWebhookActivationLogsRequest) WebhookId(webhookId float32) apiGetWebhookActivationLogsRequest { + r.webhookId = &webhookId + return r +} + +func (r apiGetWebhookActivationLogsRequest) ApplicationId(applicationId float32) apiGetWebhookActivationLogsRequest { + r.applicationId = &applicationId + return r +} + +func (r apiGetWebhookActivationLogsRequest) CampaignId(campaignId float32) apiGetWebhookActivationLogsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiGetWebhookActivationLogsRequest) CreatedBefore(createdBefore time.Time) apiGetWebhookActivationLogsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetWebhookActivationLogsRequest) CreatedAfter(createdAfter time.Time) apiGetWebhookActivationLogsRequest { + r.createdAfter = &createdAfter + return r } /* -GetRuleset Get ruleset -Retrieve the specified ruleset. +GetWebhookActivationLogs List webhook activation log entries +Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId - * @param rulesetId -@return apiGetRulesetRequest +@return apiGetWebhookActivationLogsRequest */ -func (a *ManagementApiService) GetRuleset(ctx _context.Context, applicationId int32, campaignId int32, rulesetId int32) apiGetRulesetRequest { - return apiGetRulesetRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, - rulesetId: rulesetId, +func (a *ManagementApiService) GetWebhookActivationLogs(ctx _context.Context) apiGetWebhookActivationLogsRequest { + return apiGetWebhookActivationLogsRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return Ruleset + @return InlineResponse20027 */ -func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { +func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20027, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Ruleset + localVarReturnValue InlineResponse20027 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRuleset") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookActivationLogs") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"rulesetId"+"}", _neturl.QueryEscape(parameterToString(r.rulesetId, "")), -1) + localVarPath := localBasePath + "/v1/webhook_activation_logs" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.integrationRequestUuid != nil { + localVarQueryParams.Add("integrationRequestUuid", parameterToString(*r.integrationRequestUuid, "")) + } + if r.webhookId != nil { + localVarQueryParams.Add("webhookId", parameterToString(*r.webhookId, "")) + } + if r.applicationId != nil { + localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) + } + if r.campaignId != nil { + localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9919,7 +12236,7 @@ func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Ruleset + var v InlineResponse20027 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9942,73 +12259,104 @@ func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetRulesetsRequest struct { +type apiGetWebhookLogsRequest struct { ctx _context.Context apiService *ManagementApiService - applicationId int32 - campaignId int32 pageSize *int32 skip *int32 sort *string + status *string + webhookId *float32 + applicationId *float32 + campaignId *float32 + requestUuid *string + createdBefore *time.Time + createdAfter *time.Time } -func (r apiGetRulesetsRequest) PageSize(pageSize int32) apiGetRulesetsRequest { +func (r apiGetWebhookLogsRequest) PageSize(pageSize int32) apiGetWebhookLogsRequest { r.pageSize = &pageSize return r } -func (r apiGetRulesetsRequest) Skip(skip int32) apiGetRulesetsRequest { +func (r apiGetWebhookLogsRequest) Skip(skip int32) apiGetWebhookLogsRequest { r.skip = &skip return r } -func (r apiGetRulesetsRequest) Sort(sort string) apiGetRulesetsRequest { +func (r apiGetWebhookLogsRequest) Sort(sort string) apiGetWebhookLogsRequest { r.sort = &sort return r } -/* -GetRulesets List campaign rulesets -List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. -**Important:** The response also includes deleted rules. -You should only consider the latest revision of the returned rulesets. +func (r apiGetWebhookLogsRequest) Status(status string) apiGetWebhookLogsRequest { + r.status = &status + return r +} + +func (r apiGetWebhookLogsRequest) WebhookId(webhookId float32) apiGetWebhookLogsRequest { + r.webhookId = &webhookId + return r +} + +func (r apiGetWebhookLogsRequest) ApplicationId(applicationId float32) apiGetWebhookLogsRequest { + r.applicationId = &applicationId + return r +} + +func (r apiGetWebhookLogsRequest) CampaignId(campaignId float32) apiGetWebhookLogsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiGetWebhookLogsRequest) RequestUuid(requestUuid string) apiGetWebhookLogsRequest { + r.requestUuid = &requestUuid + return r +} + +func (r apiGetWebhookLogsRequest) CreatedBefore(createdBefore time.Time) apiGetWebhookLogsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetWebhookLogsRequest) CreatedAfter(createdAfter time.Time) apiGetWebhookLogsRequest { + r.createdAfter = &createdAfter + return r +} +/* +GetWebhookLogs List webhook log entries +Retrieve all webhook log entries. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiGetRulesetsRequest +@return apiGetWebhookLogsRequest */ -func (a *ManagementApiService) GetRulesets(ctx _context.Context, applicationId int32, campaignId int32) apiGetRulesetsRequest { - return apiGetRulesetsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) GetWebhookLogs(ctx _context.Context) apiGetWebhookLogsRequest { + return apiGetWebhookLogsRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse2003 + @return InlineResponse20028 */ -func (r apiGetRulesetsRequest) Execute() (InlineResponse2003, *_nethttp.Response, error) { +func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20028, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2003 + localVarReturnValue InlineResponse20028 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRulesets") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookLogs") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath := localBasePath + "/v1/webhook_logs" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -10023,6 +12371,27 @@ func (r apiGetRulesetsRequest) Execute() (InlineResponse2003, *_nethttp.Response if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } + if r.status != nil { + localVarQueryParams.Add("status", parameterToString(*r.status, "")) + } + if r.webhookId != nil { + localVarQueryParams.Add("webhookId", parameterToString(*r.webhookId, "")) + } + if r.applicationId != nil { + localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) + } + if r.campaignId != nil { + localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) + } + if r.requestUuid != nil { + localVarQueryParams.Add("requestUuid", parameterToString(*r.requestUuid, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -10076,7 +12445,7 @@ func (r apiGetRulesetsRequest) Execute() (InlineResponse2003, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2003 + var v InlineResponse20028 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10099,54 +12468,85 @@ func (r apiGetRulesetsRequest) Execute() (InlineResponse2003, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetUserRequest struct { - ctx _context.Context - apiService *ManagementApiService - userId int32 +type apiGetWebhooksRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationIds *string + sort *string + pageSize *int32 + skip *int32 } -/* -GetUser Get a single user -Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves. +func (r apiGetWebhooksRequest) ApplicationIds(applicationIds string) apiGetWebhooksRequest { + r.applicationIds = &applicationIds + return r +} + +func (r apiGetWebhooksRequest) Sort(sort string) apiGetWebhooksRequest { + r.sort = &sort + return r +} + +func (r apiGetWebhooksRequest) PageSize(pageSize int32) apiGetWebhooksRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetWebhooksRequest) Skip(skip int32) apiGetWebhooksRequest { + r.skip = &skip + return r +} +/* +GetWebhooks List webhooks +List all webhooks. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userId -@return apiGetUserRequest +@return apiGetWebhooksRequest */ -func (a *ManagementApiService) GetUser(ctx _context.Context, userId int32) apiGetUserRequest { - return apiGetUserRequest{ +func (a *ManagementApiService) GetWebhooks(ctx _context.Context) apiGetWebhooksRequest { + return apiGetWebhooksRequest{ apiService: a, ctx: ctx, - userId: userId, } } /* Execute executes the request - @return User + @return InlineResponse20026 */ -func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { +func (r apiGetWebhooksRequest) Execute() (InlineResponse20026, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue User + localVarReturnValue InlineResponse20026 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUser") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhooks") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/users/{userId}" - localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(r.userId, "")), -1) + localVarPath := localBasePath + "/v1/webhooks" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.applicationIds != nil { + localVarQueryParams.Add("applicationIds", parameterToString(*r.applicationIds, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -10200,7 +12600,7 @@ func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v User + var v InlineResponse20026 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10223,79 +12623,82 @@ func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetUsersRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string +type apiImportAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 + upFile *string } -func (r apiGetUsersRequest) PageSize(pageSize int32) apiGetUsersRequest { - r.pageSize = &pageSize +func (r apiImportAccountCollectionRequest) UpFile(upFile string) apiImportAccountCollectionRequest { + r.upFile = &upFile return r } -func (r apiGetUsersRequest) Skip(skip int32) apiGetUsersRequest { - r.skip = &skip - return r -} +/* +ImportAccountCollection Import data in existing account-level collection +Upload a CSV file containing the collection of string values that should be attached as payload for collection. +The file should be sent as multipart data. -func (r apiGetUsersRequest) Sort(sort string) apiGetUsersRequest { - r.sort = &sort - return r -} +The import **replaces** the initial content of the collection. -/* -GetUsers List users in account -Retrieve all users in your account. +The CSV file **must** only contain the following column: + +- `item`: the values in your collection. + +A collection is limited to 500,000 items. + +Example: + +``` +item +Addidas +Nike +Asics +``` + +**Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetUsersRequest + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiImportAccountCollectionRequest */ -func (a *ManagementApiService) GetUsers(ctx _context.Context) apiGetUsersRequest { - return apiGetUsersRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) ImportAccountCollection(ctx _context.Context, collectionId int32) apiImportAccountCollectionRequest { + return apiImportAccountCollectionRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, } } /* Execute executes the request - @return InlineResponse20026 + @return Import */ -func (r apiGetUsersRequest) Execute() (InlineResponse20026, *_nethttp.Response, error) { +func (r apiImportAccountCollectionRequest) Execute() (Import, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20026 + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUsers") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportAccountCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/users" + localVarPath := localBasePath + "/v1/collections/{collectionId}/import" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"multipart/form-data"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10311,6 +12714,9 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20026, *_nethttp.Response, if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -10347,7 +12753,27 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20026, *_nethttp.Response, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20026 + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10370,55 +12796,81 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20026, *_nethttp.Response, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetWebhookRequest struct { - ctx _context.Context - apiService *ManagementApiService - webhookId int32 +type apiImportAllowedListRequest struct { + ctx _context.Context + apiService *ManagementApiService + attributeId int32 + upFile *string +} + +func (r apiImportAllowedListRequest) UpFile(upFile string) apiImportAllowedListRequest { + r.upFile = &upFile + return r } /* -GetWebhook Get Webhook -Returns an webhook by its id. +ImportAllowedList Import allowed values for attribute +Upload a CSV file containing a list of allowed values for the specified attribute. +These values are also called [picklist values](/docs/product/account/dev-tools/managing-attributes/#picklist-values). + +The file should be sent as multipart data. + +The import **replaces** the previous list of allowed values for this attribute, if any. + +The CSV file **must** only contain the following column: +- `item` (required): the values in your allowed list, for example a list of SKU's. + +An allowed list is limited to 500,000 items. + +Example: + +```text +item +CS-VG-04032021-UP-50D-10 +CS-DV-04042021-UP-49D-12 +CS-DG-02082021-UP-50G-07 +``` + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param webhookId -@return apiGetWebhookRequest + * @param attributeId +@return apiImportAllowedListRequest */ -func (a *ManagementApiService) GetWebhook(ctx _context.Context, webhookId int32) apiGetWebhookRequest { - return apiGetWebhookRequest{ - apiService: a, - ctx: ctx, - webhookId: webhookId, +func (a *ManagementApiService) ImportAllowedList(ctx _context.Context, attributeId int32) apiImportAllowedListRequest { + return apiImportAllowedListRequest{ + apiService: a, + ctx: ctx, + attributeId: attributeId, } } /* Execute executes the request - @return Webhook + @return Import */ -func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { +func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Webhook + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhook") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportAllowedList") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhooks/{webhookId}" - localVarPath = strings.Replace(localVarPath, "{"+"webhookId"+"}", _neturl.QueryEscape(parameterToString(r.webhookId, "")), -1) + localVarPath := localBasePath + "/v1/attributes/{attributeId}/allowed_list/import" + localVarPath = strings.Replace(localVarPath, "{"+"attributeId"+"}", _neturl.QueryEscape(parameterToString(r.attributeId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"multipart/form-data"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10434,6 +12886,9 @@ func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -10470,7 +12925,37 @@ func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Webhook + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10493,132 +12978,90 @@ func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetWebhookActivationLogsRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string - integrationRequestUuid *string - webhookId *float32 - applicationId *float32 - campaignId *float32 - createdBefore *time.Time - createdAfter *time.Time +type apiImportCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 + upFile *string } -func (r apiGetWebhookActivationLogsRequest) PageSize(pageSize int32) apiGetWebhookActivationLogsRequest { - r.pageSize = &pageSize +func (r apiImportCollectionRequest) UpFile(upFile string) apiImportCollectionRequest { + r.upFile = &upFile return r } -func (r apiGetWebhookActivationLogsRequest) Skip(skip int32) apiGetWebhookActivationLogsRequest { - r.skip = &skip - return r -} +/* +ImportCollection Import data in existing collection +Upload a CSV file containing the collection of string values that should be attached as payload for collection. +The file should be sent as multipart data. -func (r apiGetWebhookActivationLogsRequest) Sort(sort string) apiGetWebhookActivationLogsRequest { - r.sort = &sort - return r -} +The import **replaces** the initial content of the collection. -func (r apiGetWebhookActivationLogsRequest) IntegrationRequestUuid(integrationRequestUuid string) apiGetWebhookActivationLogsRequest { - r.integrationRequestUuid = &integrationRequestUuid - return r -} +The CSV file **must** only contain the following column: -func (r apiGetWebhookActivationLogsRequest) WebhookId(webhookId float32) apiGetWebhookActivationLogsRequest { - r.webhookId = &webhookId - return r -} +- `item`: the values in your collection. -func (r apiGetWebhookActivationLogsRequest) ApplicationId(applicationId float32) apiGetWebhookActivationLogsRequest { - r.applicationId = &applicationId - return r -} +A collection is limited to 500,000 items. -func (r apiGetWebhookActivationLogsRequest) CampaignId(campaignId float32) apiGetWebhookActivationLogsRequest { - r.campaignId = &campaignId - return r -} +Example: -func (r apiGetWebhookActivationLogsRequest) CreatedBefore(createdBefore time.Time) apiGetWebhookActivationLogsRequest { - r.createdBefore = &createdBefore - return r -} +``` +item +Addidas +Nike +Asics +``` -func (r apiGetWebhookActivationLogsRequest) CreatedAfter(createdAfter time.Time) apiGetWebhookActivationLogsRequest { - r.createdAfter = &createdAfter - return r -} +**Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection. -/* -GetWebhookActivationLogs List webhook activation log entries -Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetWebhookActivationLogsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiImportCollectionRequest */ -func (a *ManagementApiService) GetWebhookActivationLogs(ctx _context.Context) apiGetWebhookActivationLogsRequest { - return apiGetWebhookActivationLogsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) ImportCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiImportCollectionRequest { + return apiImportCollectionRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + collectionId: collectionId, } } /* Execute executes the request - @return InlineResponse20023 + @return Import */ -func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20023, *_nethttp.Response, error) { +func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20023 + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookActivationLogs") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhook_activation_logs" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.integrationRequestUuid != nil { - localVarQueryParams.Add("integrationRequestUuid", parameterToString(*r.integrationRequestUuid, "")) - } - if r.webhookId != nil { - localVarQueryParams.Add("webhookId", parameterToString(*r.webhookId, "")) - } - if r.applicationId != nil { - localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) - } - if r.campaignId != nil { - localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"multipart/form-data"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10634,6 +13077,9 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20023, *_ne if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -10670,7 +13116,17 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20023, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20023 + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10690,144 +13146,94 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20023, *_ne return localVarReturnValue, localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil -} - -type apiGetWebhookLogsRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string - status *string - webhookId *float32 - applicationId *float32 - campaignId *float32 - requestUuid *string - createdBefore *time.Time - createdAfter *time.Time -} - -func (r apiGetWebhookLogsRequest) PageSize(pageSize int32) apiGetWebhookLogsRequest { - r.pageSize = &pageSize - return r + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiGetWebhookLogsRequest) Skip(skip int32) apiGetWebhookLogsRequest { - r.skip = &skip - return r +type apiImportCouponsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + upFile *string } -func (r apiGetWebhookLogsRequest) Sort(sort string) apiGetWebhookLogsRequest { - r.sort = &sort +func (r apiImportCouponsRequest) UpFile(upFile string) apiImportCouponsRequest { + r.upFile = &upFile return r } -func (r apiGetWebhookLogsRequest) Status(status string) apiGetWebhookLogsRequest { - r.status = &status - return r -} +/* +ImportCoupons Import coupons +Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. -func (r apiGetWebhookLogsRequest) WebhookId(webhookId float32) apiGetWebhookLogsRequest { - r.webhookId = &webhookId - return r -} +The CSV file can contain the following columns: -func (r apiGetWebhookLogsRequest) ApplicationId(applicationId float32) apiGetWebhookLogsRequest { - r.applicationId = &applicationId - return r -} +- `value` (required): The coupon code. +- `expirydate`: The end date in RFC3339 of the code redemption period. +- `startdate`: The start date in RFC3339 of the code redemption period. +- `limitval`: The maximum amount of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. +- `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. +- `discountlimit`: The amount of discounts that can be given with this coupon code. + For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) + called `category` associated to the coupon entity, set it with `"{""category"": ""10_off""}"`. -func (r apiGetWebhookLogsRequest) CampaignId(campaignId float32) apiGetWebhookLogsRequest { - r.campaignId = &campaignId - return r -} +**Important:** Do not leave empty columns in the file. -func (r apiGetWebhookLogsRequest) RequestUuid(requestUuid string) apiGetWebhookLogsRequest { - r.requestUuid = &requestUuid - return r -} +You can use the timezone of your choice. It is converted to UTC internally by Talon.One. -func (r apiGetWebhookLogsRequest) CreatedBefore(createdBefore time.Time) apiGetWebhookLogsRequest { - r.createdBefore = &createdBefore - return r -} +**Example:** -func (r apiGetWebhookLogsRequest) CreatedAfter(createdAfter time.Time) apiGetWebhookLogsRequest { - r.createdAfter = &createdAfter - return r -} +```text +"value","expirydate","startdate","recipientintegrationid","limitval","attributes","discountlimit" +COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"": ""10_off""}",2.4 +``` + +Once imported, you can find the `batchId` in the Campaign Manager or by +using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). -/* -GetWebhookLogs List webhook log entries -Retrieve all webhook log entries. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetWebhookLogsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiImportCouponsRequest */ -func (a *ManagementApiService) GetWebhookLogs(ctx _context.Context) apiGetWebhookLogsRequest { - return apiGetWebhookLogsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) ImportCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiImportCouponsRequest { + return apiImportCouponsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse20024 + @return Import */ -func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20024, *_nethttp.Response, error) { +func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20024 + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookLogs") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCoupons") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhook_logs" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.status != nil { - localVarQueryParams.Add("status", parameterToString(*r.status, "")) - } - if r.webhookId != nil { - localVarQueryParams.Add("webhookId", parameterToString(*r.webhookId, "")) - } - if r.applicationId != nil { - localVarQueryParams.Add("applicationId", parameterToString(*r.applicationId, "")) - } - if r.campaignId != nil { - localVarQueryParams.Add("campaignId", parameterToString(*r.campaignId, "")) - } - if r.requestUuid != nil { - localVarQueryParams.Add("requestUuid", parameterToString(*r.requestUuid, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"multipart/form-data"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10843,6 +13249,9 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20024, *_nethttp.Resp if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -10879,7 +13288,7 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20024, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20024 + var v Import err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10902,87 +13311,86 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20024, *_nethttp.Resp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetWebhooksRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationIds *string - sort *string - pageSize *int32 - skip *int32 +type apiImportLoyaltyPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + upFile *string } -func (r apiGetWebhooksRequest) ApplicationIds(applicationIds string) apiGetWebhooksRequest { - r.applicationIds = &applicationIds +func (r apiImportLoyaltyPointsRequest) UpFile(upFile string) apiImportLoyaltyPointsRequest { + r.upFile = &upFile return r } -func (r apiGetWebhooksRequest) Sort(sort string) apiGetWebhooksRequest { - r.sort = &sort - return r -} +/* +ImportLoyaltyPoints Import loyalty points +Upload a CSV file containing the [loyalty](https://www.talon.one/pillar-pages/loyalty) points that should be created. +The file should be sent as multipart data. -func (r apiGetWebhooksRequest) PageSize(pageSize int32) apiGetWebhooksRequest { - r.pageSize = &pageSize - return r -} +**Important**: For existing customer profiles, the imported points are _added_ to +their active points. Learn more about [Loyalty programs](https://docs.talon.one/docs/product/loyalty-programs/overview). -func (r apiGetWebhooksRequest) Skip(skip int32) apiGetWebhooksRequest { - r.skip = &skip - return r -} +The CSV file can contain the following columns: + +- `customerprofileid`: The integration ID of the customer profile that should receive the loyalty points. +- `amount`: The amount of points to award to the customer profile. +- `startdate`: The earliest date when the points can be redeemed. On this date and until the expiry date, the points are `active`. +- `expirydate`: The latest date when the points can be redeemed. After this date, the points are `expired`. +- `subledgerid` (optional): The ID of the subledger that should received the points. +- `reason` (optional): A reason why these points were awarded. + +**Important:** Do not leave empty columns in the file. + +You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + +**Example:** + +```text +customerprofileid,amount,startdate,expirydate,subledgerid,reason +URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement +``` -/* -GetWebhooks List webhooks -List all webhooks. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetWebhooksRequest + * @param loyaltyProgramId Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). +@return apiImportLoyaltyPointsRequest */ -func (a *ManagementApiService) GetWebhooks(ctx _context.Context) apiGetWebhooksRequest { - return apiGetWebhooksRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) ImportLoyaltyPoints(ctx _context.Context, loyaltyProgramId int32) apiImportLoyaltyPointsRequest { + return apiImportLoyaltyPointsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return InlineResponse20022 + @return Import */ -func (r apiGetWebhooksRequest) Execute() (InlineResponse20022, *_nethttp.Response, error) { +func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20022 + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhooks") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportLoyaltyPoints") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhooks" + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/import_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.applicationIds != nil { - localVarQueryParams.Add("applicationIds", parameterToString(*r.applicationIds, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"multipart/form-data"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10998,6 +13406,9 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20022, *_nethttp.Respons if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -11034,7 +13445,7 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20022, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20022 + var v Import err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11057,36 +13468,53 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20022, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportCollectionRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - collectionId int32 - upFile *string +type apiImportPoolGiveawaysRequest struct { + ctx _context.Context + apiService *ManagementApiService + poolId int32 + upFile *string } -func (r apiImportCollectionRequest) UpFile(upFile string) apiImportCollectionRequest { +func (r apiImportPoolGiveawaysRequest) UpFile(upFile string) apiImportPoolGiveawaysRequest { r.upFile = &upFile return r } /* -ImportCollection Import collection via CSV file -Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. +ImportPoolGiveaways Import giveaway codes into a giveaway pool +Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. + +The CSV file can contain the following columns: +- `code` (required): the code of your giveaway, for instance, a gift card redemption code. +- `startdate`: the start date in RFC3339 of the code redemption period. +- `enddate`: the last date in RFC3339 of the code redemption period. +- `attributes`: A json object describing _custom_ giveaway attribute names and their values. Double the double-quotes in the object. + For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) + called `provider` associated to the giveaway entity, set it with `"{""provider"": ""myPartnerCompany""}"`. + +**Important:** Do not leave empty columns in the file. + +The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. +You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + +**Example:** + +```text +code,startdate,enddate,attributes +GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}" +GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Amazon""}" +GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"{""provider"": ""Aliexpress""}" +``` + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId - * @param collectionId -@return apiImportCollectionRequest + * @param poolId +@return apiImportPoolGiveawaysRequest */ -func (a *ManagementApiService) ImportCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiImportCollectionRequest { - return apiImportCollectionRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, - collectionId: collectionId, +func (a *ManagementApiService) ImportPoolGiveaways(ctx _context.Context, poolId int32) apiImportPoolGiveawaysRequest { + return apiImportPoolGiveawaysRequest{ + apiService: a, + ctx: ctx, + poolId: poolId, } } @@ -11094,7 +13522,7 @@ func (a *ManagementApiService) ImportCollection(ctx _context.Context, applicatio Execute executes the request @return Import */ -func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -11104,15 +13532,13 @@ func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCollection") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportPoolGiveaways") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + localVarPath := localBasePath + "/v1/giveaways/pools/{poolId}/import" + localVarPath = strings.Replace(localVarPath, "{"+"poolId"+"}", _neturl.QueryEscape(parameterToString(r.poolId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -11197,7 +13623,7 @@ func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportCouponsRequest struct { +type apiImportReferralsRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 @@ -11205,43 +13631,45 @@ type apiImportCouponsRequest struct { upFile *string } -func (r apiImportCouponsRequest) UpFile(upFile string) apiImportCouponsRequest { +func (r apiImportReferralsRequest) UpFile(upFile string) apiImportReferralsRequest { r.upFile = &upFile return r } /* -ImportCoupons Import coupons via CSV file -Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. +ImportReferrals Import referrals +Upload a CSV file containing the referrals that should be created. +The file should be sent as multipart data. The CSV file can contain the following columns: -- `value` (required): The coupon code. -- `expirydate`: The end date in RFC3339 of the code redemption period. +- `code` (required): The referral code. +- `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. -- `limitval`: The maximum amount of redemptions of this code. Defaults to `1` when not provided. +- `expirydate`: The end date in RFC3339 of the code redemption period. +- `limitval`: The maximum amount of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. - For example, if you created a custom attribute called `category`, set it with `"{""category"": ""10_off""}"`. -You can use thhe timezone of your choice. It is converted to UTC internally by Talon.One. + For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) + called `category` associated to the referral entity, set it with `"{""category"": ""10_off""}"`. -Example: +You can use the timezone of your choice. It is converted to UTC internally by Talon.One. -``` -"value","expirydate","startdate","recipientintegrationid","limitval","attributes" -COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"{""Category"": ""10_off""}" -``` +**Example:** -Once imported, you can find the `batchId` in the Campaign Manager or by -using [List coupons](#operation/getReservedCustomers). +```text +code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes +REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"{""my_attribute"": ""10_off""}" +REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"{""my_attribute"": ""20_off""}" +``` * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiImportCouponsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiImportReferralsRequest */ -func (a *ManagementApiService) ImportCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiImportCouponsRequest { - return apiImportCouponsRequest{ +func (a *ManagementApiService) ImportReferrals(ctx _context.Context, applicationId int32, campaignId int32) apiImportReferralsRequest { + return apiImportReferralsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -11253,7 +13681,7 @@ func (a *ManagementApiService) ImportCoupons(ctx _context.Context, applicationId Execute executes the request @return Import */ -func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -11263,12 +13691,12 @@ func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCoupons") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportReferrals") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) @@ -11355,83 +13783,96 @@ func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportLoyaltyPointsRequest struct { - ctx _context.Context - apiService *ManagementApiService - programID int32 - upFile *string +type apiListAccountCollectionsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool + name *string } -func (r apiImportLoyaltyPointsRequest) UpFile(upFile string) apiImportLoyaltyPointsRequest { - r.upFile = &upFile +func (r apiListAccountCollectionsRequest) PageSize(pageSize int32) apiListAccountCollectionsRequest { + r.pageSize = &pageSize return r } -/* -ImportLoyaltyPoints Import loyalty points via CSV file -Upload a CSV file containing the [loyalty](https://www.talon.one/pillar-pages/loyalty) points that should be created. -The file should be sent as multipart data. - -**Important**: Importing points does **not** overwrite existing points for any customer. - -The CSV file can contain the following columns: - -- `customerprofileid`: The integration ID of the customer profile that should receive the loyalty points. -- `amount`: The amount of points to award to the customer profile. -- `startdate`: The earliest date when the points can be redeemed. On this date and until the expiry date, the points are `active`. -- `expirydate`: The latest date when the points can be redeemed. After this date, the points are `expired`. -- `subledgerid` (optional): The ID of the subledger that should received the points. -- `reason` (optional): A reason why these points were awarded. +func (r apiListAccountCollectionsRequest) Skip(skip int32) apiListAccountCollectionsRequest { + r.skip = &skip + return r +} -You can use the timezone of your choice. It is converted to UTC internally by Talon.One. +func (r apiListAccountCollectionsRequest) Sort(sort string) apiListAccountCollectionsRequest { + r.sort = &sort + return r +} -Example: +func (r apiListAccountCollectionsRequest) WithTotalResultSize(withTotalResultSize bool) apiListAccountCollectionsRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} -```csv -customerprofileid,amount,startdate,expirydate,subledgerid,reason -URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement -``` +func (r apiListAccountCollectionsRequest) Name(name string) apiListAccountCollectionsRequest { + r.name = &name + return r +} +/* +ListAccountCollections List collections in account +List collections in account. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID -@return apiImportLoyaltyPointsRequest +@return apiListAccountCollectionsRequest */ -func (a *ManagementApiService) ImportLoyaltyPoints(ctx _context.Context, programID int32) apiImportLoyaltyPointsRequest { - return apiImportLoyaltyPointsRequest{ +func (a *ManagementApiService) ListAccountCollections(ctx _context.Context) apiListAccountCollectionsRequest { + return apiListAccountCollectionsRequest{ apiService: a, ctx: ctx, - programID: programID, } } /* Execute executes the request - @return Import + @return InlineResponse2009 */ -func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiListAccountCollectionsRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Import + localVarReturnValue InlineResponse2009 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportLoyaltyPoints") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListAccountCollections") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/import_points" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + localVarPath := localBasePath + "/v1/collections" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } + if r.name != nil { + localVarQueryParams.Add("name", parameterToString(*r.name, "")) + } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"multipart/form-data"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -11447,9 +13888,6 @@ func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, er if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - if r.upFile != nil { - localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) - } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -11486,7 +13924,37 @@ func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, er error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Import + var v InlineResponse2009 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11509,72 +13977,104 @@ func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, er return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportPoolGiveawaysRequest struct { - ctx _context.Context - apiService *ManagementApiService - poolId int32 - upFile *string +type apiListCollectionsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool + name *string } -func (r apiImportPoolGiveawaysRequest) UpFile(upFile string) apiImportPoolGiveawaysRequest { - r.upFile = &upFile +func (r apiListCollectionsRequest) PageSize(pageSize int32) apiListCollectionsRequest { + r.pageSize = &pageSize return r } -/* -ImportPoolGiveaways Import giveaway codes into a giveaway pool -Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. +func (r apiListCollectionsRequest) Skip(skip int32) apiListCollectionsRequest { + r.skip = &skip + return r +} -The CSV file can contain the following columns: -- `code` (required): the code of your giveaway, for instance, a gift card redemption code. -- `startdate`: the start date in RFC3339 of the code redemption period. -- `enddate`: the last date in RFC3339 of the code redemption period. -- `attributes`: A json object describing _custom_ giveaway attribute names and their values. Double the double-quotes in the object. - For example, if you created a custom attribute called `provider`, set it with `"{""provider"": ""myPartnerCompany""}"`. +func (r apiListCollectionsRequest) Sort(sort string) apiListCollectionsRequest { + r.sort = &sort + return r +} -The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. -You can use the timezone of your choice. It is converted to UTC internally by Talon.One. +func (r apiListCollectionsRequest) WithTotalResultSize(withTotalResultSize bool) apiListCollectionsRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} + +func (r apiListCollectionsRequest) Name(name string) apiListCollectionsRequest { + r.name = &name + return r +} +/* +ListCollections List collections +List collections in the campaign. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param poolId -@return apiImportPoolGiveawaysRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. +@return apiListCollectionsRequest */ -func (a *ManagementApiService) ImportPoolGiveaways(ctx _context.Context, poolId int32) apiImportPoolGiveawaysRequest { - return apiImportPoolGiveawaysRequest{ - apiService: a, - ctx: ctx, - poolId: poolId, +func (a *ManagementApiService) ListCollections(ctx _context.Context, applicationId int32, campaignId int32) apiListCollectionsRequest { + return apiListCollectionsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return Import + @return InlineResponse20011 */ -func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiListCollectionsRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Import + localVarReturnValue InlineResponse20011 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportPoolGiveaways") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListCollections") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/giveaways/pools/{poolId}/import" - localVarPath = strings.Replace(localVarPath, "{"+"poolId"+"}", _neturl.QueryEscape(parameterToString(r.poolId, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } + if r.name != nil { + localVarQueryParams.Add("name", parameterToString(*r.name, "")) + } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"multipart/form-data"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -11590,9 +14090,6 @@ func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, er if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - if r.upFile != nil { - localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) - } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -11629,7 +14126,17 @@ func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, er error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Import + var v InlineResponse20011 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11652,79 +14159,100 @@ func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, er return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportReferralsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - upFile *string +type apiListCollectionsInApplicationRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool + name *string +} + +func (r apiListCollectionsInApplicationRequest) PageSize(pageSize int32) apiListCollectionsInApplicationRequest { + r.pageSize = &pageSize + return r +} + +func (r apiListCollectionsInApplicationRequest) Skip(skip int32) apiListCollectionsInApplicationRequest { + r.skip = &skip + return r +} + +func (r apiListCollectionsInApplicationRequest) Sort(sort string) apiListCollectionsInApplicationRequest { + r.sort = &sort + return r +} + +func (r apiListCollectionsInApplicationRequest) WithTotalResultSize(withTotalResultSize bool) apiListCollectionsInApplicationRequest { + r.withTotalResultSize = &withTotalResultSize + return r } -func (r apiImportReferralsRequest) UpFile(upFile string) apiImportReferralsRequest { - r.upFile = &upFile +func (r apiListCollectionsInApplicationRequest) Name(name string) apiListCollectionsInApplicationRequest { + r.name = &name return r } /* -ImportReferrals Import referrals via CSV file -Upload a CSV file containing the referrals that should be created. -The file should be sent as multipart data. - -The CSV file can contain the following columns: - -- `code` (required): The referral code. -- `advocateprofileintegrationid` (required): The profile ID of the advocate. -- `startdate`: The start date in RFC3339 of the code redemption period. -- `expirydate`: The end date in RFC3339 of the code redemption period. -- `limitval`: The maximum amount of redemptions of this code. Unlimited (0) when blank. -- `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. - For example, if you created a custom attribute called `category`, set it with `"{""category"": ""10_off""}"`. - -You can use the timezone of your choice. It is converted to UTC internally by Talon.One. - +ListCollectionsInApplication List collections in application +List collections from all campaigns in the Application. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId -@return apiImportReferralsRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. +@return apiListCollectionsInApplicationRequest */ -func (a *ManagementApiService) ImportReferrals(ctx _context.Context, applicationId int32, campaignId int32) apiImportReferralsRequest { - return apiImportReferralsRequest{ +func (a *ManagementApiService) ListCollectionsInApplication(ctx _context.Context, applicationId int32) apiListCollectionsInApplicationRequest { + return apiListCollectionsInApplicationRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, } } /* Execute executes the request - @return Import + @return InlineResponse20011 */ -func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiListCollectionsInApplicationRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Import + localVarReturnValue InlineResponse20011 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportReferrals") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListCollectionsInApplication") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals" + localVarPath := localBasePath + "/v1/applications/{applicationId}/collections" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } + if r.name != nil { + localVarQueryParams.Add("name", parameterToString(*r.name, "")) + } // to determine the Content-Type header - localVarHTTPContentTypes := []string{"multipart/form-data"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -11740,9 +14268,6 @@ func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - if r.upFile != nil { - localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) - } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -11779,7 +14304,17 @@ func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Import + var v InlineResponse20011 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11803,11 +14338,11 @@ func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) } type apiRemoveLoyaltyPointsRequest struct { - ctx _context.Context - apiService *ManagementApiService - programID string - integrationID string - body *LoyaltyPoints + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId string + integrationId string + body *LoyaltyPoints } func (r apiRemoveLoyaltyPointsRequest) Body(body LoyaltyPoints) apiRemoveLoyaltyPointsRequest { @@ -11823,16 +14358,16 @@ To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID - * @param integrationID + * @param loyaltyProgramId The identifier for the loyalty program. + * @param integrationId The identifier of the profile. @return apiRemoveLoyaltyPointsRequest */ -func (a *ManagementApiService) RemoveLoyaltyPoints(ctx _context.Context, programID string, integrationID string) apiRemoveLoyaltyPointsRequest { +func (a *ManagementApiService) RemoveLoyaltyPoints(ctx _context.Context, loyaltyProgramId string, integrationId string) apiRemoveLoyaltyPointsRequest { return apiRemoveLoyaltyPointsRequest{ - apiService: a, - ctx: ctx, - programID: programID, - integrationID: integrationID, + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, } } @@ -11854,9 +14389,9 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationID"+"}", _neturl.QueryEscape(parameterToString(r.integrationID, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -11876,7 +14411,7 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -11920,6 +14455,35 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.model = v + } return localVarHTTPResponse, newErr } @@ -12150,11 +14714,16 @@ func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Campaig } /* -SearchCouponsAdvancedApplicationWideWithoutTotalCount List coupons that match the given attributes in all active campaigns of an application -Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application +SearchCouponsAdvancedApplicationWideWithoutTotalCount List coupons that match the given attributes (without total count) +List the coupons whose attributes match the query criteria in all **active** campaigns of the given Application. + +The match is successful if all the attributes of the request are found in a coupon, +even if the coupon has more attributes that are not present on the request. + +**Note:** The total count is not included in the response. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. @return apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest */ func (a *ManagementApiService) SearchCouponsAdvancedApplicationWideWithoutTotalCount(ctx _context.Context, applicationId int32) apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest { @@ -12167,16 +14736,16 @@ func (a *ManagementApiService) SearchCouponsAdvancedApplicationWideWithoutTotalC /* Execute executes the request - @return InlineResponse2005 + @return InlineResponse2006 */ -func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { +func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2005 + localVarReturnValue InlineResponse2006 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.SearchCouponsAdvancedApplicationWideWithoutTotalCount") @@ -12289,7 +14858,7 @@ func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2005 + var v InlineResponse2006 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12398,12 +14967,18 @@ func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) BatchId(batchId string } /* -SearchCouponsAdvancedWithoutTotalCount List coupons that match the given attributes -Gets a list of all the coupons with attributes matching the query criteria +SearchCouponsAdvancedWithoutTotalCount List coupons that match the given attributes in campaign (without total count) +List the coupons whose attributes match the query criteria +in the given campaign. + +The match is successful if all the attributes of the request are found in a coupon, +even if the coupon has more attributes that are not present on the request. + +**Note:** The total count is not included in the response. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. @return apiSearchCouponsAdvancedWithoutTotalCountRequest */ func (a *ManagementApiService) SearchCouponsAdvancedWithoutTotalCount(ctx _context.Context, applicationId int32, campaignId int32) apiSearchCouponsAdvancedWithoutTotalCountRequest { @@ -12417,26 +14992,197 @@ func (a *ManagementApiService) SearchCouponsAdvancedWithoutTotalCount(ctx _conte /* Execute executes the request - @return InlineResponse2005 + @return InlineResponse2006 */ -func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { +func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2005 + localVarReturnValue InlineResponse2006 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.SearchCouponsAdvancedWithoutTotalCount") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + if r.value != nil { + localVarQueryParams.Add("value", parameterToString(*r.value, "")) + } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } + if r.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) + } + if r.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) + } + if r.referralId != nil { + localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) + } + if r.recipientIntegrationId != nil { + localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) + } + if r.exactMatch != nil { + localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) + } + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse2006 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiUpdateAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 + body *UpdateCollection +} + +func (r apiUpdateAccountCollectionRequest) Body(body UpdateCollection) apiUpdateAccountCollectionRequest { + r.body = &body + return r +} + +/* +UpdateAccountCollection Update account-level collection +Edit the description of the account-level collection and enable or disable the collection in the specified Applications. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiUpdateAccountCollectionRequest +*/ +func (a *ManagementApiService) UpdateAccountCollection(ctx _context.Context, collectionId int32) apiUpdateAccountCollectionRequest { + return apiUpdateAccountCollectionRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, + } +} + +/* +Execute executes the request + @return Collection +*/ +func (r apiUpdateAccountCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.SearchCouponsAdvancedWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateAccountCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath := localBasePath + "/v1/collections/{collectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -12446,42 +15192,6 @@ func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineRespo return localVarReturnValue, nil, reportError("body is required and must be specified") } - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) - } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) - } - if r.sort != nil { - localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) - } - if r.value != nil { - localVarQueryParams.Add("value", parameterToString(*r.value, "")) - } - if r.createdBefore != nil { - localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) - } - if r.createdAfter != nil { - localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) - } - if r.valid != nil { - localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) - } - if r.usable != nil { - localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) - } - if r.referralId != nil { - localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) - } - if r.recipientIntegrationId != nil { - localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) - } - if r.exactMatch != nil { - localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) - } - if r.batchId != nil { - localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -12537,7 +15247,37 @@ func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineRespo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2005 + var v Collection + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12573,7 +15313,7 @@ func (r apiUpdateAdditionalCostRequest) Body(body NewAdditionalCost) apiUpdateAd } /* -UpdateAdditionalCost Update an additional cost +UpdateAdditionalCost Update additional cost Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -12709,7 +15449,7 @@ func (r apiUpdateAttributeRequest) Body(body NewAttribute) apiUpdateAttributeReq } /* -UpdateAttribute Update a custom attribute +UpdateAttribute Update custom attribute Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one. @@ -12851,8 +15591,8 @@ func (r apiUpdateCampaignRequest) Body(body UpdateCampaign) apiUpdateCampaignReq UpdateCampaign Update campaign Update the given campaign. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. @return apiUpdateCampaignRequest */ func (a *ManagementApiService) UpdateCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiUpdateCampaignRequest { @@ -12973,6 +15713,159 @@ func (r apiUpdateCampaignRequest) Execute() (Campaign, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, nil } +type apiUpdateCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 + body *UpdateCampaignCollection +} + +func (r apiUpdateCollectionRequest) Body(body UpdateCampaignCollection) apiUpdateCollectionRequest { + r.body = &body + return r +} + +/* +UpdateCollection Update collection description +Edit the description of the collection. + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param collectionId The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). +@return apiUpdateCollectionRequest +*/ +func (a *ManagementApiService) UpdateCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiUpdateCollectionRequest { + return apiUpdateCollectionRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + collectionId: collectionId, + } +} + +/* +Execute executes the request + @return Collection +*/ +func (r apiUpdateCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Collection + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateCollection") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Collection + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type apiUpdateCouponRequest struct { ctx _context.Context apiService *ManagementApiService @@ -12991,8 +15884,8 @@ func (r apiUpdateCouponRequest) Body(body UpdateCoupon) apiUpdateCouponRequest { UpdateCoupon Update coupon Update the specified coupon. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. * @param couponId The ID of the coupon code to update @return apiUpdateCouponRequest */ @@ -13130,15 +16023,20 @@ func (r apiUpdateCouponBatchRequest) Body(body UpdateCouponBatch) apiUpdateCoupo } /* -UpdateCouponBatch Update a batch of coupons -Update a batch of coupons. You can find the `batchId` in the **Coupons** view of your Application +UpdateCouponBatch Update coupons +Update all coupons of an campaign, or a specific batch of coupons. +You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager or by using [List coupons](#operation/getCouponsWithoutTotalCount). +**Important**: +- Only send sequential requests to this endpoint. +- Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team. + To update a specific coupon, use [Update coupon](#operation/updateCoupon). * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. @return apiUpdateCouponBatchRequest */ func (a *ManagementApiService) UpdateCouponBatch(ctx _context.Context, applicationId int32, campaignId int32) apiUpdateCouponBatchRequest { @@ -13240,62 +16138,58 @@ func (r apiUpdateCouponBatchRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } -type apiUpdateReferralRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - referralId string - body *UpdateReferral +type apiUpdateNotificationWebhookRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + notificationWebhookId int32 + body *NewNotificationWebhook } -func (r apiUpdateReferralRequest) Body(body UpdateReferral) apiUpdateReferralRequest { +func (r apiUpdateNotificationWebhookRequest) Body(body NewNotificationWebhook) apiUpdateNotificationWebhookRequest { r.body = &body return r } /* -UpdateReferral Update referral -Update the specified referral. +UpdateNotificationWebhook Update notification webhook +Update the given outbound notification webhook. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId - * @param referralId The ID of the referral code to delete -@return apiUpdateReferralRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param notificationWebhookId +@return apiUpdateNotificationWebhookRequest */ -func (a *ManagementApiService) UpdateReferral(ctx _context.Context, applicationId int32, campaignId int32, referralId string) apiUpdateReferralRequest { - return apiUpdateReferralRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, - referralId: referralId, +func (a *ManagementApiService) UpdateNotificationWebhook(ctx _context.Context, applicationId int32, notificationWebhookId int32) apiUpdateNotificationWebhookRequest { + return apiUpdateNotificationWebhookRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + notificationWebhookId: notificationWebhookId, } } /* Execute executes the request - @return Referral + @return NotificationWebhook */ -func (r apiUpdateReferralRequest) Execute() (Referral, *_nethttp.Response, error) { +func (r apiUpdateNotificationWebhookRequest) Execute() (NotificationWebhook, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPut localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Referral + localVarReturnValue NotificationWebhook ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateReferral") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateNotificationWebhook") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"referralId"+"}", _neturl.QueryEscape(parameterToString(r.referralId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"notificationWebhookId"+"}", _neturl.QueryEscape(parameterToString(r.notificationWebhookId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -13360,7 +16254,7 @@ func (r apiUpdateReferralRequest) Execute() (Referral, *_nethttp.Response, error error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Referral + var v NotificationWebhook err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -13383,62 +16277,62 @@ func (r apiUpdateReferralRequest) Execute() (Referral, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, nil } -type apiUpdateRulesetRequest struct { +type apiUpdateReferralRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - rulesetId int32 - body *NewRuleset + referralId string + body *UpdateReferral } -func (r apiUpdateRulesetRequest) Body(body NewRuleset) apiUpdateRulesetRequest { +func (r apiUpdateReferralRequest) Body(body UpdateReferral) apiUpdateReferralRequest { r.body = &body return r } /* -UpdateRuleset Update ruleset -Update a ruleset. +UpdateReferral Update referral +Update the specified referral. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId - * @param campaignId - * @param rulesetId -@return apiUpdateRulesetRequest + * @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + * @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + * @param referralId The ID of the referral code to delete +@return apiUpdateReferralRequest */ -func (a *ManagementApiService) UpdateRuleset(ctx _context.Context, applicationId int32, campaignId int32, rulesetId int32) apiUpdateRulesetRequest { - return apiUpdateRulesetRequest{ +func (a *ManagementApiService) UpdateReferral(ctx _context.Context, applicationId int32, campaignId int32, referralId string) apiUpdateReferralRequest { + return apiUpdateReferralRequest{ apiService: a, ctx: ctx, applicationId: applicationId, campaignId: campaignId, - rulesetId: rulesetId, + referralId: referralId, } } /* Execute executes the request - @return Ruleset + @return Referral */ -func (r apiUpdateRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { +func (r apiUpdateReferralRequest) Execute() (Referral, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPut localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Ruleset + localVarReturnValue Referral ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateRuleset") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateReferral") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"rulesetId"+"}", _neturl.QueryEscape(parameterToString(r.rulesetId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"referralId"+"}", _neturl.QueryEscape(parameterToString(r.referralId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -13503,7 +16397,7 @@ func (r apiUpdateRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Ruleset + var v Referral err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() diff --git a/client.go b/client.go index 99ada922..f3b88bb6 100644 --- a/client.go +++ b/client.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/configuration.go b/configuration.go index 03ee8011..f31dc5ef 100644 --- a/configuration.go +++ b/configuration.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -97,11 +97,11 @@ type Configuration struct { func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "OpenAPI-Generator/2.5.0/go", + UserAgent: "OpenAPI-Generator/2.6.0/go", Debug: false, Servers: ServerConfigurations{ { - URL: "/", + URL: "https://yourbaseurl.talon.one/", Description: "No description provided", }, }, diff --git a/docs/AcceptCouponEffectProps.md b/docs/AcceptCouponEffectProps.md index e29402d1..90f9f027 100644 --- a/docs/AcceptCouponEffectProps.md +++ b/docs/AcceptCouponEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The coupon code that was accepted | +**Value** | Pointer to **string** | The coupon code that was accepted. | ## Methods diff --git a/docs/AcceptReferralEffectProps.md b/docs/AcceptReferralEffectProps.md index 526053e0..e6fda435 100644 --- a/docs/AcceptReferralEffectProps.md +++ b/docs/AcceptReferralEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The referral code that was accepted | +**Value** | Pointer to **string** | The referral code that was accepted. | ## Methods diff --git a/docs/AccessLogEntry.md b/docs/AccessLogEntry.md index cf3e7d2f..514d99b4 100644 --- a/docs/AccessLogEntry.md +++ b/docs/AccessLogEntry.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uuid** | Pointer to **string** | UUID reference of request | -**Status** | Pointer to **int32** | HTTP status code of response | -**Method** | Pointer to **string** | HTTP method of request | +**Uuid** | Pointer to **string** | UUID reference of request. | +**Status** | Pointer to **int32** | HTTP status code of response. | +**Method** | Pointer to **string** | HTTP method of request. | **RequestUri** | Pointer to **string** | target URI of request | **Time** | Pointer to [**time.Time**](time.Time.md) | timestamp of request | **RequestPayload** | Pointer to **string** | payload of request | diff --git a/docs/Account.md b/docs/Account.md index af10983d..0bcc05f5 100644 --- a/docs/Account.md +++ b/docs/Account.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | **CompanyName** | Pointer to **string** | | -**DomainName** | Pointer to **string** | Subdomain Name for yourcompany.talon.one | -**State** | Pointer to **string** | State of the account (active, deactivated) | +**DomainName** | Pointer to **string** | Subdomain Name for yourcompany.talon.one. | +**State** | Pointer to **string** | State of the account (active, deactivated). | **BillingEmail** | Pointer to **string** | The billing email address associated with your company account. | **PlanName** | Pointer to **string** | The name of your booked plan. | [optional] **PlanExpires** | Pointer to [**time.Time**](time.Time.md) | The point in time at which your current plan expires. | [optional] @@ -21,7 +21,7 @@ Name | Type | Description | Notes **UserCount** | Pointer to **int32** | The current number of Campaign Manager Users in your account. | **CampaignsActiveCount** | Pointer to **int32** | The current number of active Campaigns in your account. | **CampaignsInactiveCount** | Pointer to **int32** | The current number of inactive Campaigns in your account. | -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] ## Methods diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md index e6a6d41f..027b27ce 100644 --- a/docs/AccountAdditionalCost.md +++ b/docs/AccountAdditionalCost.md @@ -4,13 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **Name** | Pointer to **string** | The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. | **Title** | Pointer to **string** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | **Description** | Pointer to **string** | A description of this additional cost. | -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this additional cost | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional] +**Type** | Pointer to **string** | The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session. | [optional] [default to TYPE_SESSION] ## Methods @@ -189,6 +190,31 @@ HasSubscribedApplicationsIds returns a boolean if a field has been set. SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +### GetType + +`func (o *AccountAdditionalCost) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAdditionalCost) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *AccountAdditionalCost) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *AccountAdditionalCost) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountAnalytics.md b/docs/AccountAnalytics.md index 419b0dcd..613ed627 100644 --- a/docs/AccountAnalytics.md +++ b/docs/AccountAnalytics.md @@ -4,24 +4,25 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Applications** | Pointer to **int32** | Total number of applications in the account | -**LiveApplications** | Pointer to **int32** | Total number of live applications in the account | -**SandboxApplications** | Pointer to **int32** | Total number of sandbox applications in the account | -**Campaigns** | Pointer to **int32** | Total number of campaigns in the account | -**ActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in the account | -**LiveActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in live applications in the account | -**Coupons** | Pointer to **int32** | Total number of coupons in the account | -**ActiveCoupons** | Pointer to **int32** | Total number of active coupons in the account | -**ExpiredCoupons** | Pointer to **int32** | Total number of expired coupons in the account | -**ReferralCodes** | Pointer to **int32** | Total number of referral codes in the account | -**ActiveReferralCodes** | Pointer to **int32** | Total number of active referral codes in the account | -**ExpiredReferralCodes** | Pointer to **int32** | Total number of expired referral codes in the account | -**ActiveRules** | Pointer to **int32** | Total number of active rules in the account | -**Users** | Pointer to **int32** | Total number of users in the account | -**Roles** | Pointer to **int32** | Total number of roles in the account | -**CustomAttributes** | Pointer to **int32** | Total number of custom attributes in the account | -**Webhooks** | Pointer to **int32** | Total number of webhooks in the account | -**LoyaltyPrograms** | Pointer to **int32** | Total number of loyalty programs in the account | +**Applications** | Pointer to **int32** | Total number of applications in the account. | +**LiveApplications** | Pointer to **int32** | Total number of live applications in the account. | +**SandboxApplications** | Pointer to **int32** | Total number of sandbox applications in the account. | +**Campaigns** | Pointer to **int32** | Total number of campaigns in the account. | +**ActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in the account. | +**LiveActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in live applications in the account. | +**Coupons** | Pointer to **int32** | Total number of coupons in the account. | +**ActiveCoupons** | Pointer to **int32** | Total number of active coupons in the account. | +**ExpiredCoupons** | Pointer to **int32** | Total number of expired coupons in the account. | +**ReferralCodes** | Pointer to **int32** | Total number of referral codes in the account. | +**ActiveReferralCodes** | Pointer to **int32** | Total number of active referral codes in the account. | +**ExpiredReferralCodes** | Pointer to **int32** | Total number of expired referral codes in the account. | +**ActiveRules** | Pointer to **int32** | Total number of active rules in the account. | +**Users** | Pointer to **int32** | Total number of users in the account. | +**Roles** | Pointer to **int32** | Total number of roles in the account. | +**CustomAttributes** | Pointer to **int32** | Total number of custom attributes in the account. | +**Webhooks** | Pointer to **int32** | Total number of webhooks in the account. | +**LoyaltyPrograms** | Pointer to **int32** | Total number of all loyalty programs in the account. | +**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of live loyalty programs in the account. | ## Methods @@ -475,6 +476,31 @@ HasLoyaltyPrograms returns a boolean if a field has been set. SetLoyaltyPrograms gets a reference to the given int32 and assigns it to the LoyaltyPrograms field. +### GetLiveLoyaltyPrograms + +`func (o *AccountAnalytics) GetLiveLoyaltyPrograms() int32` + +GetLiveLoyaltyPrograms returns the LiveLoyaltyPrograms field if non-nil, zero value otherwise. + +### GetLiveLoyaltyProgramsOk + +`func (o *AccountAnalytics) GetLiveLoyaltyProgramsOk() (int32, bool)` + +GetLiveLoyaltyProgramsOk returns a tuple with the LiveLoyaltyPrograms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLiveLoyaltyPrograms + +`func (o *AccountAnalytics) HasLiveLoyaltyPrograms() bool` + +HasLiveLoyaltyPrograms returns a boolean if a field has been set. + +### SetLiveLoyaltyPrograms + +`func (o *AccountAnalytics) SetLiveLoyaltyPrograms(v int32)` + +SetLiveLoyaltyPrograms gets a reference to the given int32 and assigns it to the LiveLoyaltyPrograms field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountLimits.md b/docs/AccountLimits.md index e9fc02ab..b8fde5bd 100644 --- a/docs/AccountLimits.md +++ b/docs/AccountLimits.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**LiveApplications** | Pointer to **int32** | Total number of allowed live applications in the account | -**SandboxApplications** | Pointer to **int32** | Total number of allowed sandbox applications in the account | -**ActiveCampaigns** | Pointer to **int32** | Total number of allowed active campaigns in live applications in the account | -**Coupons** | Pointer to **int32** | Total number of allowed coupons in the account | -**ReferralCodes** | Pointer to **int32** | Total number of allowed referral codes in the account | -**ActiveRules** | Pointer to **int32** | Total number of allowed active rulesets in the account | -**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of allowed live loyalty programs in the account | -**SandboxLoyaltyPrograms** | Pointer to **int32** | Total number of allowed sandbox loyalty programs in the account | -**Webhooks** | Pointer to **int32** | Total number of allowed webhooks in the account | -**Users** | Pointer to **int32** | Total number of allowed users in the account | -**ApiVolume** | Pointer to **int32** | Allowed volume of API requests to the account | -**PromotionTypes** | Pointer to **[]string** | Array of promotion types that are employed in the account | +**LiveApplications** | Pointer to **int32** | Total number of allowed live applications in the account. | +**SandboxApplications** | Pointer to **int32** | Total number of allowed sandbox applications in the account. | +**ActiveCampaigns** | Pointer to **int32** | Total number of allowed active campaigns in live applications in the account. | +**Coupons** | Pointer to **int32** | Total number of allowed coupons in the account. | +**ReferralCodes** | Pointer to **int32** | Total number of allowed referral codes in the account. | +**ActiveRules** | Pointer to **int32** | Total number of allowed active rulesets in the account. | +**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of allowed live loyalty programs in the account. | +**SandboxLoyaltyPrograms** | Pointer to **int32** | Total number of allowed sandbox loyalty programs in the account. | +**Webhooks** | Pointer to **int32** | Total number of allowed webhooks in the account. | +**Users** | Pointer to **int32** | Total number of allowed users in the account. | +**ApiVolume** | Pointer to **int32** | Allowed volume of API requests to the account. | +**PromotionTypes** | Pointer to **[]string** | Array of promotion types that are employed in the account. | ## Methods diff --git a/docs/AddFreeItemEffectProps.md b/docs/AddFreeItemEffectProps.md index d81fde26..77b2f866 100644 --- a/docs/AddFreeItemEffectProps.md +++ b/docs/AddFreeItemEffectProps.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Sku** | Pointer to **string** | SKU of the item that needs to be added | -**Name** | Pointer to **string** | The name/description of the effect | +**Sku** | Pointer to **string** | SKU of the item that needs to be added. | +**Name** | Pointer to **string** | The name/description of the effect. | ## Methods diff --git a/docs/AddItemCatalogAction.md b/docs/AddItemCatalogAction.md new file mode 100644 index 00000000..47380355 --- /dev/null +++ b/docs/AddItemCatalogAction.md @@ -0,0 +1,117 @@ +# AddItemCatalogAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sku** | Pointer to **string** | The unique SKU of the item to add. | +**Price** | Pointer to **float32** | Price of the item. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | The attributes of the item to add. | [optional] +**ReplaceIfExists** | Pointer to **bool** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional] [default to false] + +## Methods + +### GetSku + +`func (o *AddItemCatalogAction) GetSku() string` + +GetSku returns the Sku field if non-nil, zero value otherwise. + +### GetSkuOk + +`func (o *AddItemCatalogAction) GetSkuOk() (string, bool)` + +GetSkuOk returns a tuple with the Sku field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSku + +`func (o *AddItemCatalogAction) HasSku() bool` + +HasSku returns a boolean if a field has been set. + +### SetSku + +`func (o *AddItemCatalogAction) SetSku(v string)` + +SetSku gets a reference to the given string and assigns it to the Sku field. + +### GetPrice + +`func (o *AddItemCatalogAction) GetPrice() float32` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *AddItemCatalogAction) GetPriceOk() (float32, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPrice + +`func (o *AddItemCatalogAction) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + +### SetPrice + +`func (o *AddItemCatalogAction) SetPrice(v float32)` + +SetPrice gets a reference to the given float32 and assigns it to the Price field. + +### GetAttributes + +`func (o *AddItemCatalogAction) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AddItemCatalogAction) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *AddItemCatalogAction) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *AddItemCatalogAction) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetReplaceIfExists + +`func (o *AddItemCatalogAction) GetReplaceIfExists() bool` + +GetReplaceIfExists returns the ReplaceIfExists field if non-nil, zero value otherwise. + +### GetReplaceIfExistsOk + +`func (o *AddItemCatalogAction) GetReplaceIfExistsOk() (bool, bool)` + +GetReplaceIfExistsOk returns a tuple with the ReplaceIfExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReplaceIfExists + +`func (o *AddItemCatalogAction) HasReplaceIfExists() bool` + +HasReplaceIfExists returns a boolean if a field has been set. + +### SetReplaceIfExists + +`func (o *AddItemCatalogAction) SetReplaceIfExists(v bool)` + +SetReplaceIfExists gets a reference to the given bool and assigns it to the ReplaceIfExists field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md index 062d587c..17e286aa 100644 --- a/docs/AddLoyaltyPointsEffectProps.md +++ b/docs/AddLoyaltyPointsEffectProps.md @@ -4,14 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this loyalty point addition | -**ProgramId** | Pointer to **int32** | The ID of the loyalty program where these points were added | -**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were added | -**Value** | Pointer to **float32** | The amount of points that were added | -**RecipientIntegrationId** | Pointer to **string** | The user for whom these points were added | -**StartDate** | Pointer to [**time.Time**](time.Time.md) | Date after which points will be valid | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Date after which points will expire | [optional] -**TransactionUUID** | Pointer to **string** | The identifier of this addition in the loyalty ledger | +**Name** | Pointer to **string** | The reason of the point addition. | +**ProgramId** | Pointer to **int32** | The ID of the loyalty program where these points were added. | +**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were added. | +**Value** | Pointer to **float32** | The amount of points that were added. | +**DesiredValue** | Pointer to **float32** | The original amount of loyalty points to be awarded. | [optional] +**RecipientIntegrationId** | Pointer to **string** | The user for whom these points were added. | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Date after which points will be valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Date after which points will expire. | [optional] +**TransactionUUID** | Pointer to **string** | The identifier of this addition in the loyalty ledger. | +**CartItemPosition** | Pointer to **float32** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] +**CartItemSubPosition** | Pointer to **float32** | The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. | [optional] +**CardIdentifier** | Pointer to **string** | The card on which these points were added. | [optional] ## Methods @@ -115,6 +119,31 @@ HasValue returns a boolean if a field has been set. SetValue gets a reference to the given float32 and assigns it to the Value field. +### GetDesiredValue + +`func (o *AddLoyaltyPointsEffectProps) GetDesiredValue() float32` + +GetDesiredValue returns the DesiredValue field if non-nil, zero value otherwise. + +### GetDesiredValueOk + +`func (o *AddLoyaltyPointsEffectProps) GetDesiredValueOk() (float32, bool)` + +GetDesiredValueOk returns a tuple with the DesiredValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDesiredValue + +`func (o *AddLoyaltyPointsEffectProps) HasDesiredValue() bool` + +HasDesiredValue returns a boolean if a field has been set. + +### SetDesiredValue + +`func (o *AddLoyaltyPointsEffectProps) SetDesiredValue(v float32)` + +SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. + ### GetRecipientIntegrationId `func (o *AddLoyaltyPointsEffectProps) GetRecipientIntegrationId() string` @@ -215,6 +244,81 @@ HasTransactionUUID returns a boolean if a field has been set. SetTransactionUUID gets a reference to the given string and assigns it to the TransactionUUID field. +### GetCartItemPosition + +`func (o *AddLoyaltyPointsEffectProps) GetCartItemPosition() float32` + +GetCartItemPosition returns the CartItemPosition field if non-nil, zero value otherwise. + +### GetCartItemPositionOk + +`func (o *AddLoyaltyPointsEffectProps) GetCartItemPositionOk() (float32, bool)` + +GetCartItemPositionOk returns a tuple with the CartItemPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemPosition + +`func (o *AddLoyaltyPointsEffectProps) HasCartItemPosition() bool` + +HasCartItemPosition returns a boolean if a field has been set. + +### SetCartItemPosition + +`func (o *AddLoyaltyPointsEffectProps) SetCartItemPosition(v float32)` + +SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. + +### GetCartItemSubPosition + +`func (o *AddLoyaltyPointsEffectProps) GetCartItemSubPosition() float32` + +GetCartItemSubPosition returns the CartItemSubPosition field if non-nil, zero value otherwise. + +### GetCartItemSubPositionOk + +`func (o *AddLoyaltyPointsEffectProps) GetCartItemSubPositionOk() (float32, bool)` + +GetCartItemSubPositionOk returns a tuple with the CartItemSubPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemSubPosition + +`func (o *AddLoyaltyPointsEffectProps) HasCartItemSubPosition() bool` + +HasCartItemSubPosition returns a boolean if a field has been set. + +### SetCartItemSubPosition + +`func (o *AddLoyaltyPointsEffectProps) SetCartItemSubPosition(v float32)` + +SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. + +### GetCardIdentifier + +`func (o *AddLoyaltyPointsEffectProps) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *AddLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool)` + +GetCardIdentifierOk returns a tuple with the CardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardIdentifier + +`func (o *AddLoyaltyPointsEffectProps) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *AddLoyaltyPointsEffectProps) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Application.md b/docs/Application.md index ae6fdc57..2005feb9 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -4,25 +4,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **Name** | Pointer to **string** | The name of this application. | **Description** | Pointer to **string** | A longer description of the application. | [optional] **Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | -**Currency** | Pointer to **string** | A string describing a default currency for new customer sessions. | -**CaseSensitivity** | Pointer to **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] -**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] -**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] -**DefaultDiscountScope** | Pointer to **string** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] -**EnableCascadingDiscounts** | Pointer to **bool** | Indicates if discounts should cascade for this application | [optional] -**EnableFlattenedCartItems** | Pointer to **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one | [optional] +**Currency** | Pointer to **string** | The default currency for new customer sessions. | +**CaseSensitivity** | Pointer to **string** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] +**CampaignPriority** | Pointer to **string** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional] [default to CAMPAIGN_PRIORITY_UNIVERSAL] +**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to EXCLUSIVE_CAMPAIGNS_STRATEGY_LIST_ORDER] +**DefaultDiscountScope** | Pointer to **string** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] +**EnableCascadingDiscounts** | Pointer to **bool** | Indicates if discounts should cascade for this Application. | [optional] +**EnableFlattenedCartItems** | Pointer to **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [optional] -**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox application | [optional] -**LoyaltyPrograms** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | +**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox Application. | [optional] +**EnablePartialDiscounts** | Pointer to **bool** | Indicates if this Application supports partial discounts. | [optional] +**DefaultDiscountAdditionalCostPerItemScope** | Pointer to **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] +**LoyaltyPrograms** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | ## Methods @@ -476,6 +478,56 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetEnablePartialDiscounts + +`func (o *Application) GetEnablePartialDiscounts() bool` + +GetEnablePartialDiscounts returns the EnablePartialDiscounts field if non-nil, zero value otherwise. + +### GetEnablePartialDiscountsOk + +`func (o *Application) GetEnablePartialDiscountsOk() (bool, bool)` + +GetEnablePartialDiscountsOk returns a tuple with the EnablePartialDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnablePartialDiscounts + +`func (o *Application) HasEnablePartialDiscounts() bool` + +HasEnablePartialDiscounts returns a boolean if a field has been set. + +### SetEnablePartialDiscounts + +`func (o *Application) SetEnablePartialDiscounts(v bool)` + +SetEnablePartialDiscounts gets a reference to the given bool and assigns it to the EnablePartialDiscounts field. + +### GetDefaultDiscountAdditionalCostPerItemScope + +`func (o *Application) GetDefaultDiscountAdditionalCostPerItemScope() string` + +GetDefaultDiscountAdditionalCostPerItemScope returns the DefaultDiscountAdditionalCostPerItemScope field if non-nil, zero value otherwise. + +### GetDefaultDiscountAdditionalCostPerItemScopeOk + +`func (o *Application) GetDefaultDiscountAdditionalCostPerItemScopeOk() (string, bool)` + +GetDefaultDiscountAdditionalCostPerItemScopeOk returns a tuple with the DefaultDiscountAdditionalCostPerItemScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultDiscountAdditionalCostPerItemScope + +`func (o *Application) HasDefaultDiscountAdditionalCostPerItemScope() bool` + +HasDefaultDiscountAdditionalCostPerItemScope returns a boolean if a field has been set. + +### SetDefaultDiscountAdditionalCostPerItemScope + +`func (o *Application) SetDefaultDiscountAdditionalCostPerItemScope(v string)` + +SetDefaultDiscountAdditionalCostPerItemScope gets a reference to the given string and assigns it to the DefaultDiscountAdditionalCostPerItemScope field. + ### GetLoyaltyPrograms `func (o *Application) GetLoyaltyPrograms() []LoyaltyProgram` diff --git a/docs/ApplicationApiHealth.md b/docs/ApplicationApiHealth.md index cf0f0862..3b220879 100644 --- a/docs/ApplicationApiHealth.md +++ b/docs/ApplicationApiHealth.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Summary** | Pointer to **string** | One-word summary of the health of the API connection of an application | -**LastUsed** | Pointer to [**time.Time**](time.Time.md) | time of last request relevant to the API health test | +**Summary** | Pointer to **string** | One-word summary of the health of the API connection of an application. | +**LastUsed** | Pointer to [**time.Time**](time.Time.md) | time of last request relevant to the API health test. | ## Methods diff --git a/docs/ApplicationApiKey.md b/docs/ApplicationApiKey.md index c9babc59..b5131efa 100644 --- a/docs/ApplicationApiKey.md +++ b/docs/ApplicationApiKey.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Title** | Pointer to **string** | Title for API Key | -**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | -**Platform** | Pointer to **string** | Platform the API key is valid for. | [optional] -**Id** | Pointer to **int32** | ID of the API Key | -**CreatedBy** | Pointer to **int32** | ID of user who created | -**AccountID** | Pointer to **int32** | ID of account the key is used for | -**ApplicationID** | Pointer to **int32** | ID of application the key is used for | -**Created** | Pointer to [**time.Time**](time.Time.md) | The date the API key was created | +**Title** | Pointer to **string** | Title for API Key. | +**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired. | +**Platform** | Pointer to **string** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional] +**Id** | Pointer to **int32** | ID of the API Key. | +**CreatedBy** | Pointer to **int32** | ID of user who created. | +**AccountID** | Pointer to **int32** | ID of account the key is used for. | +**ApplicationID** | Pointer to **int32** | ID of application the key is used for. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The date the API key was created. | ## Methods diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md index 818b9b18..920a05e8 100644 --- a/docs/ApplicationCampaignStats.md +++ b/docs/ApplicationCampaignStats.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Draft** | Pointer to **int32** | Number of draft campaigns | -**Disabled** | Pointer to **int32** | Number of disabled campaigns | -**Scheduled** | Pointer to **int32** | Number of scheduled campaigns | -**Running** | Pointer to **int32** | Number of running campaigns | -**Expired** | Pointer to **int32** | Number of expired campaigns | -**Archived** | Pointer to **int32** | Number of archived campaigns | +**Draft** | Pointer to **int32** | Number of draft campaigns. | +**Disabled** | Pointer to **int32** | Number of disabled campaigns. | +**Scheduled** | Pointer to **int32** | Number of scheduled campaigns. | +**Running** | Pointer to **int32** | Number of running campaigns. | +**Expired** | Pointer to **int32** | Number of expired campaigns. | +**Archived** | Pointer to **int32** | Number of archived campaigns. | ## Methods diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md index d852f7d4..8ba9fa10 100644 --- a/docs/ApplicationCustomer.md +++ b/docs/ApplicationCustomer.md @@ -4,16 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. | -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. | -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. The integration ID set by your integration layer. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | **AccountId** | Pointer to **int32** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | **ClosedSessions** | Pointer to **int32** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | -**TotalSales** | Pointer to **float32** | Sum of all purchases made by this customer | -**LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] -**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] -**LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received from this customer | +**TotalSales** | Pointer to **float32** | Sum of all purchases made by this customer. | +**LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | A list of audiences the customer belongs to. | [optional] +**LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. | **AdvocateIntegrationId** | Pointer to **string** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] ## Methods diff --git a/docs/ApplicationCustomerSearch.md b/docs/ApplicationCustomerSearch.md deleted file mode 100644 index 920fa2f9..00000000 --- a/docs/ApplicationCustomerSearch.md +++ /dev/null @@ -1,91 +0,0 @@ -# ApplicationCustomerSearch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional] -**IntegrationIDs** | Pointer to **[]string** | | [optional] -**ProfileIDs** | Pointer to **[]int32** | | [optional] - -## Methods - -### GetAttributes - -`func (o *ApplicationCustomerSearch) GetAttributes() map[string]interface{}` - -GetAttributes returns the Attributes field if non-nil, zero value otherwise. - -### GetAttributesOk - -`func (o *ApplicationCustomerSearch) GetAttributesOk() (map[string]interface{}, bool)` - -GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAttributes - -`func (o *ApplicationCustomerSearch) HasAttributes() bool` - -HasAttributes returns a boolean if a field has been set. - -### SetAttributes - -`func (o *ApplicationCustomerSearch) SetAttributes(v map[string]interface{})` - -SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. - -### GetIntegrationIDs - -`func (o *ApplicationCustomerSearch) GetIntegrationIDs() []string` - -GetIntegrationIDs returns the IntegrationIDs field if non-nil, zero value otherwise. - -### GetIntegrationIDsOk - -`func (o *ApplicationCustomerSearch) GetIntegrationIDsOk() ([]string, bool)` - -GetIntegrationIDsOk returns a tuple with the IntegrationIDs field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasIntegrationIDs - -`func (o *ApplicationCustomerSearch) HasIntegrationIDs() bool` - -HasIntegrationIDs returns a boolean if a field has been set. - -### SetIntegrationIDs - -`func (o *ApplicationCustomerSearch) SetIntegrationIDs(v []string)` - -SetIntegrationIDs gets a reference to the given []string and assigns it to the IntegrationIDs field. - -### GetProfileIDs - -`func (o *ApplicationCustomerSearch) GetProfileIDs() []int32` - -GetProfileIDs returns the ProfileIDs field if non-nil, zero value otherwise. - -### GetProfileIDsOk - -`func (o *ApplicationCustomerSearch) GetProfileIDsOk() ([]int32, bool)` - -GetProfileIDsOk returns a tuple with the ProfileIDs field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasProfileIDs - -`func (o *ApplicationCustomerSearch) HasProfileIDs() bool` - -HasProfileIDs returns a boolean if a field has been set. - -### SetProfileIDs - -`func (o *ApplicationCustomerSearch) SetProfileIDs(v []int32)` - -SetProfileIDs gets a reference to the given []int32 and assigns it to the ProfileIDs field. - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md index e0b51d96..0dde5f1c 100644 --- a/docs/ApplicationEvent.md +++ b/docs/ApplicationEvent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **ProfileId** | Pointer to **int32** | The globally unique Talon.One ID of the customer that created this entity. | [optional] diff --git a/docs/ApplicationNotification.md b/docs/ApplicationNotification.md new file mode 100644 index 00000000..e4728463 --- /dev/null +++ b/docs/ApplicationNotification.md @@ -0,0 +1,39 @@ +# ApplicationNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | Pointer to **string** | Event type. It can be one of the following: ['campaign_priorities_changed'] | + +## Methods + +### GetEvent + +`func (o *ApplicationNotification) GetEvent() string` + +GetEvent returns the Event field if non-nil, zero value otherwise. + +### GetEventOk + +`func (o *ApplicationNotification) GetEventOk() (string, bool)` + +GetEventOk returns a tuple with the Event field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvent + +`func (o *ApplicationNotification) HasEvent() bool` + +HasEvent returns a boolean if a field has been set. + +### SetEvent + +`func (o *ApplicationNotification) SetEvent(v string)` + +SetEvent gets a reference to the given string and assigns it to the Event field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApplicationReferee.md b/docs/ApplicationReferee.md index 15394477..4d47be0e 100644 --- a/docs/ApplicationReferee.md +++ b/docs/ApplicationReferee.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**SessionId** | Pointer to **string** | Integration ID of the session in which the customer redeemed the referral | -**AdvocateIntegrationId** | Pointer to **string** | Integration ID of the Advocate's Profile | -**FriendIntegrationId** | Pointer to **string** | Integration ID of the Friend's Profile | +**SessionId** | Pointer to **string** | Integration ID of the session in which the customer redeemed the referral. | +**AdvocateIntegrationId** | Pointer to **string** | Integration ID of the Advocate's Profile. | +**FriendIntegrationId** | Pointer to **string** | Integration ID of the Friend's Profile. | **Code** | Pointer to **string** | Advocate's referral code. | -**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment the customer redeemed the referral | +**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment the customer redeemed the referral. | ## Methods diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index e8c9733f..76c89440 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -4,19 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **ProfileId** | Pointer to **int32** | The globally unique Talon.One ID of the customer that created this entity. | [optional] -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. | **Profileintegrationid** | Pointer to **string** | Integration ID of the customer for the session. | [optional] **Coupon** | Pointer to **string** | Any coupon code entered. | **Referral** | Pointer to **string** | Any referral code entered. | -**State** | Pointer to **string** | Indicating if the customer session is in progress (`open`), `closed`, or `cancelled`. For more information about customer sessions, see [Customer sessions](/docs/dev/concepts/entities#customer-session-states) in the docs. | +**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). | **CartItems** | Pointer to [**[]CartItem**](CartItem.md) | Serialized JSON representation. | -**Discounts** | Pointer to **map[string]float32** | A map of labelled discount values, in the same currency as the session. | +**Discounts** | Pointer to **map[string]float32** | **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. | +**TotalDiscounts** | Pointer to **float32** | The total sum of the discounts applied to this session. | **Total** | Pointer to **float32** | The total sum of the session before any discounts applied. | -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] ## Methods @@ -295,6 +296,31 @@ HasDiscounts returns a boolean if a field has been set. SetDiscounts gets a reference to the given map[string]float32 and assigns it to the Discounts field. +### GetTotalDiscounts + +`func (o *ApplicationSession) GetTotalDiscounts() float32` + +GetTotalDiscounts returns the TotalDiscounts field if non-nil, zero value otherwise. + +### GetTotalDiscountsOk + +`func (o *ApplicationSession) GetTotalDiscountsOk() (float32, bool)` + +GetTotalDiscountsOk returns a tuple with the TotalDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalDiscounts + +`func (o *ApplicationSession) HasTotalDiscounts() bool` + +HasTotalDiscounts returns a boolean if a field has been set. + +### SetTotalDiscounts + +`func (o *ApplicationSession) SetTotalDiscounts(v float32)` + +SetTotalDiscounts gets a reference to the given float32 and assigns it to the TotalDiscounts field. + ### GetTotal `func (o *ApplicationSession) GetTotal() float32` diff --git a/docs/AsyncCouponCreationResponse.md b/docs/AsyncCouponCreationResponse.md new file mode 100644 index 00000000..a8db295f --- /dev/null +++ b/docs/AsyncCouponCreationResponse.md @@ -0,0 +1,39 @@ +# AsyncCouponCreationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | The batch ID that all coupons created by the request will have. | + +## Methods + +### GetBatchId + +`func (o *AsyncCouponCreationResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *AsyncCouponCreationResponse) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *AsyncCouponCreationResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *AsyncCouponCreationResponse) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Attribute.md b/docs/Attribute.md index ad9742e4..2e5ffddc 100644 --- a/docs/Attribute.md +++ b/docs/Attribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **Entity** | Pointer to **string** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. | @@ -14,8 +14,13 @@ Name | Type | Description | Notes **Type** | Pointer to **string** | The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. | **Description** | Pointer to **string** | A description of this attribute. | **Suggestions** | Pointer to **[]string** | A list of suggestions for the attribute. | +**HasAllowedList** | Pointer to **bool** | Whether or not this attribute has an allowed list of values associated with it. | [optional] [default to false] +**RestrictedBySuggestions** | Pointer to **bool** | Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). | [optional] [default to false] **Editable** | Pointer to **bool** | Whether or not this attribute can be edited. | -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this attribute | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications where this attribute is available. | [optional] +**SubscribedCatalogsIds** | Pointer to **[]int32** | A list of the IDs of the catalogs where this attribute is available. | [optional] +**AllowedSubscriptions** | Pointer to **[]string** | A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. | [optional] +**EventTypeId** | Pointer to **int32** | | [optional] ## Methods @@ -269,6 +274,56 @@ HasSuggestions returns a boolean if a field has been set. SetSuggestions gets a reference to the given []string and assigns it to the Suggestions field. +### GetHasAllowedList + +`func (o *Attribute) GetHasAllowedList() bool` + +GetHasAllowedList returns the HasAllowedList field if non-nil, zero value otherwise. + +### GetHasAllowedListOk + +`func (o *Attribute) GetHasAllowedListOk() (bool, bool)` + +GetHasAllowedListOk returns a tuple with the HasAllowedList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasAllowedList + +`func (o *Attribute) HasHasAllowedList() bool` + +HasHasAllowedList returns a boolean if a field has been set. + +### SetHasAllowedList + +`func (o *Attribute) SetHasAllowedList(v bool)` + +SetHasAllowedList gets a reference to the given bool and assigns it to the HasAllowedList field. + +### GetRestrictedBySuggestions + +`func (o *Attribute) GetRestrictedBySuggestions() bool` + +GetRestrictedBySuggestions returns the RestrictedBySuggestions field if non-nil, zero value otherwise. + +### GetRestrictedBySuggestionsOk + +`func (o *Attribute) GetRestrictedBySuggestionsOk() (bool, bool)` + +GetRestrictedBySuggestionsOk returns a tuple with the RestrictedBySuggestions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRestrictedBySuggestions + +`func (o *Attribute) HasRestrictedBySuggestions() bool` + +HasRestrictedBySuggestions returns a boolean if a field has been set. + +### SetRestrictedBySuggestions + +`func (o *Attribute) SetRestrictedBySuggestions(v bool)` + +SetRestrictedBySuggestions gets a reference to the given bool and assigns it to the RestrictedBySuggestions field. + ### GetEditable `func (o *Attribute) GetEditable() bool` @@ -319,6 +374,81 @@ HasSubscribedApplicationsIds returns a boolean if a field has been set. SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +### GetSubscribedCatalogsIds + +`func (o *Attribute) GetSubscribedCatalogsIds() []int32` + +GetSubscribedCatalogsIds returns the SubscribedCatalogsIds field if non-nil, zero value otherwise. + +### GetSubscribedCatalogsIdsOk + +`func (o *Attribute) GetSubscribedCatalogsIdsOk() ([]int32, bool)` + +GetSubscribedCatalogsIdsOk returns a tuple with the SubscribedCatalogsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedCatalogsIds + +`func (o *Attribute) HasSubscribedCatalogsIds() bool` + +HasSubscribedCatalogsIds returns a boolean if a field has been set. + +### SetSubscribedCatalogsIds + +`func (o *Attribute) SetSubscribedCatalogsIds(v []int32)` + +SetSubscribedCatalogsIds gets a reference to the given []int32 and assigns it to the SubscribedCatalogsIds field. + +### GetAllowedSubscriptions + +`func (o *Attribute) GetAllowedSubscriptions() []string` + +GetAllowedSubscriptions returns the AllowedSubscriptions field if non-nil, zero value otherwise. + +### GetAllowedSubscriptionsOk + +`func (o *Attribute) GetAllowedSubscriptionsOk() ([]string, bool)` + +GetAllowedSubscriptionsOk returns a tuple with the AllowedSubscriptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAllowedSubscriptions + +`func (o *Attribute) HasAllowedSubscriptions() bool` + +HasAllowedSubscriptions returns a boolean if a field has been set. + +### SetAllowedSubscriptions + +`func (o *Attribute) SetAllowedSubscriptions(v []string)` + +SetAllowedSubscriptions gets a reference to the given []string and assigns it to the AllowedSubscriptions field. + +### GetEventTypeId + +`func (o *Attribute) GetEventTypeId() int32` + +GetEventTypeId returns the EventTypeId field if non-nil, zero value otherwise. + +### GetEventTypeIdOk + +`func (o *Attribute) GetEventTypeIdOk() (int32, bool)` + +GetEventTypeIdOk returns a tuple with the EventTypeId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEventTypeId + +`func (o *Attribute) HasEventTypeId() bool` + +HasEventTypeId returns a boolean if a field has been set. + +### SetEventTypeId + +`func (o *Attribute) SetEventTypeId(v int32)` + +SetEventTypeId gets a reference to the given int32 and assigns it to the EventTypeId field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Audience.md b/docs/Audience.md index 285be60b..12aae661 100644 --- a/docs/Audience.md +++ b/docs/Audience.md @@ -5,11 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | -**Name** | Pointer to **string** | The human-friendly display name for this Audience. | -**Integration** | Pointer to **string** | Integration that this audience was created in. | -**IntegrationId** | Pointer to **string** | The ID of this Audience in the third-party integration | +**Name** | Pointer to **string** | The human-friendly display name for this audience. | +**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox Application. | [optional] +**Description** | Pointer to **string** | A description of the audience. | [optional] +**Integration** | Pointer to **string** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. | [optional] +**IntegrationId** | Pointer to **string** | The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. | [optional] +**CreatedIn3rdParty** | Pointer to **bool** | Determines if this audience is a 3rd party audience or not. | [optional] ## Methods @@ -113,6 +116,56 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. +### GetSandbox + +`func (o *Audience) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *Audience) GetSandboxOk() (bool, bool)` + +GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandbox + +`func (o *Audience) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *Audience) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + +### GetDescription + +`func (o *Audience) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Audience) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *Audience) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *Audience) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetIntegration `func (o *Audience) GetIntegration() string` @@ -163,6 +216,31 @@ HasIntegrationId returns a boolean if a field has been set. SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. +### GetCreatedIn3rdParty + +`func (o *Audience) GetCreatedIn3rdParty() bool` + +GetCreatedIn3rdParty returns the CreatedIn3rdParty field if non-nil, zero value otherwise. + +### GetCreatedIn3rdPartyOk + +`func (o *Audience) GetCreatedIn3rdPartyOk() (bool, bool)` + +GetCreatedIn3rdPartyOk returns a tuple with the CreatedIn3rdParty field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedIn3rdParty + +`func (o *Audience) HasCreatedIn3rdParty() bool` + +HasCreatedIn3rdParty returns a boolean if a field has been set. + +### SetCreatedIn3rdParty + +`func (o *Audience) SetCreatedIn3rdParty(v bool)` + +SetCreatedIn3rdParty gets a reference to the given bool and assigns it to the CreatedIn3rdParty field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AudienceAnalytics.md b/docs/AudienceAnalytics.md new file mode 100644 index 00000000..a0e7914d --- /dev/null +++ b/docs/AudienceAnalytics.md @@ -0,0 +1,65 @@ +# AudienceAnalytics + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AudienceId** | Pointer to **int32** | The ID of the audience. | [optional] +**MembersCount** | Pointer to **int32** | The count of members under a single audience. | [optional] + +## Methods + +### GetAudienceId + +`func (o *AudienceAnalytics) GetAudienceId() int32` + +GetAudienceId returns the AudienceId field if non-nil, zero value otherwise. + +### GetAudienceIdOk + +`func (o *AudienceAnalytics) GetAudienceIdOk() (int32, bool)` + +GetAudienceIdOk returns a tuple with the AudienceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudienceId + +`func (o *AudienceAnalytics) HasAudienceId() bool` + +HasAudienceId returns a boolean if a field has been set. + +### SetAudienceId + +`func (o *AudienceAnalytics) SetAudienceId(v int32)` + +SetAudienceId gets a reference to the given int32 and assigns it to the AudienceId field. + +### GetMembersCount + +`func (o *AudienceAnalytics) GetMembersCount() int32` + +GetMembersCount returns the MembersCount field if non-nil, zero value otherwise. + +### GetMembersCountOk + +`func (o *AudienceAnalytics) GetMembersCountOk() (int32, bool)` + +GetMembersCountOk returns a tuple with the MembersCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMembersCount + +`func (o *AudienceAnalytics) HasMembersCount() bool` + +HasMembersCount returns a boolean if a field has been set. + +### SetMembersCount + +`func (o *AudienceAnalytics) SetMembersCount(v int32)` + +SetMembersCount gets a reference to the given int32 and assigns it to the MembersCount field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AudienceIntegrationId.md b/docs/AudienceIntegrationId.md new file mode 100644 index 00000000..d42c27e5 --- /dev/null +++ b/docs/AudienceIntegrationId.md @@ -0,0 +1,39 @@ +# AudienceIntegrationId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IntegrationId** | Pointer to **string** | The ID of this audience in the third-party integration. | [optional] + +## Methods + +### GetIntegrationId + +`func (o *AudienceIntegrationId) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *AudienceIntegrationId) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *AudienceIntegrationId) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *AudienceIntegrationId) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md index 3164a2f2..832efbaf 100644 --- a/docs/BaseLoyaltyProgram.md +++ b/docs/BaseLoyaltyProgram.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] **DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | [optional] **DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | [optional] -**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | [optional] -**Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | [optional] +**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | [optional] +**UsersPerCardLimit** | Pointer to **int32** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] ## Methods @@ -164,30 +164,30 @@ HasAllowSubledger returns a boolean if a field has been set. SetAllowSubledger gets a reference to the given bool and assigns it to the AllowSubledger field. -### GetTimezone +### GetUsersPerCardLimit -`func (o *BaseLoyaltyProgram) GetTimezone() string` +`func (o *BaseLoyaltyProgram) GetUsersPerCardLimit() int32` -GetTimezone returns the Timezone field if non-nil, zero value otherwise. +GetUsersPerCardLimit returns the UsersPerCardLimit field if non-nil, zero value otherwise. -### GetTimezoneOk +### GetUsersPerCardLimitOk -`func (o *BaseLoyaltyProgram) GetTimezoneOk() (string, bool)` +`func (o *BaseLoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool)` -GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTimezone +### HasUsersPerCardLimit -`func (o *BaseLoyaltyProgram) HasTimezone() bool` +`func (o *BaseLoyaltyProgram) HasUsersPerCardLimit() bool` -HasTimezone returns a boolean if a field has been set. +HasUsersPerCardLimit returns a boolean if a field has been set. -### SetTimezone +### SetUsersPerCardLimit -`func (o *BaseLoyaltyProgram) SetTimezone(v string)` +`func (o *BaseLoyaltyProgram) SetUsersPerCardLimit(v int32)` -SetTimezone gets a reference to the given string and assigns it to the Timezone field. +SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Binding.md b/docs/Binding.md index a6e9c336..225b681f 100644 --- a/docs/Binding.md +++ b/docs/Binding.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | A descriptive name for the value to be bound. | -**Type** | Pointer to **string** | The kind of binding. Possible values are cartItemFilter, subledgerBalance. | [optional] +**Type** | Pointer to **string** | The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` | [optional] **Expression** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that will be evaluated and its result attached to the name of the binding. | +**ValueType** | Pointer to **string** | Can be one of the following: - `string` - `number` - `boolean` | [optional] ## Methods @@ -85,6 +86,31 @@ HasExpression returns a boolean if a field has been set. SetExpression gets a reference to the given []interface{} and assigns it to the Expression field. +### GetValueType + +`func (o *Binding) GetValueType() string` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *Binding) GetValueTypeOk() (string, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValueType + +`func (o *Binding) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### SetValueType + +`func (o *Binding) SetValueType(v string)` + +SetValueType gets a reference to the given string and assigns it to the ValueType field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BulkApplicationNotification.md b/docs/BulkApplicationNotification.md new file mode 100644 index 00000000..371e3894 --- /dev/null +++ b/docs/BulkApplicationNotification.md @@ -0,0 +1,65 @@ +# BulkApplicationNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]ApplicationNotification**](ApplicationNotification.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *BulkApplicationNotification) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *BulkApplicationNotification) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *BulkApplicationNotification) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *BulkApplicationNotification) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *BulkApplicationNotification) GetData() []ApplicationNotification` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *BulkApplicationNotification) GetDataOk() ([]ApplicationNotification, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *BulkApplicationNotification) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *BulkApplicationNotification) SetData(v []ApplicationNotification)` + +SetData gets a reference to the given []ApplicationNotification and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/BulkCampaignNotification.md b/docs/BulkCampaignNotification.md new file mode 100644 index 00000000..7e3a9408 --- /dev/null +++ b/docs/BulkCampaignNotification.md @@ -0,0 +1,65 @@ +# BulkCampaignNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]CampaignNotification**](CampaignNotification.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *BulkCampaignNotification) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *BulkCampaignNotification) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *BulkCampaignNotification) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *BulkCampaignNotification) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *BulkCampaignNotification) GetData() []CampaignNotification` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *BulkCampaignNotification) GetDataOk() ([]CampaignNotification, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *BulkCampaignNotification) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *BulkCampaignNotification) SetData(v []CampaignNotification)` + +SetData gets a reference to the given []CampaignNotification and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Campaign.md b/docs/Campaign.md index 30174f44..1653cb29 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -12,28 +12,31 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A detailed description of the campaign. | **StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] **EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp the campaign will become inactive. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] **State** | Pointer to **string** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to STATE_ENABLED] -**ActiveRulesetId** | Pointer to **int32** | ID of Ruleset this campaign applies on customer session evaluation. | [optional] +**ActiveRulesetId** | Pointer to **int32** | [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] **Tags** | Pointer to **[]string** | A list of tags for the campaign. | -**Features** | Pointer to **[]string** | A list of features for the campaign. | +**Features** | Pointer to **[]string** | The features enabled in this campaign. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign | -**CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. | +**CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. | [optional] **CouponRedemptionCount** | Pointer to **int32** | Number of coupons redeemed in the campaign. | [optional] **ReferralRedemptionCount** | Pointer to **int32** | Number of referral codes redeemed in the campaign. | [optional] **DiscountCount** | Pointer to **float32** | Total amount of discounts redeemed in the campaign. | [optional] **DiscountEffectCount** | Pointer to **int32** | Total number of times discounts were redeemed in this campaign. | [optional] **CouponCreationCount** | Pointer to **int32** | Total number of coupons created by rules in this campaign. | [optional] +**CustomEffectCount** | Pointer to **int32** | Total number of custom effects triggered by rules in this campaign. | [optional] **ReferralCreationCount** | Pointer to **int32** | Total number of referrals created by rules in this campaign. | [optional] +**AddFreeItemEffectCount** | Pointer to **int32** | Total number of times triggering add free item effext is allowed in this campaign. | [optional] **AwardedGiveawaysCount** | Pointer to **int32** | Total number of giveaways awarded by rules in this campaign. | [optional] **CreatedLoyaltyPointsCount** | Pointer to **float32** | Total number of loyalty points created by rules in this campaign. | [optional] **CreatedLoyaltyPointsEffectCount** | Pointer to **int32** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] **RedeemedLoyaltyPointsCount** | Pointer to **float32** | Total number of loyalty points redeemed by rules in this campaign. | [optional] **RedeemedLoyaltyPointsEffectCount** | Pointer to **int32** | Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional] +**CallApiEffectCount** | Pointer to **int32** | Total number of webhook triggered by rules in this campaign. | [optional] **LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received by this campaign. | [optional] -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the campaign or any of its elements. | [optional] +**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] **CreatedBy** | Pointer to **string** | Name of the user who created this campaign if available. | [optional] **UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign if available. | [optional] **TemplateId** | Pointer to **int32** | The ID of the Campaign Template this Campaign was created from. | [optional] @@ -590,6 +593,31 @@ HasCouponCreationCount returns a boolean if a field has been set. SetCouponCreationCount gets a reference to the given int32 and assigns it to the CouponCreationCount field. +### GetCustomEffectCount + +`func (o *Campaign) GetCustomEffectCount() int32` + +GetCustomEffectCount returns the CustomEffectCount field if non-nil, zero value otherwise. + +### GetCustomEffectCountOk + +`func (o *Campaign) GetCustomEffectCountOk() (int32, bool)` + +GetCustomEffectCountOk returns a tuple with the CustomEffectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomEffectCount + +`func (o *Campaign) HasCustomEffectCount() bool` + +HasCustomEffectCount returns a boolean if a field has been set. + +### SetCustomEffectCount + +`func (o *Campaign) SetCustomEffectCount(v int32)` + +SetCustomEffectCount gets a reference to the given int32 and assigns it to the CustomEffectCount field. + ### GetReferralCreationCount `func (o *Campaign) GetReferralCreationCount() int32` @@ -615,6 +643,31 @@ HasReferralCreationCount returns a boolean if a field has been set. SetReferralCreationCount gets a reference to the given int32 and assigns it to the ReferralCreationCount field. +### GetAddFreeItemEffectCount + +`func (o *Campaign) GetAddFreeItemEffectCount() int32` + +GetAddFreeItemEffectCount returns the AddFreeItemEffectCount field if non-nil, zero value otherwise. + +### GetAddFreeItemEffectCountOk + +`func (o *Campaign) GetAddFreeItemEffectCountOk() (int32, bool)` + +GetAddFreeItemEffectCountOk returns a tuple with the AddFreeItemEffectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAddFreeItemEffectCount + +`func (o *Campaign) HasAddFreeItemEffectCount() bool` + +HasAddFreeItemEffectCount returns a boolean if a field has been set. + +### SetAddFreeItemEffectCount + +`func (o *Campaign) SetAddFreeItemEffectCount(v int32)` + +SetAddFreeItemEffectCount gets a reference to the given int32 and assigns it to the AddFreeItemEffectCount field. + ### GetAwardedGiveawaysCount `func (o *Campaign) GetAwardedGiveawaysCount() int32` @@ -740,6 +793,31 @@ HasRedeemedLoyaltyPointsEffectCount returns a boolean if a field has been set. SetRedeemedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the RedeemedLoyaltyPointsEffectCount field. +### GetCallApiEffectCount + +`func (o *Campaign) GetCallApiEffectCount() int32` + +GetCallApiEffectCount returns the CallApiEffectCount field if non-nil, zero value otherwise. + +### GetCallApiEffectCountOk + +`func (o *Campaign) GetCallApiEffectCountOk() (int32, bool)` + +GetCallApiEffectCountOk returns a tuple with the CallApiEffectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCallApiEffectCount + +`func (o *Campaign) HasCallApiEffectCount() bool` + +HasCallApiEffectCount returns a boolean if a field has been set. + +### SetCallApiEffectCount + +`func (o *Campaign) SetCallApiEffectCount(v int32)` + +SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. + ### GetLastActivity `func (o *Campaign) GetLastActivity() time.Time` diff --git a/docs/CampaignActivationRequest.md b/docs/CampaignActivationRequest.md new file mode 100644 index 00000000..989f90e2 --- /dev/null +++ b/docs/CampaignActivationRequest.md @@ -0,0 +1,39 @@ +# CampaignActivationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserIds** | Pointer to **[]int32** | The list of IDs of the users who will receive the activation request. | + +## Methods + +### GetUserIds + +`func (o *CampaignActivationRequest) GetUserIds() []int32` + +GetUserIds returns the UserIds field if non-nil, zero value otherwise. + +### GetUserIdsOk + +`func (o *CampaignActivationRequest) GetUserIdsOk() ([]int32, bool)` + +GetUserIdsOk returns a tuple with the UserIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUserIds + +`func (o *CampaignActivationRequest) HasUserIds() bool` + +HasUserIds returns a boolean if a field has been set. + +### SetUserIds + +`func (o *CampaignActivationRequest) SetUserIds(v []int32)` + +SetUserIds gets a reference to the given []int32 and assigns it to the UserIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignCollection.md b/docs/CampaignCollection.md new file mode 100644 index 00000000..c8d35918 --- /dev/null +++ b/docs/CampaignCollection.md @@ -0,0 +1,299 @@ +# CampaignCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] +**Name** | Pointer to **string** | The name of this collection. | +**ModifiedBy** | Pointer to **int32** | ID of the user who last updated this effect if available. | [optional] +**CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | +**ApplicationId** | Pointer to **int32** | The ID of the Application that owns this entity. | [optional] +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | [optional] +**Payload** | Pointer to **[]string** | The content of the collection. | [optional] + +## Methods + +### GetId + +`func (o *CampaignCollection) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignCollection) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CampaignCollection) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CampaignCollection) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CampaignCollection) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignCollection) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CampaignCollection) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CampaignCollection) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetAccountId + +`func (o *CampaignCollection) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *CampaignCollection) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *CampaignCollection) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *CampaignCollection) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetModified + +`func (o *CampaignCollection) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignCollection) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *CampaignCollection) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *CampaignCollection) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetDescription + +`func (o *CampaignCollection) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignCollection) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *CampaignCollection) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *CampaignCollection) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetName + +`func (o *CampaignCollection) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignCollection) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CampaignCollection) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CampaignCollection) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetModifiedBy + +`func (o *CampaignCollection) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *CampaignCollection) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *CampaignCollection) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *CampaignCollection) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *CampaignCollection) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CampaignCollection) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *CampaignCollection) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *CampaignCollection) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetApplicationId + +`func (o *CampaignCollection) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *CampaignCollection) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *CampaignCollection) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *CampaignCollection) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetCampaignId + +`func (o *CampaignCollection) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *CampaignCollection) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *CampaignCollection) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *CampaignCollection) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetPayload + +`func (o *CampaignCollection) GetPayload() []string` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *CampaignCollection) GetPayloadOk() ([]string, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *CampaignCollection) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *CampaignCollection) SetPayload(v []string)` + +SetPayload gets a reference to the given []string and assigns it to the Payload field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignCollectionWithoutPayload.md b/docs/CampaignCollectionWithoutPayload.md new file mode 100644 index 00000000..1442072a --- /dev/null +++ b/docs/CampaignCollectionWithoutPayload.md @@ -0,0 +1,273 @@ +# CampaignCollectionWithoutPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] +**Name** | Pointer to **string** | The name of this collection. | +**ModifiedBy** | Pointer to **int32** | ID of the user who last updated this effect if available. | [optional] +**CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | +**ApplicationId** | Pointer to **int32** | The ID of the Application that owns this entity. | [optional] +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | [optional] + +## Methods + +### GetId + +`func (o *CampaignCollectionWithoutPayload) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignCollectionWithoutPayload) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CampaignCollectionWithoutPayload) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CampaignCollectionWithoutPayload) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CampaignCollectionWithoutPayload) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignCollectionWithoutPayload) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CampaignCollectionWithoutPayload) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CampaignCollectionWithoutPayload) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetAccountId + +`func (o *CampaignCollectionWithoutPayload) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *CampaignCollectionWithoutPayload) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *CampaignCollectionWithoutPayload) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *CampaignCollectionWithoutPayload) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetModified + +`func (o *CampaignCollectionWithoutPayload) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignCollectionWithoutPayload) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *CampaignCollectionWithoutPayload) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *CampaignCollectionWithoutPayload) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetDescription + +`func (o *CampaignCollectionWithoutPayload) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignCollectionWithoutPayload) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *CampaignCollectionWithoutPayload) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *CampaignCollectionWithoutPayload) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetName + +`func (o *CampaignCollectionWithoutPayload) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignCollectionWithoutPayload) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CampaignCollectionWithoutPayload) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CampaignCollectionWithoutPayload) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetModifiedBy + +`func (o *CampaignCollectionWithoutPayload) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *CampaignCollectionWithoutPayload) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *CampaignCollectionWithoutPayload) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *CampaignCollectionWithoutPayload) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *CampaignCollectionWithoutPayload) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CampaignCollectionWithoutPayload) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *CampaignCollectionWithoutPayload) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *CampaignCollectionWithoutPayload) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetApplicationId + +`func (o *CampaignCollectionWithoutPayload) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *CampaignCollectionWithoutPayload) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *CampaignCollectionWithoutPayload) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *CampaignCollectionWithoutPayload) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetCampaignId + +`func (o *CampaignCollectionWithoutPayload) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *CampaignCollectionWithoutPayload) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *CampaignCollectionWithoutPayload) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *CampaignCollectionWithoutPayload) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignCopy.md b/docs/CampaignCopy.md index 646f6991..86a98918 100644 --- a/docs/CampaignCopy.md +++ b/docs/CampaignCopy.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | Name of the copied campaign (Defaults to \"Copy of original campaign name\") | [optional] -**ApplicationIds** | Pointer to **[]int32** | Application IDs of the applications to which a campaign should be copied to | +**Name** | Pointer to **string** | Name of the copied campaign (Defaults to \"Copy of original campaign name\"). | [optional] +**ApplicationIds** | Pointer to **[]int32** | Application IDs of the applications to which a campaign should be copied to. | **Description** | Pointer to **string** | A detailed description of the campaign. | [optional] **StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] **EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] diff --git a/docs/CampaignCreatedNotification.md b/docs/CampaignCreatedNotification.md new file mode 100644 index 00000000..9f945d5f --- /dev/null +++ b/docs/CampaignCreatedNotification.md @@ -0,0 +1,39 @@ +# CampaignCreatedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | Pointer to [**Campaign**](Campaign.md) | | + +## Methods + +### GetCampaign + +`func (o *CampaignCreatedNotification) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignCreatedNotification) GetCampaignOk() (Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaign + +`func (o *CampaignCreatedNotification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *CampaignCreatedNotification) SetCampaign(v Campaign)` + +SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignDeletedNotification.md b/docs/CampaignDeletedNotification.md new file mode 100644 index 00000000..36f0f6d3 --- /dev/null +++ b/docs/CampaignDeletedNotification.md @@ -0,0 +1,39 @@ +# CampaignDeletedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | Pointer to [**Campaign**](Campaign.md) | | + +## Methods + +### GetCampaign + +`func (o *CampaignDeletedNotification) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignDeletedNotification) GetCampaignOk() (Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaign + +`func (o *CampaignDeletedNotification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *CampaignDeletedNotification) SetCampaign(v Campaign)` + +SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignEditedNotification.md b/docs/CampaignEditedNotification.md new file mode 100644 index 00000000..ce40c987 --- /dev/null +++ b/docs/CampaignEditedNotification.md @@ -0,0 +1,65 @@ +# CampaignEditedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | Pointer to [**Campaign**](Campaign.md) | | +**OldCampaign** | Pointer to [**Campaign**](Campaign.md) | | + +## Methods + +### GetCampaign + +`func (o *CampaignEditedNotification) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignEditedNotification) GetCampaignOk() (Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaign + +`func (o *CampaignEditedNotification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *CampaignEditedNotification) SetCampaign(v Campaign)` + +SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. + +### GetOldCampaign + +`func (o *CampaignEditedNotification) GetOldCampaign() Campaign` + +GetOldCampaign returns the OldCampaign field if non-nil, zero value otherwise. + +### GetOldCampaignOk + +`func (o *CampaignEditedNotification) GetOldCampaignOk() (Campaign, bool)` + +GetOldCampaignOk returns a tuple with the OldCampaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOldCampaign + +`func (o *CampaignEditedNotification) HasOldCampaign() bool` + +HasOldCampaign returns a boolean if a field has been set. + +### SetOldCampaign + +`func (o *CampaignEditedNotification) SetOldCampaign(v Campaign)` + +SetOldCampaign gets a reference to the given Campaign and assigns it to the OldCampaign field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md index 4cd65056..4855a5e9 100644 --- a/docs/CampaignGroup.md +++ b/docs/CampaignGroup.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **Name** | Pointer to **string** | The name of this campaign group. | **Description** | Pointer to **string** | A longer description of the campaign group. | [optional] -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for | [optional] -**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for. | [optional] +**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns. | [optional] ## Methods diff --git a/docs/CampaignNotification.md b/docs/CampaignNotification.md new file mode 100644 index 00000000..79f87533 --- /dev/null +++ b/docs/CampaignNotification.md @@ -0,0 +1,39 @@ +# CampaignNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | Pointer to **string** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] | + +## Methods + +### GetEvent + +`func (o *CampaignNotification) GetEvent() string` + +GetEvent returns the Event field if non-nil, zero value otherwise. + +### GetEventOk + +`func (o *CampaignNotification) GetEventOk() (string, bool)` + +GetEventOk returns a tuple with the Event field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvent + +`func (o *CampaignNotification) HasEvent() bool` + +HasEvent returns a boolean if a field has been set. + +### SetEvent + +`func (o *CampaignNotification) SetEvent(v string)` + +SetEvent gets a reference to the given string and assigns it to the Event field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignPrioritiesChangedNotification.md b/docs/CampaignPrioritiesChangedNotification.md new file mode 100644 index 00000000..471164c1 --- /dev/null +++ b/docs/CampaignPrioritiesChangedNotification.md @@ -0,0 +1,91 @@ +# CampaignPrioritiesChangedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | Pointer to [**Application**](Application.md) | | +**OldPriorities** | Pointer to [**map[string][]int32**](array.md) | Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] | [optional] +**Priorities** | Pointer to [**map[string][]int32**](array.md) | Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] | + +## Methods + +### GetApplication + +`func (o *CampaignPrioritiesChangedNotification) GetApplication() Application` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *CampaignPrioritiesChangedNotification) GetApplicationOk() (Application, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplication + +`func (o *CampaignPrioritiesChangedNotification) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### SetApplication + +`func (o *CampaignPrioritiesChangedNotification) SetApplication(v Application)` + +SetApplication gets a reference to the given Application and assigns it to the Application field. + +### GetOldPriorities + +`func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() map[string][]int32` + +GetOldPriorities returns the OldPriorities field if non-nil, zero value otherwise. + +### GetOldPrioritiesOk + +`func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (map[string][]int32, bool)` + +GetOldPrioritiesOk returns a tuple with the OldPriorities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOldPriorities + +`func (o *CampaignPrioritiesChangedNotification) HasOldPriorities() bool` + +HasOldPriorities returns a boolean if a field has been set. + +### SetOldPriorities + +`func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v map[string][]int32)` + +SetOldPriorities gets a reference to the given map[string][]int32 and assigns it to the OldPriorities field. + +### GetPriorities + +`func (o *CampaignPrioritiesChangedNotification) GetPriorities() map[string][]int32` + +GetPriorities returns the Priorities field if non-nil, zero value otherwise. + +### GetPrioritiesOk + +`func (o *CampaignPrioritiesChangedNotification) GetPrioritiesOk() (map[string][]int32, bool)` + +GetPrioritiesOk returns a tuple with the Priorities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPriorities + +`func (o *CampaignPrioritiesChangedNotification) HasPriorities() bool` + +HasPriorities returns a boolean if a field has been set. + +### SetPriorities + +`func (o *CampaignPrioritiesChangedNotification) SetPriorities(v map[string][]int32)` + +SetPriorities gets a reference to the given map[string][]int32 and assigns it to the Priorities field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignPrioritiesV2.md b/docs/CampaignPrioritiesV2.md new file mode 100644 index 00000000..8959a196 --- /dev/null +++ b/docs/CampaignPrioritiesV2.md @@ -0,0 +1,91 @@ +# CampaignPrioritiesV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Exclusive** | Pointer to [**[]CampaignSetIDs**](CampaignSetIDs.md) | | [optional] +**Stackable** | Pointer to [**[]CampaignSetIDs**](CampaignSetIDs.md) | | [optional] +**Universal** | Pointer to [**[]CampaignSetIDs**](CampaignSetIDs.md) | | [optional] + +## Methods + +### GetExclusive + +`func (o *CampaignPrioritiesV2) GetExclusive() []CampaignSetIDs` + +GetExclusive returns the Exclusive field if non-nil, zero value otherwise. + +### GetExclusiveOk + +`func (o *CampaignPrioritiesV2) GetExclusiveOk() ([]CampaignSetIDs, bool)` + +GetExclusiveOk returns a tuple with the Exclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExclusive + +`func (o *CampaignPrioritiesV2) HasExclusive() bool` + +HasExclusive returns a boolean if a field has been set. + +### SetExclusive + +`func (o *CampaignPrioritiesV2) SetExclusive(v []CampaignSetIDs)` + +SetExclusive gets a reference to the given []CampaignSetIDs and assigns it to the Exclusive field. + +### GetStackable + +`func (o *CampaignPrioritiesV2) GetStackable() []CampaignSetIDs` + +GetStackable returns the Stackable field if non-nil, zero value otherwise. + +### GetStackableOk + +`func (o *CampaignPrioritiesV2) GetStackableOk() ([]CampaignSetIDs, bool)` + +GetStackableOk returns a tuple with the Stackable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStackable + +`func (o *CampaignPrioritiesV2) HasStackable() bool` + +HasStackable returns a boolean if a field has been set. + +### SetStackable + +`func (o *CampaignPrioritiesV2) SetStackable(v []CampaignSetIDs)` + +SetStackable gets a reference to the given []CampaignSetIDs and assigns it to the Stackable field. + +### GetUniversal + +`func (o *CampaignPrioritiesV2) GetUniversal() []CampaignSetIDs` + +GetUniversal returns the Universal field if non-nil, zero value otherwise. + +### GetUniversalOk + +`func (o *CampaignPrioritiesV2) GetUniversalOk() ([]CampaignSetIDs, bool)` + +GetUniversalOk returns a tuple with the Universal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUniversal + +`func (o *CampaignPrioritiesV2) HasUniversal() bool` + +HasUniversal returns a boolean if a field has been set. + +### SetUniversal + +`func (o *CampaignPrioritiesV2) SetUniversal(v []CampaignSetIDs)` + +SetUniversal gets a reference to the given []CampaignSetIDs and assigns it to the Universal field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignRulesetChangedNotification.md b/docs/CampaignRulesetChangedNotification.md new file mode 100644 index 00000000..63fa4352 --- /dev/null +++ b/docs/CampaignRulesetChangedNotification.md @@ -0,0 +1,91 @@ +# CampaignRulesetChangedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | Pointer to [**Campaign**](Campaign.md) | | +**OldRuleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] +**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | + +## Methods + +### GetCampaign + +`func (o *CampaignRulesetChangedNotification) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignRulesetChangedNotification) GetCampaignOk() (Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaign + +`func (o *CampaignRulesetChangedNotification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *CampaignRulesetChangedNotification) SetCampaign(v Campaign)` + +SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. + +### GetOldRuleset + +`func (o *CampaignRulesetChangedNotification) GetOldRuleset() Ruleset` + +GetOldRuleset returns the OldRuleset field if non-nil, zero value otherwise. + +### GetOldRulesetOk + +`func (o *CampaignRulesetChangedNotification) GetOldRulesetOk() (Ruleset, bool)` + +GetOldRulesetOk returns a tuple with the OldRuleset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOldRuleset + +`func (o *CampaignRulesetChangedNotification) HasOldRuleset() bool` + +HasOldRuleset returns a boolean if a field has been set. + +### SetOldRuleset + +`func (o *CampaignRulesetChangedNotification) SetOldRuleset(v Ruleset)` + +SetOldRuleset gets a reference to the given Ruleset and assigns it to the OldRuleset field. + +### GetRuleset + +`func (o *CampaignRulesetChangedNotification) GetRuleset() Ruleset` + +GetRuleset returns the Ruleset field if non-nil, zero value otherwise. + +### GetRulesetOk + +`func (o *CampaignRulesetChangedNotification) GetRulesetOk() (Ruleset, bool)` + +GetRulesetOk returns a tuple with the Ruleset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRuleset + +`func (o *CampaignRulesetChangedNotification) HasRuleset() bool` + +HasRuleset returns a boolean if a field has been set. + +### SetRuleset + +`func (o *CampaignRulesetChangedNotification) SetRuleset(v Ruleset)` + +SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignSearch.md b/docs/CampaignSearch.md index 46c76885..20d4af02 100644 --- a/docs/CampaignSearch.md +++ b/docs/CampaignSearch.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes. | ## Methods diff --git a/docs/CampaignSet.md b/docs/CampaignSet.md index f3ec87bd..58940bcf 100644 --- a/docs/CampaignSet.md +++ b/docs/CampaignSet.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**Version** | Pointer to **int32** | Version of the campaign set | +**Version** | Pointer to **int32** | Version of the campaign set. | **Set** | Pointer to [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | | ## Methods diff --git a/docs/CampaignSetBranchNode.md b/docs/CampaignSetBranchNode.md index 07f81e83..3984366d 100644 --- a/docs/CampaignSetBranchNode.md +++ b/docs/CampaignSetBranchNode.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | Pointer to **string** | Indicates the node type | +**Type** | Pointer to **string** | Indicates the node type. | **Name** | Pointer to **string** | Name of the set | -**Operator** | Pointer to **string** | How does the set operates on its elements | -**Elements** | Pointer to [**[]CampaignSetNode**](CampaignSetNode.md) | Child elements of this set | +**Operator** | Pointer to **string** | How does the set operates on its elements. | +**Elements** | Pointer to [**[]CampaignSetNode**](CampaignSetNode.md) | Child elements of this set. | ## Methods diff --git a/docs/CampaignSetIDs.md b/docs/CampaignSetIDs.md new file mode 100644 index 00000000..3f4825d0 --- /dev/null +++ b/docs/CampaignSetIDs.md @@ -0,0 +1,39 @@ +# CampaignSetIDs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignId** | Pointer to **int32** | ID of the campaign | [optional] + +## Methods + +### GetCampaignId + +`func (o *CampaignSetIDs) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *CampaignSetIDs) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *CampaignSetIDs) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *CampaignSetIDs) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignSetLeafNode.md b/docs/CampaignSetLeafNode.md index ce971fa6..67544352 100644 --- a/docs/CampaignSetLeafNode.md +++ b/docs/CampaignSetLeafNode.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | Pointer to **string** | Indicates the node type | +**Type** | Pointer to **string** | Indicates the node type. | **CampaignId** | Pointer to **int32** | ID of the campaign | ## Methods diff --git a/docs/CampaignSetV2.md b/docs/CampaignSetV2.md new file mode 100644 index 00000000..59b1d607 --- /dev/null +++ b/docs/CampaignSetV2.md @@ -0,0 +1,143 @@ +# CampaignSetV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | +**Version** | Pointer to **int32** | Version of the campaign set. | +**Set** | Pointer to [**CampaignPrioritiesV2**](CampaignPrioritiesV2.md) | | + +## Methods + +### GetId + +`func (o *CampaignSetV2) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignSetV2) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CampaignSetV2) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CampaignSetV2) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CampaignSetV2) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignSetV2) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CampaignSetV2) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CampaignSetV2) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetApplicationId + +`func (o *CampaignSetV2) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *CampaignSetV2) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *CampaignSetV2) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *CampaignSetV2) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetVersion + +`func (o *CampaignSetV2) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *CampaignSetV2) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *CampaignSetV2) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *CampaignSetV2) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetSet + +`func (o *CampaignSetV2) GetSet() CampaignPrioritiesV2` + +GetSet returns the Set field if non-nil, zero value otherwise. + +### GetSetOk + +`func (o *CampaignSetV2) GetSetOk() (CampaignPrioritiesV2, bool)` + +GetSetOk returns a tuple with the Set field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSet + +`func (o *CampaignSetV2) HasSet() bool` + +HasSet returns a boolean if a field has been set. + +### SetSet + +`func (o *CampaignSetV2) SetSet(v CampaignPrioritiesV2)` + +SetSet gets a reference to the given CampaignPrioritiesV2 and assigns it to the Set field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignStateChangedNotification.md b/docs/CampaignStateChangedNotification.md new file mode 100644 index 00000000..d09dcb76 --- /dev/null +++ b/docs/CampaignStateChangedNotification.md @@ -0,0 +1,91 @@ +# CampaignStateChangedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | Pointer to [**Campaign**](Campaign.md) | | +**OldState** | Pointer to **string** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] | +**NewState** | Pointer to **string** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] | + +## Methods + +### GetCampaign + +`func (o *CampaignStateChangedNotification) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignStateChangedNotification) GetCampaignOk() (Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaign + +`func (o *CampaignStateChangedNotification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *CampaignStateChangedNotification) SetCampaign(v Campaign)` + +SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. + +### GetOldState + +`func (o *CampaignStateChangedNotification) GetOldState() string` + +GetOldState returns the OldState field if non-nil, zero value otherwise. + +### GetOldStateOk + +`func (o *CampaignStateChangedNotification) GetOldStateOk() (string, bool)` + +GetOldStateOk returns a tuple with the OldState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOldState + +`func (o *CampaignStateChangedNotification) HasOldState() bool` + +HasOldState returns a boolean if a field has been set. + +### SetOldState + +`func (o *CampaignStateChangedNotification) SetOldState(v string)` + +SetOldState gets a reference to the given string and assigns it to the OldState field. + +### GetNewState + +`func (o *CampaignStateChangedNotification) GetNewState() string` + +GetNewState returns the NewState field if non-nil, zero value otherwise. + +### GetNewStateOk + +`func (o *CampaignStateChangedNotification) GetNewStateOk() (string, bool)` + +GetNewStateOk returns a tuple with the NewState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNewState + +`func (o *CampaignStateChangedNotification) HasNewState() bool` + +HasNewState returns a boolean if a field has been set. + +### SetNewState + +`func (o *CampaignStateChangedNotification) SetNewState(v string)` + +SetNewState gets a reference to the given string and assigns it to the NewState field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignTemplate.md b/docs/CampaignTemplate.md index 73a5a070..81346035 100644 --- a/docs/CampaignTemplate.md +++ b/docs/CampaignTemplate.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **UserId** | Pointer to **int32** | The ID of the account that owns this entity. | @@ -19,9 +19,11 @@ Name | Type | Description | Notes **Features** | Pointer to **[]string** | A list of features for the campaign template. | [optional] **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template | [optional] +**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template. | [optional] **TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | Template parameters are fields which can be used to replace values in a rule. | [optional] -**ApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this campaign template A list of the IDs of the applications that are subscribed to this campaign template | +**ApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this campaign template. A list of the IDs of the applications that are subscribed to this campaign template. | +**CampaignCollections** | Pointer to [**[]CampaignTemplateCollection**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional] +**DefaultCampaignGroupId** | Pointer to **int32** | The default campaignGroupId. | [optional] **Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the campaign template or any of its elements. | [optional] **UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign template if available. | [optional] **ValidApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | @@ -478,6 +480,56 @@ HasApplicationsIds returns a boolean if a field has been set. SetApplicationsIds gets a reference to the given []int32 and assigns it to the ApplicationsIds field. +### GetCampaignCollections + +`func (o *CampaignTemplate) GetCampaignCollections() []CampaignTemplateCollection` + +GetCampaignCollections returns the CampaignCollections field if non-nil, zero value otherwise. + +### GetCampaignCollectionsOk + +`func (o *CampaignTemplate) GetCampaignCollectionsOk() ([]CampaignTemplateCollection, bool)` + +GetCampaignCollectionsOk returns a tuple with the CampaignCollections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignCollections + +`func (o *CampaignTemplate) HasCampaignCollections() bool` + +HasCampaignCollections returns a boolean if a field has been set. + +### SetCampaignCollections + +`func (o *CampaignTemplate) SetCampaignCollections(v []CampaignTemplateCollection)` + +SetCampaignCollections gets a reference to the given []CampaignTemplateCollection and assigns it to the CampaignCollections field. + +### GetDefaultCampaignGroupId + +`func (o *CampaignTemplate) GetDefaultCampaignGroupId() int32` + +GetDefaultCampaignGroupId returns the DefaultCampaignGroupId field if non-nil, zero value otherwise. + +### GetDefaultCampaignGroupIdOk + +`func (o *CampaignTemplate) GetDefaultCampaignGroupIdOk() (int32, bool)` + +GetDefaultCampaignGroupIdOk returns a tuple with the DefaultCampaignGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultCampaignGroupId + +`func (o *CampaignTemplate) HasDefaultCampaignGroupId() bool` + +HasDefaultCampaignGroupId returns a boolean if a field has been set. + +### SetDefaultCampaignGroupId + +`func (o *CampaignTemplate) SetDefaultCampaignGroupId(v int32)` + +SetDefaultCampaignGroupId gets a reference to the given int32 and assigns it to the DefaultCampaignGroupId field. + ### GetUpdated `func (o *CampaignTemplate) GetUpdated() time.Time` diff --git a/docs/CampaignTemplateCollection.md b/docs/CampaignTemplateCollection.md new file mode 100644 index 00000000..40368172 --- /dev/null +++ b/docs/CampaignTemplateCollection.md @@ -0,0 +1,65 @@ +# CampaignTemplateCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of this collection. | +**Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] + +## Methods + +### GetName + +`func (o *CampaignTemplateCollection) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplateCollection) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CampaignTemplateCollection) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CampaignTemplateCollection) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *CampaignTemplateCollection) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignTemplateCollection) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *CampaignTemplateCollection) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *CampaignTemplateCollection) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignTemplateParams.md b/docs/CampaignTemplateParams.md index f9bfacf1..22b6a6ec 100644 --- a/docs/CampaignTemplateParams.md +++ b/docs/CampaignTemplateParams.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | Name of the campaign template parameter. | -**Type** | Pointer to **string** | Can be one of the following three ['string','number','boolean'] | +**Type** | Pointer to **string** | Defines the type of parameter value. | **Description** | Pointer to **string** | Explains the meaning of this template parameter and the placeholder value that will define it. It is used on campaign creation from this template. | +**AttributeId** | Pointer to **int32** | ID of the corresponding attribute. | [optional] ## Methods @@ -85,6 +86,31 @@ HasDescription returns a boolean if a field has been set. SetDescription gets a reference to the given string and assigns it to the Description field. +### GetAttributeId + +`func (o *CampaignTemplateParams) GetAttributeId() int32` + +GetAttributeId returns the AttributeId field if non-nil, zero value otherwise. + +### GetAttributeIdOk + +`func (o *CampaignTemplateParams) GetAttributeIdOk() (int32, bool)` + +GetAttributeIdOk returns a tuple with the AttributeId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributeId + +`func (o *CampaignTemplateParams) HasAttributeId() bool` + +HasAttributeId returns a boolean if a field has been set. + +### SetAttributeId + +`func (o *CampaignTemplateParams) SetAttributeId(v int32)` + +SetAttributeId gets a reference to the given int32 and assigns it to the AttributeId field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CardLedgerTransactionLogEntry.md b/docs/CardLedgerTransactionLogEntry.md new file mode 100644 index 00000000..033e9524 --- /dev/null +++ b/docs/CardLedgerTransactionLogEntry.md @@ -0,0 +1,351 @@ +# CardLedgerTransactionLogEntry + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to [**time.Time**](time.Time.md) | Date and time the loyalty card transaction occurred. | +**ProgramId** | Pointer to **int32** | ID of the loyalty program. | +**CardIdentifier** | Pointer to **string** | Identifier of the loyalty card. | +**ApplicationId** | Pointer to **int32** | The ID of the Application that owns this entity. | [optional] +**SessionId** | Pointer to **int32** | The **internal** ID of the session. | [optional] +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | +**Type** | Pointer to **string** | Type of transaction. Possible values are: - `addition`: Points were added. - `subtraction`: Points were subtracted. | +**Name** | Pointer to **string** | Name or reason of the loyalty ledger transaction. | +**StartDate** | Pointer to **string** | Date when points become active. Possible values are: - `immediate`: Points are active immediately. - `timestamp value`: Points become active from the given date. | +**ExpiryDate** | Pointer to **string** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points become active from the given date. | +**SubledgerId** | Pointer to **string** | ID of the subledger. | +**Amount** | Pointer to **float32** | Amount of loyalty points added or deducted in the transaction. | +**Id** | Pointer to **int32** | ID of the loyalty ledger entry. | + +## Methods + +### GetCreated + +`func (o *CardLedgerTransactionLogEntry) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CardLedgerTransactionLogEntry) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CardLedgerTransactionLogEntry) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CardLedgerTransactionLogEntry) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetProgramId + +`func (o *CardLedgerTransactionLogEntry) GetProgramId() int32` + +GetProgramId returns the ProgramId field if non-nil, zero value otherwise. + +### GetProgramIdOk + +`func (o *CardLedgerTransactionLogEntry) GetProgramIdOk() (int32, bool)` + +GetProgramIdOk returns a tuple with the ProgramId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramId + +`func (o *CardLedgerTransactionLogEntry) HasProgramId() bool` + +HasProgramId returns a boolean if a field has been set. + +### SetProgramId + +`func (o *CardLedgerTransactionLogEntry) SetProgramId(v int32)` + +SetProgramId gets a reference to the given int32 and assigns it to the ProgramId field. + +### GetCardIdentifier + +`func (o *CardLedgerTransactionLogEntry) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *CardLedgerTransactionLogEntry) GetCardIdentifierOk() (string, bool)` + +GetCardIdentifierOk returns a tuple with the CardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardIdentifier + +`func (o *CardLedgerTransactionLogEntry) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *CardLedgerTransactionLogEntry) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + +### GetApplicationId + +`func (o *CardLedgerTransactionLogEntry) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *CardLedgerTransactionLogEntry) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *CardLedgerTransactionLogEntry) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *CardLedgerTransactionLogEntry) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetSessionId + +`func (o *CardLedgerTransactionLogEntry) GetSessionId() int32` + +GetSessionId returns the SessionId field if non-nil, zero value otherwise. + +### GetSessionIdOk + +`func (o *CardLedgerTransactionLogEntry) GetSessionIdOk() (int32, bool)` + +GetSessionIdOk returns a tuple with the SessionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSessionId + +`func (o *CardLedgerTransactionLogEntry) HasSessionId() bool` + +HasSessionId returns a boolean if a field has been set. + +### SetSessionId + +`func (o *CardLedgerTransactionLogEntry) SetSessionId(v int32)` + +SetSessionId gets a reference to the given int32 and assigns it to the SessionId field. + +### GetCustomerSessionId + +`func (o *CardLedgerTransactionLogEntry) GetCustomerSessionId() string` + +GetCustomerSessionId returns the CustomerSessionId field if non-nil, zero value otherwise. + +### GetCustomerSessionIdOk + +`func (o *CardLedgerTransactionLogEntry) GetCustomerSessionIdOk() (string, bool)` + +GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerSessionId + +`func (o *CardLedgerTransactionLogEntry) HasCustomerSessionId() bool` + +HasCustomerSessionId returns a boolean if a field has been set. + +### SetCustomerSessionId + +`func (o *CardLedgerTransactionLogEntry) SetCustomerSessionId(v string)` + +SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. + +### GetType + +`func (o *CardLedgerTransactionLogEntry) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CardLedgerTransactionLogEntry) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *CardLedgerTransactionLogEntry) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *CardLedgerTransactionLogEntry) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetName + +`func (o *CardLedgerTransactionLogEntry) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CardLedgerTransactionLogEntry) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CardLedgerTransactionLogEntry) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CardLedgerTransactionLogEntry) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetStartDate + +`func (o *CardLedgerTransactionLogEntry) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *CardLedgerTransactionLogEntry) GetStartDateOk() (string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartDate + +`func (o *CardLedgerTransactionLogEntry) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *CardLedgerTransactionLogEntry) SetStartDate(v string)` + +SetStartDate gets a reference to the given string and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *CardLedgerTransactionLogEntry) GetExpiryDate() string` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *CardLedgerTransactionLogEntry) GetExpiryDateOk() (string, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *CardLedgerTransactionLogEntry) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *CardLedgerTransactionLogEntry) SetExpiryDate(v string)` + +SetExpiryDate gets a reference to the given string and assigns it to the ExpiryDate field. + +### GetSubledgerId + +`func (o *CardLedgerTransactionLogEntry) GetSubledgerId() string` + +GetSubledgerId returns the SubledgerId field if non-nil, zero value otherwise. + +### GetSubledgerIdOk + +`func (o *CardLedgerTransactionLogEntry) GetSubledgerIdOk() (string, bool)` + +GetSubledgerIdOk returns a tuple with the SubledgerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubledgerId + +`func (o *CardLedgerTransactionLogEntry) HasSubledgerId() bool` + +HasSubledgerId returns a boolean if a field has been set. + +### SetSubledgerId + +`func (o *CardLedgerTransactionLogEntry) SetSubledgerId(v string)` + +SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. + +### GetAmount + +`func (o *CardLedgerTransactionLogEntry) GetAmount() float32` + +GetAmount returns the Amount field if non-nil, zero value otherwise. + +### GetAmountOk + +`func (o *CardLedgerTransactionLogEntry) GetAmountOk() (float32, bool)` + +GetAmountOk returns a tuple with the Amount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAmount + +`func (o *CardLedgerTransactionLogEntry) HasAmount() bool` + +HasAmount returns a boolean if a field has been set. + +### SetAmount + +`func (o *CardLedgerTransactionLogEntry) SetAmount(v float32)` + +SetAmount gets a reference to the given float32 and assigns it to the Amount field. + +### GetId + +`func (o *CardLedgerTransactionLogEntry) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CardLedgerTransactionLogEntry) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CardLedgerTransactionLogEntry) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CardLedgerTransactionLogEntry) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CardLedgerTransactionLogEntryIntegrationApi.md b/docs/CardLedgerTransactionLogEntryIntegrationApi.md new file mode 100644 index 00000000..19c93fbd --- /dev/null +++ b/docs/CardLedgerTransactionLogEntryIntegrationApi.md @@ -0,0 +1,351 @@ +# CardLedgerTransactionLogEntryIntegrationApi + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to [**time.Time**](time.Time.md) | Date and time the loyalty card transaction occurred. | +**ProgramId** | Pointer to **int32** | ID of the loyalty program. | +**CardIdentifier** | Pointer to **string** | Identifier of the loyalty card. | +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | +**Type** | Pointer to **string** | Type of transaction. Possible values are: - `addition`: Points were added. - `subtraction`: Points were subtracted. | +**Name** | Pointer to **string** | Name or reason of the loyalty ledger transaction. | +**StartDate** | Pointer to **string** | Date when points become active. Possible values are: - `immediate`: Points are active immediately. - `timestamp value`: Points become active from the given date. | +**ExpiryDate** | Pointer to **string** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date. | +**SubledgerId** | Pointer to **string** | ID of the subledger. | +**Amount** | Pointer to **float32** | Amount of loyalty points added or deducted in the transaction. | +**Id** | Pointer to **int32** | ID of the loyalty ledger transaction. | +**RulesetId** | Pointer to **int32** | The ID of the ruleset containing the rule that triggered this effect. | [optional] +**RuleName** | Pointer to **string** | The name of the rule that triggered this effect. | [optional] + +## Methods + +### GetCreated + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetProgramId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetProgramId() int32` + +GetProgramId returns the ProgramId field if non-nil, zero value otherwise. + +### GetProgramIdOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetProgramIdOk() (int32, bool)` + +GetProgramIdOk returns a tuple with the ProgramId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasProgramId() bool` + +HasProgramId returns a boolean if a field has been set. + +### SetProgramId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetProgramId(v int32)` + +SetProgramId gets a reference to the given int32 and assigns it to the ProgramId field. + +### GetCardIdentifier + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCardIdentifierOk() (string, bool)` + +GetCardIdentifierOk returns a tuple with the CardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardIdentifier + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + +### GetCustomerSessionId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCustomerSessionId() string` + +GetCustomerSessionId returns the CustomerSessionId field if non-nil, zero value otherwise. + +### GetCustomerSessionIdOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCustomerSessionIdOk() (string, bool)` + +GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerSessionId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasCustomerSessionId() bool` + +HasCustomerSessionId returns a boolean if a field has been set. + +### SetCustomerSessionId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCustomerSessionId(v string)` + +SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. + +### GetType + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetName + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetStartDate + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetStartDateOk() (string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartDate + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetStartDate(v string)` + +SetStartDate gets a reference to the given string and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetExpiryDate() string` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetExpiryDateOk() (string, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetExpiryDate(v string)` + +SetExpiryDate gets a reference to the given string and assigns it to the ExpiryDate field. + +### GetSubledgerId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetSubledgerId() string` + +GetSubledgerId returns the SubledgerId field if non-nil, zero value otherwise. + +### GetSubledgerIdOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetSubledgerIdOk() (string, bool)` + +GetSubledgerIdOk returns a tuple with the SubledgerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubledgerId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasSubledgerId() bool` + +HasSubledgerId returns a boolean if a field has been set. + +### SetSubledgerId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetSubledgerId(v string)` + +SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. + +### GetAmount + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetAmount() float32` + +GetAmount returns the Amount field if non-nil, zero value otherwise. + +### GetAmountOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetAmountOk() (float32, bool)` + +GetAmountOk returns a tuple with the Amount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAmount + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasAmount() bool` + +HasAmount returns a boolean if a field has been set. + +### SetAmount + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetAmount(v float32)` + +SetAmount gets a reference to the given float32 and assigns it to the Amount field. + +### GetId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetRulesetId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRulesetId() int32` + +GetRulesetId returns the RulesetId field if non-nil, zero value otherwise. + +### GetRulesetIdOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRulesetIdOk() (int32, bool)` + +GetRulesetIdOk returns a tuple with the RulesetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRulesetId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasRulesetId() bool` + +HasRulesetId returns a boolean if a field has been set. + +### SetRulesetId + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetRulesetId(v int32)` + +SetRulesetId gets a reference to the given int32 and assigns it to the RulesetId field. + +### GetRuleName + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRuleName() string` + +GetRuleName returns the RuleName field if non-nil, zero value otherwise. + +### GetRuleNameOk + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRuleNameOk() (string, bool)` + +GetRuleNameOk returns a tuple with the RuleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRuleName + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) HasRuleName() bool` + +HasRuleName returns a boolean if a field has been set. + +### SetRuleName + +`func (o *CardLedgerTransactionLogEntryIntegrationApi) SetRuleName(v string)` + +SetRuleName gets a reference to the given string and assigns it to the RuleName field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CartItem.md b/docs/CartItem.md index f53bb017..5c2b4d69 100644 --- a/docs/CartItem.md +++ b/docs/CartItem.md @@ -4,17 +4,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | Name of item | -**Sku** | Pointer to **string** | Stock keeping unit of item | -**Quantity** | Pointer to **int32** | Quantity of item. **Important:** If you enabled [cart item flattening](https://help.talon.one/hc/en-us/articles/360016036899-Flattening-Cart-Items), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. | -**Price** | Pointer to **float32** | Price of item | -**Category** | Pointer to **string** | Type, group or model of the item | [optional] -**Weight** | Pointer to **float32** | Weight of item in grams | [optional] -**Height** | Pointer to **float32** | Height of item in mm | [optional] -**Width** | Pointer to **float32** | Width of item in mm | [optional] -**Length** | Pointer to **float32** | Length of item in mm | [optional] -**Position** | Pointer to **float32** | Position of the Cart Item in the Cart (calculated internally) | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. You can use built-in attributes or create your own. See [Attributes](https://docs.talon.one/docs/dev/concepts/attributes). | [optional] +**Name** | Pointer to **string** | Name of item. | +**Sku** | Pointer to **string** | Stock keeping unit of item. | +**Quantity** | Pointer to **int32** | Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. | +**ReturnedQuantity** | Pointer to **int32** | Number of returned items, calculated internally based on returns of this item. | [optional] +**RemainingQuantity** | Pointer to **int32** | Remaining quantity of the item, calculated internally based on returns of this item. | [optional] +**Price** | Pointer to **float32** | Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/). If it is part of a catalog, setting a price here overrides the price from the catalog. | +**Category** | Pointer to **string** | Type, group or model of the item. | [optional] +**Weight** | Pointer to **float32** | Weight of item in grams. | [optional] +**Height** | Pointer to **float32** | Height of item in mm. | [optional] +**Width** | Pointer to **float32** | Width of item in mm. | [optional] +**Length** | Pointer to **float32** | Length of item in mm. | [optional] +**Position** | Pointer to **float32** | Position of the Cart Item in the Cart (calculated internally). | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. | [optional] +**AdditionalCosts** | Pointer to [**map[string]AdditionalCost**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). | [optional] +**CatalogItemID** | Pointer to **int32** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-cart-item-catalogs). | [optional] ## Methods @@ -93,6 +97,56 @@ HasQuantity returns a boolean if a field has been set. SetQuantity gets a reference to the given int32 and assigns it to the Quantity field. +### GetReturnedQuantity + +`func (o *CartItem) GetReturnedQuantity() int32` + +GetReturnedQuantity returns the ReturnedQuantity field if non-nil, zero value otherwise. + +### GetReturnedQuantityOk + +`func (o *CartItem) GetReturnedQuantityOk() (int32, bool)` + +GetReturnedQuantityOk returns a tuple with the ReturnedQuantity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReturnedQuantity + +`func (o *CartItem) HasReturnedQuantity() bool` + +HasReturnedQuantity returns a boolean if a field has been set. + +### SetReturnedQuantity + +`func (o *CartItem) SetReturnedQuantity(v int32)` + +SetReturnedQuantity gets a reference to the given int32 and assigns it to the ReturnedQuantity field. + +### GetRemainingQuantity + +`func (o *CartItem) GetRemainingQuantity() int32` + +GetRemainingQuantity returns the RemainingQuantity field if non-nil, zero value otherwise. + +### GetRemainingQuantityOk + +`func (o *CartItem) GetRemainingQuantityOk() (int32, bool)` + +GetRemainingQuantityOk returns a tuple with the RemainingQuantity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRemainingQuantity + +`func (o *CartItem) HasRemainingQuantity() bool` + +HasRemainingQuantity returns a boolean if a field has been set. + +### SetRemainingQuantity + +`func (o *CartItem) SetRemainingQuantity(v int32)` + +SetRemainingQuantity gets a reference to the given int32 and assigns it to the RemainingQuantity field. + ### GetPrice `func (o *CartItem) GetPrice() float32` @@ -293,6 +347,56 @@ HasAttributes returns a boolean if a field has been set. SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +### GetAdditionalCosts + +`func (o *CartItem) GetAdditionalCosts() map[string]AdditionalCost` + +GetAdditionalCosts returns the AdditionalCosts field if non-nil, zero value otherwise. + +### GetAdditionalCostsOk + +`func (o *CartItem) GetAdditionalCostsOk() (map[string]AdditionalCost, bool)` + +GetAdditionalCostsOk returns a tuple with the AdditionalCosts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalCosts + +`func (o *CartItem) HasAdditionalCosts() bool` + +HasAdditionalCosts returns a boolean if a field has been set. + +### SetAdditionalCosts + +`func (o *CartItem) SetAdditionalCosts(v map[string]AdditionalCost)` + +SetAdditionalCosts gets a reference to the given map[string]AdditionalCost and assigns it to the AdditionalCosts field. + +### GetCatalogItemID + +`func (o *CartItem) GetCatalogItemID() int32` + +GetCatalogItemID returns the CatalogItemID field if non-nil, zero value otherwise. + +### GetCatalogItemIDOk + +`func (o *CartItem) GetCatalogItemIDOk() (int32, bool)` + +GetCatalogItemIDOk returns a tuple with the CatalogItemID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCatalogItemID + +`func (o *CartItem) HasCatalogItemID() bool` + +HasCatalogItemID returns a boolean if a field has been set. + +### SetCatalogItemID + +`func (o *CartItem) SetCatalogItemID(v int32)` + +SetCatalogItemID gets a reference to the given int32 and assigns it to the CatalogItemID field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Catalog.md b/docs/Catalog.md new file mode 100644 index 00000000..8228b349 --- /dev/null +++ b/docs/Catalog.md @@ -0,0 +1,247 @@ +# Catalog + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**Name** | Pointer to **string** | The cart item catalog name. | +**Description** | Pointer to **string** | A description of this cart item catalog. | +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this catalog. | [optional] +**Version** | Pointer to **int32** | The current version of this catalog. | +**CreatedBy** | Pointer to **int32** | The ID of user who created this catalog. | + +## Methods + +### GetId + +`func (o *Catalog) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Catalog) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *Catalog) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Catalog) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *Catalog) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Catalog) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *Catalog) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *Catalog) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetAccountId + +`func (o *Catalog) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Catalog) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *Catalog) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *Catalog) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetModified + +`func (o *Catalog) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Catalog) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *Catalog) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *Catalog) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetName + +`func (o *Catalog) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Catalog) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *Catalog) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *Catalog) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *Catalog) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Catalog) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *Catalog) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *Catalog) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *Catalog) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *Catalog) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *Catalog) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *Catalog) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetVersion + +`func (o *Catalog) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *Catalog) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *Catalog) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *Catalog) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetCreatedBy + +`func (o *Catalog) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *Catalog) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *Catalog) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *Catalog) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CatalogAction.md b/docs/CatalogAction.md new file mode 100644 index 00000000..de7f0e38 --- /dev/null +++ b/docs/CatalogAction.md @@ -0,0 +1,65 @@ +# CatalogAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of sync action. | +**Payload** | Pointer to [**map[string]interface{}**](.md) | | + +## Methods + +### GetType + +`func (o *CatalogAction) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CatalogAction) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *CatalogAction) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *CatalogAction) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetPayload + +`func (o *CatalogAction) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *CatalogAction) GetPayloadOk() (map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *CatalogAction) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *CatalogAction) SetPayload(v map[string]interface{})` + +SetPayload gets a reference to the given map[string]interface{} and assigns it to the Payload field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CatalogActionFilter.md b/docs/CatalogActionFilter.md new file mode 100644 index 00000000..3f1aff17 --- /dev/null +++ b/docs/CatalogActionFilter.md @@ -0,0 +1,91 @@ +# CatalogActionFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attr** | Pointer to **string** | The name of the attribute to filter on. | +**Op** | Pointer to **string** | The filtering operator. | +**Value** | Pointer to [**map[string]interface{}**](.md) | The value to filter for. | + +## Methods + +### GetAttr + +`func (o *CatalogActionFilter) GetAttr() string` + +GetAttr returns the Attr field if non-nil, zero value otherwise. + +### GetAttrOk + +`func (o *CatalogActionFilter) GetAttrOk() (string, bool)` + +GetAttrOk returns a tuple with the Attr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttr + +`func (o *CatalogActionFilter) HasAttr() bool` + +HasAttr returns a boolean if a field has been set. + +### SetAttr + +`func (o *CatalogActionFilter) SetAttr(v string)` + +SetAttr gets a reference to the given string and assigns it to the Attr field. + +### GetOp + +`func (o *CatalogActionFilter) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *CatalogActionFilter) GetOpOk() (string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOp + +`func (o *CatalogActionFilter) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### SetOp + +`func (o *CatalogActionFilter) SetOp(v string)` + +SetOp gets a reference to the given string and assigns it to the Op field. + +### GetValue + +`func (o *CatalogActionFilter) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CatalogActionFilter) GetValueOk() (map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *CatalogActionFilter) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *CatalogActionFilter) SetValue(v map[string]interface{})` + +SetValue gets a reference to the given map[string]interface{} and assigns it to the Value field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md new file mode 100644 index 00000000..3c34dcd3 --- /dev/null +++ b/docs/CatalogItem.md @@ -0,0 +1,195 @@ +# CatalogItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**Sku** | Pointer to **string** | The stock keeping unit of the item. | +**Price** | Pointer to **float32** | Price of the item. | [optional] +**Catalogid** | Pointer to **int32** | The ID of the catalog the item belongs to. | +**Version** | Pointer to **int32** | The version of the catalog item. | +**Attributes** | Pointer to [**[]ItemAttribute**](ItemAttribute.md) | | [optional] + +## Methods + +### GetId + +`func (o *CatalogItem) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CatalogItem) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CatalogItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CatalogItem) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CatalogItem) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CatalogItem) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CatalogItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CatalogItem) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetSku + +`func (o *CatalogItem) GetSku() string` + +GetSku returns the Sku field if non-nil, zero value otherwise. + +### GetSkuOk + +`func (o *CatalogItem) GetSkuOk() (string, bool)` + +GetSkuOk returns a tuple with the Sku field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSku + +`func (o *CatalogItem) HasSku() bool` + +HasSku returns a boolean if a field has been set. + +### SetSku + +`func (o *CatalogItem) SetSku(v string)` + +SetSku gets a reference to the given string and assigns it to the Sku field. + +### GetPrice + +`func (o *CatalogItem) GetPrice() float32` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *CatalogItem) GetPriceOk() (float32, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPrice + +`func (o *CatalogItem) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + +### SetPrice + +`func (o *CatalogItem) SetPrice(v float32)` + +SetPrice gets a reference to the given float32 and assigns it to the Price field. + +### GetCatalogid + +`func (o *CatalogItem) GetCatalogid() int32` + +GetCatalogid returns the Catalogid field if non-nil, zero value otherwise. + +### GetCatalogidOk + +`func (o *CatalogItem) GetCatalogidOk() (int32, bool)` + +GetCatalogidOk returns a tuple with the Catalogid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCatalogid + +`func (o *CatalogItem) HasCatalogid() bool` + +HasCatalogid returns a boolean if a field has been set. + +### SetCatalogid + +`func (o *CatalogItem) SetCatalogid(v int32)` + +SetCatalogid gets a reference to the given int32 and assigns it to the Catalogid field. + +### GetVersion + +`func (o *CatalogItem) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *CatalogItem) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *CatalogItem) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *CatalogItem) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetAttributes + +`func (o *CatalogItem) GetAttributes() []ItemAttribute` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *CatalogItem) GetAttributesOk() ([]ItemAttribute, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *CatalogItem) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *CatalogItem) SetAttributes(v []ItemAttribute)` + +SetAttributes gets a reference to the given []ItemAttribute and assigns it to the Attributes field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CatalogSyncRequest.md b/docs/CatalogSyncRequest.md new file mode 100644 index 00000000..13b9c492 --- /dev/null +++ b/docs/CatalogSyncRequest.md @@ -0,0 +1,65 @@ +# CatalogSyncRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Actions** | Pointer to [**[]CatalogAction**](CatalogAction.md) | | +**Version** | Pointer to **int32** | The version number of the catalog to apply the actions on. | [optional] + +## Methods + +### GetActions + +`func (o *CatalogSyncRequest) GetActions() []CatalogAction` + +GetActions returns the Actions field if non-nil, zero value otherwise. + +### GetActionsOk + +`func (o *CatalogSyncRequest) GetActionsOk() ([]CatalogAction, bool)` + +GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActions + +`func (o *CatalogSyncRequest) HasActions() bool` + +HasActions returns a boolean if a field has been set. + +### SetActions + +`func (o *CatalogSyncRequest) SetActions(v []CatalogAction)` + +SetActions gets a reference to the given []CatalogAction and assigns it to the Actions field. + +### GetVersion + +`func (o *CatalogSyncRequest) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *CatalogSyncRequest) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *CatalogSyncRequest) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *CatalogSyncRequest) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Change.md b/docs/Change.md index f56d9160..fe1bf697 100644 --- a/docs/Change.md +++ b/docs/Change.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **UserId** | Pointer to **int32** | The ID of the account that owns this entity. | -**ApplicationId** | Pointer to **int32** | ID of application associated with change | [optional] +**ApplicationId** | Pointer to **int32** | ID of application associated with change. | [optional] **Entity** | Pointer to **string** | API endpoint on which the change was initiated. | **Old** | Pointer to [**map[string]interface{}**](.md) | Resource before the change occurred. | [optional] **New** | Pointer to [**map[string]interface{}**](.md) | Resource after the change occurred. | [optional] diff --git a/docs/CodeGeneratorSettings.md b/docs/CodeGeneratorSettings.md index 18e1b7fb..7779e380 100644 --- a/docs/CodeGeneratorSettings.md +++ b/docs/CodeGeneratorSettings.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ValidCharacters** | Pointer to **[]string** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | -**CouponPattern** | Pointer to **string** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | +**ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. Defaults to a list equivalent to the `[A-Z, 0-9]` regexp. | +**CouponPattern** | Pointer to **string** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | ## Methods diff --git a/docs/Collection.md b/docs/Collection.md index d86c0f1b..1b639f4f 100644 --- a/docs/Collection.md +++ b/docs/Collection.md @@ -4,17 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | -**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | -**Name** | Pointer to **string** | The name of this collection. | **Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] -**Payload** | Pointer to **[]string** | Payload contains limited amount of collection items | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the Applications where this collection is enabled. | [optional] +**Name** | Pointer to **string** | The name of this collection. | **ModifiedBy** | Pointer to **int32** | ID of the user who last updated this effect if available. | [optional] **CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | +**ApplicationId** | Pointer to **int32** | The ID of the Application that owns this entity. | [optional] +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | [optional] +**Payload** | Pointer to **[]string** | The content of the collection. | [optional] ## Methods @@ -93,80 +94,80 @@ HasAccountId returns a boolean if a field has been set. SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. -### GetApplicationId +### GetModified -`func (o *Collection) GetApplicationId() int32` +`func (o *Collection) GetModified() time.Time` -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. +GetModified returns the Modified field if non-nil, zero value otherwise. -### GetApplicationIdOk +### GetModifiedOk -`func (o *Collection) GetApplicationIdOk() (int32, bool)` +`func (o *Collection) GetModifiedOk() (time.Time, bool)` -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasApplicationId +### HasModified -`func (o *Collection) HasApplicationId() bool` +`func (o *Collection) HasModified() bool` -HasApplicationId returns a boolean if a field has been set. +HasModified returns a boolean if a field has been set. -### SetApplicationId +### SetModified -`func (o *Collection) SetApplicationId(v int32)` +`func (o *Collection) SetModified(v time.Time)` -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. +SetModified gets a reference to the given time.Time and assigns it to the Modified field. -### GetCampaignId +### GetDescription -`func (o *Collection) GetCampaignId() int32` +`func (o *Collection) GetDescription() string` -GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. +GetDescription returns the Description field if non-nil, zero value otherwise. -### GetCampaignIdOk +### GetDescriptionOk -`func (o *Collection) GetCampaignIdOk() (int32, bool)` +`func (o *Collection) GetDescriptionOk() (string, bool)` -GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasCampaignId +### HasDescription -`func (o *Collection) HasCampaignId() bool` +`func (o *Collection) HasDescription() bool` -HasCampaignId returns a boolean if a field has been set. +HasDescription returns a boolean if a field has been set. -### SetCampaignId +### SetDescription -`func (o *Collection) SetCampaignId(v int32)` +`func (o *Collection) SetDescription(v string)` -SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +SetDescription gets a reference to the given string and assigns it to the Description field. -### GetModified +### GetSubscribedApplicationsIds -`func (o *Collection) GetModified() time.Time` +`func (o *Collection) GetSubscribedApplicationsIds() []int32` -GetModified returns the Modified field if non-nil, zero value otherwise. +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. -### GetModifiedOk +### GetSubscribedApplicationsIdsOk -`func (o *Collection) GetModifiedOk() (time.Time, bool)` +`func (o *Collection) GetSubscribedApplicationsIdsOk() ([]int32, bool)` -GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasModified +### HasSubscribedApplicationsIds -`func (o *Collection) HasModified() bool` +`func (o *Collection) HasSubscribedApplicationsIds() bool` -HasModified returns a boolean if a field has been set. +HasSubscribedApplicationsIds returns a boolean if a field has been set. -### SetModified +### SetSubscribedApplicationsIds -`func (o *Collection) SetModified(v time.Time)` +`func (o *Collection) SetSubscribedApplicationsIds(v []int32)` -SetModified gets a reference to the given time.Time and assigns it to the Modified field. +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. ### GetName @@ -193,105 +194,130 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. -### GetDescription +### GetModifiedBy -`func (o *Collection) GetDescription() string` +`func (o *Collection) GetModifiedBy() int32` -GetDescription returns the Description field if non-nil, zero value otherwise. +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. -### GetDescriptionOk +### GetModifiedByOk -`func (o *Collection) GetDescriptionOk() (string, bool)` +`func (o *Collection) GetModifiedByOk() (int32, bool)` -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasDescription +### HasModifiedBy -`func (o *Collection) HasDescription() bool` +`func (o *Collection) HasModifiedBy() bool` -HasDescription returns a boolean if a field has been set. +HasModifiedBy returns a boolean if a field has been set. -### SetDescription +### SetModifiedBy -`func (o *Collection) SetDescription(v string)` +`func (o *Collection) SetModifiedBy(v int32)` -SetDescription gets a reference to the given string and assigns it to the Description field. +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. -### GetPayload +### GetCreatedBy -`func (o *Collection) GetPayload() []string` +`func (o *Collection) GetCreatedBy() int32` -GetPayload returns the Payload field if non-nil, zero value otherwise. +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. -### GetPayloadOk +### GetCreatedByOk -`func (o *Collection) GetPayloadOk() ([]string, bool)` +`func (o *Collection) GetCreatedByOk() (int32, bool)` -GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasPayload +### HasCreatedBy -`func (o *Collection) HasPayload() bool` +`func (o *Collection) HasCreatedBy() bool` -HasPayload returns a boolean if a field has been set. +HasCreatedBy returns a boolean if a field has been set. -### SetPayload +### SetCreatedBy -`func (o *Collection) SetPayload(v []string)` +`func (o *Collection) SetCreatedBy(v int32)` -SetPayload gets a reference to the given []string and assigns it to the Payload field. +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. -### GetModifiedBy +### GetApplicationId -`func (o *Collection) GetModifiedBy() int32` +`func (o *Collection) GetApplicationId() int32` -GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. -### GetModifiedByOk +### GetApplicationIdOk -`func (o *Collection) GetModifiedByOk() (int32, bool)` +`func (o *Collection) GetApplicationIdOk() (int32, bool)` -GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasModifiedBy +### HasApplicationId -`func (o *Collection) HasModifiedBy() bool` +`func (o *Collection) HasApplicationId() bool` -HasModifiedBy returns a boolean if a field has been set. +HasApplicationId returns a boolean if a field has been set. -### SetModifiedBy +### SetApplicationId -`func (o *Collection) SetModifiedBy(v int32)` +`func (o *Collection) SetApplicationId(v int32)` -SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. -### GetCreatedBy +### GetCampaignId -`func (o *Collection) GetCreatedBy() int32` +`func (o *Collection) GetCampaignId() int32` -GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. -### GetCreatedByOk +### GetCampaignIdOk -`func (o *Collection) GetCreatedByOk() (int32, bool)` +`func (o *Collection) GetCampaignIdOk() (int32, bool)` -GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasCreatedBy +### HasCampaignId -`func (o *Collection) HasCreatedBy() bool` +`func (o *Collection) HasCampaignId() bool` -HasCreatedBy returns a boolean if a field has been set. +HasCampaignId returns a boolean if a field has been set. -### SetCreatedBy +### SetCampaignId -`func (o *Collection) SetCreatedBy(v int32)` +`func (o *Collection) SetCampaignId(v int32)` -SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetPayload + +`func (o *Collection) GetPayload() []string` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *Collection) GetPayloadOk() ([]string, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *Collection) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *Collection) SetPayload(v []string)` + +SetPayload gets a reference to the given []string and assigns it to the Payload field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CollectionItem.md b/docs/CollectionItem.md new file mode 100644 index 00000000..8eb6b0b4 --- /dev/null +++ b/docs/CollectionItem.md @@ -0,0 +1,39 @@ +# CollectionItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Item** | Pointer to **string** | | + +## Methods + +### GetItem + +`func (o *CollectionItem) GetItem() string` + +GetItem returns the Item field if non-nil, zero value otherwise. + +### GetItemOk + +`func (o *CollectionItem) GetItemOk() (string, bool)` + +GetItemOk returns a tuple with the Item field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasItem + +`func (o *CollectionItem) HasItem() bool` + +HasItem returns a boolean if a field has been set. + +### SetItem + +`func (o *CollectionItem) SetItem(v string)` + +SetItem gets a reference to the given string and assigns it to the Item field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CollectionWithoutPayload.md b/docs/CollectionWithoutPayload.md new file mode 100644 index 00000000..0d54c733 --- /dev/null +++ b/docs/CollectionWithoutPayload.md @@ -0,0 +1,299 @@ +# CollectionWithoutPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the Applications where this collection is enabled. | [optional] +**Name** | Pointer to **string** | The name of this collection. | +**ModifiedBy** | Pointer to **int32** | ID of the user who last updated this effect if available. | [optional] +**CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | +**ApplicationId** | Pointer to **int32** | The ID of the Application that owns this entity. | [optional] +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | [optional] + +## Methods + +### GetId + +`func (o *CollectionWithoutPayload) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CollectionWithoutPayload) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CollectionWithoutPayload) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CollectionWithoutPayload) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CollectionWithoutPayload) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CollectionWithoutPayload) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CollectionWithoutPayload) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CollectionWithoutPayload) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetAccountId + +`func (o *CollectionWithoutPayload) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *CollectionWithoutPayload) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *CollectionWithoutPayload) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *CollectionWithoutPayload) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetModified + +`func (o *CollectionWithoutPayload) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CollectionWithoutPayload) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *CollectionWithoutPayload) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *CollectionWithoutPayload) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetDescription + +`func (o *CollectionWithoutPayload) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CollectionWithoutPayload) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *CollectionWithoutPayload) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *CollectionWithoutPayload) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *CollectionWithoutPayload) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *CollectionWithoutPayload) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *CollectionWithoutPayload) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *CollectionWithoutPayload) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetName + +`func (o *CollectionWithoutPayload) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CollectionWithoutPayload) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CollectionWithoutPayload) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CollectionWithoutPayload) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetModifiedBy + +`func (o *CollectionWithoutPayload) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *CollectionWithoutPayload) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *CollectionWithoutPayload) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *CollectionWithoutPayload) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *CollectionWithoutPayload) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CollectionWithoutPayload) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *CollectionWithoutPayload) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *CollectionWithoutPayload) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetApplicationId + +`func (o *CollectionWithoutPayload) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *CollectionWithoutPayload) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *CollectionWithoutPayload) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *CollectionWithoutPayload) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetCampaignId + +`func (o *CollectionWithoutPayload) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *CollectionWithoutPayload) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *CollectionWithoutPayload) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *CollectionWithoutPayload) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Coupon.md b/docs/Coupon.md index 7e6e8c1b..20c12b11 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -4,22 +4,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | -**Value** | Pointer to **string** | The actual coupon code. | -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**Value** | Pointer to **string** | The coupon code. | +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **UsageCounter** | Pointer to **int32** | The number of times this coupon has been successfully used. | **DiscountCounter** | Pointer to **float32** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] **DiscountRemainder** | Pointer to **float32** | The remaining discount this coupon can give. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Custom attributes associated with this coupon. | [optional] **ReferralId** | Pointer to **int32** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] **RecipientIntegrationId** | Pointer to **string** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] **ImportId** | Pointer to **int32** | The ID of the Import which created this coupon. | [optional] -**Reservation** | Pointer to **bool** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] +**Reservation** | Pointer to **bool** | Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation endpoint](/integration-api/#operation/createCouponReservation). - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons endpoint](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients endpoint](/management-api/#operation/createCouponsForMultipleRecipients). | [optional] [default to true] **BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] ## Methods @@ -224,6 +225,31 @@ HasExpiryDate returns a boolean if a field has been set. SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +### GetLimits + +`func (o *Coupon) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *Coupon) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *Coupon) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *Coupon) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + ### GetUsageCounter `func (o *Coupon) GetUsageCounter() int32` diff --git a/docs/CouponConstraints.md b/docs/CouponConstraints.md index a16cbbe2..5143d14d 100644 --- a/docs/CouponConstraints.md +++ b/docs/CouponConstraints.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional] **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] diff --git a/docs/CouponCreatedEffectProps.md b/docs/CouponCreatedEffectProps.md index 95aa4880..dee6999c 100644 --- a/docs/CouponCreatedEffectProps.md +++ b/docs/CouponCreatedEffectProps.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The coupon code that was created | -**ProfileId** | Pointer to **string** | The integration identifier of the customer for whom this coupon was created | +**Value** | Pointer to **string** | The coupon code that was created. | +**ProfileId** | Pointer to **string** | The integration identifier of the customer for whom this coupon was created. | ## Methods diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md index f812ae77..4abc0835 100644 --- a/docs/CouponCreationJob.md +++ b/docs/CouponCreationJob.md @@ -4,26 +4,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] **NumberOfCoupons** | Pointer to **int32** | The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons | -**BatchId** | Pointer to **string** | The batch ID coupons created by this job will bear | -**Status** | Pointer to **string** | The current status of this request. The value should be either 'pending', 'completed' or 'failed' | -**CreatedAmount** | Pointer to **int32** | The number of coupon codes that were already created for this request | -**FailCount** | Pointer to **int32** | The number of times this job failed | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons. | +**BatchId** | Pointer to **string** | The batch ID coupons created by this job will bear. | +**Status** | Pointer to **string** | The current status of this request. Possible values: - `pending` - `completed` - `failed` - `coupon pattern full` | +**CreatedAmount** | Pointer to **int32** | The number of coupon codes that were already created for this request. | +**FailCount** | Pointer to **int32** | The number of times this job failed. | **Errors** | Pointer to **[]string** | An array of individual problems encountered during the request. | **CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | -**Communicated** | Pointer to **bool** | Whether or not the user that created this job was notified of its final state | -**BatchExecutionCount** | Pointer to **int32** | The number of times an attempt to create a batch of coupons was made during the processing of the job | +**Communicated** | Pointer to **bool** | Whether or not the user that created this job was notified of its final state. | +**ChunkExecutionCount** | Pointer to **int32** | The number of times an attempt to create a chunk of coupons was made during the processing of the job. | +**ChunkSize** | Pointer to **int32** | The number of coupons that will be created in a single transactions. Coupons will be created in chunks until arriving at the requested amount. | [optional] ## Methods @@ -502,30 +503,55 @@ HasCommunicated returns a boolean if a field has been set. SetCommunicated gets a reference to the given bool and assigns it to the Communicated field. -### GetBatchExecutionCount +### GetChunkExecutionCount -`func (o *CouponCreationJob) GetBatchExecutionCount() int32` +`func (o *CouponCreationJob) GetChunkExecutionCount() int32` -GetBatchExecutionCount returns the BatchExecutionCount field if non-nil, zero value otherwise. +GetChunkExecutionCount returns the ChunkExecutionCount field if non-nil, zero value otherwise. -### GetBatchExecutionCountOk +### GetChunkExecutionCountOk -`func (o *CouponCreationJob) GetBatchExecutionCountOk() (int32, bool)` +`func (o *CouponCreationJob) GetChunkExecutionCountOk() (int32, bool)` -GetBatchExecutionCountOk returns a tuple with the BatchExecutionCount field if it's non-nil, zero value otherwise +GetChunkExecutionCountOk returns a tuple with the ChunkExecutionCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasBatchExecutionCount +### HasChunkExecutionCount -`func (o *CouponCreationJob) HasBatchExecutionCount() bool` +`func (o *CouponCreationJob) HasChunkExecutionCount() bool` -HasBatchExecutionCount returns a boolean if a field has been set. +HasChunkExecutionCount returns a boolean if a field has been set. -### SetBatchExecutionCount +### SetChunkExecutionCount -`func (o *CouponCreationJob) SetBatchExecutionCount(v int32)` +`func (o *CouponCreationJob) SetChunkExecutionCount(v int32)` -SetBatchExecutionCount gets a reference to the given int32 and assigns it to the BatchExecutionCount field. +SetChunkExecutionCount gets a reference to the given int32 and assigns it to the ChunkExecutionCount field. + +### GetChunkSize + +`func (o *CouponCreationJob) GetChunkSize() int32` + +GetChunkSize returns the ChunkSize field if non-nil, zero value otherwise. + +### GetChunkSizeOk + +`func (o *CouponCreationJob) GetChunkSizeOk() (int32, bool)` + +GetChunkSizeOk returns a tuple with the ChunkSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasChunkSize + +`func (o *CouponCreationJob) HasChunkSize() bool` + +HasChunkSize returns a boolean if a field has been set. + +### SetChunkSize + +`func (o *CouponCreationJob) SetChunkSize(v int32)` + +SetChunkSize gets a reference to the given int32 and assigns it to the ChunkSize field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CouponLimitConfigs.md b/docs/CouponLimitConfigs.md new file mode 100644 index 00000000..f15792a8 --- /dev/null +++ b/docs/CouponLimitConfigs.md @@ -0,0 +1,39 @@ +# CouponLimitConfigs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] + +## Methods + +### GetLimits + +`func (o *CouponLimitConfigs) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *CouponLimitConfigs) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *CouponLimitConfigs) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *CouponLimitConfigs) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CouponReservations.md b/docs/CouponReservations.md index eb445609..e22b6779 100644 --- a/docs/CouponReservations.md +++ b/docs/CouponReservations.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationIDs** | Pointer to **[]string** | List of Integration IDs | +**IntegrationIDs** | Pointer to **[]string** | List of customer integration IDs. | ## Methods diff --git a/docs/CouponSearch.md b/docs/CouponSearch.md index 5827bd75..0fb67450 100644 --- a/docs/CouponSearch.md +++ b/docs/CouponSearch.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a coupon. All provided attributes will be exactly matched against attributes | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a coupon. All provided attributes will be exactly matched against attributes. | ## Methods diff --git a/docs/CouponValue.md b/docs/CouponValue.md index 133cd390..811f7a4c 100644 --- a/docs/CouponValue.md +++ b/docs/CouponValue.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The actual coupon code. | [optional] +**Value** | Pointer to **string** | The coupon code. | [optional] ## Methods diff --git a/docs/CreateApplicationApiKey.md b/docs/CreateApplicationApiKey.md index 28c8a792..e1cdc0cd 100644 --- a/docs/CreateApplicationApiKey.md +++ b/docs/CreateApplicationApiKey.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Title** | Pointer to **string** | Title for API Key | -**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | -**Platform** | Pointer to **string** | Platform the API key is valid for. | [optional] +**Title** | Pointer to **string** | Title for API Key. | +**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired. | +**Platform** | Pointer to **string** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional] ## Methods diff --git a/docs/CreateManagementKey.md b/docs/CreateManagementKey.md new file mode 100644 index 00000000..0d9902cd --- /dev/null +++ b/docs/CreateManagementKey.md @@ -0,0 +1,91 @@ +# CreateManagementKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name for management key. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | The date the management key expires. | +**Endpoints** | Pointer to [**[]Endpoint**](Endpoint.md) | The list of endpoints that can be accessed with the key | + +## Methods + +### GetName + +`func (o *CreateManagementKey) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateManagementKey) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CreateManagementKey) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CreateManagementKey) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetExpiryDate + +`func (o *CreateManagementKey) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *CreateManagementKey) GetExpiryDateOk() (time.Time, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *CreateManagementKey) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *CreateManagementKey) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetEndpoints + +`func (o *CreateManagementKey) GetEndpoints() []Endpoint` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *CreateManagementKey) GetEndpointsOk() ([]Endpoint, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndpoints + +`func (o *CreateManagementKey) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### SetEndpoints + +`func (o *CreateManagementKey) SetEndpoints(v []Endpoint)` + +SetEndpoints gets a reference to the given []Endpoint and assigns it to the Endpoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateTemplateCampaign.md b/docs/CreateTemplateCampaign.md index 21fac275..22200185 100644 --- a/docs/CreateTemplateCampaign.md +++ b/docs/CreateTemplateCampaign.md @@ -7,9 +7,11 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | A user-facing name for this campaign. | **Description** | Pointer to **string** | A detailed description of the campaign. | [optional] **TemplateId** | Pointer to **int32** | The ID of the Campaign Template which will be used in order to create the Campaign. | -**CampaignAttributesOverrides** | Pointer to [**map[string]interface{}**](.md) | Custom Campaign Attributes. If the the Campaign Template defines the same values, they will be overridden. | [optional] +**CampaignAttributesOverrides** | Pointer to [**map[string]interface{}**](.md) | Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden. | [optional] **TemplateParamValues** | Pointer to [**[]Binding**](Binding.md) | Actual values to replace the template placeholder values in the Ruleset bindings. Values for all Template Parameters must be provided. | [optional] **LimitOverrides** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden. | [optional] +**CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. | [optional] +**Tags** | Pointer to **[]string** | A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list. | [optional] ## Methods @@ -163,6 +165,56 @@ HasLimitOverrides returns a boolean if a field has been set. SetLimitOverrides gets a reference to the given []LimitConfig and assigns it to the LimitOverrides field. +### GetCampaignGroups + +`func (o *CreateTemplateCampaign) GetCampaignGroups() []int32` + +GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. + +### GetCampaignGroupsOk + +`func (o *CreateTemplateCampaign) GetCampaignGroupsOk() ([]int32, bool)` + +GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignGroups + +`func (o *CreateTemplateCampaign) HasCampaignGroups() bool` + +HasCampaignGroups returns a boolean if a field has been set. + +### SetCampaignGroups + +`func (o *CreateTemplateCampaign) SetCampaignGroups(v []int32)` + +SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. + +### GetTags + +`func (o *CreateTemplateCampaign) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *CreateTemplateCampaign) GetTagsOk() ([]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTags + +`func (o *CreateTemplateCampaign) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### SetTags + +`func (o *CreateTemplateCampaign) SetTags(v []string)` + +SetTags gets a reference to the given []string and assigns it to the Tags field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateTemplateCampaignResponse.md b/docs/CreateTemplateCampaignResponse.md index 325056d9..2cca8fdc 100644 --- a/docs/CreateTemplateCampaignResponse.md +++ b/docs/CreateTemplateCampaignResponse.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Campaign** | Pointer to [**Campaign**](Campaign.md) | | **Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | +**Collections** | Pointer to [**[]Collection**](Collection.md) | | [optional] ## Methods @@ -59,6 +60,31 @@ HasRuleset returns a boolean if a field has been set. SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. +### GetCollections + +`func (o *CreateTemplateCampaignResponse) GetCollections() []Collection` + +GetCollections returns the Collections field if non-nil, zero value otherwise. + +### GetCollectionsOk + +`func (o *CreateTemplateCampaignResponse) GetCollectionsOk() ([]Collection, bool)` + +GetCollectionsOk returns a tuple with the Collections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCollections + +`func (o *CreateTemplateCampaignResponse) HasCollections() bool` + +HasCollections returns a boolean if a field has been set. + +### SetCollections + +`func (o *CreateTemplateCampaignResponse) SetCollections(v []Collection)` + +SetCollections gets a reference to the given []Collection and assigns it to the Collections field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomEffect.md b/docs/CustomEffect.md index 433a8cb9..511a7aef 100644 --- a/docs/CustomEffect.md +++ b/docs/CustomEffect.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | @@ -14,7 +14,7 @@ Name | Type | Description | Notes **Payload** | Pointer to **string** | The JSON payload of this effect. | **Description** | Pointer to **string** | The description of this effect. | [optional] **Enabled** | Pointer to **bool** | Determines if this effect is active. | -**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions. | [optional] **ModifiedBy** | Pointer to **int32** | ID of the user who last updated this effect if available. | [optional] **CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | diff --git a/docs/CustomEffectProps.md b/docs/CustomEffectProps.md index b7b2fbb9..47348d46 100644 --- a/docs/CustomEffectProps.md +++ b/docs/CustomEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**EffectId** | Pointer to **int32** | The ID of the custom effect that was triggered | +**EffectId** | Pointer to **int32** | The ID of the custom effect that was triggered. | **Name** | Pointer to **string** | The type of the custom effect. | **Payload** | Pointer to [**map[string]interface{}**](.md) | The JSON payload of the custom effect. | diff --git a/docs/CustomerActivityReport.md b/docs/CustomerActivityReport.md index 7bc66f6a..65719dc2 100644 --- a/docs/CustomerActivityReport.md +++ b/docs/CustomerActivityReport.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Name** | Pointer to **string** | The name for this customer profile. | **CustomerId** | Pointer to **int32** | The internal Talon.One ID of the customer. | diff --git a/docs/CustomerAnalytics.md b/docs/CustomerAnalytics.md index d6bf4a58..838e8fff 100644 --- a/docs/CustomerAnalytics.md +++ b/docs/CustomerAnalytics.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AcceptedCoupons** | Pointer to **int32** | Total accepted coupons for this customer | -**CreatedCoupons** | Pointer to **int32** | Total created coupons for this customer | -**FreeItems** | Pointer to **int32** | Total free items given to this customer | -**TotalOrders** | Pointer to **int32** | Total orders made by this customer | -**TotalDiscountedOrders** | Pointer to **int32** | Total orders made by this customer that had a discount | -**TotalRevenue** | Pointer to **float32** | Total Revenue across all closed sessions | -**TotalDiscounts** | Pointer to **float32** | The sum of discounts that were given across all closed sessions | +**AcceptedCoupons** | Pointer to **int32** | Total accepted coupons for this customer. | +**CreatedCoupons** | Pointer to **int32** | Total created coupons for this customer. | +**FreeItems** | Pointer to **int32** | Total free items given to this customer. | +**TotalOrders** | Pointer to **int32** | Total orders made by this customer. | +**TotalDiscountedOrders** | Pointer to **int32** | Total orders made by this customer that had a discount. | +**TotalRevenue** | Pointer to **float32** | Total Revenue across all closed sessions. | +**TotalDiscounts** | Pointer to **float32** | The sum of discounts that were given across all closed sessions. | ## Methods diff --git a/docs/CustomerInventory.md b/docs/CustomerInventory.md index 03b8d4ad..32b77b61 100644 --- a/docs/CustomerInventory.md +++ b/docs/CustomerInventory.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Profile** | Pointer to [**CustomerProfile**](CustomerProfile.md) | | [optional] **Loyalty** | Pointer to [**Loyalty**](Loyalty.md) | | [optional] -**Referrals** | Pointer to [**[]Referral**](Referral.md) | | [optional] -**Coupons** | Pointer to [**[]InventoryCoupon**](InventoryCoupon.md) | | [optional] +**Referrals** | Pointer to [**[]InventoryReferral**](InventoryReferral.md) | | [optional] +**Coupons** | Pointer to [**[]InventoryCoupon**](InventoryCoupon.md) | The coupons reserved by this profile. This array includes hard and soft reservations. See each coupon's `reservation` property. | [optional] **Giveaways** | Pointer to [**[]Giveaway**](Giveaway.md) | | [optional] ## Methods @@ -64,13 +64,13 @@ SetLoyalty gets a reference to the given Loyalty and assigns it to the Loyalty f ### GetReferrals -`func (o *CustomerInventory) GetReferrals() []Referral` +`func (o *CustomerInventory) GetReferrals() []InventoryReferral` GetReferrals returns the Referrals field if non-nil, zero value otherwise. ### GetReferralsOk -`func (o *CustomerInventory) GetReferralsOk() ([]Referral, bool)` +`func (o *CustomerInventory) GetReferralsOk() ([]InventoryReferral, bool)` GetReferralsOk returns a tuple with the Referrals field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -83,9 +83,9 @@ HasReferrals returns a boolean if a field has been set. ### SetReferrals -`func (o *CustomerInventory) SetReferrals(v []Referral)` +`func (o *CustomerInventory) SetReferrals(v []InventoryReferral)` -SetReferrals gets a reference to the given []Referral and assigns it to the Referrals field. +SetReferrals gets a reference to the given []InventoryReferral and assigns it to the Referrals field. ### GetCoupons diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md index 9fc0a2da..e243c072 100644 --- a/docs/CustomerProfile.md +++ b/docs/CustomerProfile.md @@ -4,16 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. The exact moment this entity was created. | -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | **AccountId** | Pointer to **int32** | The ID of the Talon.One account that owns this profile. | **ClosedSessions** | Pointer to **int32** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | -**TotalSales** | Pointer to **float32** | Sum of all purchases made by this customer | -**LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] -**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] -**LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received from this customer | +**TotalSales** | Pointer to **float32** | Sum of all purchases made by this customer. | +**LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | A list of audiences the customer belongs to. | [optional] +**LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. | ## Methods diff --git a/docs/CustomerProfileAudienceRequestItem.md b/docs/CustomerProfileAudienceRequestItem.md index 1cf358a9..70bfdcf8 100644 --- a/docs/CustomerProfileAudienceRequestItem.md +++ b/docs/CustomerProfileAudienceRequestItem.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Action** | Pointer to **string** | | -**ProfileIntegrationId** | Pointer to **string** | The ID of this audience in the third-party integration. | +**Action** | Pointer to **string** | Defines the action to perform: - `add`: Adds the customer profile to the audience. - `delete`: Removes the customer profile from the audience. | +**ProfileIntegrationId** | Pointer to **string** | The ID of this customer profile in the third-party integration. | **AudienceId** | Pointer to **int32** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). | ## Methods diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md index c7b35e2d..df390cea 100644 --- a/docs/CustomerProfileIntegrationRequestV2.md +++ b/docs/CustomerProfileIntegrationRequestV2.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] **AudiencesChanges** | Pointer to [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional] -**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. | [optional] +**ResponseContent** | Pointer to **[]string** | Optional list of extra data that you want to get in the response. Use this property to get as much data as you need in one request instead of sending extra requests to other endpoints. **Note:** `ruleFailureReasons` is always part of the response when the [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. | [optional] ## Methods diff --git a/docs/CustomerProfileSearchQuery.md b/docs/CustomerProfileSearchQuery.md index a40dacb7..ab43325f 100644 --- a/docs/CustomerProfileSearchQuery.md +++ b/docs/CustomerProfileSearchQuery.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes. | [optional] **IntegrationIDs** | Pointer to **[]string** | | [optional] **ProfileIDs** | Pointer to **[]int32** | | [optional] diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md index ae31b907..3e3134e5 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -4,20 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | **Coupon** | Pointer to **string** | Any coupon code entered. | **Referral** | Pointer to **string** | Any referral code entered. | -**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entities](/docs/dev/concepts/entities#customer-session). | [default to STATE_OPEN] +**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). | [default to STATE_OPEN] **CartItems** | Pointer to [**[]CartItem**](CartItem.md) | Serialized JSON representation. | -**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. | [optional] +**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). | [optional] **Total** | Pointer to **float32** | The total sum of the cart in one session. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | **FirstSession** | Pointer to **bool** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | **Discounts** | Pointer to **map[string]float32** | A map of labelled discount values, values will be in the same currency as the application associated with the session. | -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received on this session | +**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received on this session. | ## Methods diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md index fc457860..38740078 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -4,49 +4,51 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | -**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. The exact moment this entity was created. | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | -**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. | [optional] -**ReferralCode** | Pointer to **string** | Any referral code entered. | [optional] -**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entites](/docs/dev/concepts/entities#customer-session). | [default to STATE_OPEN] -**CartItems** | Pointer to [**[]CartItem**](CartItem.md) | All items the customer will be purchasing in this session | -**AdditionalCosts** | Pointer to [**map[string]AdditionalCost**](AdditionalCost.md) | Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees. | [optional] -**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | +**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional] +**ReferralCode** | Pointer to **string** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional] +**LoyaltyCards** | Pointer to **[]string** | Any loyalty cards used. | [optional] +**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). | [default to STATE_OPEN] +**CartItems** | Pointer to [**[]CartItem**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | +**AdditionalCosts** | Pointer to [**map[string]AdditionalCost**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). | [optional] +**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains an identifier by the time you close it. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | **FirstSession** | Pointer to **bool** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | -**Total** | Pointer to **float32** | The total sum of cart-items, as well as additional costs, before any discounts applied | -**CartItemTotal** | Pointer to **float32** | The total sum of cart-items before any discounts applied | -**AdditionalCostTotal** | Pointer to **float32** | The total sum of additional costs before any discounts applied | -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received on this session | +**Total** | Pointer to **float32** | The total sum of cart-items, as well as additional costs, before any discounts applied. | +**CartItemTotal** | Pointer to **float32** | The total sum of cart-items before any discounts applied. | +**AdditionalCostTotal** | Pointer to **float32** | The total sum of additional costs before any discounts applied. | +**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received on this session. | ## Methods -### GetIntegrationId +### GetId -`func (o *CustomerSessionV2) GetIntegrationId() string` +`func (o *CustomerSessionV2) GetId() int32` -GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. +GetId returns the Id field if non-nil, zero value otherwise. -### GetIntegrationIdOk +### GetIdOk -`func (o *CustomerSessionV2) GetIntegrationIdOk() (string, bool)` +`func (o *CustomerSessionV2) GetIdOk() (int32, bool)` -GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasIntegrationId +### HasId -`func (o *CustomerSessionV2) HasIntegrationId() bool` +`func (o *CustomerSessionV2) HasId() bool` -HasIntegrationId returns a boolean if a field has been set. +HasId returns a boolean if a field has been set. -### SetIntegrationId +### SetId -`func (o *CustomerSessionV2) SetIntegrationId(v string)` +`func (o *CustomerSessionV2) SetId(v int32)` -SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. +SetId gets a reference to the given int32 and assigns it to the Id field. ### GetCreated @@ -73,6 +75,31 @@ HasCreated returns a boolean if a field has been set. SetCreated gets a reference to the given time.Time and assigns it to the Created field. +### GetIntegrationId + +`func (o *CustomerSessionV2) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *CustomerSessionV2) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *CustomerSessionV2) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *CustomerSessionV2) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + ### GetApplicationId `func (o *CustomerSessionV2) GetApplicationId() int32` @@ -173,6 +200,31 @@ HasReferralCode returns a boolean if a field has been set. SetReferralCode gets a reference to the given string and assigns it to the ReferralCode field. +### GetLoyaltyCards + +`func (o *CustomerSessionV2) GetLoyaltyCards() []string` + +GetLoyaltyCards returns the LoyaltyCards field if non-nil, zero value otherwise. + +### GetLoyaltyCardsOk + +`func (o *CustomerSessionV2) GetLoyaltyCardsOk() ([]string, bool)` + +GetLoyaltyCardsOk returns a tuple with the LoyaltyCards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyaltyCards + +`func (o *CustomerSessionV2) HasLoyaltyCards() bool` + +HasLoyaltyCards returns a boolean if a field has been set. + +### SetLoyaltyCards + +`func (o *CustomerSessionV2) SetLoyaltyCards(v []string)` + +SetLoyaltyCards gets a reference to the given []string and assigns it to the LoyaltyCards field. + ### GetState `func (o *CustomerSessionV2) GetState() string` diff --git a/docs/DeductLoyaltyPointsEffectProps.md b/docs/DeductLoyaltyPointsEffectProps.md index 896f5ebb..e5e848b8 100644 --- a/docs/DeductLoyaltyPointsEffectProps.md +++ b/docs/DeductLoyaltyPointsEffectProps.md @@ -4,12 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**RuleTitle** | Pointer to **string** | The title of the rule that contained triggered this points deduction | -**ProgramId** | Pointer to **int32** | The ID of the loyalty program where these points were added | -**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were added | -**Value** | Pointer to **float32** | The amount of points that were deducted | -**TransactionUUID** | Pointer to **string** | The identifier of this deduction in the loyalty ledger | +**RuleTitle** | Pointer to **string** | The title of the rule that contained triggered this points deduction. | +**ProgramId** | Pointer to **int32** | The ID of the loyalty program where these points were added. | +**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were added. | +**Value** | Pointer to **float32** | The amount of points that were deducted. | +**TransactionUUID** | Pointer to **string** | The identifier of this deduction in the loyalty ledger. | **Name** | Pointer to **string** | The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. | +**CardIdentifier** | Pointer to **string** | The card on which these points were added. | [optional] ## Methods @@ -163,6 +164,31 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. +### GetCardIdentifier + +`func (o *DeductLoyaltyPointsEffectProps) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *DeductLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool)` + +GetCardIdentifierOk returns a tuple with the CardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardIdentifier + +`func (o *DeductLoyaltyPointsEffectProps) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *DeductLoyaltyPointsEffectProps) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Effect.md b/docs/Effect.md index 09ec316b..55e432aa 100644 --- a/docs/Effect.md +++ b/docs/Effect.md @@ -4,12 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CampaignId** | Pointer to **int32** | The ID of the campaign that triggered this effect | -**RulesetId** | Pointer to **int32** | The ID of the ruleset that was active in the campaign when this effect was triggered | -**RuleIndex** | Pointer to **int32** | The position of the rule that triggered this effect within the ruleset | -**RuleName** | Pointer to **string** | The name of the rule that triggered this effect | -**EffectType** | Pointer to **string** | The type of effect that was triggered | -**TriggeredByCoupon** | Pointer to **int32** | The ID of the coupon that was being evaluated when this effect was triggered | [optional] +**CampaignId** | Pointer to **int32** | The ID of the campaign that triggered this effect. | +**RulesetId** | Pointer to **int32** | The ID of the ruleset that was active in the campaign when this effect was triggered. | +**RuleIndex** | Pointer to **int32** | The position of the rule that triggered this effect within the ruleset. | +**RuleName** | Pointer to **string** | The name of the rule that triggered this effect. | +**EffectType** | Pointer to **string** | The type of effect that was triggered. | +**TriggeredByCoupon** | Pointer to **int32** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] +**TriggeredForCatalogItem** | Pointer to **int32** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] **Props** | Pointer to [**map[string]interface{}**](.md) | | ## Methods @@ -164,6 +165,31 @@ HasTriggeredByCoupon returns a boolean if a field has been set. SetTriggeredByCoupon gets a reference to the given int32 and assigns it to the TriggeredByCoupon field. +### GetTriggeredForCatalogItem + +`func (o *Effect) GetTriggeredForCatalogItem() int32` + +GetTriggeredForCatalogItem returns the TriggeredForCatalogItem field if non-nil, zero value otherwise. + +### GetTriggeredForCatalogItemOk + +`func (o *Effect) GetTriggeredForCatalogItemOk() (int32, bool)` + +GetTriggeredForCatalogItemOk returns a tuple with the TriggeredForCatalogItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTriggeredForCatalogItem + +`func (o *Effect) HasTriggeredForCatalogItem() bool` + +HasTriggeredForCatalogItem returns a boolean if a field has been set. + +### SetTriggeredForCatalogItem + +`func (o *Effect) SetTriggeredForCatalogItem(v int32)` + +SetTriggeredForCatalogItem gets a reference to the given int32 and assigns it to the TriggeredForCatalogItem field. + ### GetProps `func (o *Effect) GetProps() map[string]interface{}` diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md index 345ba540..034c8fcc 100644 --- a/docs/EffectEntity.md +++ b/docs/EffectEntity.md @@ -4,12 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CampaignId** | Pointer to **int32** | The ID of the campaign that triggered this effect | -**RulesetId** | Pointer to **int32** | The ID of the ruleset that was active in the campaign when this effect was triggered | -**RuleIndex** | Pointer to **int32** | The position of the rule that triggered this effect within the ruleset | -**RuleName** | Pointer to **string** | The name of the rule that triggered this effect | -**EffectType** | Pointer to **string** | The type of effect that was triggered | -**TriggeredByCoupon** | Pointer to **int32** | The ID of the coupon that was being evaluated when this effect was triggered | [optional] +**CampaignId** | Pointer to **int32** | The ID of the campaign that triggered this effect. | +**RulesetId** | Pointer to **int32** | The ID of the ruleset that was active in the campaign when this effect was triggered. | +**RuleIndex** | Pointer to **int32** | The position of the rule that triggered this effect within the ruleset. | +**RuleName** | Pointer to **string** | The name of the rule that triggered this effect. | +**EffectType** | Pointer to **string** | The type of effect that was triggered. | +**TriggeredByCoupon** | Pointer to **int32** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] +**TriggeredForCatalogItem** | Pointer to **int32** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] ## Methods @@ -163,6 +164,31 @@ HasTriggeredByCoupon returns a boolean if a field has been set. SetTriggeredByCoupon gets a reference to the given int32 and assigns it to the TriggeredByCoupon field. +### GetTriggeredForCatalogItem + +`func (o *EffectEntity) GetTriggeredForCatalogItem() int32` + +GetTriggeredForCatalogItem returns the TriggeredForCatalogItem field if non-nil, zero value otherwise. + +### GetTriggeredForCatalogItemOk + +`func (o *EffectEntity) GetTriggeredForCatalogItemOk() (int32, bool)` + +GetTriggeredForCatalogItemOk returns a tuple with the TriggeredForCatalogItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTriggeredForCatalogItem + +`func (o *EffectEntity) HasTriggeredForCatalogItem() bool` + +HasTriggeredForCatalogItem returns a boolean if a field has been set. + +### SetTriggeredForCatalogItem + +`func (o *EffectEntity) SetTriggeredForCatalogItem(v int32)` + +SetTriggeredForCatalogItem gets a reference to the given int32 and assigns it to the TriggeredForCatalogItem field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Endpoint.md b/docs/Endpoint.md new file mode 100644 index 00000000..c41c0cab --- /dev/null +++ b/docs/Endpoint.md @@ -0,0 +1,39 @@ +# Endpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Path** | Pointer to **string** | allowed endpoint | + +## Methods + +### GetPath + +`func (o *Endpoint) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *Endpoint) GetPathOk() (string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPath + +`func (o *Endpoint) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### SetPath + +`func (o *Endpoint) SetPath(v string)` + +SetPath gets a reference to the given string and assigns it to the Path field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Entity.md b/docs/Entity.md index 7757934b..205169fe 100644 --- a/docs/Entity.md +++ b/docs/Entity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | ## Methods diff --git a/docs/Environment.md b/docs/Environment.md index aff8a432..0ed60fb8 100644 --- a/docs/Environment.md +++ b/docs/Environment.md @@ -4,18 +4,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **Slots** | Pointer to [**[]SlotDef**](SlotDef.md) | The slots defined for this application. | **Functions** | Pointer to [**[]FunctionDef**](FunctionDef.md) | The functions defined for this application. | **Templates** | Pointer to [**[]TemplateDef**](TemplateDef.md) | The templates defined for this application. | -**Variables** | Pointer to **string** | A stringified version of the environment's Talang variables scope | +**Variables** | Pointer to **string** | A stringified version of the environment's Talang variables scope. | **GiveawaysPools** | Pointer to [**[]GiveawaysPool**](GiveawaysPool.md) | The giveaways pools that the application is subscribed to. | [optional] **LoyaltyPrograms** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | The loyalty programs that the application is subscribed to. | [optional] **Attributes** | Pointer to [**[]Attribute**](Attribute.md) | The attributes that the application is subscribed to. | [optional] **AdditionalCosts** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional] **Audiences** | Pointer to [**[]Audience**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional] +**Collections** | Pointer to [**[]Collection**](Collection.md) | The account-level collections that the application is subscribed to. | [optional] ## Methods @@ -319,6 +320,31 @@ HasAudiences returns a boolean if a field has been set. SetAudiences gets a reference to the given []Audience and assigns it to the Audiences field. +### GetCollections + +`func (o *Environment) GetCollections() []Collection` + +GetCollections returns the Collections field if non-nil, zero value otherwise. + +### GetCollectionsOk + +`func (o *Environment) GetCollectionsOk() ([]Collection, bool)` + +GetCollectionsOk returns a tuple with the Collections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCollections + +`func (o *Environment) HasCollections() bool` + +HasCollections returns a boolean if a field has been set. + +### SetCollections + +`func (o *Environment) SetCollections(v []Collection)` + +SetCollections gets a reference to the given []Collection and assigns it to the Collections field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ErrorResponseWithStatus.md b/docs/ErrorResponseWithStatus.md new file mode 100644 index 00000000..91262d33 --- /dev/null +++ b/docs/ErrorResponseWithStatus.md @@ -0,0 +1,91 @@ +# ErrorResponseWithStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | | [optional] +**Errors** | Pointer to [**[]ApiError**](APIError.md) | An array of individual problems encountered during the request. | [optional] +**StatusCode** | Pointer to **int32** | The error code | [optional] + +## Methods + +### GetMessage + +`func (o *ErrorResponseWithStatus) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ErrorResponseWithStatus) GetMessageOk() (string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMessage + +`func (o *ErrorResponseWithStatus) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### SetMessage + +`func (o *ErrorResponseWithStatus) SetMessage(v string)` + +SetMessage gets a reference to the given string and assigns it to the Message field. + +### GetErrors + +`func (o *ErrorResponseWithStatus) GetErrors() []ApiError` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ErrorResponseWithStatus) GetErrorsOk() ([]ApiError, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasErrors + +`func (o *ErrorResponseWithStatus) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrors + +`func (o *ErrorResponseWithStatus) SetErrors(v []ApiError)` + +SetErrors gets a reference to the given []ApiError and assigns it to the Errors field. + +### GetStatusCode + +`func (o *ErrorResponseWithStatus) GetStatusCode() int32` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *ErrorResponseWithStatus) GetStatusCodeOk() (int32, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatusCode + +`func (o *ErrorResponseWithStatus) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### SetStatusCode + +`func (o *ErrorResponseWithStatus) SetStatusCode(v int32)` + +SetStatusCode gets a reference to the given int32 and assigns it to the StatusCode field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ErrorSource.md b/docs/ErrorSource.md index d82f7cfc..c73955cf 100644 --- a/docs/ErrorSource.md +++ b/docs/ErrorSource.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Pointer** | Pointer to **string** | Pointer to the path in the payload that caused this error. | [optional] **Parameter** | Pointer to **string** | Query parameter that caused this error. | [optional] **Line** | Pointer to **string** | Line number in uploaded multipart file that caused this error. 'N/A' if unknown. | [optional] -**Resource** | Pointer to **string** | Pointer to the resource that caused this error | [optional] +**Resource** | Pointer to **string** | Pointer to the resource that caused this error. | [optional] ## Methods diff --git a/docs/Event.md b/docs/Event.md index db77a469..f2f914eb 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] **Type** | Pointer to **string** | A string representing the event. Must not be a reserved event name. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON data associated with the event. | **SessionId** | Pointer to **string** | The ID of the session that this event occurred in. | [optional] -**Effects** | Pointer to [**[][]interface{}**]([][]interface{}.md) | An array of \"effects\" that must be applied in response to this event. Example effects include `addItemToCart` or `setDiscount`. | +**Effects** | Pointer to [**[][]interface{}**]([][]interface{}.md) |An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](/docs/dev/integration-api/api-effects). | **LedgerEntries** | Pointer to [**[]LedgerEntry**](LedgerEntry.md) | Ledger entries for the event. | **Meta** | Pointer to [**Meta**](Meta.md) | | [optional] diff --git a/docs/EventType.md b/docs/EventType.md index a21b2888..136f7a1f 100644 --- a/docs/EventType.md +++ b/docs/EventType.md @@ -4,18 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | -**ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | **Title** | Pointer to **string** | The human-friendly display name for this event type. Use a short, past-tense, description of the event. | **Name** | Pointer to **string** | The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created. | -**Description** | Pointer to **string** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. | -**MimeType** | Pointer to **string** | This defines how the request payload will be parsed before your handler code is run. | -**ExamplePayload** | Pointer to **string** | It is often helpful to include an example payload with the event type definition for documentation purposes. | [optional] -**Schema** | Pointer to [**map[string]interface{}**](.md) | It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. | [optional] -**HandlerLanguage** | Pointer to **string** | The language of the handler code. Currently only `\"talang\"` is supported. | [optional] -**Handler** | Pointer to **string** | Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules. | -**Version** | Pointer to **int32** | The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. | +**Description** | Pointer to **string** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. | [optional] ## Methods @@ -69,31 +62,6 @@ HasCreated returns a boolean if a field has been set. SetCreated gets a reference to the given time.Time and assigns it to the Created field. -### GetApplicationIds - -`func (o *EventType) GetApplicationIds() []int32` - -GetApplicationIds returns the ApplicationIds field if non-nil, zero value otherwise. - -### GetApplicationIdsOk - -`func (o *EventType) GetApplicationIdsOk() ([]int32, bool)` - -GetApplicationIdsOk returns a tuple with the ApplicationIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationIds - -`func (o *EventType) HasApplicationIds() bool` - -HasApplicationIds returns a boolean if a field has been set. - -### SetApplicationIds - -`func (o *EventType) SetApplicationIds(v []int32)` - -SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds field. - ### GetTitle `func (o *EventType) GetTitle() string` @@ -169,156 +137,6 @@ HasDescription returns a boolean if a field has been set. SetDescription gets a reference to the given string and assigns it to the Description field. -### GetMimeType - -`func (o *EventType) GetMimeType() string` - -GetMimeType returns the MimeType field if non-nil, zero value otherwise. - -### GetMimeTypeOk - -`func (o *EventType) GetMimeTypeOk() (string, bool)` - -GetMimeTypeOk returns a tuple with the MimeType field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasMimeType - -`func (o *EventType) HasMimeType() bool` - -HasMimeType returns a boolean if a field has been set. - -### SetMimeType - -`func (o *EventType) SetMimeType(v string)` - -SetMimeType gets a reference to the given string and assigns it to the MimeType field. - -### GetExamplePayload - -`func (o *EventType) GetExamplePayload() string` - -GetExamplePayload returns the ExamplePayload field if non-nil, zero value otherwise. - -### GetExamplePayloadOk - -`func (o *EventType) GetExamplePayloadOk() (string, bool)` - -GetExamplePayloadOk returns a tuple with the ExamplePayload field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasExamplePayload - -`func (o *EventType) HasExamplePayload() bool` - -HasExamplePayload returns a boolean if a field has been set. - -### SetExamplePayload - -`func (o *EventType) SetExamplePayload(v string)` - -SetExamplePayload gets a reference to the given string and assigns it to the ExamplePayload field. - -### GetSchema - -`func (o *EventType) GetSchema() map[string]interface{}` - -GetSchema returns the Schema field if non-nil, zero value otherwise. - -### GetSchemaOk - -`func (o *EventType) GetSchemaOk() (map[string]interface{}, bool)` - -GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSchema - -`func (o *EventType) HasSchema() bool` - -HasSchema returns a boolean if a field has been set. - -### SetSchema - -`func (o *EventType) SetSchema(v map[string]interface{})` - -SetSchema gets a reference to the given map[string]interface{} and assigns it to the Schema field. - -### GetHandlerLanguage - -`func (o *EventType) GetHandlerLanguage() string` - -GetHandlerLanguage returns the HandlerLanguage field if non-nil, zero value otherwise. - -### GetHandlerLanguageOk - -`func (o *EventType) GetHandlerLanguageOk() (string, bool)` - -GetHandlerLanguageOk returns a tuple with the HandlerLanguage field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasHandlerLanguage - -`func (o *EventType) HasHandlerLanguage() bool` - -HasHandlerLanguage returns a boolean if a field has been set. - -### SetHandlerLanguage - -`func (o *EventType) SetHandlerLanguage(v string)` - -SetHandlerLanguage gets a reference to the given string and assigns it to the HandlerLanguage field. - -### GetHandler - -`func (o *EventType) GetHandler() string` - -GetHandler returns the Handler field if non-nil, zero value otherwise. - -### GetHandlerOk - -`func (o *EventType) GetHandlerOk() (string, bool)` - -GetHandlerOk returns a tuple with the Handler field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasHandler - -`func (o *EventType) HasHandler() bool` - -HasHandler returns a boolean if a field has been set. - -### SetHandler - -`func (o *EventType) SetHandler(v string)` - -SetHandler gets a reference to the given string and assigns it to the Handler field. - -### GetVersion - -`func (o *EventType) GetVersion() int32` - -GetVersion returns the Version field if non-nil, zero value otherwise. - -### GetVersionOk - -`func (o *EventType) GetVersionOk() (int32, bool)` - -GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasVersion - -`func (o *EventType) HasVersion() bool` - -HasVersion returns a boolean if a field has been set. - -### SetVersion - -`func (o *EventType) SetVersion(v int32)` - -SetVersion gets a reference to the given int32 and assigns it to the Version field. - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/EventV2.md b/docs/EventV2.md new file mode 100644 index 00000000..bd5ef71e --- /dev/null +++ b/docs/EventV2.md @@ -0,0 +1,91 @@ +# EventV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**Type** | Pointer to **string** | A string representing the event. Must not be a reserved event name. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON data associated with the event. | [optional] + +## Methods + +### GetProfileId + +`func (o *EventV2) GetProfileId() string` + +GetProfileId returns the ProfileId field if non-nil, zero value otherwise. + +### GetProfileIdOk + +`func (o *EventV2) GetProfileIdOk() (string, bool)` + +GetProfileIdOk returns a tuple with the ProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileId + +`func (o *EventV2) HasProfileId() bool` + +HasProfileId returns a boolean if a field has been set. + +### SetProfileId + +`func (o *EventV2) SetProfileId(v string)` + +SetProfileId gets a reference to the given string and assigns it to the ProfileId field. + +### GetType + +`func (o *EventV2) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EventV2) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *EventV2) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *EventV2) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetAttributes + +`func (o *EventV2) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EventV2) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *EventV2) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *EventV2) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Export.md b/docs/Export.md index 67768ba6..00bad52e 100644 --- a/docs/Export.md +++ b/docs/Export.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **UserId** | Pointer to **int32** | The ID of the account that owns this entity. | **Entity** | Pointer to **string** | The name of the entity that was exported. | -**Filter** | Pointer to [**map[string]interface{}**](.md) | Map of keys and values that were used to filter the exported rows | +**Filter** | Pointer to [**map[string]interface{}**](.md) | Map of keys and values that were used to filter the exported rows. | ## Methods diff --git a/docs/FeatureFlag.md b/docs/FeatureFlag.md index 04729c9a..96515b2a 100644 --- a/docs/FeatureFlag.md +++ b/docs/FeatureFlag.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name for the featureflag | -**Value** | Pointer to **string** | The value for the featureflag | +**Name** | Pointer to **string** | The name for the featureflag. | +**Value** | Pointer to **string** | The value for the featureflag. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last created. | [optional] **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | [optional] diff --git a/docs/FeatureFlags.md b/docs/FeatureFlags.md deleted file mode 100644 index e86ea97a..00000000 --- a/docs/FeatureFlags.md +++ /dev/null @@ -1,117 +0,0 @@ -# FeatureFlags - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | -**Loyalty** | Pointer to **bool** | Whether the account has access to the loyalty features or not | [optional] -**CouponsWithoutCount** | Pointer to **bool** | Whether the account queries coupons with or without total result size | [optional] -**BetaEffects** | Pointer to **bool** | Whether the account can test beta effects or not | [optional] - -## Methods - -### GetAccountId - -`func (o *FeatureFlags) GetAccountId() int32` - -GetAccountId returns the AccountId field if non-nil, zero value otherwise. - -### GetAccountIdOk - -`func (o *FeatureFlags) GetAccountIdOk() (int32, bool)` - -GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAccountId - -`func (o *FeatureFlags) HasAccountId() bool` - -HasAccountId returns a boolean if a field has been set. - -### SetAccountId - -`func (o *FeatureFlags) SetAccountId(v int32)` - -SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. - -### GetLoyalty - -`func (o *FeatureFlags) GetLoyalty() bool` - -GetLoyalty returns the Loyalty field if non-nil, zero value otherwise. - -### GetLoyaltyOk - -`func (o *FeatureFlags) GetLoyaltyOk() (bool, bool)` - -GetLoyaltyOk returns a tuple with the Loyalty field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLoyalty - -`func (o *FeatureFlags) HasLoyalty() bool` - -HasLoyalty returns a boolean if a field has been set. - -### SetLoyalty - -`func (o *FeatureFlags) SetLoyalty(v bool)` - -SetLoyalty gets a reference to the given bool and assigns it to the Loyalty field. - -### GetCouponsWithoutCount - -`func (o *FeatureFlags) GetCouponsWithoutCount() bool` - -GetCouponsWithoutCount returns the CouponsWithoutCount field if non-nil, zero value otherwise. - -### GetCouponsWithoutCountOk - -`func (o *FeatureFlags) GetCouponsWithoutCountOk() (bool, bool)` - -GetCouponsWithoutCountOk returns a tuple with the CouponsWithoutCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponsWithoutCount - -`func (o *FeatureFlags) HasCouponsWithoutCount() bool` - -HasCouponsWithoutCount returns a boolean if a field has been set. - -### SetCouponsWithoutCount - -`func (o *FeatureFlags) SetCouponsWithoutCount(v bool)` - -SetCouponsWithoutCount gets a reference to the given bool and assigns it to the CouponsWithoutCount field. - -### GetBetaEffects - -`func (o *FeatureFlags) GetBetaEffects() bool` - -GetBetaEffects returns the BetaEffects field if non-nil, zero value otherwise. - -### GetBetaEffectsOk - -`func (o *FeatureFlags) GetBetaEffectsOk() (bool, bool)` - -GetBetaEffectsOk returns a tuple with the BetaEffects field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasBetaEffects - -`func (o *FeatureFlags) HasBetaEffects() bool` - -HasBetaEffects returns a boolean if a field has been set. - -### SetBetaEffects - -`func (o *FeatureFlags) SetBetaEffects(v bool)` - -SetBetaEffects gets a reference to the given bool and assigns it to the BetaEffects field. - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FeedNotification.md b/docs/FeedNotification.md index 1dbf863a..9e591c4d 100644 --- a/docs/FeedNotification.md +++ b/docs/FeedNotification.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Title** | Pointer to **string** | Title of the feed notification | -**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was created | -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was last updated | -**ArticleUrl** | Pointer to **string** | URL to the feed notification in the help center | -**Type** | Pointer to **string** | The type of the feed notification | -**Body** | Pointer to **string** | Body of the feed notification | +**Title** | Pointer to **string** | Title of the feed notification. | +**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was created. | +**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was last updated. | +**ArticleUrl** | Pointer to **string** | URL to the feed notification in the help center. | +**Type** | Pointer to **string** | The type of the feed notification. | +**Body** | Pointer to **string** | Body of the feed notification. | ## Methods diff --git a/docs/Giveaway.md b/docs/Giveaway.md index ddada4f1..aaa3a218 100644 --- a/docs/Giveaway.md +++ b/docs/Giveaway.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Code** | Pointer to **string** | The code value of this giveaway. | **PoolId** | Pointer to **int32** | The ID of the pool to return giveaway codes from. | diff --git a/docs/GiveawaysPool.md b/docs/GiveawaysPool.md index 2664a99f..c0588991 100644 --- a/docs/GiveawaysPool.md +++ b/docs/GiveawaysPool.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **Name** | Pointer to **string** | The name of this giveaways pool. | **Description** | Pointer to **string** | The description of this giveaways pool. | [optional] -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this giveaways pool is enabled for | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this giveaways pool is enabled for. | [optional] **Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the giveaways pool. | [optional] **CreatedBy** | Pointer to **int32** | ID of the user who created this giveaways pool. | **ModifiedBy** | Pointer to **int32** | ID of the user who last updated this giveaways pool if available. | [optional] diff --git a/docs/Import.md b/docs/Import.md index cf203fb2..a0ae9a34 100644 --- a/docs/Import.md +++ b/docs/Import.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **UserId** | Pointer to **int32** | The ID of the account that owns this entity. | -**Entity** | Pointer to **string** | The name of the entity that was imported. Possible values are Coupons and LoyaltyPoints. | -**Amount** | Pointer to **int32** | The number of members that imported. | +**Entity** | Pointer to **string** | The name of the entity that was imported. | +**Amount** | Pointer to **int32** | The number of values that were imported. | ## Methods diff --git a/docs/InlineResponse20010.md b/docs/InlineResponse20010.md index d7b0f2bc..25041d00 100644 --- a/docs/InlineResponse20010.md +++ b/docs/InlineResponse20010.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]CampaignAnalytics**](CampaignAnalytics.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]CollectionItem**](CollectionItem.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20010) GetTotalResultSize() int32` +`func (o *InlineResponse20010) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse20010) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20010) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse20010) HasTotalResultSize() bool` +`func (o *InlineResponse20010) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse20010) SetTotalResultSize(v int32)` +`func (o *InlineResponse20010) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData -`func (o *InlineResponse20010) GetData() []CampaignAnalytics` +`func (o *InlineResponse20010) GetData() []CollectionItem` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20010) GetDataOk() ([]CampaignAnalytics, bool)` +`func (o *InlineResponse20010) GetDataOk() ([]CollectionItem, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20010) SetData(v []CampaignAnalytics)` +`func (o *InlineResponse20010) SetData(v []CollectionItem)` -SetData gets a reference to the given []CampaignAnalytics and assigns it to the Data field. +SetData gets a reference to the given []CollectionItem and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20011.md b/docs/InlineResponse20011.md index c0888238..64e63a0c 100644 --- a/docs/InlineResponse20011.md +++ b/docs/InlineResponse20011.md @@ -4,71 +4,71 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | [optional] **HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]Collection**](Collection.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20011) GetTotalResultSize() int32` +`func (o *InlineResponse20011) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse20011) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20011) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse20011) HasTotalResultSize() bool` +`func (o *InlineResponse20011) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse20011) SetTotalResultSize(v int32)` +`func (o *InlineResponse20011) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20011) GetHasMore() bool` +`func (o *InlineResponse20011) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20011) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20011) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20011) HasHasMore() bool` +`func (o *InlineResponse20011) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20011) SetHasMore(v bool)` +`func (o *InlineResponse20011) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20011) GetData() []ApplicationCustomer` +`func (o *InlineResponse20011) GetData() []Collection` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20011) GetDataOk() ([]ApplicationCustomer, bool)` +`func (o *InlineResponse20011) GetDataOk() ([]Collection, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -81,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20011) SetData(v []ApplicationCustomer)` +`func (o *InlineResponse20011) SetData(v []Collection)` -SetData gets a reference to the given []ApplicationCustomer and assigns it to the Data field. +SetData gets a reference to the given []Collection and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20012.md b/docs/InlineResponse20012.md index 45056849..65ccaa46 100644 --- a/docs/InlineResponse20012.md +++ b/docs/InlineResponse20012.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | +**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | ## Methods @@ -36,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20012) GetData() []ApplicationCustomer` +`func (o *InlineResponse20012) GetData() []AccessLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20012) GetDataOk() ([]ApplicationCustomer, bool)` +`func (o *InlineResponse20012) GetDataOk() ([]AccessLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20012) SetData(v []ApplicationCustomer)` +`func (o *InlineResponse20012) SetData(v []AccessLogEntry)` -SetData gets a reference to the given []ApplicationCustomer and assigns it to the Data field. +SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20013.md b/docs/InlineResponse20013.md index a2c84f85..ac9942c6 100644 --- a/docs/InlineResponse20013.md +++ b/docs/InlineResponse20013.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]CustomerProfile**](CustomerProfile.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20013) GetHasMore() bool` +`func (o *InlineResponse20013) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20013) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20013) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20013) HasHasMore() bool` +`func (o *InlineResponse20013) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20013) SetHasMore(v bool)` +`func (o *InlineResponse20013) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20013) GetData() []CustomerProfile` +`func (o *InlineResponse20013) GetData() []AccessLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20013) GetDataOk() ([]CustomerProfile, bool)` +`func (o *InlineResponse20013) GetDataOk() ([]AccessLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20013) SetData(v []CustomerProfile)` +`func (o *InlineResponse20013) SetData(v []AccessLogEntry)` -SetData gets a reference to the given []CustomerProfile and assigns it to the Data field. +SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20014.md b/docs/InlineResponse20014.md index 884915a4..d2637fd3 100644 --- a/docs/InlineResponse20014.md +++ b/docs/InlineResponse20014.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]CustomerActivityReport**](CustomerActivityReport.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]CampaignAnalytics**](CampaignAnalytics.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20014) GetHasMore() bool` +`func (o *InlineResponse20014) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20014) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20014) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20014) HasHasMore() bool` +`func (o *InlineResponse20014) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20014) SetHasMore(v bool)` +`func (o *InlineResponse20014) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20014) GetData() []CustomerActivityReport` +`func (o *InlineResponse20014) GetData() []CampaignAnalytics` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20014) GetDataOk() ([]CustomerActivityReport, bool)` +`func (o *InlineResponse20014) GetDataOk() ([]CampaignAnalytics, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20014) SetData(v []CustomerActivityReport)` +`func (o *InlineResponse20014) SetData(v []CampaignAnalytics)` -SetData gets a reference to the given []CustomerActivityReport and assigns it to the Data field. +SetData gets a reference to the given []CampaignAnalytics and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20015.md b/docs/InlineResponse20015.md index c55565d4..715615fb 100644 --- a/docs/InlineResponse20015.md +++ b/docs/InlineResponse20015.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | [optional] **HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]ApplicationSession**](ApplicationSession.md) | | +**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | ## Methods +### GetTotalResultSize + +`func (o *InlineResponse20015) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20015) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *InlineResponse20015) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20015) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + ### GetHasMore `func (o *InlineResponse20015) GetHasMore() bool` @@ -36,13 +62,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20015) GetData() []ApplicationSession` +`func (o *InlineResponse20015) GetData() []ApplicationCustomer` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20015) GetDataOk() ([]ApplicationSession, bool)` +`func (o *InlineResponse20015) GetDataOk() ([]ApplicationCustomer, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20015) SetData(v []ApplicationSession)` +`func (o *InlineResponse20015) SetData(v []ApplicationCustomer)` -SetData gets a reference to the given []ApplicationSession and assigns it to the Data field. +SetData gets a reference to the given []ApplicationCustomer and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20016.md b/docs/InlineResponse20016.md index 0d73c6e5..b28d1081 100644 --- a/docs/InlineResponse20016.md +++ b/docs/InlineResponse20016.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | +**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | ## Methods @@ -36,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20016) GetData() []ApplicationEvent` +`func (o *InlineResponse20016) GetData() []ApplicationCustomer` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20016) GetDataOk() ([]ApplicationEvent, bool)` +`func (o *InlineResponse20016) GetDataOk() ([]ApplicationCustomer, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20016) SetData(v []ApplicationEvent)` +`func (o *InlineResponse20016) SetData(v []ApplicationCustomer)` -SetData gets a reference to the given []ApplicationEvent and assigns it to the Data field. +SetData gets a reference to the given []ApplicationCustomer and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20017.md b/docs/InlineResponse20017.md index fd6b01eb..71417bf8 100644 --- a/docs/InlineResponse20017.md +++ b/docs/InlineResponse20017.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to **[]string** | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]CustomerProfile**](CustomerProfile.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20017) GetTotalResultSize() int32` +`func (o *InlineResponse20017) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse20017) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20017) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse20017) HasTotalResultSize() bool` +`func (o *InlineResponse20017) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse20017) SetTotalResultSize(v int32)` +`func (o *InlineResponse20017) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData -`func (o *InlineResponse20017) GetData() []string` +`func (o *InlineResponse20017) GetData() []CustomerProfile` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20017) GetDataOk() ([]string, bool)` +`func (o *InlineResponse20017) GetDataOk() ([]CustomerProfile, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20017) SetData(v []string)` +`func (o *InlineResponse20017) SetData(v []CustomerProfile)` -SetData gets a reference to the given []string and assigns it to the Data field. +SetData gets a reference to the given []CustomerProfile and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20018.md b/docs/InlineResponse20018.md index 459b0ca4..aabcb80e 100644 --- a/docs/InlineResponse20018.md +++ b/docs/InlineResponse20018.md @@ -4,9 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | [optional] -**TotalResultSize** | Pointer to **int32** | | [optional] -**Data** | Pointer to [**[]Audience**](Audience.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]CustomerActivityReport**](CustomerActivityReport.md) | | ## Methods @@ -35,40 +34,15 @@ HasHasMore returns a boolean if a field has been set. SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -### GetTotalResultSize - -`func (o *InlineResponse20018) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20018) GetTotalResultSizeOk() (int32, bool)` - -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalResultSize - -`func (o *InlineResponse20018) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20018) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetData -`func (o *InlineResponse20018) GetData() []Audience` +`func (o *InlineResponse20018) GetData() []CustomerActivityReport` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20018) GetDataOk() ([]Audience, bool)` +`func (o *InlineResponse20018) GetDataOk() ([]CustomerActivityReport, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20018) SetData(v []Audience)` +`func (o *InlineResponse20018) SetData(v []CustomerActivityReport)` -SetData gets a reference to the given []Audience and assigns it to the Data field. +SetData gets a reference to the given []CustomerActivityReport and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20019.md b/docs/InlineResponse20019.md index f4a36ede..f7354458 100644 --- a/docs/InlineResponse20019.md +++ b/docs/InlineResponse20019.md @@ -4,9 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]ApplicationReferee**](ApplicationReferee.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]ApplicationSession**](ApplicationSession.md) | | ## Methods @@ -35,40 +34,15 @@ HasHasMore returns a boolean if a field has been set. SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -### GetTotalResultSize - -`func (o *InlineResponse20019) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20019) GetTotalResultSizeOk() (int32, bool)` - -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalResultSize - -`func (o *InlineResponse20019) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20019) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetData -`func (o *InlineResponse20019) GetData() []ApplicationReferee` +`func (o *InlineResponse20019) GetData() []ApplicationSession` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20019) GetDataOk() ([]ApplicationReferee, bool)` +`func (o *InlineResponse20019) GetDataOk() ([]ApplicationSession, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20019) SetData(v []ApplicationReferee)` +`func (o *InlineResponse20019) SetData(v []ApplicationSession)` -SetData gets a reference to the given []ApplicationReferee and assigns it to the Data field. +SetData gets a reference to the given []ApplicationSession and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md index 47408c04..39304383 100644 --- a/docs/InlineResponse20020.md +++ b/docs/InlineResponse20020.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Attribute**](Attribute.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20020) GetTotalResultSize() int32` +`func (o *InlineResponse20020) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse20020) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20020) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse20020) HasTotalResultSize() bool` +`func (o *InlineResponse20020) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse20020) SetTotalResultSize(v int32)` +`func (o *InlineResponse20020) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData -`func (o *InlineResponse20020) GetData() []Attribute` +`func (o *InlineResponse20020) GetData() []ApplicationEvent` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20020) GetDataOk() ([]Attribute, bool)` +`func (o *InlineResponse20020) GetDataOk() ([]ApplicationEvent, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20020) SetData(v []Attribute)` +`func (o *InlineResponse20020) SetData(v []ApplicationEvent)` -SetData gets a reference to the given []Attribute and assigns it to the Data field. +SetData gets a reference to the given []ApplicationEvent and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20021.md b/docs/InlineResponse20021.md index df277b47..e8d0aa50 100644 --- a/docs/InlineResponse20021.md +++ b/docs/InlineResponse20021.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | | +**Data** | Pointer to **[]string** | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20021) GetData() []AccountAdditionalCost` +`func (o *InlineResponse20021) GetData() []string` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20021) GetDataOk() ([]AccountAdditionalCost, bool)` +`func (o *InlineResponse20021) GetDataOk() ([]string, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20021) SetData(v []AccountAdditionalCost)` +`func (o *InlineResponse20021) SetData(v []string)` -SetData gets a reference to the given []AccountAdditionalCost and assigns it to the Data field. +SetData gets a reference to the given []string and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20022.md b/docs/InlineResponse20022.md index a60e707f..21eb4446 100644 --- a/docs/InlineResponse20022.md +++ b/docs/InlineResponse20022.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Webhook**](Webhook.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]Audience**](Audience.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse20022) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20022) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *InlineResponse20022) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20022) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse20022) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20022) GetData() []Webhook` +`func (o *InlineResponse20022) GetData() []Audience` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20022) GetDataOk() ([]Webhook, bool)` +`func (o *InlineResponse20022) GetDataOk() ([]Audience, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20022) SetData(v []Webhook)` +`func (o *InlineResponse20022) SetData(v []Audience)` -SetData gets a reference to the given []Webhook and assigns it to the Data field. +SetData gets a reference to the given []Audience and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20023.md b/docs/InlineResponse20023.md index 93954623..fb16a47f 100644 --- a/docs/InlineResponse20023.md +++ b/docs/InlineResponse20023.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**HasMore** | Pointer to **bool** | | **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]WebhookActivationLogEntry**](WebhookActivationLogEntry.md) | | +**Data** | Pointer to [**[]ApplicationReferee**](ApplicationReferee.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse20023) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20023) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *InlineResponse20023) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20023) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse20023) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20023) GetData() []WebhookActivationLogEntry` +`func (o *InlineResponse20023) GetData() []ApplicationReferee` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20023) GetDataOk() ([]WebhookActivationLogEntry, bool)` +`func (o *InlineResponse20023) GetDataOk() ([]ApplicationReferee, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20023) SetData(v []WebhookActivationLogEntry)` +`func (o *InlineResponse20023) SetData(v []ApplicationReferee)` -SetData gets a reference to the given []WebhookActivationLogEntry and assigns it to the Data field. +SetData gets a reference to the given []ApplicationReferee and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20024.md b/docs/InlineResponse20024.md index c1cf6107..8da05f18 100644 --- a/docs/InlineResponse20024.md +++ b/docs/InlineResponse20024.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]WebhookLogEntry**](WebhookLogEntry.md) | | +**Data** | Pointer to [**[]Attribute**](Attribute.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20024) GetData() []WebhookLogEntry` +`func (o *InlineResponse20024) GetData() []Attribute` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20024) GetDataOk() ([]WebhookLogEntry, bool)` +`func (o *InlineResponse20024) GetDataOk() ([]Attribute, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20024) SetData(v []WebhookLogEntry)` +`func (o *InlineResponse20024) SetData(v []Attribute)` -SetData gets a reference to the given []WebhookLogEntry and assigns it to the Data field. +SetData gets a reference to the given []Attribute and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20025.md b/docs/InlineResponse20025.md index f3f0b1dc..501f3d71 100644 --- a/docs/InlineResponse20025.md +++ b/docs/InlineResponse20025.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]EventType**](EventType.md) | | +**Data** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20025) GetData() []EventType` +`func (o *InlineResponse20025) GetData() []AccountAdditionalCost` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20025) GetDataOk() ([]EventType, bool)` +`func (o *InlineResponse20025) GetDataOk() ([]AccountAdditionalCost, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20025) SetData(v []EventType)` +`func (o *InlineResponse20025) SetData(v []AccountAdditionalCost)` -SetData gets a reference to the given []EventType and assigns it to the Data field. +SetData gets a reference to the given []AccountAdditionalCost and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20026.md b/docs/InlineResponse20026.md index 032fe6fd..b18d3b6c 100644 --- a/docs/InlineResponse20026.md +++ b/docs/InlineResponse20026.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]User**](User.md) | | +**Data** | Pointer to [**[]Webhook**](Webhook.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20026) GetData() []User` +`func (o *InlineResponse20026) GetData() []Webhook` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20026) GetDataOk() ([]User, bool)` +`func (o *InlineResponse20026) GetDataOk() ([]Webhook, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20026) SetData(v []User)` +`func (o *InlineResponse20026) SetData(v []Webhook)` -SetData gets a reference to the given []User and assigns it to the Data field. +SetData gets a reference to the given []Webhook and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20027.md b/docs/InlineResponse20027.md index 005a3088..583e59fa 100644 --- a/docs/InlineResponse20027.md +++ b/docs/InlineResponse20027.md @@ -4,9 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | [optional] -**HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]Change**](Change.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]WebhookActivationLogEntry**](WebhookActivationLogEntry.md) | | ## Methods @@ -35,40 +34,15 @@ HasTotalResultSize returns a boolean if a field has been set. SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. -### GetHasMore - -`func (o *InlineResponse20027) GetHasMore() bool` - -GetHasMore returns the HasMore field if non-nil, zero value otherwise. - -### GetHasMoreOk - -`func (o *InlineResponse20027) GetHasMoreOk() (bool, bool)` - -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasHasMore - -`func (o *InlineResponse20027) HasHasMore() bool` - -HasHasMore returns a boolean if a field has been set. - -### SetHasMore - -`func (o *InlineResponse20027) SetHasMore(v bool)` - -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. - ### GetData -`func (o *InlineResponse20027) GetData() []Change` +`func (o *InlineResponse20027) GetData() []WebhookActivationLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20027) GetDataOk() ([]Change, bool)` +`func (o *InlineResponse20027) GetDataOk() ([]WebhookActivationLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20027) SetData(v []Change)` +`func (o *InlineResponse20027) SetData(v []WebhookActivationLogEntry)` -SetData gets a reference to the given []Change and assigns it to the Data field. +SetData gets a reference to the given []WebhookActivationLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20028.md b/docs/InlineResponse20028.md index 71451a94..20452d50 100644 --- a/docs/InlineResponse20028.md +++ b/docs/InlineResponse20028.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Export**](Export.md) | | +**Data** | Pointer to [**[]WebhookLogEntry**](WebhookLogEntry.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20028) GetData() []Export` +`func (o *InlineResponse20028) GetData() []WebhookLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20028) GetDataOk() ([]Export, bool)` +`func (o *InlineResponse20028) GetDataOk() ([]WebhookLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20028) SetData(v []Export)` +`func (o *InlineResponse20028) SetData(v []WebhookLogEntry)` -SetData gets a reference to the given []Export and assigns it to the Data field. +SetData gets a reference to the given []WebhookLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20029.md b/docs/InlineResponse20029.md index 16a6dc54..530426b2 100644 --- a/docs/InlineResponse20029.md +++ b/docs/InlineResponse20029.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Role**](Role.md) | | +**Data** | Pointer to [**[]EventType**](EventType.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20029) GetData() []Role` +`func (o *InlineResponse20029) GetData() []EventType` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20029) GetDataOk() ([]Role, bool)` +`func (o *InlineResponse20029) GetDataOk() ([]EventType, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20029) SetData(v []Role)` +`func (o *InlineResponse20029) SetData(v []EventType)` -SetData gets a reference to the given []Role and assigns it to the Data field. +SetData gets a reference to the given []EventType and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2003.md b/docs/InlineResponse2003.md index 2ea5d68d..8ee588fc 100644 --- a/docs/InlineResponse2003.md +++ b/docs/InlineResponse2003.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Ruleset**](Ruleset.md) | | +**Data** | Pointer to [**[]NotificationWebhook**](NotificationWebhook.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse2003) GetData() []Ruleset` +`func (o *InlineResponse2003) GetData() []NotificationWebhook` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2003) GetDataOk() ([]Ruleset, bool)` +`func (o *InlineResponse2003) GetDataOk() ([]NotificationWebhook, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2003) SetData(v []Ruleset)` +`func (o *InlineResponse2003) SetData(v []NotificationWebhook)` -SetData gets a reference to the given []Ruleset and assigns it to the Data field. +SetData gets a reference to the given []NotificationWebhook and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20030.md b/docs/InlineResponse20030.md new file mode 100644 index 00000000..07c193ce --- /dev/null +++ b/docs/InlineResponse20030.md @@ -0,0 +1,65 @@ +# InlineResponse20030 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]User**](User.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20030) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20030) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *InlineResponse20030) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20030) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20030) GetData() []User` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20030) GetDataOk() ([]User, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *InlineResponse20030) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20030) SetData(v []User)` + +SetData gets a reference to the given []User and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse20031.md b/docs/InlineResponse20031.md new file mode 100644 index 00000000..1a3e9994 --- /dev/null +++ b/docs/InlineResponse20031.md @@ -0,0 +1,91 @@ +# InlineResponse20031 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | [optional] +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]Change**](Change.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20031) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20031) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *InlineResponse20031) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20031) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetHasMore + +`func (o *InlineResponse20031) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20031) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *InlineResponse20031) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20031) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + +### GetData + +`func (o *InlineResponse20031) GetData() []Change` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20031) GetDataOk() ([]Change, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *InlineResponse20031) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20031) SetData(v []Change)` + +SetData gets a reference to the given []Change and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse20032.md b/docs/InlineResponse20032.md new file mode 100644 index 00000000..1627a501 --- /dev/null +++ b/docs/InlineResponse20032.md @@ -0,0 +1,65 @@ +# InlineResponse20032 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]Export**](Export.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20032) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20032) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *InlineResponse20032) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20032) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20032) GetData() []Export` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20032) GetDataOk() ([]Export, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *InlineResponse20032) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20032) SetData(v []Export)` + +SetData gets a reference to the given []Export and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse20033.md b/docs/InlineResponse20033.md new file mode 100644 index 00000000..8d398278 --- /dev/null +++ b/docs/InlineResponse20033.md @@ -0,0 +1,65 @@ +# InlineResponse20033 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]Role**](Role.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20033) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20033) GetTotalResultSizeOk() (int32, bool)` + +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResultSize + +`func (o *InlineResponse20033) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20033) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20033) GetData() []Role` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20033) GetDataOk() ([]Role, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *InlineResponse20033) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20033) SetData(v []Role)` + +SetData gets a reference to the given []Role and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2004.md b/docs/InlineResponse2004.md index 795ecc41..4f0bf311 100644 --- a/docs/InlineResponse2004.md +++ b/docs/InlineResponse2004.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Coupon**](Coupon.md) | | +**Data** | Pointer to [**[]Ruleset**](Ruleset.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse2004) GetData() []Coupon` +`func (o *InlineResponse2004) GetData() []Ruleset` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2004) GetDataOk() ([]Coupon, bool)` +`func (o *InlineResponse2004) GetDataOk() ([]Ruleset, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2004) SetData(v []Coupon)` +`func (o *InlineResponse2004) SetData(v []Ruleset)` -SetData gets a reference to the given []Coupon and assigns it to the Data field. +SetData gets a reference to the given []Ruleset and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2005.md b/docs/InlineResponse2005.md index e553952a..cddbf28a 100644 --- a/docs/InlineResponse2005.md +++ b/docs/InlineResponse2005.md @@ -4,35 +4,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | +**TotalResultSize** | Pointer to **int32** | | **Data** | Pointer to [**[]Coupon**](Coupon.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse2005) GetHasMore() bool` +`func (o *InlineResponse2005) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse2005) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse2005) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse2005) HasHasMore() bool` +`func (o *InlineResponse2005) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse2005) SetHasMore(v bool)` +`func (o *InlineResponse2005) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData diff --git a/docs/InlineResponse2006.md b/docs/InlineResponse2006.md index 60a69081..18760f1f 100644 --- a/docs/InlineResponse2006.md +++ b/docs/InlineResponse2006.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]Referral**](Referral.md) | | +**Data** | Pointer to [**[]Coupon**](Coupon.md) | | ## Methods @@ -36,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse2006) GetData() []Referral` +`func (o *InlineResponse2006) GetData() []Coupon` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2006) GetDataOk() ([]Referral, bool)` +`func (o *InlineResponse2006) GetDataOk() ([]Coupon, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2006) SetData(v []Referral)` +`func (o *InlineResponse2006) SetData(v []Coupon)` -SetData gets a reference to the given []Referral and assigns it to the Data field. +SetData gets a reference to the given []Coupon and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2007.md b/docs/InlineResponse2007.md index 137291c2..8a0488d6 100644 --- a/docs/InlineResponse2007.md +++ b/docs/InlineResponse2007.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]Referral**](Referral.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse2007) GetTotalResultSize() int32` +`func (o *InlineResponse2007) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse2007) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse2007) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse2007) HasTotalResultSize() bool` +`func (o *InlineResponse2007) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse2007) SetTotalResultSize(v int32)` +`func (o *InlineResponse2007) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData -`func (o *InlineResponse2007) GetData() []LoyaltyProgram` +`func (o *InlineResponse2007) GetData() []Referral` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2007) GetDataOk() ([]LoyaltyProgram, bool)` +`func (o *InlineResponse2007) GetDataOk() ([]Referral, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2007) SetData(v []LoyaltyProgram)` +`func (o *InlineResponse2007) SetData(v []Referral)` -SetData gets a reference to the given []LoyaltyProgram and assigns it to the Data field. +SetData gets a reference to the given []Referral and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2008.md b/docs/InlineResponse2008.md index 6f2a5ee5..0be04d9e 100644 --- a/docs/InlineResponse2008.md +++ b/docs/InlineResponse2008.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse2008) GetHasMore() bool` +`func (o *InlineResponse2008) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse2008) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse2008) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse2008) HasHasMore() bool` +`func (o *InlineResponse2008) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse2008) SetHasMore(v bool)` +`func (o *InlineResponse2008) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse2008) GetData() []AccessLogEntry` +`func (o *InlineResponse2008) GetData() []LoyaltyProgram` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2008) GetDataOk() ([]AccessLogEntry, bool)` +`func (o *InlineResponse2008) GetDataOk() ([]LoyaltyProgram, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2008) SetData(v []AccessLogEntry)` +`func (o *InlineResponse2008) SetData(v []LoyaltyProgram)` -SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. +SetData gets a reference to the given []LoyaltyProgram and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2009.md b/docs/InlineResponse2009.md index fd057b6e..77c39d7c 100644 --- a/docs/InlineResponse2009.md +++ b/docs/InlineResponse2009.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]CollectionWithoutPayload**](CollectionWithoutPayload.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse2009) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse2009) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *InlineResponse2009) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse2009) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse2009) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse2009) GetData() []AccessLogEntry` +`func (o *InlineResponse2009) GetData() []CollectionWithoutPayload` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2009) GetDataOk() ([]AccessLogEntry, bool)` +`func (o *InlineResponse2009) GetDataOk() ([]CollectionWithoutPayload, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2009) SetData(v []AccessLogEntry)` +`func (o *InlineResponse2009) SetData(v []CollectionWithoutPayload)` -SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. +SetData gets a reference to the given []CollectionWithoutPayload and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index 8b29a5c8..ae5eef0b 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -1,6 +1,6 @@ # \IntegrationApi -All URIs are relative to *http://localhost* +All URIs are relative to *https://yourbaseurl.talon.one* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -11,12 +11,17 @@ Method | HTTP request | Description [**DeleteAudienceMembershipsV2**](IntegrationApi.md#DeleteAudienceMembershipsV2) | **Delete** /v2/audiences/{audienceId}/memberships | Delete audience memberships [**DeleteAudienceV2**](IntegrationApi.md#DeleteAudienceV2) | **Delete** /v2/audiences/{audienceId} | Delete audience [**DeleteCouponReservation**](IntegrationApi.md#DeleteCouponReservation) | **Delete** /v1/coupon_reservations/{couponValue} | Delete coupon reservations -[**DeleteCustomerData**](IntegrationApi.md#DeleteCustomerData) | **Delete** /v1/customer_data/{integrationId} | Delete the personal data of a customer -[**GetCustomerInventory**](IntegrationApi.md#GetCustomerInventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | List data associated with a specific customer profile -[**GetReservedCustomers**](IntegrationApi.md#GetReservedCustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | List users that have this coupon reserved -[**TrackEvent**](IntegrationApi.md#TrackEvent) | **Post** /v1/events | Track an Event +[**DeleteCustomerData**](IntegrationApi.md#DeleteCustomerData) | **Delete** /v1/customer_data/{integrationId} | Delete customer's personal data +[**GetCustomerInventory**](IntegrationApi.md#GetCustomerInventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | List customer data +[**GetCustomerSession**](IntegrationApi.md#GetCustomerSession) | **Get** /v2/customer_sessions/{customerSessionId} | Get customer session +[**GetLoyaltyTransactions**](IntegrationApi.md#GetLoyaltyTransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | Get loyalty ledger transaction logs +[**GetReservedCustomers**](IntegrationApi.md#GetReservedCustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved +[**ReturnCartItems**](IntegrationApi.md#ReturnCartItems) | **Post** /v2/customer_sessions/{customerSessionId}/returns | Return cart items +[**SyncCatalog**](IntegrationApi.md#SyncCatalog) | **Put** /v1/catalogs/{catalogId}/sync | Sync cart item catalog +[**TrackEvent**](IntegrationApi.md#TrackEvent) | **Post** /v1/events | Track event +[**TrackEventV2**](IntegrationApi.md#TrackEventV2) | **Post** /v2/events | Track event V2 [**UpdateAudienceCustomersAttributes**](IntegrationApi.md#UpdateAudienceCustomersAttributes) | **Put** /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience -[**UpdateAudienceV2**](IntegrationApi.md#UpdateAudienceV2) | **Put** /v2/audiences/{audienceId} | Update audience +[**UpdateAudienceV2**](IntegrationApi.md#UpdateAudienceV2) | **Put** /v2/audiences/{audienceId} | Update audience name [**UpdateCustomerProfileAudiences**](IntegrationApi.md#UpdateCustomerProfileAudiences) | **Post** /v2/customer_audiences | Update multiple customer profiles' audiences [**UpdateCustomerProfileV2**](IntegrationApi.md#UpdateCustomerProfileV2) | **Put** /v2/customer_profiles/{integrationId} | Update customer profile [**UpdateCustomerProfilesV2**](IntegrationApi.md#UpdateCustomerProfilesV2) | **Put** /v2/customer_profiles | Update multiple customer profiles @@ -77,7 +82,7 @@ Create coupon reservation Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**couponValue** | **string** | The value of a coupon | +**couponValue** | **string** | The code of the coupon. | ### Other Parameters @@ -222,7 +227,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -265,7 +270,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -286,7 +291,7 @@ Delete coupon reservations Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**couponValue** | **string** | The value of a coupon | +**couponValue** | **string** | The code of the coupon. | ### Other Parameters @@ -309,7 +314,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -320,7 +325,7 @@ Name | Type | Description | Notes > DeleteCustomerData(ctx, integrationId).Execute() -Delete the personal data of a customer +Delete customer's personal data @@ -330,7 +335,7 @@ Delete the personal data of a customer Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**integrationId** | **string** | The custom identifier for this profile, must be unique within the account. | +**integrationId** | **string** | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). | ### Other Parameters @@ -352,7 +357,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -361,9 +366,9 @@ Name | Type | Description | Notes ## GetCustomerInventory -> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).Execute() +> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).LoyaltyProjectionEndDate(loyaltyProjectionEndDate).Execute() -List data associated with a specific customer profile +List customer data @@ -373,7 +378,7 @@ List data associated with a specific customer profile Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**integrationId** | **string** | The custom identifier for this profile, must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). | +**integrationId** | **string** | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). | ### Other Parameters @@ -388,6 +393,7 @@ Name | Type | Description | Notes **coupons** | **bool** | Set to `true` to include coupon information in the response. | **loyalty** | **bool** | Set to `true` to include loyalty information in the response. | **giveaways** | **bool** | Set to `true` to include giveaways information in the response. | + **loyaltyProjectionEndDate** | **time.Time** | Set an end date to query the projected loyalty balances. You can project results up to 31 days from today. | ### Return type @@ -407,11 +413,103 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## GetCustomerSession + +> IntegrationCustomerSessionResponse GetCustomerSession(ctx, customerSessionId).Execute() + +Get customer session + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**customerSessionId** | **string** | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomerSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IntegrationCustomerSessionResponse**](IntegrationCustomerSessionResponse.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLoyaltyTransactions + +> LedgerTransactionLogEntryIntegrationApi GetLoyaltyTransactions(ctx, loyaltyProgramId, integrationId).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute() + +Get loyalty ledger transaction logs + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). | +**integrationId** | **string** | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyTransactionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **startDate** | **time.Time** | Time from which results are returned. It must be an RFC3339 timestamp string. | + **endDate** | **time.Time** | Only return results older than this timestamp. It must be an RFC3339 timestamp string. | + **pageSize** | **int32** | The number of items in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + +### Return type + +[**LedgerTransactionLogEntryIntegrationApi**](LedgerTransactionLogEntryIntegrationAPI.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## GetReservedCustomers > InlineResponse200 GetReservedCustomers(ctx, couponValue).Execute() -List users that have this coupon reserved +List customers that have this coupon reserved @@ -421,7 +519,7 @@ List users that have this coupon reserved Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**couponValue** | **string** | The value of a coupon | +**couponValue** | **string** | The code of the coupon. | ### Other Parameters @@ -450,11 +548,100 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## ReturnCartItems + +> IntegrationStateV2 ReturnCartItems(ctx, customerSessionId).Body(body).Dry(dry).Execute() + +Return cart items + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**customerSessionId** | **string** | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReturnCartItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md) | | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | + +### Return type + +[**IntegrationStateV2**](IntegrationStateV2.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## SyncCatalog + +> Catalog SyncCatalog(ctx, catalogId).Body(body).Execute() + +Sync cart item catalog + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**catalogId** | **int32** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncCatalogRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**CatalogSyncRequest**](CatalogSyncRequest.md) | | + +### Return type + +[**Catalog**](Catalog.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## TrackEvent > IntegrationState TrackEvent(ctx).Body(body).Dry(dry).Execute() -Track an Event +Track event @@ -490,6 +677,47 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## TrackEventV2 + +> IntegrationStateV2 TrackEventV2(ctx).Body(body).Silent(silent).Dry(dry).Execute() + +Track event V2 + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTrackEventV2Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md) | | + **silent** | **string** | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [default to yes] + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | + +### Return type + +[**IntegrationStateV2**](IntegrationStateV2.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## UpdateAudienceCustomersAttributes > UpdateAudienceCustomersAttributes(ctx, audienceId).Body(body).Execute() @@ -527,7 +755,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -538,7 +766,7 @@ Name | Type | Description | Notes > Audience UpdateAudienceV2(ctx, audienceId).Body(body).Execute() -Update audience +Update audience name @@ -610,7 +838,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -631,7 +859,7 @@ Update customer profile Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**integrationId** | **string** | The custom identifier for this profile. Must be unique within the account. | +**integrationId** | **string** | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. | ### Other Parameters @@ -642,8 +870,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md) | | - **runRuleEngine** | **bool** | Indicates whether to run the rule engine. Setting this property to `false` improves response times. | [default to false] - **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`. | + **runRuleEngine** | **bool** | Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. | [default to false] + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. This property only works when `runRuleEngine=true`. | ### Return type @@ -717,7 +945,7 @@ Update customer session Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**customerSessionId** | **string** | The custom identifier for this session, must be unique within the account. | +**customerSessionId** | **string** | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). | ### Other Parameters diff --git a/docs/IntegrationCustomerSessionResponse.md b/docs/IntegrationCustomerSessionResponse.md new file mode 100644 index 00000000..90fabba7 --- /dev/null +++ b/docs/IntegrationCustomerSessionResponse.md @@ -0,0 +1,65 @@ +# IntegrationCustomerSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerSession** | Pointer to [**CustomerSessionV2**](CustomerSessionV2.md) | | [optional] +**Effects** | Pointer to [**[]Effect**](Effect.md) | | [optional] + +## Methods + +### GetCustomerSession + +`func (o *IntegrationCustomerSessionResponse) GetCustomerSession() CustomerSessionV2` + +GetCustomerSession returns the CustomerSession field if non-nil, zero value otherwise. + +### GetCustomerSessionOk + +`func (o *IntegrationCustomerSessionResponse) GetCustomerSessionOk() (CustomerSessionV2, bool)` + +GetCustomerSessionOk returns a tuple with the CustomerSession field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerSession + +`func (o *IntegrationCustomerSessionResponse) HasCustomerSession() bool` + +HasCustomerSession returns a boolean if a field has been set. + +### SetCustomerSession + +`func (o *IntegrationCustomerSessionResponse) SetCustomerSession(v CustomerSessionV2)` + +SetCustomerSession gets a reference to the given CustomerSessionV2 and assigns it to the CustomerSession field. + +### GetEffects + +`func (o *IntegrationCustomerSessionResponse) GetEffects() []Effect` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *IntegrationCustomerSessionResponse) GetEffectsOk() ([]Effect, bool)` + +GetEffectsOk returns a tuple with the Effects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEffects + +`func (o *IntegrationCustomerSessionResponse) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + +### SetEffects + +`func (o *IntegrationCustomerSessionResponse) SetEffects(v []Effect)` + +SetEffects gets a reference to the given []Effect and assigns it to the Effects field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IntegrationEntity.md b/docs/IntegrationEntity.md index a6a4f052..13deedcf 100644 --- a/docs/IntegrationEntity.md +++ b/docs/IntegrationEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | +**IntegrationId** | Pointer to **string** | The integration ID set by your integration layer. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | ## Methods diff --git a/docs/IntegrationEvent.md b/docs/IntegrationEvent.md index 862ec4d4..3b09e6a3 100644 --- a/docs/IntegrationEvent.md +++ b/docs/IntegrationEvent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] **Type** | Pointer to **string** | A string representing the event. Must not be a reserved event name. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON data associated with the event. | diff --git a/docs/IntegrationEventV2Request.md b/docs/IntegrationEventV2Request.md new file mode 100644 index 00000000..ef8ae23c --- /dev/null +++ b/docs/IntegrationEventV2Request.md @@ -0,0 +1,117 @@ +# IntegrationEventV2Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**Type** | Pointer to **string** | A string representing the event. Must not be a reserved event name. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON data associated with the event. | [optional] +**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the tracking custom event. | [optional] + +## Methods + +### GetProfileId + +`func (o *IntegrationEventV2Request) GetProfileId() string` + +GetProfileId returns the ProfileId field if non-nil, zero value otherwise. + +### GetProfileIdOk + +`func (o *IntegrationEventV2Request) GetProfileIdOk() (string, bool)` + +GetProfileIdOk returns a tuple with the ProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileId + +`func (o *IntegrationEventV2Request) HasProfileId() bool` + +HasProfileId returns a boolean if a field has been set. + +### SetProfileId + +`func (o *IntegrationEventV2Request) SetProfileId(v string)` + +SetProfileId gets a reference to the given string and assigns it to the ProfileId field. + +### GetType + +`func (o *IntegrationEventV2Request) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IntegrationEventV2Request) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *IntegrationEventV2Request) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *IntegrationEventV2Request) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetAttributes + +`func (o *IntegrationEventV2Request) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IntegrationEventV2Request) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *IntegrationEventV2Request) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *IntegrationEventV2Request) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetResponseContent + +`func (o *IntegrationEventV2Request) GetResponseContent() []string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *IntegrationEventV2Request) GetResponseContentOk() ([]string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasResponseContent + +`func (o *IntegrationEventV2Request) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### SetResponseContent + +`func (o *IntegrationEventV2Request) SetResponseContent(v []string)` + +SetResponseContent gets a reference to the given []string and assigns it to the ResponseContent field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IntegrationProfileEntity.md b/docs/IntegrationProfileEntity.md index bd090831..106f051f 100644 --- a/docs/IntegrationProfileEntity.md +++ b/docs/IntegrationProfileEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] ## Methods diff --git a/docs/IntegrationRequest.md b/docs/IntegrationRequest.md index ec7a3a2e..16505674 100644 --- a/docs/IntegrationRequest.md +++ b/docs/IntegrationRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CustomerSession** | Pointer to [**NewCustomerSessionV2**](NewCustomerSessionV2.md) | | -**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer session update. **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. | [optional] +**ResponseContent** | Pointer to **[]string** | Optional list of extra data that you want to get in the response. Use this property to get as much data as you need in one request instead of sending extra requests to other endpoints. **Note:** `ruleFailureReasons` is always part of the response when the [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. | [optional] ## Methods diff --git a/docs/IntegrationStateV2.md b/docs/IntegrationStateV2.md index 1a120a4e..8e9d756c 100644 --- a/docs/IntegrationStateV2.md +++ b/docs/IntegrationStateV2.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **CustomerProfile** | Pointer to [**CustomerProfile**](CustomerProfile.md) | | [optional] **Event** | Pointer to [**Event**](Event.md) | | [optional] **Loyalty** | Pointer to [**Loyalty**](Loyalty.md) | | [optional] -**Referral** | Pointer to [**Referral**](Referral.md) | | [optional] +**Referral** | Pointer to [**InventoryReferral**](InventoryReferral.md) | | [optional] **Coupons** | Pointer to [**[]Coupon**](Coupon.md) | | [optional] **TriggeredCampaigns** | Pointer to [**[]Campaign**](Campaign.md) | | [optional] **Effects** | Pointer to [**[]Effect**](Effect.md) | | @@ -16,6 +16,8 @@ Name | Type | Description | Notes **CreatedCoupons** | Pointer to [**[]Coupon**](Coupon.md) | | **CreatedReferrals** | Pointer to [**[]Referral**](Referral.md) | | **AwardedGiveaways** | Pointer to [**[]Giveaway**](Giveaway.md) | | [optional] +**Return** | Pointer to [**Return**](Return.md) | | [optional] +**PreviousReturns** | Pointer to [**[]Return**](Return.md) | | [optional] ## Methods @@ -121,13 +123,13 @@ SetLoyalty gets a reference to the given Loyalty and assigns it to the Loyalty f ### GetReferral -`func (o *IntegrationStateV2) GetReferral() Referral` +`func (o *IntegrationStateV2) GetReferral() InventoryReferral` GetReferral returns the Referral field if non-nil, zero value otherwise. ### GetReferralOk -`func (o *IntegrationStateV2) GetReferralOk() (Referral, bool)` +`func (o *IntegrationStateV2) GetReferralOk() (InventoryReferral, bool)` GetReferralOk returns a tuple with the Referral field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -140,9 +142,9 @@ HasReferral returns a boolean if a field has been set. ### SetReferral -`func (o *IntegrationStateV2) SetReferral(v Referral)` +`func (o *IntegrationStateV2) SetReferral(v InventoryReferral)` -SetReferral gets a reference to the given Referral and assigns it to the Referral field. +SetReferral gets a reference to the given InventoryReferral and assigns it to the Referral field. ### GetCoupons @@ -319,6 +321,56 @@ HasAwardedGiveaways returns a boolean if a field has been set. SetAwardedGiveaways gets a reference to the given []Giveaway and assigns it to the AwardedGiveaways field. +### GetReturn + +`func (o *IntegrationStateV2) GetReturn() Return` + +GetReturn returns the Return field if non-nil, zero value otherwise. + +### GetReturnOk + +`func (o *IntegrationStateV2) GetReturnOk() (Return, bool)` + +GetReturnOk returns a tuple with the Return field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReturn + +`func (o *IntegrationStateV2) HasReturn() bool` + +HasReturn returns a boolean if a field has been set. + +### SetReturn + +`func (o *IntegrationStateV2) SetReturn(v Return)` + +SetReturn gets a reference to the given Return and assigns it to the Return field. + +### GetPreviousReturns + +`func (o *IntegrationStateV2) GetPreviousReturns() []Return` + +GetPreviousReturns returns the PreviousReturns field if non-nil, zero value otherwise. + +### GetPreviousReturnsOk + +`func (o *IntegrationStateV2) GetPreviousReturnsOk() ([]Return, bool)` + +GetPreviousReturnsOk returns a tuple with the PreviousReturns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPreviousReturns + +`func (o *IntegrationStateV2) HasPreviousReturns() bool` + +HasPreviousReturns returns a boolean if a field has been set. + +### SetPreviousReturns + +`func (o *IntegrationStateV2) SetPreviousReturns(v []Return)` + +SetPreviousReturns gets a reference to the given []Return and assigns it to the PreviousReturns field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md index f0d82366..ca327376 100644 --- a/docs/InventoryCoupon.md +++ b/docs/InventoryCoupon.md @@ -4,25 +4,26 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | -**Value** | Pointer to **string** | The actual coupon code. | -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**Value** | Pointer to **string** | The coupon code. | +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **UsageCounter** | Pointer to **int32** | The number of times this coupon has been successfully used. | **DiscountCounter** | Pointer to **float32** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] **DiscountRemainder** | Pointer to **float32** | The remaining discount this coupon can give. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Custom attributes associated with this coupon. | [optional] **ReferralId** | Pointer to **int32** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] **RecipientIntegrationId** | Pointer to **string** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] **ImportId** | Pointer to **int32** | The ID of the Import which created this coupon. | [optional] -**Reservation** | Pointer to **bool** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] +**Reservation** | Pointer to **bool** | Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation endpoint](/integration-api/#operation/createCouponReservation). - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons endpoint](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients endpoint](/management-api/#operation/createCouponsForMultipleRecipients). | [optional] [default to true] **BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] **ProfileRedemptionCount** | Pointer to **int32** | The number of times the coupon was redeemed by the profile. | -**State** | Pointer to **string** | Can be either active, used, expired, pending or disabled. active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. pending: coupons that have a start date in the future. disabled: coupons of non-active campaigns. | +**State** | Pointer to **string** | Can be: - `active`: The coupon can be used. It is a reserved coupon that is neither pending, used nor expired, and has a non-exhausted limit counter. - `used`: The coupon has been redeemed and cannot be used again. It is not pending and has reached its redemption limit or was redeemed by the profile before expiration. - `expired`: The coupon was never redeemed and it is now expired. It is non-pending, non-active and non-used by the profile. - `pending`: The coupon will be usable in the future. - `disabled`: The coupon is part of a non-active campaign. | ## Methods @@ -226,6 +227,31 @@ HasExpiryDate returns a boolean if a field has been set. SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +### GetLimits + +`func (o *InventoryCoupon) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *InventoryCoupon) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *InventoryCoupon) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *InventoryCoupon) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + ### GetUsageCounter `func (o *InventoryCoupon) GetUsageCounter() int32` diff --git a/docs/InventoryReferral.md b/docs/InventoryReferral.md new file mode 100644 index 00000000..4c3e8d78 --- /dev/null +++ b/docs/InventoryReferral.md @@ -0,0 +1,377 @@ +# InventoryReferral + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | +**CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | +**AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**ImportId** | Pointer to **int32** | The ID of the Import which created this referral. | [optional] +**Code** | Pointer to **string** | The referral code. | +**UsageCounter** | Pointer to **int32** | The number of times this referral code has been successfully used. | +**BatchId** | Pointer to **string** | The ID of the batch the referrals belong to. | [optional] +**ReferredCustomers** | Pointer to **[]string** | An array of referred customers. | + +## Methods + +### GetId + +`func (o *InventoryReferral) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *InventoryReferral) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *InventoryReferral) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *InventoryReferral) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *InventoryReferral) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *InventoryReferral) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *InventoryReferral) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *InventoryReferral) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetStartDate + +`func (o *InventoryReferral) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *InventoryReferral) GetStartDateOk() (time.Time, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartDate + +`func (o *InventoryReferral) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *InventoryReferral) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *InventoryReferral) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *InventoryReferral) GetExpiryDateOk() (time.Time, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *InventoryReferral) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *InventoryReferral) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageLimit + +`func (o *InventoryReferral) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *InventoryReferral) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *InventoryReferral) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *InventoryReferral) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + +### GetCampaignId + +`func (o *InventoryReferral) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *InventoryReferral) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *InventoryReferral) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *InventoryReferral) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetAdvocateProfileIntegrationId + +`func (o *InventoryReferral) GetAdvocateProfileIntegrationId() string` + +GetAdvocateProfileIntegrationId returns the AdvocateProfileIntegrationId field if non-nil, zero value otherwise. + +### GetAdvocateProfileIntegrationIdOk + +`func (o *InventoryReferral) GetAdvocateProfileIntegrationIdOk() (string, bool)` + +GetAdvocateProfileIntegrationIdOk returns a tuple with the AdvocateProfileIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdvocateProfileIntegrationId + +`func (o *InventoryReferral) HasAdvocateProfileIntegrationId() bool` + +HasAdvocateProfileIntegrationId returns a boolean if a field has been set. + +### SetAdvocateProfileIntegrationId + +`func (o *InventoryReferral) SetAdvocateProfileIntegrationId(v string)` + +SetAdvocateProfileIntegrationId gets a reference to the given string and assigns it to the AdvocateProfileIntegrationId field. + +### GetFriendProfileIntegrationId + +`func (o *InventoryReferral) GetFriendProfileIntegrationId() string` + +GetFriendProfileIntegrationId returns the FriendProfileIntegrationId field if non-nil, zero value otherwise. + +### GetFriendProfileIntegrationIdOk + +`func (o *InventoryReferral) GetFriendProfileIntegrationIdOk() (string, bool)` + +GetFriendProfileIntegrationIdOk returns a tuple with the FriendProfileIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFriendProfileIntegrationId + +`func (o *InventoryReferral) HasFriendProfileIntegrationId() bool` + +HasFriendProfileIntegrationId returns a boolean if a field has been set. + +### SetFriendProfileIntegrationId + +`func (o *InventoryReferral) SetFriendProfileIntegrationId(v string)` + +SetFriendProfileIntegrationId gets a reference to the given string and assigns it to the FriendProfileIntegrationId field. + +### GetAttributes + +`func (o *InventoryReferral) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *InventoryReferral) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *InventoryReferral) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *InventoryReferral) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetImportId + +`func (o *InventoryReferral) GetImportId() int32` + +GetImportId returns the ImportId field if non-nil, zero value otherwise. + +### GetImportIdOk + +`func (o *InventoryReferral) GetImportIdOk() (int32, bool)` + +GetImportIdOk returns a tuple with the ImportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasImportId + +`func (o *InventoryReferral) HasImportId() bool` + +HasImportId returns a boolean if a field has been set. + +### SetImportId + +`func (o *InventoryReferral) SetImportId(v int32)` + +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. + +### GetCode + +`func (o *InventoryReferral) GetCode() string` + +GetCode returns the Code field if non-nil, zero value otherwise. + +### GetCodeOk + +`func (o *InventoryReferral) GetCodeOk() (string, bool)` + +GetCodeOk returns a tuple with the Code field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCode + +`func (o *InventoryReferral) HasCode() bool` + +HasCode returns a boolean if a field has been set. + +### SetCode + +`func (o *InventoryReferral) SetCode(v string)` + +SetCode gets a reference to the given string and assigns it to the Code field. + +### GetUsageCounter + +`func (o *InventoryReferral) GetUsageCounter() int32` + +GetUsageCounter returns the UsageCounter field if non-nil, zero value otherwise. + +### GetUsageCounterOk + +`func (o *InventoryReferral) GetUsageCounterOk() (int32, bool)` + +GetUsageCounterOk returns a tuple with the UsageCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageCounter + +`func (o *InventoryReferral) HasUsageCounter() bool` + +HasUsageCounter returns a boolean if a field has been set. + +### SetUsageCounter + +`func (o *InventoryReferral) SetUsageCounter(v int32)` + +SetUsageCounter gets a reference to the given int32 and assigns it to the UsageCounter field. + +### GetBatchId + +`func (o *InventoryReferral) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *InventoryReferral) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *InventoryReferral) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *InventoryReferral) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + +### GetReferredCustomers + +`func (o *InventoryReferral) GetReferredCustomers() []string` + +GetReferredCustomers returns the ReferredCustomers field if non-nil, zero value otherwise. + +### GetReferredCustomersOk + +`func (o *InventoryReferral) GetReferredCustomersOk() ([]string, bool)` + +GetReferredCustomersOk returns a tuple with the ReferredCustomers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferredCustomers + +`func (o *InventoryReferral) HasReferredCustomers() bool` + +HasReferredCustomers returns a boolean if a field has been set. + +### SetReferredCustomers + +`func (o *InventoryReferral) SetReferredCustomers(v []string)` + +SetReferredCustomers gets a reference to the given []string and assigns it to the ReferredCustomers field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ItemAttribute.md b/docs/ItemAttribute.md new file mode 100644 index 00000000..bcdc623a --- /dev/null +++ b/docs/ItemAttribute.md @@ -0,0 +1,91 @@ +# ItemAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributeid** | Pointer to **int32** | The ID of the attribute of the item. | +**Name** | Pointer to **string** | The name of the attribute. | +**Value** | Pointer to [**map[string]interface{}**](.md) | The value of the attribute. | + +## Methods + +### GetAttributeid + +`func (o *ItemAttribute) GetAttributeid() int32` + +GetAttributeid returns the Attributeid field if non-nil, zero value otherwise. + +### GetAttributeidOk + +`func (o *ItemAttribute) GetAttributeidOk() (int32, bool)` + +GetAttributeidOk returns a tuple with the Attributeid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributeid + +`func (o *ItemAttribute) HasAttributeid() bool` + +HasAttributeid returns a boolean if a field has been set. + +### SetAttributeid + +`func (o *ItemAttribute) SetAttributeid(v int32)` + +SetAttributeid gets a reference to the given int32 and assigns it to the Attributeid field. + +### GetName + +`func (o *ItemAttribute) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ItemAttribute) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ItemAttribute) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ItemAttribute) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetValue + +`func (o *ItemAttribute) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ItemAttribute) GetValueOk() (map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *ItemAttribute) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *ItemAttribute) SetValue(v map[string]interface{})` + +SetValue gets a reference to the given map[string]interface{} and assigns it to the Value field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LedgerEntry.md b/docs/LedgerEntry.md index 57049ce6..9a2208f1 100644 --- a/docs/LedgerEntry.md +++ b/docs/LedgerEntry.md @@ -4,16 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | **AccountId** | Pointer to **int32** | The ID of the Talon.One account that owns this profile. | -**LoyaltyProgramId** | Pointer to **int32** | ID of the ledger | -**EventId** | Pointer to **int32** | ID of the related event | -**Amount** | Pointer to **int32** | Amount of loyalty points | -**Reason** | Pointer to **string** | reason for awarding/deducting points | -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the points | -**ReferenceId** | Pointer to **int32** | The ID of the balancing ledgerEntry | [optional] +**LoyaltyProgramId** | Pointer to **int32** | ID of the ledger. | +**EventId** | Pointer to **int32** | ID of the related event. | +**Amount** | Pointer to **int32** | Amount of loyalty points. | +**Reason** | Pointer to **string** | reason for awarding/deducting points. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the points. | +**ReferenceId** | Pointer to **int32** | The ID of the balancing ledgerEntry. | [optional] ## Methods diff --git a/docs/LedgerInfo.md b/docs/LedgerInfo.md index 2e85ef41..440d3834 100644 --- a/docs/LedgerInfo.md +++ b/docs/LedgerInfo.md @@ -4,13 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CurrentBalance** | Pointer to **float32** | Sum of current active points amounts | -**PendingBalance** | Pointer to **float32** | Sum of pending points amounts | -**ExpiredBalance** | Pointer to **float32** | Sum of expired points amounts | -**SpentBalance** | Pointer to **float32** | Sum of spent points amounts | -**TentativeCurrentBalance** | Pointer to **float32** | Sum of current active points amounts, including additions and deductions on open sessions | +**CurrentBalance** | Pointer to **float32** | Sum of currently active points. | +**PendingBalance** | Pointer to **float32** | Sum of pending points. | +**ExpiredBalance** | Pointer to **float32** | Sum of expired points. | +**SpentBalance** | Pointer to **float32** | Sum of spent points. | +**TentativeCurrentBalance** | Pointer to **float32** | Sum of currently active points, including points added and deducted in open sessions. | **CurrentTier** | Pointer to [**Tier**](Tier.md) | | [optional] **PointsToNextTier** | Pointer to **float32** | Points required to move up a tier. | [optional] +**Projection** | Pointer to [**LoyaltyProjection**](LoyaltyProjection.md) | | [optional] ## Methods @@ -189,6 +190,31 @@ HasPointsToNextTier returns a boolean if a field has been set. SetPointsToNextTier gets a reference to the given float32 and assigns it to the PointsToNextTier field. +### GetProjection + +`func (o *LedgerInfo) GetProjection() LoyaltyProjection` + +GetProjection returns the Projection field if non-nil, zero value otherwise. + +### GetProjectionOk + +`func (o *LedgerInfo) GetProjectionOk() (LoyaltyProjection, bool)` + +GetProjectionOk returns a tuple with the Projection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProjection + +`func (o *LedgerInfo) HasProjection() bool` + +HasProjection returns a boolean if a field has been set. + +### SetProjection + +`func (o *LedgerInfo) SetProjection(v LoyaltyProjection)` + +SetProjection gets a reference to the given LoyaltyProjection and assigns it to the Projection field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LedgerTransactionLogEntryIntegrationApi.md b/docs/LedgerTransactionLogEntryIntegrationApi.md new file mode 100644 index 00000000..d9b00482 --- /dev/null +++ b/docs/LedgerTransactionLogEntryIntegrationApi.md @@ -0,0 +1,325 @@ +# LedgerTransactionLogEntryIntegrationApi + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to [**time.Time**](time.Time.md) | Date and time the loyalty card transaction occurred. | +**ProgramId** | Pointer to **int32** | ID of the loyalty program. | +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | +**Type** | Pointer to **string** | Type of transaction. Possible values are: - `addition`: Points were added. - `subtraction`: Points were subtracted. | +**Name** | Pointer to **string** | Name or reason of the loyalty ledger transaction. | +**StartDate** | Pointer to **string** | Date when points become active. Possible values are: - `immediate`: Points are active immediately. - `timestamp value`: Points become active from the given date. | +**ExpiryDate** | Pointer to **string** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date. | +**SubledgerId** | Pointer to **string** | ID of the subledger. | +**Amount** | Pointer to **float32** | Amount of loyalty points added or deducted in the transaction. | +**Id** | Pointer to **int32** | ID of the loyalty ledger transaction. | +**RulesetId** | Pointer to **int32** | The ID of the ruleset containing the rule that triggered this effect. | [optional] +**RuleName** | Pointer to **string** | The name of the rule that triggered this effect. | [optional] + +## Methods + +### GetCreated + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetProgramId + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetProgramId() int32` + +GetProgramId returns the ProgramId field if non-nil, zero value otherwise. + +### GetProgramIdOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetProgramIdOk() (int32, bool)` + +GetProgramIdOk returns a tuple with the ProgramId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramId + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasProgramId() bool` + +HasProgramId returns a boolean if a field has been set. + +### SetProgramId + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetProgramId(v int32)` + +SetProgramId gets a reference to the given int32 and assigns it to the ProgramId field. + +### GetCustomerSessionId + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetCustomerSessionId() string` + +GetCustomerSessionId returns the CustomerSessionId field if non-nil, zero value otherwise. + +### GetCustomerSessionIdOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetCustomerSessionIdOk() (string, bool)` + +GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerSessionId + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasCustomerSessionId() bool` + +HasCustomerSessionId returns a boolean if a field has been set. + +### SetCustomerSessionId + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetCustomerSessionId(v string)` + +SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. + +### GetType + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetName + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetStartDate + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetStartDateOk() (string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartDate + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetStartDate(v string)` + +SetStartDate gets a reference to the given string and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetExpiryDate() string` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetExpiryDateOk() (string, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetExpiryDate(v string)` + +SetExpiryDate gets a reference to the given string and assigns it to the ExpiryDate field. + +### GetSubledgerId + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetSubledgerId() string` + +GetSubledgerId returns the SubledgerId field if non-nil, zero value otherwise. + +### GetSubledgerIdOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetSubledgerIdOk() (string, bool)` + +GetSubledgerIdOk returns a tuple with the SubledgerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubledgerId + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasSubledgerId() bool` + +HasSubledgerId returns a boolean if a field has been set. + +### SetSubledgerId + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetSubledgerId(v string)` + +SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. + +### GetAmount + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetAmount() float32` + +GetAmount returns the Amount field if non-nil, zero value otherwise. + +### GetAmountOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetAmountOk() (float32, bool)` + +GetAmountOk returns a tuple with the Amount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAmount + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasAmount() bool` + +HasAmount returns a boolean if a field has been set. + +### SetAmount + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetAmount(v float32)` + +SetAmount gets a reference to the given float32 and assigns it to the Amount field. + +### GetId + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetRulesetId + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetRulesetId() int32` + +GetRulesetId returns the RulesetId field if non-nil, zero value otherwise. + +### GetRulesetIdOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetRulesetIdOk() (int32, bool)` + +GetRulesetIdOk returns a tuple with the RulesetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRulesetId + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasRulesetId() bool` + +HasRulesetId returns a boolean if a field has been set. + +### SetRulesetId + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetRulesetId(v int32)` + +SetRulesetId gets a reference to the given int32 and assigns it to the RulesetId field. + +### GetRuleName + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetRuleName() string` + +GetRuleName returns the RuleName field if non-nil, zero value otherwise. + +### GetRuleNameOk + +`func (o *LedgerTransactionLogEntryIntegrationApi) GetRuleNameOk() (string, bool)` + +GetRuleNameOk returns a tuple with the RuleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRuleName + +`func (o *LedgerTransactionLogEntryIntegrationApi) HasRuleName() bool` + +HasRuleName returns a boolean if a field has been set. + +### SetRuleName + +`func (o *LedgerTransactionLogEntryIntegrationApi) SetRuleName(v string)` + +SetRuleName gets a reference to the given string and assigns it to the RuleName field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LimitConfig.md b/docs/LimitConfig.md index 9c81e8aa..c6ca268c 100644 --- a/docs/LimitConfig.md +++ b/docs/LimitConfig.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Action** | Pointer to **string** | The limitable action to which this limit will be applied | -**Limit** | Pointer to **float32** | The value to set for the limit | -**Period** | Pointer to **string** | The period on which the budget limit recurs | [optional] -**Entities** | Pointer to **[]string** | The entities that make the address of this limit | +**Action** | Pointer to **string** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` | +**Limit** | Pointer to **float32** | The value to set for the limit. | +**Period** | Pointer to **string** | The period on which the budget limit recurs. | [optional] +**Entities** | Pointer to **[]string** | The entity that this limit applies to. | ## Methods diff --git a/docs/Loyalty.md b/docs/Loyalty.md index 809e6d8a..2379ab66 100644 --- a/docs/Loyalty.md +++ b/docs/Loyalty.md @@ -4,10 +4,36 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Programs** | Pointer to [**map[string]LoyaltyProgramLedgers**](LoyaltyProgramLedgers.md) | A map holding information about the loyalty programs balance | +**Cards** | Pointer to [**[]LoyaltyCard**](LoyaltyCard.md) | Displays information about the balances of the loyalty cards. | [optional] +**Programs** | Pointer to [**map[string]LoyaltyProgramLedgers**](LoyaltyProgramLedgers.md) | Displays information about point balances in profile-based programs. | ## Methods +### GetCards + +`func (o *Loyalty) GetCards() []LoyaltyCard` + +GetCards returns the Cards field if non-nil, zero value otherwise. + +### GetCardsOk + +`func (o *Loyalty) GetCardsOk() ([]LoyaltyCard, bool)` + +GetCardsOk returns a tuple with the Cards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCards + +`func (o *Loyalty) HasCards() bool` + +HasCards returns a boolean if a field has been set. + +### SetCards + +`func (o *Loyalty) SetCards(v []LoyaltyCard)` + +SetCards gets a reference to the given []LoyaltyCard and assigns it to the Cards field. + ### GetPrograms `func (o *Loyalty) GetPrograms() map[string]LoyaltyProgramLedgers` diff --git a/docs/LoyaltyBalance.md b/docs/LoyaltyBalance.md new file mode 100644 index 00000000..d3b4d5ea --- /dev/null +++ b/docs/LoyaltyBalance.md @@ -0,0 +1,117 @@ +# LoyaltyBalance + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ActivePoints** | Pointer to **float32** | Total amount of points awarded to this customer and available to spend. | [optional] +**PendingPoints** | Pointer to **float32** | Total amount of points awarded to this customer but not available until their start date. | [optional] +**SpentPoints** | Pointer to **float32** | Total amount of points already spent by this customer. | [optional] +**ExpiredPoints** | Pointer to **float32** | Total amount of points awarded but never redeemed. They cannot be used anymore. | [optional] + +## Methods + +### GetActivePoints + +`func (o *LoyaltyBalance) GetActivePoints() float32` + +GetActivePoints returns the ActivePoints field if non-nil, zero value otherwise. + +### GetActivePointsOk + +`func (o *LoyaltyBalance) GetActivePointsOk() (float32, bool)` + +GetActivePointsOk returns a tuple with the ActivePoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivePoints + +`func (o *LoyaltyBalance) HasActivePoints() bool` + +HasActivePoints returns a boolean if a field has been set. + +### SetActivePoints + +`func (o *LoyaltyBalance) SetActivePoints(v float32)` + +SetActivePoints gets a reference to the given float32 and assigns it to the ActivePoints field. + +### GetPendingPoints + +`func (o *LoyaltyBalance) GetPendingPoints() float32` + +GetPendingPoints returns the PendingPoints field if non-nil, zero value otherwise. + +### GetPendingPointsOk + +`func (o *LoyaltyBalance) GetPendingPointsOk() (float32, bool)` + +GetPendingPointsOk returns a tuple with the PendingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPendingPoints + +`func (o *LoyaltyBalance) HasPendingPoints() bool` + +HasPendingPoints returns a boolean if a field has been set. + +### SetPendingPoints + +`func (o *LoyaltyBalance) SetPendingPoints(v float32)` + +SetPendingPoints gets a reference to the given float32 and assigns it to the PendingPoints field. + +### GetSpentPoints + +`func (o *LoyaltyBalance) GetSpentPoints() float32` + +GetSpentPoints returns the SpentPoints field if non-nil, zero value otherwise. + +### GetSpentPointsOk + +`func (o *LoyaltyBalance) GetSpentPointsOk() (float32, bool)` + +GetSpentPointsOk returns a tuple with the SpentPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSpentPoints + +`func (o *LoyaltyBalance) HasSpentPoints() bool` + +HasSpentPoints returns a boolean if a field has been set. + +### SetSpentPoints + +`func (o *LoyaltyBalance) SetSpentPoints(v float32)` + +SetSpentPoints gets a reference to the given float32 and assigns it to the SpentPoints field. + +### GetExpiredPoints + +`func (o *LoyaltyBalance) GetExpiredPoints() float32` + +GetExpiredPoints returns the ExpiredPoints field if non-nil, zero value otherwise. + +### GetExpiredPointsOk + +`func (o *LoyaltyBalance) GetExpiredPointsOk() (float32, bool)` + +GetExpiredPointsOk returns a tuple with the ExpiredPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiredPoints + +`func (o *LoyaltyBalance) HasExpiredPoints() bool` + +HasExpiredPoints returns a boolean if a field has been set. + +### SetExpiredPoints + +`func (o *LoyaltyBalance) SetExpiredPoints(v float32)` + +SetExpiredPoints gets a reference to the given float32 and assigns it to the ExpiredPoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyBalances.md b/docs/LoyaltyBalances.md new file mode 100644 index 00000000..1adca3cd --- /dev/null +++ b/docs/LoyaltyBalances.md @@ -0,0 +1,65 @@ +# LoyaltyBalances + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Balance** | Pointer to [**LoyaltyBalance**](LoyaltyBalance.md) | | [optional] +**SubledgerBalances** | Pointer to [**map[string]LoyaltyBalance**](LoyaltyBalance.md) | Map of the loyalty balances of the subledgers of a ledger. | [optional] + +## Methods + +### GetBalance + +`func (o *LoyaltyBalances) GetBalance() LoyaltyBalance` + +GetBalance returns the Balance field if non-nil, zero value otherwise. + +### GetBalanceOk + +`func (o *LoyaltyBalances) GetBalanceOk() (LoyaltyBalance, bool)` + +GetBalanceOk returns a tuple with the Balance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBalance + +`func (o *LoyaltyBalances) HasBalance() bool` + +HasBalance returns a boolean if a field has been set. + +### SetBalance + +`func (o *LoyaltyBalances) SetBalance(v LoyaltyBalance)` + +SetBalance gets a reference to the given LoyaltyBalance and assigns it to the Balance field. + +### GetSubledgerBalances + +`func (o *LoyaltyBalances) GetSubledgerBalances() map[string]LoyaltyBalance` + +GetSubledgerBalances returns the SubledgerBalances field if non-nil, zero value otherwise. + +### GetSubledgerBalancesOk + +`func (o *LoyaltyBalances) GetSubledgerBalancesOk() (map[string]LoyaltyBalance, bool)` + +GetSubledgerBalancesOk returns a tuple with the SubledgerBalances field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubledgerBalances + +`func (o *LoyaltyBalances) HasSubledgerBalances() bool` + +HasSubledgerBalances returns a boolean if a field has been set. + +### SetSubledgerBalances + +`func (o *LoyaltyBalances) SetSubledgerBalances(v map[string]LoyaltyBalance)` + +SetSubledgerBalances gets a reference to the given map[string]LoyaltyBalance and assigns it to the SubledgerBalances field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyCard.md b/docs/LoyaltyCard.md new file mode 100644 index 00000000..e492ffd1 --- /dev/null +++ b/docs/LoyaltyCard.md @@ -0,0 +1,273 @@ +# LoyaltyCard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**ProgramID** | Pointer to **int32** | The ID of the loyalty program that owns this entity. | +**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'disabled'] | +**Identifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | +**UsersPerCardLimit** | Pointer to **int32** | The max amount of user profiles a card can be shared with. 0 means unlimited. | +**Profiles** | Pointer to [**[]LoyaltyCardProfileRegistration**](LoyaltyCardProfileRegistration.md) | Integration IDs of the customers associated with the card. | [optional] +**Ledger** | Pointer to [**LedgerInfo**](LedgerInfo.md) | | [optional] +**Subledgers** | Pointer to [**map[string]LedgerInfo**](LedgerInfo.md) | Displays point balances of the card in the subledgers of the loyalty program. | [optional] +**Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update of the loyalty card. | [optional] + +## Methods + +### GetId + +`func (o *LoyaltyCard) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoyaltyCard) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *LoyaltyCard) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *LoyaltyCard) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *LoyaltyCard) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoyaltyCard) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *LoyaltyCard) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *LoyaltyCard) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetProgramID + +`func (o *LoyaltyCard) GetProgramID() int32` + +GetProgramID returns the ProgramID field if non-nil, zero value otherwise. + +### GetProgramIDOk + +`func (o *LoyaltyCard) GetProgramIDOk() (int32, bool)` + +GetProgramIDOk returns a tuple with the ProgramID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramID + +`func (o *LoyaltyCard) HasProgramID() bool` + +HasProgramID returns a boolean if a field has been set. + +### SetProgramID + +`func (o *LoyaltyCard) SetProgramID(v int32)` + +SetProgramID gets a reference to the given int32 and assigns it to the ProgramID field. + +### GetStatus + +`func (o *LoyaltyCard) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *LoyaltyCard) GetStatusOk() (string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatus + +`func (o *LoyaltyCard) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatus + +`func (o *LoyaltyCard) SetStatus(v string)` + +SetStatus gets a reference to the given string and assigns it to the Status field. + +### GetIdentifier + +`func (o *LoyaltyCard) GetIdentifier() string` + +GetIdentifier returns the Identifier field if non-nil, zero value otherwise. + +### GetIdentifierOk + +`func (o *LoyaltyCard) GetIdentifierOk() (string, bool)` + +GetIdentifierOk returns a tuple with the Identifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIdentifier + +`func (o *LoyaltyCard) HasIdentifier() bool` + +HasIdentifier returns a boolean if a field has been set. + +### SetIdentifier + +`func (o *LoyaltyCard) SetIdentifier(v string)` + +SetIdentifier gets a reference to the given string and assigns it to the Identifier field. + +### GetUsersPerCardLimit + +`func (o *LoyaltyCard) GetUsersPerCardLimit() int32` + +GetUsersPerCardLimit returns the UsersPerCardLimit field if non-nil, zero value otherwise. + +### GetUsersPerCardLimitOk + +`func (o *LoyaltyCard) GetUsersPerCardLimitOk() (int32, bool)` + +GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsersPerCardLimit + +`func (o *LoyaltyCard) HasUsersPerCardLimit() bool` + +HasUsersPerCardLimit returns a boolean if a field has been set. + +### SetUsersPerCardLimit + +`func (o *LoyaltyCard) SetUsersPerCardLimit(v int32)` + +SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. + +### GetProfiles + +`func (o *LoyaltyCard) GetProfiles() []LoyaltyCardProfileRegistration` + +GetProfiles returns the Profiles field if non-nil, zero value otherwise. + +### GetProfilesOk + +`func (o *LoyaltyCard) GetProfilesOk() ([]LoyaltyCardProfileRegistration, bool)` + +GetProfilesOk returns a tuple with the Profiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfiles + +`func (o *LoyaltyCard) HasProfiles() bool` + +HasProfiles returns a boolean if a field has been set. + +### SetProfiles + +`func (o *LoyaltyCard) SetProfiles(v []LoyaltyCardProfileRegistration)` + +SetProfiles gets a reference to the given []LoyaltyCardProfileRegistration and assigns it to the Profiles field. + +### GetLedger + +`func (o *LoyaltyCard) GetLedger() LedgerInfo` + +GetLedger returns the Ledger field if non-nil, zero value otherwise. + +### GetLedgerOk + +`func (o *LoyaltyCard) GetLedgerOk() (LedgerInfo, bool)` + +GetLedgerOk returns a tuple with the Ledger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLedger + +`func (o *LoyaltyCard) HasLedger() bool` + +HasLedger returns a boolean if a field has been set. + +### SetLedger + +`func (o *LoyaltyCard) SetLedger(v LedgerInfo)` + +SetLedger gets a reference to the given LedgerInfo and assigns it to the Ledger field. + +### GetSubledgers + +`func (o *LoyaltyCard) GetSubledgers() map[string]LedgerInfo` + +GetSubledgers returns the Subledgers field if non-nil, zero value otherwise. + +### GetSubledgersOk + +`func (o *LoyaltyCard) GetSubledgersOk() (map[string]LedgerInfo, bool)` + +GetSubledgersOk returns a tuple with the Subledgers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubledgers + +`func (o *LoyaltyCard) HasSubledgers() bool` + +HasSubledgers returns a boolean if a field has been set. + +### SetSubledgers + +`func (o *LoyaltyCard) SetSubledgers(v map[string]LedgerInfo)` + +SetSubledgers gets a reference to the given map[string]LedgerInfo and assigns it to the Subledgers field. + +### GetModified + +`func (o *LoyaltyCard) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *LoyaltyCard) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *LoyaltyCard) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *LoyaltyCard) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyCardProfileRegistration.md b/docs/LoyaltyCardProfileRegistration.md new file mode 100644 index 00000000..a8b33cb0 --- /dev/null +++ b/docs/LoyaltyCardProfileRegistration.md @@ -0,0 +1,65 @@ +# LoyaltyCardProfileRegistration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IntegrationId** | Pointer to **string** | Integration ID of the customer associated with the card. | +**Timestamp** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the registration to the card. | + +## Methods + +### GetIntegrationId + +`func (o *LoyaltyCardProfileRegistration) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *LoyaltyCardProfileRegistration) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *LoyaltyCardProfileRegistration) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *LoyaltyCardProfileRegistration) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + +### GetTimestamp + +`func (o *LoyaltyCardProfileRegistration) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *LoyaltyCardProfileRegistration) GetTimestampOk() (time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTimestamp + +`func (o *LoyaltyCardProfileRegistration) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### SetTimestamp + +`func (o *LoyaltyCardProfileRegistration) SetTimestamp(v time.Time)` + +SetTimestamp gets a reference to the given time.Time and assigns it to the Timestamp field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyCardRegistration.md b/docs/LoyaltyCardRegistration.md new file mode 100644 index 00000000..64ce09a1 --- /dev/null +++ b/docs/LoyaltyCardRegistration.md @@ -0,0 +1,39 @@ +# LoyaltyCardRegistration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IntegrationId** | Pointer to **string** | The integrationId of the customer profile. | + +## Methods + +### GetIntegrationId + +`func (o *LoyaltyCardRegistration) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *LoyaltyCardRegistration) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *LoyaltyCardRegistration) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *LoyaltyCardRegistration) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyLedgerEntry.md b/docs/LoyaltyLedgerEntry.md index baee7f8f..30a8f0a3 100644 --- a/docs/LoyaltyLedgerEntry.md +++ b/docs/LoyaltyLedgerEntry.md @@ -6,7 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Created** | Pointer to [**time.Time**](time.Time.md) | | **ProgramID** | Pointer to **int32** | | -**CustomerProfileID** | Pointer to **string** | | +**CustomerProfileID** | Pointer to **string** | | [optional] +**CardID** | Pointer to **int32** | | [optional] **CustomerSessionID** | Pointer to **string** | | [optional] **EventID** | Pointer to **int32** | | [optional] **Type** | Pointer to **string** | The type of the ledger transaction. Possible values are addition, subtraction, expire or expiring (for expiring points ledgers) | @@ -14,7 +15,7 @@ Name | Type | Description | Notes **StartDate** | Pointer to [**time.Time**](time.Time.md) | | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | | [optional] **Name** | Pointer to **string** | A name referencing the condition or effect that added this entry, or the specific name provided in an API call. | -**SubLedgerID** | Pointer to **string** | This specifies if we are adding loyalty points to the main ledger or a subledger | +**SubLedgerID** | Pointer to **string** | This specifies if we are adding loyalty points to the main ledger or a subledger. | **UserID** | Pointer to **int32** | This is the ID of the user who created this entry, if the addition or subtraction was done manually. | [optional] ## Methods @@ -94,6 +95,31 @@ HasCustomerProfileID returns a boolean if a field has been set. SetCustomerProfileID gets a reference to the given string and assigns it to the CustomerProfileID field. +### GetCardID + +`func (o *LoyaltyLedgerEntry) GetCardID() int32` + +GetCardID returns the CardID field if non-nil, zero value otherwise. + +### GetCardIDOk + +`func (o *LoyaltyLedgerEntry) GetCardIDOk() (int32, bool)` + +GetCardIDOk returns a tuple with the CardID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardID + +`func (o *LoyaltyLedgerEntry) HasCardID() bool` + +HasCardID returns a boolean if a field has been set. + +### SetCardID + +`func (o *LoyaltyLedgerEntry) SetCardID(v int32)` + +SetCardID gets a reference to the given int32 and assigns it to the CardID field. + ### GetCustomerSessionID `func (o *LoyaltyLedgerEntry) GetCustomerSessionID() string` diff --git a/docs/LoyaltyLedgerTransactions.md b/docs/LoyaltyLedgerTransactions.md new file mode 100644 index 00000000..a370aa95 --- /dev/null +++ b/docs/LoyaltyLedgerTransactions.md @@ -0,0 +1,65 @@ +# LoyaltyLedgerTransactions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasMore** | Pointer to **bool** | true means there is more data in the source collection to request. | [optional] +**Data** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | List of transaction entries from a loyalty ledger. | [optional] + +## Methods + +### GetHasMore + +`func (o *LoyaltyLedgerTransactions) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *LoyaltyLedgerTransactions) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *LoyaltyLedgerTransactions) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *LoyaltyLedgerTransactions) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + +### GetData + +`func (o *LoyaltyLedgerTransactions) GetData() []LoyaltyLedgerEntry` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *LoyaltyLedgerTransactions) GetDataOk() ([]LoyaltyLedgerEntry, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *LoyaltyLedgerTransactions) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *LoyaltyLedgerTransactions) SetData(v []LoyaltyLedgerEntry)` + +SetData gets a reference to the given []LoyaltyLedgerEntry and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyPoints.md b/docs/LoyaltyPoints.md index ca4b9c6b..3d93a6cc 100644 --- a/docs/LoyaltyPoints.md +++ b/docs/LoyaltyPoints.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Points** | Pointer to **float32** | Amount of loyalty points | -**Name** | Pointer to **string** | Allows to specify a name for the addition or deduction | [optional] +**Points** | Pointer to **float32** | Amount of loyalty points. | +**Name** | Pointer to **string** | Allows to specify a name/reason for the point addition or deduction. | [optional] **ValidityDuration** | Pointer to **string** | Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). | [optional] **PendingDuration** | Pointer to **string** | Indicates the amount of time before the points are considered valid. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). | [optional] -**SubLedgerID** | Pointer to **string** | This specifies if we are adding loyalty points to the main ledger or a subledger | [optional] +**SubLedgerID** | Pointer to **string** | This specifies if we are adding loyalty points to the main ledger or a subledger. | [optional] ## Methods diff --git a/docs/LoyaltyProgram.md b/docs/LoyaltyProgram.md index 71ca1405..ec9fd5e1 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -4,18 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | The ID of loyalty program. Unique ID for this entity. | +**Id** | Pointer to **int32** | The ID of loyalty program. Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Title** | Pointer to **string** | The display title for the Loyalty Program. | **Description** | Pointer to **string** | Description of our Loyalty Program. | **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | **DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | **DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | -**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | -**Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | [optional] +**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | +**UsersPerCardLimit** | Pointer to **int32** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] **AccountID** | Pointer to **int32** | The ID of the Talon.One account that owns this program. | **Name** | Pointer to **string** | The internal name for the Loyalty Program. This is an immutable value. | -**Tiers** | Pointer to [**[]LoyaltyTier**](LoyaltyTier.md) | The tiers in this loyalty program | [optional] +**Tiers** | Pointer to [**[]LoyaltyTier**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] +**Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | +**CardBased** | Pointer to **bool** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false] ## Methods @@ -219,30 +221,30 @@ HasAllowSubledger returns a boolean if a field has been set. SetAllowSubledger gets a reference to the given bool and assigns it to the AllowSubledger field. -### GetTimezone +### GetUsersPerCardLimit -`func (o *LoyaltyProgram) GetTimezone() string` +`func (o *LoyaltyProgram) GetUsersPerCardLimit() int32` -GetTimezone returns the Timezone field if non-nil, zero value otherwise. +GetUsersPerCardLimit returns the UsersPerCardLimit field if non-nil, zero value otherwise. -### GetTimezoneOk +### GetUsersPerCardLimitOk -`func (o *LoyaltyProgram) GetTimezoneOk() (string, bool)` +`func (o *LoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool)` -GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTimezone +### HasUsersPerCardLimit -`func (o *LoyaltyProgram) HasTimezone() bool` +`func (o *LoyaltyProgram) HasUsersPerCardLimit() bool` -HasTimezone returns a boolean if a field has been set. +HasUsersPerCardLimit returns a boolean if a field has been set. -### SetTimezone +### SetUsersPerCardLimit -`func (o *LoyaltyProgram) SetTimezone(v string)` +`func (o *LoyaltyProgram) SetUsersPerCardLimit(v int32)` -SetTimezone gets a reference to the given string and assigns it to the Timezone field. +SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. ### GetAccountID @@ -319,6 +321,56 @@ HasTiers returns a boolean if a field has been set. SetTiers gets a reference to the given []LoyaltyTier and assigns it to the Tiers field. +### GetTimezone + +`func (o *LoyaltyProgram) GetTimezone() string` + +GetTimezone returns the Timezone field if non-nil, zero value otherwise. + +### GetTimezoneOk + +`func (o *LoyaltyProgram) GetTimezoneOk() (string, bool)` + +GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTimezone + +`func (o *LoyaltyProgram) HasTimezone() bool` + +HasTimezone returns a boolean if a field has been set. + +### SetTimezone + +`func (o *LoyaltyProgram) SetTimezone(v string)` + +SetTimezone gets a reference to the given string and assigns it to the Timezone field. + +### GetCardBased + +`func (o *LoyaltyProgram) GetCardBased() bool` + +GetCardBased returns the CardBased field if non-nil, zero value otherwise. + +### GetCardBasedOk + +`func (o *LoyaltyProgram) GetCardBasedOk() (bool, bool)` + +GetCardBasedOk returns a tuple with the CardBased field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardBased + +`func (o *LoyaltyProgram) HasCardBased() bool` + +HasCardBased returns a boolean if a field has been set. + +### SetCardBased + +`func (o *LoyaltyProgram) SetCardBased(v bool)` + +SetCardBased gets a reference to the given bool and assigns it to the CardBased field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LoyaltyProgramBalance.md b/docs/LoyaltyProgramBalance.md index 7bc1f9b3..7596e2ea 100644 --- a/docs/LoyaltyProgramBalance.md +++ b/docs/LoyaltyProgramBalance.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CurrentBalance** | Pointer to **float32** | Sum of current active points amounts | -**PendingBalance** | Pointer to **float32** | Sum of pending points amounts | -**ExpiredBalance** | Pointer to **float32** | Sum of expired points amounts | -**SpentBalance** | Pointer to **float32** | Sum of spent points amounts | -**TentativeCurrentBalance** | Pointer to **float32** | Sum of current active points amounts, including additions and deductions on open sessions | +**CurrentBalance** | Pointer to **float32** | Sum of currently active points. | +**PendingBalance** | Pointer to **float32** | Sum of pending points. | +**ExpiredBalance** | Pointer to **float32** | Sum of expired points. | +**SpentBalance** | Pointer to **float32** | Sum of spent points. | +**TentativeCurrentBalance** | Pointer to **float32** | Sum of currently active points, including points added and deducted in open sessions. | ## Methods diff --git a/docs/LoyaltyProgramLedgers.md b/docs/LoyaltyProgramLedgers.md index 0b9a3b91..cf9f8da9 100644 --- a/docs/LoyaltyProgramLedgers.md +++ b/docs/LoyaltyProgramLedgers.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | The internal ID of loyalty program | -**Title** | Pointer to **string** | Visible name of loyalty program | -**Name** | Pointer to **string** | Internal name of loyalty program | +**Id** | Pointer to **int32** | The internal ID of loyalty program. | +**Title** | Pointer to **string** | Visible name of loyalty program. | +**Name** | Pointer to **string** | Internal name of loyalty program. | **Ledger** | Pointer to [**LedgerInfo**](LedgerInfo.md) | | -**SubLedgers** | Pointer to [**map[string]LedgerInfo**](LedgerInfo.md) | A map containing information about each loyalty subledger | [optional] +**SubLedgers** | Pointer to [**map[string]LedgerInfo**](LedgerInfo.md) | A map containing information about each loyalty subledger. | [optional] ## Methods diff --git a/docs/LoyaltyProjection.md b/docs/LoyaltyProjection.md new file mode 100644 index 00000000..517ccc69 --- /dev/null +++ b/docs/LoyaltyProjection.md @@ -0,0 +1,91 @@ +# LoyaltyProjection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Projections** | Pointer to [**[]LoyaltyProjectionData**](LoyaltyProjectionData.md) | | [optional] +**TotalExpiringPoints** | Pointer to **float32** | Sum of points to be expired by the projection date set in the query parameter. | +**TotalActivatingPoints** | Pointer to **float32** | Sum of points to be active by the projection date set in the query parameter. | + +## Methods + +### GetProjections + +`func (o *LoyaltyProjection) GetProjections() []LoyaltyProjectionData` + +GetProjections returns the Projections field if non-nil, zero value otherwise. + +### GetProjectionsOk + +`func (o *LoyaltyProjection) GetProjectionsOk() ([]LoyaltyProjectionData, bool)` + +GetProjectionsOk returns a tuple with the Projections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProjections + +`func (o *LoyaltyProjection) HasProjections() bool` + +HasProjections returns a boolean if a field has been set. + +### SetProjections + +`func (o *LoyaltyProjection) SetProjections(v []LoyaltyProjectionData)` + +SetProjections gets a reference to the given []LoyaltyProjectionData and assigns it to the Projections field. + +### GetTotalExpiringPoints + +`func (o *LoyaltyProjection) GetTotalExpiringPoints() float32` + +GetTotalExpiringPoints returns the TotalExpiringPoints field if non-nil, zero value otherwise. + +### GetTotalExpiringPointsOk + +`func (o *LoyaltyProjection) GetTotalExpiringPointsOk() (float32, bool)` + +GetTotalExpiringPointsOk returns a tuple with the TotalExpiringPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalExpiringPoints + +`func (o *LoyaltyProjection) HasTotalExpiringPoints() bool` + +HasTotalExpiringPoints returns a boolean if a field has been set. + +### SetTotalExpiringPoints + +`func (o *LoyaltyProjection) SetTotalExpiringPoints(v float32)` + +SetTotalExpiringPoints gets a reference to the given float32 and assigns it to the TotalExpiringPoints field. + +### GetTotalActivatingPoints + +`func (o *LoyaltyProjection) GetTotalActivatingPoints() float32` + +GetTotalActivatingPoints returns the TotalActivatingPoints field if non-nil, zero value otherwise. + +### GetTotalActivatingPointsOk + +`func (o *LoyaltyProjection) GetTotalActivatingPointsOk() (float32, bool)` + +GetTotalActivatingPointsOk returns a tuple with the TotalActivatingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalActivatingPoints + +`func (o *LoyaltyProjection) HasTotalActivatingPoints() bool` + +HasTotalActivatingPoints returns a boolean if a field has been set. + +### SetTotalActivatingPoints + +`func (o *LoyaltyProjection) SetTotalActivatingPoints(v float32)` + +SetTotalActivatingPoints gets a reference to the given float32 and assigns it to the TotalActivatingPoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyProjectionData.md b/docs/LoyaltyProjectionData.md new file mode 100644 index 00000000..deed9075 --- /dev/null +++ b/docs/LoyaltyProjectionData.md @@ -0,0 +1,117 @@ +# LoyaltyProjectionData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to [**time.Time**](time.Time.md) | Specific date of projection. | +**ExpiringPoints** | Pointer to **float32** | Points that will be expired by the specified date. | +**ActivatingPoints** | Pointer to **float32** | Points that will be active by the specified date. | +**ProjectedBalance** | Pointer to **float32** | Current balance plus projected active points, minus expiring points. | + +## Methods + +### GetDate + +`func (o *LoyaltyProjectionData) GetDate() time.Time` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *LoyaltyProjectionData) GetDateOk() (time.Time, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDate + +`func (o *LoyaltyProjectionData) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDate + +`func (o *LoyaltyProjectionData) SetDate(v time.Time)` + +SetDate gets a reference to the given time.Time and assigns it to the Date field. + +### GetExpiringPoints + +`func (o *LoyaltyProjectionData) GetExpiringPoints() float32` + +GetExpiringPoints returns the ExpiringPoints field if non-nil, zero value otherwise. + +### GetExpiringPointsOk + +`func (o *LoyaltyProjectionData) GetExpiringPointsOk() (float32, bool)` + +GetExpiringPointsOk returns a tuple with the ExpiringPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiringPoints + +`func (o *LoyaltyProjectionData) HasExpiringPoints() bool` + +HasExpiringPoints returns a boolean if a field has been set. + +### SetExpiringPoints + +`func (o *LoyaltyProjectionData) SetExpiringPoints(v float32)` + +SetExpiringPoints gets a reference to the given float32 and assigns it to the ExpiringPoints field. + +### GetActivatingPoints + +`func (o *LoyaltyProjectionData) GetActivatingPoints() float32` + +GetActivatingPoints returns the ActivatingPoints field if non-nil, zero value otherwise. + +### GetActivatingPointsOk + +`func (o *LoyaltyProjectionData) GetActivatingPointsOk() (float32, bool)` + +GetActivatingPointsOk returns a tuple with the ActivatingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivatingPoints + +`func (o *LoyaltyProjectionData) HasActivatingPoints() bool` + +HasActivatingPoints returns a boolean if a field has been set. + +### SetActivatingPoints + +`func (o *LoyaltyProjectionData) SetActivatingPoints(v float32)` + +SetActivatingPoints gets a reference to the given float32 and assigns it to the ActivatingPoints field. + +### GetProjectedBalance + +`func (o *LoyaltyProjectionData) GetProjectedBalance() float32` + +GetProjectedBalance returns the ProjectedBalance field if non-nil, zero value otherwise. + +### GetProjectedBalanceOk + +`func (o *LoyaltyProjectionData) GetProjectedBalanceOk() (float32, bool)` + +GetProjectedBalanceOk returns a tuple with the ProjectedBalance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProjectedBalance + +`func (o *LoyaltyProjectionData) HasProjectedBalance() bool` + +HasProjectedBalance returns a boolean if a field has been set. + +### SetProjectedBalance + +`func (o *LoyaltyProjectionData) SetProjectedBalance(v float32)` + +SetProjectedBalance gets a reference to the given float32 and assigns it to the ProjectedBalance field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltySubLedger.md b/docs/LoyaltySubLedger.md index 7aeeeb50..35933459 100644 --- a/docs/LoyaltySubLedger.md +++ b/docs/LoyaltySubLedger.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance. | +**Total** | Pointer to **float32** | **DEPRECATED** Use `totalActivePoints` property instead. Total amount of currently active and available points in the customer's balance. | **TotalActivePoints** | Pointer to **float32** | Total amount of currently active and available points in the customer's balance. | **TotalPendingPoints** | Pointer to **float32** | Total amount of pending points, which are not active yet but will become active in the future. | **TotalSpentPoints** | Pointer to **float32** | Total amount of points already spent by this customer. | diff --git a/docs/LoyaltyTier.md b/docs/LoyaltyTier.md index fb576ca3..e57ba9a3 100644 --- a/docs/LoyaltyTier.md +++ b/docs/LoyaltyTier.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ProgramID** | Pointer to **int32** | The ID of the loyalty program that owns this entity. | **Name** | Pointer to **string** | The name of the tier | -**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier | +**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier. | ## Methods diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index afdf53cd..6d77e07b 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -1,38 +1,47 @@ # \ManagementApi -All URIs are relative to *http://localhost* +All URIs are relative to *https://yourbaseurl.talon.one* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AddLoyaltyPoints**](ManagementApi.md#AddLoyaltyPoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in loyalty program for given customer -[**CopyCampaignToApplications**](ManagementApi.md#CopyCampaignToApplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application -[**CreateAdditionalCost**](ManagementApi.md#CreateAdditionalCost) | **Post** /v1/additional_costs | Define a new additional cost +[**AddLoyaltyPoints**](ManagementApi.md#AddLoyaltyPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points in loyalty program for given customer +[**CopyCampaignToApplications**](ManagementApi.md#CopyCampaignToApplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified application +[**CreateAccountCollection**](ManagementApi.md#CreateAccountCollection) | **Post** /v1/collections | Create account-level collection +[**CreateAdditionalCost**](ManagementApi.md#CreateAdditionalCost) | **Post** /v1/additional_costs | Create additional cost [**CreateAttribute**](ManagementApi.md#CreateAttribute) | **Post** /v1/attributes | Create custom attribute -[**CreateCampaign**](ManagementApi.md#CreateCampaign) | **Post** /v1/applications/{applicationId}/campaigns | Create campaign +[**CreateCampaignFromTemplate**](ManagementApi.md#CreateCampaignFromTemplate) | **Post** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template +[**CreateCollection**](ManagementApi.md#CreateCollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create collection [**CreateCoupons**](ManagementApi.md#CreateCoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons +[**CreateCouponsAsync**](ManagementApi.md#CreateCouponsAsync) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously [**CreateCouponsForMultipleRecipients**](ManagementApi.md#CreateCouponsForMultipleRecipients) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients +[**CreateNotificationWebhook**](ManagementApi.md#CreateNotificationWebhook) | **Post** /v1/applications/{applicationId}/notification_webhooks | Create notification webhook [**CreatePasswordRecoveryEmail**](ManagementApi.md#CreatePasswordRecoveryEmail) | **Post** /v1/password_recovery_emails | Request a password reset -[**CreateRuleset**](ManagementApi.md#CreateRuleset) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create ruleset [**CreateSession**](ManagementApi.md#CreateSession) | **Post** /v1/sessions | Create session +[**DeleteAccountCollection**](ManagementApi.md#DeleteAccountCollection) | **Delete** /v1/collections/{collectionId} | Delete account-level collection [**DeleteCampaign**](ManagementApi.md#DeleteCampaign) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign +[**DeleteCollection**](ManagementApi.md#DeleteCollection) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete collection [**DeleteCoupon**](ManagementApi.md#DeleteCoupon) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon [**DeleteCoupons**](ManagementApi.md#DeleteCoupons) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons +[**DeleteNotificationWebhook**](ManagementApi.md#DeleteNotificationWebhook) | **Delete** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification webhook [**DeleteReferral**](ManagementApi.md#DeleteReferral) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral [**DestroySession**](ManagementApi.md#DestroySession) | **Delete** /v1/sessions | Destroy session -[**ExportCoupons**](ManagementApi.md#ExportCoupons) | **Get** /v1/applications/{applicationId}/export_coupons | Export coupons to CSV file -[**ExportCustomerSessions**](ManagementApi.md#ExportCustomerSessions) | **Get** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions to CSV file -[**ExportEffects**](ManagementApi.md#ExportEffects) | **Get** /v1/applications/{applicationId}/export_effects | Export triggered effects to CSV file -[**ExportLoyaltyBalance**](ManagementApi.md#ExportLoyaltyBalance) | **Get** /v1/loyalty_programs/{programID}/export_customer_balance | Export customer loyalty balance to a CSV file -[**ExportLoyaltyLedger**](ManagementApi.md#ExportLoyaltyLedger) | **Get** /v1/loyalty_programs/{programID}/profile/{integrationID}/export_log | Export a customer's loyalty ledger log to CSV file -[**ExportReferrals**](ManagementApi.md#ExportReferrals) | **Get** /v1/applications/{applicationId}/export_referrals | Export referrals to CSV file +[**ExportAccountCollectionItems**](ManagementApi.md#ExportAccountCollectionItems) | **Get** /v1/collections/{collectionId}/export | Export account-level collection's items +[**ExportCollectionItems**](ManagementApi.md#ExportCollectionItems) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export a collection's items +[**ExportCoupons**](ManagementApi.md#ExportCoupons) | **Get** /v1/applications/{applicationId}/export_coupons | Export coupons +[**ExportCustomerSessions**](ManagementApi.md#ExportCustomerSessions) | **Get** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions +[**ExportEffects**](ManagementApi.md#ExportEffects) | **Get** /v1/applications/{applicationId}/export_effects | Export triggered effects +[**ExportLoyaltyBalance**](ManagementApi.md#ExportLoyaltyBalance) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to a CSV file +[**ExportLoyaltyLedger**](ManagementApi.md#ExportLoyaltyLedger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export a customer's loyalty ledger log +[**ExportReferrals**](ManagementApi.md#ExportReferrals) | **Get** /v1/applications/{applicationId}/export_referrals | Export referrals [**GetAccessLogsWithoutTotalCount**](ManagementApi.md#GetAccessLogsWithoutTotalCount) | **Get** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for Application [**GetAccount**](ManagementApi.md#GetAccount) | **Get** /v1/accounts/{accountId} | Get account details [**GetAccountAnalytics**](ManagementApi.md#GetAccountAnalytics) | **Get** /v1/accounts/{accountId}/analytics | Get account analytics -[**GetAdditionalCost**](ManagementApi.md#GetAdditionalCost) | **Get** /v1/additional_costs/{additionalCostId} | Get an additional cost +[**GetAccountCollection**](ManagementApi.md#GetAccountCollection) | **Get** /v1/collections/{collectionId} | Get account-level collection +[**GetAdditionalCost**](ManagementApi.md#GetAdditionalCost) | **Get** /v1/additional_costs/{additionalCostId} | Get additional cost [**GetAdditionalCosts**](ManagementApi.md#GetAdditionalCosts) | **Get** /v1/additional_costs | List additional costs [**GetAllAccessLogs**](ManagementApi.md#GetAllAccessLogs) | **Get** /v1/access_logs | List access logs [**GetAllRoles**](ManagementApi.md#GetAllRoles) | **Get** /v1/roles | List roles -[**GetApplication**](ManagementApi.md#GetApplication) | **Get** /v1/applications/{applicationId} | Get Application +[**GetApplication**](ManagementApi.md#GetApplication) | **Get** /v1/applications/{applicationId} | Get application [**GetApplicationApiHealth**](ManagementApi.md#GetApplicationApiHealth) | **Get** /v1/applications/{applicationId}/health_report | Get report of health of application API [**GetApplicationCustomer**](ManagementApi.md#GetApplicationCustomer) | **Get** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer [**GetApplicationCustomerFriends**](ManagementApi.md#GetApplicationCustomerFriends) | **Get** /v1/applications/{applicationId}/profile/{integrationId}/friends | List friends referred by customer profile @@ -42,16 +51,17 @@ Method | HTTP request | Description [**GetApplicationEventsWithoutTotalCount**](ManagementApi.md#GetApplicationEventsWithoutTotalCount) | **Get** /v1/applications/{applicationId}/events/no_total | List Applications events [**GetApplicationSession**](ManagementApi.md#GetApplicationSession) | **Get** /v1/applications/{applicationId}/sessions/{sessionId} | Get Application session [**GetApplicationSessions**](ManagementApi.md#GetApplicationSessions) | **Get** /v1/applications/{applicationId}/sessions | List Application sessions -[**GetApplications**](ManagementApi.md#GetApplications) | **Get** /v1/applications | List Applications -[**GetAttribute**](ManagementApi.md#GetAttribute) | **Get** /v1/attributes/{attributeId} | Get a custom attribute +[**GetApplications**](ManagementApi.md#GetApplications) | **Get** /v1/applications | List applications +[**GetAttribute**](ManagementApi.md#GetAttribute) | **Get** /v1/attributes/{attributeId} | Get custom attribute [**GetAttributes**](ManagementApi.md#GetAttributes) | **Get** /v1/attributes | List custom attributes [**GetAudiences**](ManagementApi.md#GetAudiences) | **Get** /v1/audiences | List audiences [**GetCampaign**](ManagementApi.md#GetCampaign) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId} | Get campaign [**GetCampaignAnalytics**](ManagementApi.md#GetCampaignAnalytics) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns [**GetCampaignByAttributes**](ManagementApi.md#GetCampaignByAttributes) | **Post** /v1/applications/{applicationId}/campaigns_search | List campaigns that match the given attributes [**GetCampaigns**](ManagementApi.md#GetCampaigns) | **Get** /v1/applications/{applicationId}/campaigns | List campaigns -[**GetChanges**](ManagementApi.md#GetChanges) | **Get** /v1/changes | Get audit log for an account -[**GetCouponsByAttributes**](ManagementApi.md#GetCouponsByAttributes) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search | List coupons that match the given attributes +[**GetChanges**](ManagementApi.md#GetChanges) | **Get** /v1/changes | Get audit logs for an account +[**GetCollection**](ManagementApi.md#GetCollection) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get collection +[**GetCollectionItems**](ManagementApi.md#GetCollectionItems) | **Get** /v1/collections/{collectionId}/items | Get collection items [**GetCouponsWithoutTotalCount**](ManagementApi.md#GetCouponsWithoutTotalCount) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons [**GetCustomerActivityReport**](ManagementApi.md#GetCustomerActivityReport) | **Get** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report [**GetCustomerActivityReportsWithoutTotalCount**](ManagementApi.md#GetCustomerActivityReportsWithoutTotalCount) | **Get** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers @@ -59,44 +69,53 @@ Method | HTTP request | Description [**GetCustomerProfile**](ManagementApi.md#GetCustomerProfile) | **Get** /v1/customers/{customerId} | Get customer profile [**GetCustomerProfiles**](ManagementApi.md#GetCustomerProfiles) | **Get** /v1/customers/no_total | List customer profiles [**GetCustomersByAttributes**](ManagementApi.md#GetCustomersByAttributes) | **Post** /v1/customer_search/no_total | List customer profiles matching the given attributes -[**GetEventTypes**](ManagementApi.md#GetEventTypes) | **Get** /v1/event_types | List Event Types -[**GetExports**](ManagementApi.md#GetExports) | **Get** /v1/exports | Get Exports -[**GetLoyaltyPoints**](ManagementApi.md#GetLoyaltyPoints) | **Get** /v1/loyalty_programs/{programID}/profile/{integrationID} | Get the Loyalty Ledger for this integrationID -[**GetLoyaltyProgram**](ManagementApi.md#GetLoyaltyProgram) | **Get** /v1/loyalty_programs/{programID} | Get loyalty program +[**GetEventTypes**](ManagementApi.md#GetEventTypes) | **Get** /v1/event_types | List event types +[**GetExports**](ManagementApi.md#GetExports) | **Get** /v1/exports | Get exports +[**GetLoyaltyPoints**](ManagementApi.md#GetLoyaltyPoints) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get the Loyalty Ledger for this integrationID +[**GetLoyaltyProgram**](ManagementApi.md#GetLoyaltyProgram) | **Get** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program [**GetLoyaltyPrograms**](ManagementApi.md#GetLoyaltyPrograms) | **Get** /v1/loyalty_programs | List loyalty programs -[**GetLoyaltyStatistics**](ManagementApi.md#GetLoyaltyStatistics) | **Get** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID +[**GetLoyaltyStatistics**](ManagementApi.md#GetLoyaltyStatistics) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics by loyalty program ID +[**GetNotificationWebhook**](ManagementApi.md#GetNotificationWebhook) | **Get** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Get notification webhook +[**GetNotificationWebhooks**](ManagementApi.md#GetNotificationWebhooks) | **Get** /v1/applications/{applicationId}/notification_webhooks | List notification webhooks [**GetReferralsWithoutTotalCount**](ManagementApi.md#GetReferralsWithoutTotalCount) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals [**GetRole**](ManagementApi.md#GetRole) | **Get** /v1/roles/{roleId} | Get role [**GetRuleset**](ManagementApi.md#GetRuleset) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset [**GetRulesets**](ManagementApi.md#GetRulesets) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets -[**GetUser**](ManagementApi.md#GetUser) | **Get** /v1/users/{userId} | Get a single user +[**GetUser**](ManagementApi.md#GetUser) | **Get** /v1/users/{userId} | Get user [**GetUsers**](ManagementApi.md#GetUsers) | **Get** /v1/users | List users in account -[**GetWebhook**](ManagementApi.md#GetWebhook) | **Get** /v1/webhooks/{webhookId} | Get Webhook +[**GetWebhook**](ManagementApi.md#GetWebhook) | **Get** /v1/webhooks/{webhookId} | Get webhook [**GetWebhookActivationLogs**](ManagementApi.md#GetWebhookActivationLogs) | **Get** /v1/webhook_activation_logs | List webhook activation log entries [**GetWebhookLogs**](ManagementApi.md#GetWebhookLogs) | **Get** /v1/webhook_logs | List webhook log entries [**GetWebhooks**](ManagementApi.md#GetWebhooks) | **Get** /v1/webhooks | List webhooks -[**ImportCollection**](ManagementApi.md#ImportCollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import collection via CSV file -[**ImportCoupons**](ManagementApi.md#ImportCoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file -[**ImportLoyaltyPoints**](ManagementApi.md#ImportLoyaltyPoints) | **Post** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file +[**ImportAccountCollection**](ManagementApi.md#ImportAccountCollection) | **Post** /v1/collections/{collectionId}/import | Import data in existing account-level collection +[**ImportAllowedList**](ManagementApi.md#ImportAllowedList) | **Post** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute +[**ImportCollection**](ManagementApi.md#ImportCollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data in existing collection +[**ImportCoupons**](ManagementApi.md#ImportCoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons +[**ImportLoyaltyPoints**](ManagementApi.md#ImportLoyaltyPoints) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points [**ImportPoolGiveaways**](ManagementApi.md#ImportPoolGiveaways) | **Post** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool -[**ImportReferrals**](ManagementApi.md#ImportReferrals) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file -[**RemoveLoyaltyPoints**](ManagementApi.md#RemoveLoyaltyPoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in loyalty program for given customer +[**ImportReferrals**](ManagementApi.md#ImportReferrals) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals +[**ListAccountCollections**](ManagementApi.md#ListAccountCollections) | **Get** /v1/collections | List collections in account +[**ListCollections**](ManagementApi.md#ListCollections) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections +[**ListCollectionsInApplication**](ManagementApi.md#ListCollectionsInApplication) | **Get** /v1/applications/{applicationId}/collections | List collections in application +[**RemoveLoyaltyPoints**](ManagementApi.md#RemoveLoyaltyPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points in loyalty program for given customer [**ResetPassword**](ManagementApi.md#ResetPassword) | **Post** /v1/reset_password | Reset password -[**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](ManagementApi.md#SearchCouponsAdvancedApplicationWideWithoutTotalCount) | **Post** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes in all active campaigns of an application -[**SearchCouponsAdvancedWithoutTotalCount**](ManagementApi.md#SearchCouponsAdvancedWithoutTotalCount) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes -[**UpdateAdditionalCost**](ManagementApi.md#UpdateAdditionalCost) | **Put** /v1/additional_costs/{additionalCostId} | Update an additional cost -[**UpdateAttribute**](ManagementApi.md#UpdateAttribute) | **Put** /v1/attributes/{attributeId} | Update a custom attribute +[**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](ManagementApi.md#SearchCouponsAdvancedApplicationWideWithoutTotalCount) | **Post** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count) +[**SearchCouponsAdvancedWithoutTotalCount**](ManagementApi.md#SearchCouponsAdvancedWithoutTotalCount) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count) +[**UpdateAccountCollection**](ManagementApi.md#UpdateAccountCollection) | **Put** /v1/collections/{collectionId} | Update account-level collection +[**UpdateAdditionalCost**](ManagementApi.md#UpdateAdditionalCost) | **Put** /v1/additional_costs/{additionalCostId} | Update additional cost +[**UpdateAttribute**](ManagementApi.md#UpdateAttribute) | **Put** /v1/attributes/{attributeId} | Update custom attribute [**UpdateCampaign**](ManagementApi.md#UpdateCampaign) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign +[**UpdateCollection**](ManagementApi.md#UpdateCollection) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update collection description [**UpdateCoupon**](ManagementApi.md#UpdateCoupon) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon -[**UpdateCouponBatch**](ManagementApi.md#UpdateCouponBatch) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a batch of coupons +[**UpdateCouponBatch**](ManagementApi.md#UpdateCouponBatch) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons +[**UpdateNotificationWebhook**](ManagementApi.md#UpdateNotificationWebhook) | **Put** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification webhook [**UpdateReferral**](ManagementApi.md#UpdateReferral) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral -[**UpdateRuleset**](ManagementApi.md#UpdateRuleset) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update ruleset ## AddLoyaltyPoints -> AddLoyaltyPoints(ctx, programID, integrationID).Body(body).Execute() +> AddLoyaltyPoints(ctx, loyaltyProgramId, integrationId).Body(body).Execute() Add points in loyalty program for given customer @@ -108,8 +127,8 @@ Add points in loyalty program for given customer Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **string** | | -**integrationID** | **string** | | +**loyaltyProgramId** | **string** | The identifier for the loyalty program. | +**integrationId** | **string** | The identifier of the profile. | ### Other Parameters @@ -133,7 +152,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -144,7 +163,7 @@ Name | Type | Description | Notes > InlineResponse2002 CopyCampaignToApplications(ctx, applicationId, campaignId).Body(body).Execute() -Copy the campaign into every specified application +Copy the campaign into the specified application @@ -154,8 +173,8 @@ Copy the campaign into every specified application Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters @@ -186,11 +205,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateAdditionalCost +## CreateAccountCollection -> AccountAdditionalCost CreateAdditionalCost(ctx).Body(body).Execute() +> Collection CreateAccountCollection(ctx).Body(body).Execute() -Define a new additional cost +Create account-level collection @@ -200,16 +219,16 @@ Define a new additional cost ### Other Parameters -Other parameters are passed through a pointer to a apiCreateAdditionalCostRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateAccountCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAdditionalCost**](NewAdditionalCost.md) | | + **body** | [**NewCollection**](NewCollection.md) | | ### Return type -[**AccountAdditionalCost**](AccountAdditionalCost.md) +[**Collection**](Collection.md) ### Authorization @@ -225,11 +244,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateAttribute +## CreateAdditionalCost -> Attribute CreateAttribute(ctx).Body(body).Execute() +> AccountAdditionalCost CreateAdditionalCost(ctx).Body(body).Execute() -Create custom attribute +Create additional cost @@ -239,16 +258,16 @@ Create custom attribute ### Other Parameters -Other parameters are passed through a pointer to a apiCreateAttributeRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateAdditionalCostRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAttribute**](NewAttribute.md) | | + **body** | [**NewAdditionalCost**](NewAdditionalCost.md) | | ### Return type -[**Attribute**](Attribute.md) +[**AccountAdditionalCost**](AccountAdditionalCost.md) ### Authorization @@ -264,35 +283,30 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateCampaign +## CreateAttribute -> Campaign CreateCampaign(ctx, applicationId).Body(body).Execute() +> Attribute CreateAttribute(ctx).Body(body).Execute() -Create campaign +Create custom attribute ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiCreateCampaignRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateAttributeRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NewCampaign**](NewCampaign.md) | | + **body** | [**NewAttribute**](NewAttribute.md) | | ### Return type -[**Campaign**](Campaign.md) +[**Attribute**](Attribute.md) ### Authorization @@ -308,11 +322,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateCoupons +## CreateCampaignFromTemplate -> InlineResponse2004 CreateCoupons(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() +> CreateTemplateCampaignResponse CreateCampaignFromTemplate(ctx, applicationId).Body(body).Execute() -Create coupons +Create campaign from campaign template @@ -322,24 +336,21 @@ Create coupons Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiCreateCouponsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateCampaignFromTemplateRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**NewCoupons**](NewCoupons.md) | | - **silent** | **string** | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [default to yes] + **body** | [**CreateTemplateCampaign**](CreateTemplateCampaign.md) | | ### Return type -[**InlineResponse2004**](inline_response_200_4.md) +[**CreateTemplateCampaignResponse**](CreateTemplateCampaignResponse.md) ### Authorization @@ -355,11 +366,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateCouponsForMultipleRecipients +## CreateCollection -> InlineResponse2004 CreateCouponsForMultipleRecipients(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() +> Collection CreateCollection(ctx, applicationId, campaignId).Body(body).Execute() -Create coupons for multiple recipients +Create collection @@ -369,24 +380,23 @@ Create coupons for multiple recipients Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiCreateCouponsForMultipleRecipientsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md) | | - **silent** | **string** | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [default to yes] + **body** | [**NewCampaignCollection**](NewCampaignCollection.md) | | ### Return type -[**InlineResponse2004**](inline_response_200_4.md) +[**Collection**](Collection.md) ### Authorization @@ -402,30 +412,38 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreatePasswordRecoveryEmail +## CreateCoupons -> NewPasswordEmail CreatePasswordRecoveryEmail(ctx).Body(body).Execute() +> InlineResponse2005 CreateCoupons(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() -Request a password reset +Create coupons ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiCreatePasswordRecoveryEmailRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateCouponsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewPasswordEmail**](NewPasswordEmail.md) | | + + + **body** | [**NewCoupons**](NewCoupons.md) | | + **silent** | **string** | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [default to yes] ### Return type -[**NewPasswordEmail**](NewPasswordEmail.md) +[**InlineResponse2005**](inline_response_200_5.md) ### Authorization @@ -441,11 +459,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateRuleset +## CreateCouponsAsync -> Ruleset CreateRuleset(ctx, applicationId, campaignId).Body(body).Execute() +> AsyncCouponCreationResponse CreateCouponsAsync(ctx, applicationId, campaignId).Body(body).Execute() -Create ruleset +Create coupons asynchronously @@ -455,23 +473,23 @@ Create ruleset Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiCreateRulesetRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateCouponsAsyncRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewRuleset**](NewRuleset.md) | | + **body** | [**NewCouponCreationJob**](NewCouponCreationJob.md) | | ### Return type -[**Ruleset**](Ruleset.md) +[**AsyncCouponCreationResponse**](AsyncCouponCreationResponse.md) ### Authorization @@ -487,30 +505,38 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## CreateSession +## CreateCouponsForMultipleRecipients -> Session CreateSession(ctx).Body(body).Execute() +> InlineResponse2005 CreateCouponsForMultipleRecipients(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() -Create session +Create coupons for multiple recipients ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiCreateSessionRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateCouponsForMultipleRecipientsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LoginParams**](LoginParams.md) | | + + + **body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md) | | + **silent** | **string** | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [default to yes] ### Return type -[**Session**](Session.md) +[**InlineResponse2005**](inline_response_200_5.md) ### Authorization @@ -526,11 +552,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## DeleteCampaign +## CreateNotificationWebhook -> DeleteCampaign(ctx, applicationId, campaignId).Execute() +> NotificationWebhook CreateNotificationWebhook(ctx, applicationId).Body(body).Execute() -Delete campaign +Create notification webhook @@ -540,22 +566,21 @@ Delete campaign Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteCampaignRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateNotificationWebhookRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - + **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | | ### Return type - (empty response body) +[**NotificationWebhook**](NotificationWebhook.md) ### Authorization @@ -563,46 +588,38 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## DeleteCoupon +## CreatePasswordRecoveryEmail -> DeleteCoupon(ctx, applicationId, campaignId, couponId).Execute() +> NewPasswordEmail CreatePasswordRecoveryEmail(ctx).Body(body).Execute() -Delete coupon +Request a password reset ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | -**couponId** | **string** | The ID of the coupon code to delete | ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteCouponRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreatePasswordRecoveryEmailRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - + **body** | [**NewPasswordEmail**](NewPasswordEmail.md) | | ### Return type - (empty response body) +[**NewPasswordEmail**](NewPasswordEmail.md) ### Authorization @@ -610,57 +627,38 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## DeleteCoupons +## CreateSession -> DeleteCoupons(ctx, applicationId, campaignId).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).StartsAfter(startsAfter).StartsBefore(startsBefore).ExpiresAfter(expiresAfter).ExpiresBefore(expiresBefore).Valid(valid).BatchId(batchId).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).ExactMatch(exactMatch).Execute() +> Session CreateSession(ctx).Body(body).Execute() -Delete coupons +Create session ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteCouponsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiCreateSessionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **startsAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **startsBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **expiresAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **expiresBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | - **batchId** | **string** | Filter results by batches of coupons | - **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | - **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | - **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | - **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] + **body** | [**LoginParams**](LoginParams.md) | | ### Return type - (empty response body) +[**Session**](Session.md) ### Authorization @@ -668,19 +666,19 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## DeleteReferral +## DeleteAccountCollection -> DeleteReferral(ctx, applicationId, campaignId, referralId).Execute() +> DeleteAccountCollection(ctx, collectionId).Execute() -Delete referral +Delete account-level collection @@ -690,21 +688,17 @@ Delete referral Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | -**referralId** | **string** | The ID of the referral code to delete | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | ### Other Parameters -Other parameters are passed through a pointer to a apiDeleteReferralRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteAccountCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - ### Return type (empty response body) @@ -716,28 +710,38 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## DestroySession +## DeleteCampaign -> DestroySession(ctx).Execute() +> DeleteCampaign(ctx, applicationId, campaignId).Execute() -Destroy session +Delete campaign ### Path Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiDestroySessionRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + ### Return type @@ -758,11 +762,11 @@ Other parameters are passed through a pointer to a apiDestroySessionRequest stru [[Back to README]](../README.md) -## ExportCoupons +## DeleteCollection -> string ExportCoupons(ctx, applicationId).CampaignId(campaignId).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).DateFormat(dateFormat).CampaignState(campaignState).Execute() +> DeleteCollection(ctx, applicationId, campaignId, collectionId).Execute() -Export coupons to CSV file +Delete collection @@ -772,33 +776,24 @@ Export coupons to CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | ### Other Parameters -Other parameters are passed through a pointer to a apiExportCouponsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **campaignId** | **float32** | Filter results by campaign. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | - **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | - **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | - **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | - **batchId** | **string** | Filter results by batches of coupons | - **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] - **dateFormat** | **string** | Determines the format of dates in the export document. | - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Capmaigns that are expired. - `archived`: Campaigns that are archived. | + + ### Return type -**string** + (empty response body) ### Authorization @@ -807,18 +802,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/csv +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## ExportCustomerSessions +## DeleteCoupon -> string ExportCustomerSessions(ctx, applicationId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).ProfileIntegrationId(profileIntegrationId).DateFormat(dateFormat).CustomerSessionState(customerSessionState).Execute() +> DeleteCoupon(ctx, applicationId, campaignId, couponId).Execute() -Export customer sessions to CSV file +Delete coupon @@ -828,25 +823,24 @@ Export customer sessions to CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**couponId** | **string** | The ID of the coupon code to update | ### Other Parameters -Other parameters are passed through a pointer to a apiExportCustomerSessionsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteCouponRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | - **profileIntegrationId** | **string** | Only return sessions for the customer that matches this customer integration ID. | - **dateFormat** | **string** | Determines the format of dates in the export document. | - **customerSessionState** | **string** | Filter results by state. | + + ### Return type -**string** + (empty response body) ### Authorization @@ -855,18 +849,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/csv +- **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## ExportEffects +## DeleteCoupons -> string ExportEffects(ctx, applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).DateFormat(dateFormat).Execute() +> DeleteCoupons(ctx, applicationId, campaignId).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).StartsAfter(startsAfter).StartsBefore(startsBefore).ExpiresAfter(expiresAfter).ExpiresBefore(expiresBefore).Valid(valid).BatchId(batchId).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).ExactMatch(exactMatch).Execute() -Export triggered effects to CSV file +Delete coupons @@ -876,24 +870,35 @@ Export triggered effects to CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiExportEffectsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteCouponsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **campaignId** | **float32** | Filter results by campaign. | + + **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **dateFormat** | **string** | Determines the format of dates in the export document. | + **startsAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **startsBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **expiresAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **expiresBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **valid** | **string** | - `expired`: Matches coupons in which the expiry date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiry date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. | + **batchId** | **string** | Filter results by batches of coupons | + **usable** | **string** | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | + **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | + **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | + **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] ### Return type -**string** + (empty response body) ### Authorization @@ -902,18 +907,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/csv +- **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## ExportLoyaltyBalance +## DeleteNotificationWebhook -> string ExportLoyaltyBalance(ctx, programID).Execute() +> DeleteNotificationWebhook(ctx, applicationId, notificationWebhookId).Execute() -Export customer loyalty balance to a CSV file +Delete notification webhook @@ -923,20 +928,22 @@ Export customer loyalty balance to a CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **string** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**notificationWebhookId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiExportLoyaltyBalanceRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteNotificationWebhookRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type -**string** + (empty response body) ### Authorization @@ -945,18 +952,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/csv +- **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## ExportLoyaltyLedger +## DeleteReferral -> string ExportLoyaltyLedger(ctx, programID, integrationID).RangeStart(rangeStart).RangeEnd(rangeEnd).DateFormat(dateFormat).Execute() +> DeleteReferral(ctx, applicationId, campaignId, referralId).Execute() -Export a customer's loyalty ledger log to CSV file +Delete referral @@ -966,25 +973,24 @@ Export a customer's loyalty ledger log to CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **string** | | -**integrationID** | **string** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**referralId** | **string** | The ID of the referral code to delete | ### Other Parameters -Other parameters are passed through a pointer to a apiExportLoyaltyLedgerRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiDeleteReferralRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string | - **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string | - **dateFormat** | **string** | Determines the format of dates in the export document. | + ### Return type -**string** + (empty response body) ### Authorization @@ -993,48 +999,760 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/csv +- **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## ExportReferrals +## DestroySession -> string ExportReferrals(ctx, applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).BatchId(batchId).DateFormat(dateFormat).Execute() +> DestroySession(ctx).Execute() -Export referrals to CSV file +Destroy session ### Path Parameters +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiDestroySessionRequest struct via the builder pattern + + +### Return type + + (empty response body) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportAccountCollectionItems + +> string ExportAccountCollectionItems(ctx, collectionId).Execute() + +Export account-level collection's items + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportAccountCollectionItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportCollectionItems + +> string ExportCollectionItems(ctx, applicationId, campaignId, collectionId).Execute() + +Export a collection's items + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportCollectionItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportCoupons + +> string ExportCoupons(ctx, applicationId).CampaignId(campaignId).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).DateFormat(dateFormat).CampaignState(campaignState).Execute() + +Export coupons + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportCouponsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignId** | **float32** | Filter results by campaign. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | + **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | + **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | + **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | + **batchId** | **string** | Filter results by batches of coupons | + **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] + **dateFormat** | **string** | Determines the format of dates in the export document. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportCustomerSessions + +> string ExportCustomerSessions(ctx, applicationId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).ProfileIntegrationId(profileIntegrationId).DateFormat(dateFormat).CustomerSessionState(customerSessionState).Execute() + +Export customer sessions + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportCustomerSessionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | + **profileIntegrationId** | **string** | Only return sessions for the customer that matches this customer integration ID. | + **dateFormat** | **string** | Determines the format of dates in the export document. | + **customerSessionState** | **string** | Filter results by state. | + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportEffects + +> string ExportEffects(ctx, applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).DateFormat(dateFormat).Execute() + +Export triggered effects + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportEffectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignId** | **float32** | Filter results by campaign. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **dateFormat** | **string** | Determines the format of dates in the export document. | + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportLoyaltyBalance + +> string ExportLoyaltyBalance(ctx, loyaltyProgramId).Execute() + +Export customer loyalty balance to a CSV file + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **string** | The identifier for the loyalty program. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportLoyaltyBalanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportLoyaltyLedger + +> string ExportLoyaltyLedger(ctx, loyaltyProgramId, integrationId).RangeStart(rangeStart).RangeEnd(rangeEnd).DateFormat(dateFormat).Execute() + +Export a customer's loyalty ledger log + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **string** | The identifier for the loyalty program. | +**integrationId** | **string** | The identifier of the profile. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportLoyaltyLedgerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string. | + + + **dateFormat** | **string** | Determines the format of dates in the export document. | + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportReferrals + +> string ExportReferrals(ctx, applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).BatchId(batchId).DateFormat(dateFormat).Execute() + +Export referrals + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportReferralsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignId** | **float32** | Filter results by campaign. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **valid** | **string** | - `expired`: Matches referrals in which the expiry date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiry date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. | + **usable** | **string** | - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned. | + **batchId** | **string** | Filter results by batches of referrals | + **dateFormat** | **string** | Determines the format of dates in the export document. | + +### Return type + +**string** + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAccessLogsWithoutTotalCount + +> InlineResponse20012 GetAccessLogsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() + +Get access logs for Application + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessLogsWithoutTotalCountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string. | + **path** | **string** | Only return results where the request path matches the given regular expression. | + **method** | **string** | Only return results where the request method matches the given regular expression. | + **status** | **string** | Filter results by HTTP status codes. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + +### Return type + +[**InlineResponse20012**](inline_response_200_12.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAccount + +> Account GetAccount(ctx, accountId).Execute() + +Get account details + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accountId** | **int32** | The identifier of the account. Retrieve it via the [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` property. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Account**](Account.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAccountAnalytics + +> AccountAnalytics GetAccountAnalytics(ctx, accountId).Execute() + +Get account analytics + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accountId** | **int32** | The identifier of the account. Retrieve it via the [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` property. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountAnalyticsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountAnalytics**](AccountAnalytics.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAccountCollection + +> Collection GetAccountCollection(ctx, collectionId).Execute() + +Get account-level collection + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountCollectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Collection**](Collection.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAdditionalCost + +> AccountAdditionalCost GetAdditionalCost(ctx, additionalCostId).Execute() + +Get additional cost + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**additionalCostId** | **int32** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAdditionalCostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountAdditionalCost**](AccountAdditionalCost.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAdditionalCosts + +> InlineResponse20025 GetAdditionalCosts(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() + +List additional costs + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAdditionalCostsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + +### Return type + +[**InlineResponse20025**](inline_response_200_25.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAllAccessLogs + +> InlineResponse20013 GetAllAccessLogs(ctx).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() + +List access logs + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAllAccessLogsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string. | + **path** | **string** | Only return results where the request path matches the given regular expression. | + **method** | **string** | Only return results where the request method matches the given regular expression. | + **status** | **string** | Filter results by HTTP status codes. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + +### Return type + +[**InlineResponse20013**](inline_response_200_13.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +### HTTP request headers -### Other Parameters +- **Content-Type**: Not defined +- **Accept**: application/json -Other parameters are passed through a pointer to a apiExportReferralsRequest struct via the builder pattern +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- +## GetAllRoles + +> InlineResponse20033 GetAllRoles(ctx).Execute() + +List roles + + + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAllRolesRequest struct via the builder pattern - **campaignId** | **float32** | Filter results by campaign. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future. | - **usable** | **string** | If `true`, only referrals where `usageCounter < usageLimit` will be returned. If `false`, only referrals where `usageCounter >= usageLimit` will be returned. | - **batchId** | **string** | Filter results by batches of referrals | - **dateFormat** | **string** | Determines the format of dates in the export document. | ### Return type -**string** +[**InlineResponse20033**](inline_response_200_33.md) ### Authorization @@ -1043,18 +1761,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/csv +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -## GetAccessLogsWithoutTotalCount +## GetApplication -> InlineResponse2008 GetAccessLogsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> Application GetApplication(ctx, applicationId).Execute() -Get access logs for Application +Get application @@ -1064,28 +1782,20 @@ Get access logs for Application Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAccessLogsWithoutTotalCountRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string | - **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string | - **path** | **string** | Only return results where the request path matches the given regular expression. | - **method** | **string** | Only return results where the request method matches the given regular expression. | - **status** | **string** | Filter results by HTTP status codes. | - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | ### Return type -[**InlineResponse2008**](inline_response_200_8.md) +[**Application**](Application.md) ### Authorization @@ -1101,11 +1811,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAccount +## GetApplicationApiHealth -> Account GetAccount(ctx, accountId).Execute() +> ApplicationApiHealth GetApplicationApiHealth(ctx, applicationId).Execute() -Get account details +Get report of health of application API @@ -1115,11 +1825,11 @@ Get account details Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**accountId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAccountRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationApiHealthRequest struct via the builder pattern Name | Type | Description | Notes @@ -1128,7 +1838,7 @@ Name | Type | Description | Notes ### Return type -[**Account**](Account.md) +[**ApplicationApiHealth**](ApplicationApiHealth.md) ### Authorization @@ -1144,11 +1854,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAccountAnalytics +## GetApplicationCustomer -> AccountAnalytics GetAccountAnalytics(ctx, accountId).Execute() +> ApplicationCustomer GetApplicationCustomer(ctx, applicationId, customerId).Execute() -Get account analytics +Get application's customer @@ -1158,20 +1868,22 @@ Get account analytics Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**accountId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAccountAnalyticsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationCustomerRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type -[**AccountAnalytics**](AccountAnalytics.md) +[**ApplicationCustomer**](ApplicationCustomer.md) ### Authorization @@ -1187,11 +1899,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAdditionalCost +## GetApplicationCustomerFriends -> AccountAdditionalCost GetAdditionalCost(ctx, additionalCostId).Execute() +> InlineResponse20023 GetApplicationCustomerFriends(ctx, applicationId, integrationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() -Get an additional cost +List friends referred by customer profile @@ -1201,20 +1913,26 @@ Get an additional cost Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**additionalCostId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**integrationId** | **string** | The Integration ID of the Advocate's Profile. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAdditionalCostRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationCustomerFriendsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | + ### Return type -[**AccountAdditionalCost**](AccountAdditionalCost.md) +[**InlineResponse20023**](inline_response_200_23.md) ### Authorization @@ -1230,32 +1948,38 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAdditionalCosts +## GetApplicationCustomers -> InlineResponse20021 GetAdditionalCosts(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20015 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() -List additional costs +List application's customers ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAdditionalCostsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationCustomersRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + + **integrationId** | **string** | Filter results performing an exact matching against the profile integration identifier. | **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | ### Return type -[**InlineResponse20021**](inline_response_200_21.md) +[**InlineResponse20015**](inline_response_200_15.md) ### Authorization @@ -1271,37 +1995,38 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAllAccessLogs +## GetApplicationCustomersByAttributes -> InlineResponse2009 GetAllAccessLogs(ctx).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20016 GetApplicationCustomersByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() -List access logs +List application customers matching the given attributes ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAllAccessLogsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationCustomersByAttributesRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string | - **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string | - **path** | **string** | Only return results where the request path matches the given regular expression. | - **method** | **string** | Only return results where the request method matches the given regular expression. | - **status** | **string** | Filter results by HTTP status codes. | + + **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md) | | **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | ### Return type -[**InlineResponse2009**](inline_response_200_9.md) +[**InlineResponse20016**](inline_response_200_16.md) ### Authorization @@ -1309,7 +2034,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -1317,26 +2042,37 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAllRoles +## GetApplicationEventTypes -> InlineResponse20029 GetAllRoles(ctx).Execute() +> InlineResponse20021 GetApplicationEventTypes(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List roles +List Applications event types ### Path Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAllRolesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationEventTypesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | ### Return type -[**InlineResponse20029**](inline_response_200_29.md) +[**InlineResponse20021**](inline_response_200_21.md) ### Authorization @@ -1352,11 +2088,11 @@ Other parameters are passed through a pointer to a apiGetAllRolesRequest struct [[Back to README]](../README.md) -## GetApplication +## GetApplicationEventsWithoutTotalCount -> Application GetApplication(ctx, applicationId).Execute() +> InlineResponse20020 GetApplicationEventsWithoutTotalCount(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Type_(type_).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Session(session).Profile(profile).CustomerName(customerName).CustomerEmail(customerEmail).CouponCode(couponCode).ReferralCode(referralCode).RuleQuery(ruleQuery).CampaignQuery(campaignQuery).Execute() -Get Application +List Applications events @@ -1366,20 +2102,34 @@ Get Application Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationEventsWithoutTotalCountRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **type_** | **string** | Comma-separated list of types by which to filter events. Must be exact match(es). | + **createdBefore** | **time.Time** | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | + **session** | **string** | Session integration ID filter for events. Must be exact match. | + **profile** | **string** | Profile integration ID filter for events. Must be exact match. | + **customerName** | **string** | Customer name filter for events. Will match substrings case-insensitively. | + **customerEmail** | **string** | Customer e-mail address filter for events. Will match substrings case-insensitively. | + **couponCode** | **string** | Coupon code | + **referralCode** | **string** | Referral code | + **ruleQuery** | **string** | Rule name filter for events | + **campaignQuery** | **string** | Campaign name filter for events | ### Return type -[**Application**](Application.md) +[**InlineResponse20020**](inline_response_200_20.md) ### Authorization @@ -1395,11 +2145,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationApiHealth +## GetApplicationSession -> ApplicationApiHealth GetApplicationApiHealth(ctx, applicationId).Execute() +> ApplicationSession GetApplicationSession(ctx, applicationId, sessionId).Execute() -Get report of health of application API +Get Application session @@ -1409,20 +2159,22 @@ Get report of health of application API Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**sessionId** | **int32** | The **internal** ID of the session. You can get the ID with the [List Application sessions endpoint](/#tag/Customer-data/operation/getApplicationSession). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationApiHealthRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationSessionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type -[**ApplicationApiHealth**](ApplicationApiHealth.md) +[**ApplicationSession**](ApplicationSession.md) ### Authorization @@ -1438,11 +2190,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationCustomer +## GetApplicationSessions -> ApplicationCustomer GetApplicationCustomer(ctx, applicationId, customerId).Execute() +> InlineResponse20019 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Coupon(coupon).Referral(referral).IntegrationId(integrationId).Execute() -Get application's customer +List Application sessions @@ -1452,22 +2204,30 @@ Get application's customer Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**customerId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationCustomerRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationSessionsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **profile** | **string** | Profile integration ID filter for sessions. Must be exact match. | + **state** | **string** | Filter by sessions with this state. Must be exact match. | + **createdBefore** | **time.Time** | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | + **coupon** | **string** | Filter by sessions with this coupon. Must be exact match. | + **referral** | **string** | Filter by sessions with this referral. Must be exact match. | + **integrationId** | **string** | Filter by sessions with this integrationId. Must be exact match. | ### Return type -[**ApplicationCustomer**](ApplicationCustomer.md) +[**InlineResponse20019**](inline_response_200_19.md) ### Authorization @@ -1483,40 +2243,32 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationCustomerFriends +## GetApplications -> InlineResponse20019 GetApplicationCustomerFriends(ctx, applicationId, integrationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse2001 GetApplications(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List friends referred by customer profile +List applications ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**integrationId** | **string** | The Integration ID of the Advocate's Profile. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationCustomerFriendsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetApplicationsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | ### Return type -[**InlineResponse20019**](inline_response_200_19.md) +[**InlineResponse2001**](inline_response_200_1.md) ### Authorization @@ -1532,11 +2284,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationCustomers +## GetAttribute -> InlineResponse20011 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() +> Attribute GetAttribute(ctx, attributeId).Execute() -List application's customers +Get custom attribute @@ -1546,24 +2298,62 @@ List application's customers Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**attributeId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationCustomersRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetAttributeRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **integrationId** | **string** | Filter results performing an exact matching against the profile integration identifier. | + +### Return type + +[**Attribute**](Attribute.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAttributes + +> InlineResponse20024 GetAttributes(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Entity(entity).Execute() + +List custom attributes + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **entity** | **string** | Returned attributes will be filtered by supplied entity. | ### Return type -[**InlineResponse20011**](inline_response_200_11.md) +[**InlineResponse20024**](inline_response_200_24.md) ### Authorization @@ -1579,38 +2369,33 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationCustomersByAttributes +## GetAudiences -> InlineResponse20012 GetApplicationCustomersByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20022 GetAudiences(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() -List application customers matching the given attributes +List audiences ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationCustomersByAttributesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetAudiencesRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md) | | **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | ### Return type -[**InlineResponse20012**](inline_response_200_12.md) +[**InlineResponse20022**](inline_response_200_22.md) ### Authorization @@ -1618,7 +2403,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -1626,11 +2411,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationEventTypes +## GetCampaign -> InlineResponse20017 GetApplicationEventTypes(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> Campaign GetCampaign(ctx, applicationId, campaignId).Execute() -List Applications event types +Get campaign @@ -1640,23 +2425,22 @@ List Applications event types Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationEventTypesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCampaignRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + ### Return type -[**InlineResponse20017**](inline_response_200_17.md) +[**Campaign**](Campaign.md) ### Authorization @@ -1672,11 +2456,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationEventsWithoutTotalCount +## GetCampaignAnalytics -> InlineResponse20016 GetApplicationEventsWithoutTotalCount(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Type_(type_).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Session(session).Profile(profile).CustomerName(customerName).CustomerEmail(customerEmail).CouponCode(couponCode).ReferralCode(referralCode).RuleQuery(ruleQuery).CampaignQuery(campaignQuery).Execute() +> InlineResponse20014 GetCampaignAnalytics(ctx, applicationId, campaignId).RangeStart(rangeStart).RangeEnd(rangeEnd).Granularity(granularity).Execute() -List Applications events +Get analytics of campaigns @@ -1686,34 +2470,25 @@ List Applications events Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationEventsWithoutTotalCountRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCampaignAnalyticsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **type_** | **string** | Comma-separated list of types by which to filter events. Must be exact match(es). | - **createdBefore** | **time.Time** | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | - **session** | **string** | Session integration ID filter for events. Must be exact match. | - **profile** | **string** | Profile integration ID filter for events. Must be exact match. | - **customerName** | **string** | Customer name filter for events. Will match substrings case-insensitively. | - **customerEmail** | **string** | Customer e-mail address filter for events. Will match substrings case-insensitively. | - **couponCode** | **string** | Coupon code | - **referralCode** | **string** | Referral code | - **ruleQuery** | **string** | Rule name filter for events | - **campaignQuery** | **string** | Campaign name filter for events | + + **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string. | + **granularity** | **string** | The time interval between the results in the returned time-series. | ### Return type -[**InlineResponse20016**](inline_response_200_16.md) +[**InlineResponse20014**](inline_response_200_14.md) ### Authorization @@ -1729,11 +2504,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationSession +## GetCampaignByAttributes -> ApplicationSession GetApplicationSession(ctx, applicationId, sessionId).Execute() +> InlineResponse2002 GetCampaignByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Execute() -Get Application session +List campaigns that match the given attributes @@ -1743,22 +2518,25 @@ Get Application session Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**sessionId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationSessionRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCampaignByAttributesRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - + **body** | [**CampaignSearch**](CampaignSearch.md) | | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | ### Return type -[**ApplicationSession**](ApplicationSession.md) +[**InlineResponse2002**](inline_response_200_2.md) ### Authorization @@ -1766,7 +2544,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -1774,11 +2552,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplicationSessions +## GetCampaigns -> InlineResponse20015 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Coupon(coupon).Referral(referral).IntegrationId(integrationId).Execute() +> InlineResponse2002 GetCampaigns(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Name(name).Tags(tags).CreatedBefore(createdBefore).CreatedAfter(createdAfter).CampaignGroupId(campaignGroupId).TemplateId(templateId).Execute() -List Application sessions +List campaigns @@ -1788,11 +2566,11 @@ List Application sessions Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationSessionsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCampaignsRequest struct via the builder pattern Name | Type | Description | Notes @@ -1801,17 +2579,17 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **profile** | **string** | Profile integration ID filter for sessions. Must be exact match. | - **state** | **string** | Filter by sessions with this state. Must be exact match. | - **createdBefore** | **time.Time** | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | - **coupon** | **string** | Filter by sessions with this coupon. Must be exact match. | - **referral** | **string** | Filter by sessions with this referral. Must be exact match. | - **integrationId** | **string** | Filter by sessions with this integrationId. Must be exact match. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | + **name** | **string** | Filter results performing case-insensitive matching against the name of the campaign. | + **tags** | **string** | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **campaignGroupId** | **int32** | Filter results to campaigns owned by the specified campaign group ID. | + **templateId** | **int32** | The ID of the Campaign Template this Campaign was created from. | ### Return type -[**InlineResponse20015**](inline_response_200_15.md) +[**InlineResponse2002**](inline_response_200_2.md) ### Authorization @@ -1827,11 +2605,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetApplications +## GetChanges -> InlineResponse2001 GetApplications(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20031 GetChanges(ctx).PageSize(pageSize).Skip(skip).Sort(sort).ApplicationId(applicationId).EntityPath(entityPath).UserId(userId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).WithTotalResultSize(withTotalResultSize).IncludeOld(includeOld).Execute() -List Applications +Get audit logs for an account @@ -1841,7 +2619,7 @@ List Applications ### Other Parameters -Other parameters are passed through a pointer to a apiGetApplicationsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetChangesRequest struct via the builder pattern Name | Type | Description | Notes @@ -1849,10 +2627,17 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **applicationId** | **float32** | Filter results by Application ID. | + **entityPath** | **string** | Filter results on a case insensitive matching of the url path of the entity | + **userId** | **int32** | Filter results that match the given user ID. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **withTotalResultSize** | **bool** | 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. | + **includeOld** | **bool** | When this flag is set to false, the state without the change will not be returned. The default value is true. | ### Return type -[**InlineResponse2001**](inline_response_200_1.md) +[**InlineResponse20031**](inline_response_200_31.md) ### Authorization @@ -1868,11 +2653,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAttribute +## GetCollection -> Attribute GetAttribute(ctx, attributeId).Execute() +> Collection GetCollection(ctx, applicationId, campaignId, collectionId).Execute() -Get a custom attribute +Get collection @@ -1882,20 +2667,24 @@ Get a custom attribute Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**attributeId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAttributeRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + + ### Return type -[**Attribute**](Attribute.md) +[**Collection**](Collection.md) ### Authorization @@ -1911,33 +2700,36 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAttributes +## GetCollectionItems -> InlineResponse20020 GetAttributes(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Entity(entity).Execute() +> InlineResponse20010 GetCollectionItems(ctx, collectionId).PageSize(pageSize).Skip(skip).Execute() -List custom attributes +Get collection items ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAttributesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCollectionItemsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **entity** | **string** | Returned attributes will be filtered by supplied entity | ### Return type -[**InlineResponse20020**](inline_response_200_20.md) +[**InlineResponse20010**](inline_response_200_10.md) ### Authorization @@ -1953,33 +2745,48 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetAudiences +## GetCouponsWithoutTotalCount -> InlineResponse20018 GetAudiences(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse2006 GetCouponsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).Execute() -List audiences +List coupons ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetAudiencesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCouponsWithoutTotalCountRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | + **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | + **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | + **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | + **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | + **batchId** | **string** | Filter results by batches of coupons | + **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] ### Return type -[**InlineResponse20018**](inline_response_200_18.md) +[**InlineResponse2006**](inline_response_200_6.md) ### Authorization @@ -1995,11 +2802,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCampaign +## GetCustomerActivityReport -> Campaign GetCampaign(ctx, applicationId, campaignId).Execute() +> CustomerActivityReport GetCustomerActivityReport(ctx, applicationId, customerId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Execute() -Get campaign +Get customer's activity report @@ -2009,22 +2816,26 @@ Get campaign Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCampaignRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCustomerActivityReportRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | ### Return type -[**Campaign**](Campaign.md) +[**CustomerActivityReport**](CustomerActivityReport.md) ### Authorization @@ -2040,11 +2851,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCampaignAnalytics +## GetCustomerActivityReportsWithoutTotalCount -> InlineResponse20010 GetCampaignAnalytics(ctx, applicationId, campaignId).RangeStart(rangeStart).RangeEnd(rangeEnd).Granularity(granularity).Execute() +> InlineResponse20018 GetCustomerActivityReportsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() -Get analytics of campaigns +Get Activity Reports for Application Customers @@ -2054,25 +2865,29 @@ Get analytics of campaigns Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCampaignAnalyticsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCustomerActivityReportsWithoutTotalCountRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string. | - - **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string | - **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string | - **granularity** | **string** | The time interval between the results in the returned time-series. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **name** | **string** | Only return reports matching the customer name | + **integrationId** | **string** | Filter results performing an exact matching against the profile integration identifier. | + **campaignName** | **string** | Only return reports matching the campaignName | + **advocateName** | **string** | Only return reports matching the current customer referrer name | ### Return type -[**InlineResponse20010**](inline_response_200_10.md) +[**InlineResponse20018**](inline_response_200_18.md) ### Authorization @@ -2088,11 +2903,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCampaignByAttributes +## GetCustomerAnalytics -> InlineResponse2002 GetCampaignByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Execute() +> CustomerAnalytics GetCustomerAnalytics(ctx, applicationId, customerId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List campaigns that match the given attributes +Get customer's analytics report @@ -2102,25 +2917,25 @@ List campaigns that match the given attributes Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCampaignByAttributesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCustomerAnalyticsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CampaignSearch**](CampaignSearch.md) | | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Capmaigns that are expired. - `archived`: Campaigns that are archived. | ### Return type -[**InlineResponse2002**](inline_response_200_2.md) +[**CustomerAnalytics**](CustomerAnalytics.md) ### Authorization @@ -2128,7 +2943,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -2136,11 +2951,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCampaigns +## GetCustomerProfile -> InlineResponse2002 GetCampaigns(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Name(name).Tags(tags).CreatedBefore(createdBefore).CreatedAfter(createdAfter).CampaignGroupId(campaignGroupId).TemplateId(templateId).Execute() +> CustomerProfile GetCustomerProfile(ctx, customerId).Execute() -List campaigns +Get customer profile @@ -2150,30 +2965,20 @@ List campaigns Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](/#tag/Customer-data/operation/getApplicationCustomers) endpoint. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCampaignsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCustomerProfileRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Capmaigns that are expired. - `archived`: Campaigns that are archived. | - **name** | **string** | Filter results performing case-insensitive matching against the name of the campaign. | - **tags** | **string** | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **campaignGroupId** | **int32** | Filter results to campaigns owned by the specified campaign group ID. | - **templateId** | **int32** | The ID of the Campaign Template this Campaign was created from. | ### Return type -[**InlineResponse2002**](inline_response_200_2.md) +[**CustomerProfile**](CustomerProfile.md) ### Authorization @@ -2189,11 +2994,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetChanges +## GetCustomerProfiles -> InlineResponse20027 GetChanges(ctx).PageSize(pageSize).Skip(skip).Sort(sort).ApplicationId(applicationId).EntityPath(entityPath).UserId(userId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).WithTotalResultSize(withTotalResultSize).IncludeOld(includeOld).Execute() +> InlineResponse20017 GetCustomerProfiles(ctx).PageSize(pageSize).Skip(skip).Execute() -Get audit log for an account +List customer profiles @@ -2203,25 +3008,17 @@ Get audit log for an account ### Other Parameters -Other parameters are passed through a pointer to a apiGetChangesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCustomerProfilesRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **applicationId** | **int32** | | - **entityPath** | **string** | Filter results on a case insensitive matching of the url path of the entity | - **userId** | **int32** | | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | - **includeOld** | **bool** | When this flag is set to false, the state without the change will not be returned. The default value is true. | ### Return type -[**InlineResponse20027**](inline_response_200_27.md) +[**InlineResponse20017**](inline_response_200_17.md) ### Authorization @@ -2237,49 +3034,32 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCouponsByAttributes +## GetCustomersByAttributes -> InlineResponse2004 GetCouponsByAttributes(ctx, applicationId, campaignId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).ExactMatch(exactMatch).BatchId(batchId).Execute() +> InlineResponse20017 GetCustomersByAttributes(ctx).Body(body).PageSize(pageSize).Skip(skip).Execute() -List coupons that match the given attributes +List customer profiles matching the given attributes ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCouponsByAttributesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetCustomersByAttributesRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - **body** | [**CouponSearch**](CouponSearch.md) | | + **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md) | | **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | - **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | - **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | - **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | - **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] - **batchId** | **string** | Filter results by batches of coupons | ### Return type -[**InlineResponse2004**](inline_response_200_4.md) +[**InlineResponse20017**](inline_response_200_17.md) ### Authorization @@ -2295,48 +3075,34 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCouponsWithoutTotalCount +## GetEventTypes -> InlineResponse2005 GetCouponsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).Execute() +> InlineResponse20029 GetEventTypes(ctx).Name(name).IncludeOldVersions(includeOldVersions).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List coupons +List event types ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCouponsWithoutTotalCountRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetEventTypesRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | - **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | - **referralId** | **int32** | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | - **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | - **batchId** | **string** | Filter results by batches of coupons | - **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] + **name** | **string** | Filter results to event types with the given name. This parameter implies `includeOldVersions`. | + **includeOldVersions** | **bool** | Include all versions of every event type. | [default to false] + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | ### Return type -[**InlineResponse2005**](inline_response_200_5.md) +[**InlineResponse20029**](inline_response_200_29.md) ### Authorization @@ -2352,40 +3118,34 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCustomerActivityReport +## GetExports -> CustomerActivityReport GetCustomerActivityReport(ctx, applicationId, customerId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20032 GetExports(ctx).PageSize(pageSize).Skip(skip).ApplicationId(applicationId).CampaignId(campaignId).Entity(entity).Execute() -Get customer's activity report +Get exports ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**customerId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCustomerActivityReportRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetExportsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string | - **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string | - - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **applicationId** | **float32** | Filter results by Application ID. | + **campaignId** | **int32** | Filter by the campaign ID on which the limit counters are used. | + **entity** | **string** | The name of the entity type that was exported. | ### Return type -[**CustomerActivityReport**](CustomerActivityReport.md) +[**InlineResponse20032**](inline_response_200_32.md) ### Authorization @@ -2401,11 +3161,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCustomerActivityReportsWithoutTotalCount +## GetLoyaltyPoints -> InlineResponse20014 GetCustomerActivityReportsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() +> LoyaltyLedger GetLoyaltyPoints(ctx, loyaltyProgramId, integrationId).Execute() -Get Activity Reports for Application Customers +Get the Loyalty Ledger for this integrationID @@ -2415,29 +3175,22 @@ Get Activity Reports for Application Customers Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**loyaltyProgramId** | **string** | The identifier for the loyalty program. | +**integrationId** | **string** | The identifier of the profile. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCustomerActivityReportsWithoutTotalCountRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetLoyaltyPointsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **rangeStart** | **time.Time** | Only return results from after this timestamp, must be an RFC3339 timestamp string | - **rangeEnd** | **time.Time** | Only return results from before this timestamp, must be an RFC3339 timestamp string | - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **name** | **string** | Only return reports matching the customer name | - **integrationId** | **string** | Only return reports matching the integrationId | - **campaignName** | **string** | Only return reports matching the campaignName | - **advocateName** | **string** | Only return reports matching the current customer referrer name | + ### Return type -[**InlineResponse20014**](inline_response_200_14.md) +[**LoyaltyLedger**](LoyaltyLedger.md) ### Authorization @@ -2453,11 +3206,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCustomerAnalytics +## GetLoyaltyProgram -> CustomerAnalytics GetCustomerAnalytics(ctx, applicationId, customerId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> LoyaltyProgram GetLoyaltyProgram(ctx, loyaltyProgramId).Execute() -Get customer's analytics report +Get loyalty program @@ -2467,25 +3220,20 @@ Get customer's analytics report Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**customerId** | **int32** | | +**loyaltyProgramId** | **int32** | Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCustomerAnalyticsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetLoyaltyProgramRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - ### Return type -[**CustomerAnalytics**](CustomerAnalytics.md) +[**LoyaltyProgram**](LoyaltyProgram.md) ### Authorization @@ -2501,34 +3249,26 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCustomerProfile +## GetLoyaltyPrograms -> CustomerProfile GetCustomerProfile(ctx, customerId).Execute() +> InlineResponse2008 GetLoyaltyPrograms(ctx).Execute() -Get customer profile +List loyalty programs ### Path Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**customerId** | **int32** | | +This endpoint does not need any parameter. ### Other Parameters -Other parameters are passed through a pointer to a apiGetCustomerProfileRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- +Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest struct via the builder pattern ### Return type -[**CustomerProfile**](CustomerProfile.md) +[**InlineResponse2008**](inline_response_200_8.md) ### Authorization @@ -2544,31 +3284,34 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCustomerProfiles +## GetLoyaltyStatistics -> InlineResponse20013 GetCustomerProfiles(ctx).PageSize(pageSize).Skip(skip).Execute() +> LoyaltyStatistics GetLoyaltyStatistics(ctx, loyaltyProgramId).Execute() -List customer profiles +Get loyalty program statistics by loyalty program ID ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCustomerProfilesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetLoyaltyStatisticsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | + ### Return type -[**InlineResponse20013**](inline_response_200_13.md) +[**LoyaltyStatistics**](LoyaltyStatistics.md) ### Authorization @@ -2584,32 +3327,36 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetCustomersByAttributes +## GetNotificationWebhook -> InlineResponse20013 GetCustomersByAttributes(ctx).Body(body).PageSize(pageSize).Skip(skip).Execute() +> NotificationWebhook GetNotificationWebhook(ctx, applicationId, notificationWebhookId).Execute() -List customer profiles matching the given attributes +Get notification webhook ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**notificationWebhookId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetCustomersByAttributesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetNotificationWebhookRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md) | | - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | + + ### Return type -[**InlineResponse20013**](inline_response_200_13.md) +[**NotificationWebhook**](NotificationWebhook.md) ### Authorization @@ -2617,7 +3364,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -2625,35 +3372,34 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetEventTypes +## GetNotificationWebhooks -> InlineResponse20025 GetEventTypes(ctx).ApplicationIds(applicationIds).Name(name).IncludeOldVersions(includeOldVersions).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse2003 GetNotificationWebhooks(ctx, applicationId).Execute() -List Event Types +List notification webhooks ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetEventTypesRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetNotificationWebhooksRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **applicationIds** | **string** | Filter by one or more application ids separated by comma | - **name** | **string** | Filter results to event types with the given name. This parameter implies `includeOldVersions`. | - **includeOldVersions** | **bool** | Include all versions of every event type. | [default to false] - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + ### Return type -[**InlineResponse20025**](inline_response_200_25.md) +[**InlineResponse2003**](inline_response_200_3.md) ### Authorization @@ -2669,34 +3415,45 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetExports +## GetReferralsWithoutTotalCount -> InlineResponse20028 GetExports(ctx).PageSize(pageSize).Skip(skip).ApplicationId(applicationId).CampaignId(campaignId).Entity(entity).Execute() +> InlineResponse2007 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() -Get Exports +List referrals ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetExportsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetReferralsWithoutTotalCountRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **applicationId** | **int32** | | - **campaignId** | **int32** | | - **entity** | **string** | The name of the entity type that was exported. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **code** | **string** | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future. | + **usable** | **string** | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | + **advocate** | **string** | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field | ### Return type -[**InlineResponse20028**](inline_response_200_28.md) +[**InlineResponse2007**](inline_response_200_7.md) ### Authorization @@ -2712,11 +3469,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetLoyaltyPoints +## GetRole -> LoyaltyLedger GetLoyaltyPoints(ctx, programID, integrationID).Execute() +> Role GetRole(ctx, roleId).Execute() -Get the Loyalty Ledger for this integrationID +Get role @@ -2726,22 +3483,20 @@ Get the Loyalty Ledger for this integrationID Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **string** | The identifier for the application, must be unique within the account. | -**integrationID** | **string** | The identifier for the application, must be unique within the account. | +**roleId** | **int32** | The Id of role. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetLoyaltyPointsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type -[**LoyaltyLedger**](LoyaltyLedger.md) +[**Role**](Role.md) ### Authorization @@ -2757,11 +3512,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetLoyaltyProgram +## GetRuleset -> LoyaltyProgram GetLoyaltyProgram(ctx, programID).Execute() +> Ruleset GetRuleset(ctx, applicationId, campaignId, rulesetId).Execute() -Get loyalty program +Get ruleset @@ -2771,20 +3526,24 @@ Get loyalty program Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**rulesetId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetLoyaltyProgramRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetRulesetRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + + ### Return type -[**LoyaltyProgram**](LoyaltyProgram.md) +[**Ruleset**](Ruleset.md) ### Authorization @@ -2800,26 +3559,39 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetLoyaltyPrograms +## GetRulesets -> InlineResponse2007 GetLoyaltyPrograms(ctx).Execute() +> InlineResponse2004 GetRulesets(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List loyalty programs +List campaign rulesets ### Path Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetRulesetsRequest struct via the builder pattern + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | ### Return type -[**InlineResponse2007**](inline_response_200_7.md) +[**InlineResponse2004**](inline_response_200_4.md) ### Authorization @@ -2835,11 +3607,11 @@ Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest [[Back to README]](../README.md) -## GetLoyaltyStatistics +## GetUser -> LoyaltyStatistics GetLoyaltyStatistics(ctx, programID).Execute() +> User GetUser(ctx, userId).Execute() -Get loyalty program statistics by loyalty program ID +Get user @@ -2849,11 +3621,11 @@ Get loyalty program statistics by loyalty program ID Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **int32** | | +**userId** | **int32** | The ID of the user. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetLoyaltyStatisticsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetUserRequest struct via the builder pattern Name | Type | Description | Notes @@ -2862,7 +3634,7 @@ Name | Type | Description | Notes ### Return type -[**LoyaltyStatistics**](LoyaltyStatistics.md) +[**User**](User.md) ### Authorization @@ -2878,45 +3650,32 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetReferralsWithoutTotalCount +## GetUsers -> InlineResponse2006 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() +> InlineResponse20030 GetUsers(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List referrals +List users in account ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetReferralsWithoutTotalCountRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetUsersRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **code** | **string** | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future. | - **usable** | **string** | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | - **advocate** | **string** | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field | ### Return type -[**InlineResponse2006**](inline_response_200_6.md) +[**InlineResponse20030**](inline_response_200_30.md) ### Authorization @@ -2932,11 +3691,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetRole +## GetWebhook -> Role GetRole(ctx, roleId).Execute() +> Webhook GetWebhook(ctx, webhookId).Execute() -Get role +Get webhook @@ -2946,11 +3705,11 @@ Get role Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**roleId** | **int32** | | +**webhookId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetWebhookRequest struct via the builder pattern Name | Type | Description | Notes @@ -2959,7 +3718,7 @@ Name | Type | Description | Notes ### Return type -[**Role**](Role.md) +[**Webhook**](Webhook.md) ### Authorization @@ -2975,38 +3734,38 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetRuleset +## GetWebhookActivationLogs -> Ruleset GetRuleset(ctx, applicationId, campaignId, rulesetId).Execute() +> InlineResponse20027 GetWebhookActivationLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).IntegrationRequestUuid(integrationRequestUuid).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() -Get ruleset +List webhook activation log entries ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | -**rulesetId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetRulesetRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetWebhookActivationLogsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - - + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **integrationRequestUuid** | **string** | Filter results by integration request UUID. | + **webhookId** | **float32** | Filter results by Webhook. | + **applicationId** | **float32** | Filter results by Application ID. | + **campaignId** | **float32** | Filter results by campaign. | + **createdBefore** | **time.Time** | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | ### Return type -[**Ruleset**](Ruleset.md) +[**InlineResponse20027**](inline_response_200_27.md) ### Authorization @@ -3022,39 +3781,39 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetRulesets +## GetWebhookLogs -> InlineResponse2003 GetRulesets(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20028 GetWebhookLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Status(status).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).RequestUuid(requestUuid).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() -List campaign rulesets +List webhook log entries ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetRulesetsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetWebhookLogsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **status** | **string** | Filter results by HTTP status codes. | + **webhookId** | **float32** | Filter results by Webhook. | + **applicationId** | **float32** | Filter results by Application ID. | + **campaignId** | **float32** | Filter results by campaign. | + **requestUuid** | **string** | Filter results by request UUID. | + **createdBefore** | **time.Time** | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | ### Return type -[**InlineResponse2003**](inline_response_200_3.md) +[**InlineResponse20028**](inline_response_200_28.md) ### Authorization @@ -3070,34 +3829,33 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetUser +## GetWebhooks -> User GetUser(ctx, userId).Execute() +> InlineResponse20026 GetWebhooks(ctx).ApplicationIds(applicationIds).Sort(sort).PageSize(pageSize).Skip(skip).Execute() -Get a single user +List webhooks ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**userId** | **int32** | | - + ### Other Parameters -Other parameters are passed through a pointer to a apiGetUserRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiGetWebhooksRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - + **applicationIds** | **string** | Filter by one or more application ids separated by comma. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | ### Return type -[**User**](User.md) +[**InlineResponse20026**](inline_response_200_26.md) ### Authorization @@ -3113,32 +3871,35 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetUsers +## ImportAccountCollection -> InlineResponse20026 GetUsers(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> Import ImportAccountCollection(ctx, collectionId).UpFile(upFile).Execute() -List users in account +Import data in existing account-level collection ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetUsersRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportAccountCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + + **upFile** | **string** | The file with the information about the data that should be imported. | ### Return type -[**InlineResponse20026**](inline_response_200_26.md) +[**Import**](Import.md) ### Authorization @@ -3146,7 +3907,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3154,11 +3915,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetWebhook +## ImportAllowedList -> Webhook GetWebhook(ctx, webhookId).Execute() +> Import ImportAllowedList(ctx, attributeId).UpFile(upFile).Execute() -Get Webhook +Import allowed values for attribute @@ -3168,20 +3929,21 @@ Get Webhook Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**webhookId** | **int32** | | +**attributeId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiGetWebhookRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportAllowedListRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **upFile** | **string** | The file with the information about the data that should be imported. | ### Return type -[**Webhook**](Webhook.md) +[**Import**](Import.md) ### Authorization @@ -3189,7 +3951,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3197,38 +3959,39 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetWebhookActivationLogs +## ImportCollection -> InlineResponse20023 GetWebhookActivationLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).IntegrationRequestUuid(integrationRequestUuid).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> Import ImportCollection(ctx, applicationId, campaignId, collectionId).UpFile(upFile).Execute() -List webhook activation log entries +Import data in existing collection ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetWebhookActivationLogsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportCollectionRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **integrationRequestUuid** | **string** | Filter results by integration request UUID. | - **webhookId** | **float32** | Filter results by Webhook. | - **applicationId** | **float32** | | - **campaignId** | **float32** | Filter results by campaign. | - **createdBefore** | **time.Time** | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | + + + + **upFile** | **string** | The file with the information about the data that should be imported. | ### Return type -[**InlineResponse20023**](inline_response_200_23.md) +[**Import**](Import.md) ### Authorization @@ -3236,7 +3999,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3244,39 +4007,37 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetWebhookLogs +## ImportCoupons -> InlineResponse20024 GetWebhookLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Status(status).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).RequestUuid(requestUuid).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> Import ImportCoupons(ctx, applicationId, campaignId).UpFile(upFile).Execute() -List webhook log entries +Import coupons ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiGetWebhookLogsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportCouponsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **status** | **string** | Filter results by HTTP status codes. | - **webhookId** | **float32** | Filter results by Webhook. | - **applicationId** | **float32** | | - **campaignId** | **float32** | Filter results by campaign. | - **requestUuid** | **string** | Filter results by request UUID. | - **createdBefore** | **time.Time** | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | + + + **upFile** | **string** | The file with the information about the data that should be imported. | ### Return type -[**InlineResponse20024**](inline_response_200_24.md) +[**Import**](Import.md) ### Authorization @@ -3284,7 +4045,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3292,33 +4053,35 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetWebhooks +## ImportLoyaltyPoints -> InlineResponse20022 GetWebhooks(ctx).ApplicationIds(applicationIds).Sort(sort).PageSize(pageSize).Skip(skip).Execute() +> Import ImportLoyaltyPoints(ctx, loyaltyProgramId).UpFile(upFile).Execute() -List webhooks +Import loyalty points ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms). | ### Other Parameters -Other parameters are passed through a pointer to a apiGetWebhooksRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportLoyaltyPointsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **applicationIds** | **string** | Filter by one or more application ids separated by comma | - **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | - **skip** | **int32** | Skips the given number of items when paging through large result sets. | + + **upFile** | **string** | The file with the information about the data that should be imported. | ### Return type -[**InlineResponse20022**](inline_response_200_22.md) +[**Import**](Import.md) ### Authorization @@ -3326,7 +4089,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: Not defined +- **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3334,11 +4097,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## ImportCollection +## ImportPoolGiveaways -> Import ImportCollection(ctx, applicationId, campaignId, collectionId).UpFile(upFile).Execute() +> Import ImportPoolGiveaways(ctx, poolId).UpFile(upFile).Execute() -Import collection via CSV file +Import giveaway codes into a giveaway pool @@ -3348,20 +4111,16 @@ Import collection via CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | -**collectionId** | **int32** | | +**poolId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiImportCollectionRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportPoolGiveawaysRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **upFile** | **string** | The file with the information about the data that should be imported. | ### Return type @@ -3382,11 +4141,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## ImportCoupons +## ImportReferrals -> Import ImportCoupons(ctx, applicationId, campaignId).UpFile(upFile).Execute() +> Import ImportReferrals(ctx, applicationId, campaignId).UpFile(upFile).Execute() -Import coupons via CSV file +Import referrals @@ -3396,12 +4155,12 @@ Import coupons via CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiImportCouponsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiImportReferralsRequest struct via the builder pattern Name | Type | Description | Notes @@ -3428,35 +4187,34 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## ImportLoyaltyPoints +## ListAccountCollections -> Import ImportLoyaltyPoints(ctx, programID).UpFile(upFile).Execute() +> InlineResponse2009 ListAccountCollections(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() -Import loyalty points via CSV file +List collections in account ### Path Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiImportLoyaltyPointsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiListAccountCollectionsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **upFile** | **string** | The file with the information about the data that should be imported. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | + **name** | **string** | Filter by the name of the Collection. | ### Return type -[**Import**](Import.md) +[**InlineResponse2009**](inline_response_200_9.md) ### Authorization @@ -3464,7 +4222,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: multipart/form-data +- **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3472,11 +4230,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## ImportPoolGiveaways +## ListCollections -> Import ImportPoolGiveaways(ctx, poolId).UpFile(upFile).Execute() +> InlineResponse20011 ListCollections(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() -Import giveaway codes into a giveaway pool +List collections @@ -3486,21 +4244,27 @@ Import giveaway codes into a giveaway pool Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**poolId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiImportPoolGiveawaysRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiListCollectionsRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **upFile** | **string** | The file with the information about the data that should be imported. | + + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | + **name** | **string** | Filter by the name of the Collection. | ### Return type -[**Import**](Import.md) +[**InlineResponse20011**](inline_response_200_11.md) ### Authorization @@ -3508,7 +4272,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: multipart/form-data +- **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3516,11 +4280,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## ImportReferrals +## ListCollectionsInApplication -> Import ImportReferrals(ctx, applicationId, campaignId).UpFile(upFile).Execute() +> InlineResponse20011 ListCollectionsInApplication(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() -Import referrals via CSV file +List collections in application @@ -3530,23 +4294,25 @@ Import referrals via CSV file Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters -Other parameters are passed through a pointer to a apiImportReferralsRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiListCollectionsInApplicationRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **upFile** | **string** | The file with the information about the data that should be imported. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **withTotalResultSize** | **bool** | 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. | + **name** | **string** | Filter by the name of the Collection. | ### Return type -[**Import**](Import.md) +[**InlineResponse20011**](inline_response_200_11.md) ### Authorization @@ -3554,7 +4320,7 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: multipart/form-data +- **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) @@ -3564,7 +4330,7 @@ Name | Type | Description | Notes ## RemoveLoyaltyPoints -> RemoveLoyaltyPoints(ctx, programID, integrationID).Body(body).Execute() +> RemoveLoyaltyPoints(ctx, loyaltyProgramId, integrationId).Body(body).Execute() Deduct points in loyalty program for given customer @@ -3576,8 +4342,8 @@ Deduct points in loyalty program for given customer Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **string** | | -**integrationID** | **string** | | +**loyaltyProgramId** | **string** | The identifier for the loyalty program. | +**integrationId** | **string** | The identifier of the profile. | ### Other Parameters @@ -3601,7 +4367,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: Not defined +- **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) @@ -3649,9 +4415,9 @@ Name | Type | Description | Notes ## SearchCouponsAdvancedApplicationWideWithoutTotalCount -> InlineResponse2005 SearchCouponsAdvancedApplicationWideWithoutTotalCount(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).CampaignState(campaignState).Execute() +> InlineResponse2006 SearchCouponsAdvancedApplicationWideWithoutTotalCount(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).CampaignState(campaignState).Execute() -List coupons that match the given attributes in all active campaigns of an application +List coupons that match the given attributes (without total count) @@ -3661,7 +4427,7 @@ List coupons that match the given attributes in all active campaigns of an appli Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | ### Other Parameters @@ -3684,11 +4450,11 @@ Name | Type | Description | Notes **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | **batchId** | **string** | Filter results by batches of coupons | **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Capmaigns that are expired. - `archived`: Campaigns that are archived. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | ### Return type -[**InlineResponse2005**](inline_response_200_5.md) +[**InlineResponse2006**](inline_response_200_6.md) ### Authorization @@ -3706,9 +4472,9 @@ Name | Type | Description | Notes ## SearchCouponsAdvancedWithoutTotalCount -> InlineResponse2005 SearchCouponsAdvancedWithoutTotalCount(ctx, applicationId, campaignId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).ExactMatch(exactMatch).BatchId(batchId).Execute() +> InlineResponse2006 SearchCouponsAdvancedWithoutTotalCount(ctx, applicationId, campaignId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).ExactMatch(exactMatch).BatchId(batchId).Execute() -List coupons that match the given attributes +List coupons that match the given attributes in campaign (without total count) @@ -3718,8 +4484,8 @@ List coupons that match the given attributes Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters @@ -3746,7 +4512,51 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2005**](inline_response_200_5.md) +[**InlineResponse2006**](inline_response_200_6.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateAccountCollection + +> Collection UpdateAccountCollection(ctx, collectionId).Body(body).Execute() + +Update account-level collection + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccountCollectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**UpdateCollection**](UpdateCollection.md) | | + +### Return type + +[**Collection**](Collection.md) ### Authorization @@ -3766,7 +4576,7 @@ Name | Type | Description | Notes > AccountAdditionalCost UpdateAdditionalCost(ctx, additionalCostId).Body(body).Execute() -Update an additional cost +Update additional cost @@ -3810,7 +4620,7 @@ Name | Type | Description | Notes > Attribute UpdateAttribute(ctx, attributeId).Body(body).Execute() -Update a custom attribute +Update custom attribute @@ -3864,8 +4674,8 @@ Update campaign Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters @@ -3896,6 +4706,54 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## UpdateCollection + +> Collection UpdateCollection(ctx, applicationId, campaignId, collectionId).Body(body).Execute() + +Update collection description + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCollectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **body** | [**UpdateCampaignCollection**](UpdateCampaignCollection.md) | | + +### Return type + +[**Collection**](Collection.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## UpdateCoupon > Coupon UpdateCoupon(ctx, applicationId, campaignId, couponId).Body(body).Execute() @@ -3910,8 +4768,8 @@ Update coupon Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | **couponId** | **string** | The ID of the coupon code to update | ### Other Parameters @@ -3948,7 +4806,7 @@ Name | Type | Description | Notes > UpdateCouponBatch(ctx, applicationId, campaignId).Body(body).Execute() -Update a batch of coupons +Update coupons @@ -3958,8 +4816,8 @@ Update a batch of coupons Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | ### Other Parameters @@ -3990,11 +4848,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## UpdateReferral +## UpdateNotificationWebhook -> Referral UpdateReferral(ctx, applicationId, campaignId, referralId).Body(body).Execute() +> NotificationWebhook UpdateNotificationWebhook(ctx, applicationId, notificationWebhookId).Body(body).Execute() -Update referral +Update notification webhook @@ -4004,25 +4862,23 @@ Update referral Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | -**referralId** | **string** | The ID of the referral code to delete | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**notificationWebhookId** | **int32** | | ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateReferralRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiUpdateNotificationWebhookRequest struct via the builder pattern Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - **body** | [**UpdateReferral**](UpdateReferral.md) | | + **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | | ### Return type -[**Referral**](Referral.md) +[**NotificationWebhook**](NotificationWebhook.md) ### Authorization @@ -4038,11 +4894,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## UpdateRuleset +## UpdateReferral -> Ruleset UpdateRuleset(ctx, applicationId, campaignId, rulesetId).Body(body).Execute() +> Referral UpdateReferral(ctx, applicationId, campaignId, referralId).Body(body).Execute() -Update ruleset +Update referral @@ -4052,13 +4908,13 @@ Update ruleset Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | -**campaignId** | **int32** | | -**rulesetId** | **int32** | | +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | +**referralId** | **string** | The ID of the referral code to delete | ### Other Parameters -Other parameters are passed through a pointer to a apiUpdateRulesetRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiUpdateReferralRequest struct via the builder pattern Name | Type | Description | Notes @@ -4066,11 +4922,11 @@ Name | Type | Description | Notes - **body** | [**NewRuleset**](NewRuleset.md) | | + **body** | [**UpdateReferral**](UpdateReferral.md) | | ### Return type -[**Ruleset**](Ruleset.md) +[**Referral**](Referral.md) ### Authorization diff --git a/docs/ManagementKey.md b/docs/ManagementKey.md new file mode 100644 index 00000000..e91f5e17 --- /dev/null +++ b/docs/ManagementKey.md @@ -0,0 +1,195 @@ +# ManagementKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name for management key. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | The date the management key expires. | +**Endpoints** | Pointer to [**[]Endpoint**](Endpoint.md) | The list of endpoints that can be accessed with the key | +**Id** | Pointer to **int32** | ID of the management key. | +**CreatedBy** | Pointer to **int32** | ID of the user who created it. | +**AccountID** | Pointer to **int32** | ID of account the key is used for. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The date the management key was created. | + +## Methods + +### GetName + +`func (o *ManagementKey) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagementKey) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ManagementKey) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ManagementKey) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetExpiryDate + +`func (o *ManagementKey) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *ManagementKey) GetExpiryDateOk() (time.Time, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *ManagementKey) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *ManagementKey) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetEndpoints + +`func (o *ManagementKey) GetEndpoints() []Endpoint` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *ManagementKey) GetEndpointsOk() ([]Endpoint, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndpoints + +`func (o *ManagementKey) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### SetEndpoints + +`func (o *ManagementKey) SetEndpoints(v []Endpoint)` + +SetEndpoints gets a reference to the given []Endpoint and assigns it to the Endpoints field. + +### GetId + +`func (o *ManagementKey) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagementKey) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *ManagementKey) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *ManagementKey) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreatedBy + +`func (o *ManagementKey) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *ManagementKey) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *ManagementKey) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *ManagementKey) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetAccountID + +`func (o *ManagementKey) GetAccountID() int32` + +GetAccountID returns the AccountID field if non-nil, zero value otherwise. + +### GetAccountIDOk + +`func (o *ManagementKey) GetAccountIDOk() (int32, bool)` + +GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountID + +`func (o *ManagementKey) HasAccountID() bool` + +HasAccountID returns a boolean if a field has been set. + +### SetAccountID + +`func (o *ManagementKey) SetAccountID(v int32)` + +SetAccountID gets a reference to the given int32 and assigns it to the AccountID field. + +### GetCreated + +`func (o *ManagementKey) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ManagementKey) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *ManagementKey) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *ManagementKey) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleAttribute.md b/docs/MultipleAttribute.md new file mode 100644 index 00000000..df3924fa --- /dev/null +++ b/docs/MultipleAttribute.md @@ -0,0 +1,39 @@ +# MultipleAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]Attribute**](Attribute.md) | | [optional] + +## Methods + +### GetAttributes + +`func (o *MultipleAttribute) GetAttributes() []Attribute` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MultipleAttribute) GetAttributesOk() ([]Attribute, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *MultipleAttribute) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *MultipleAttribute) SetAttributes(v []Attribute)` + +SetAttributes gets a reference to the given []Attribute and assigns it to the Attributes field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleAudiences.md b/docs/MultipleAudiences.md new file mode 100644 index 00000000..b679679e --- /dev/null +++ b/docs/MultipleAudiences.md @@ -0,0 +1,65 @@ +# MultipleAudiences + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Audiences** | Pointer to [**[]MultipleAudiencesItem**](MultipleAudiencesItem.md) | | + +## Methods + +### GetAccountId + +`func (o *MultipleAudiences) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *MultipleAudiences) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *MultipleAudiences) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *MultipleAudiences) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetAudiences + +`func (o *MultipleAudiences) GetAudiences() []MultipleAudiencesItem` + +GetAudiences returns the Audiences field if non-nil, zero value otherwise. + +### GetAudiencesOk + +`func (o *MultipleAudiences) GetAudiencesOk() ([]MultipleAudiencesItem, bool)` + +GetAudiencesOk returns a tuple with the Audiences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudiences + +`func (o *MultipleAudiences) HasAudiences() bool` + +HasAudiences returns a boolean if a field has been set. + +### SetAudiences + +`func (o *MultipleAudiences) SetAudiences(v []MultipleAudiencesItem)` + +SetAudiences gets a reference to the given []MultipleAudiencesItem and assigns it to the Audiences field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleAudiencesItem.md b/docs/MultipleAudiencesItem.md new file mode 100644 index 00000000..b0e82173 --- /dev/null +++ b/docs/MultipleAudiencesItem.md @@ -0,0 +1,143 @@ +# MultipleAudiencesItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**Name** | Pointer to **string** | The human-friendly display name for this audience. | +**IntegrationId** | Pointer to **string** | The ID of this audience in the third-party integration. | +**Status** | Pointer to **string** | Indicates whether the audience is new, updated or unmodified by the request. | + +## Methods + +### GetId + +`func (o *MultipleAudiencesItem) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultipleAudiencesItem) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *MultipleAudiencesItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *MultipleAudiencesItem) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *MultipleAudiencesItem) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultipleAudiencesItem) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *MultipleAudiencesItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *MultipleAudiencesItem) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetName + +`func (o *MultipleAudiencesItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultipleAudiencesItem) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *MultipleAudiencesItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *MultipleAudiencesItem) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetIntegrationId + +`func (o *MultipleAudiencesItem) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *MultipleAudiencesItem) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *MultipleAudiencesItem) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *MultipleAudiencesItem) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + +### GetStatus + +`func (o *MultipleAudiencesItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultipleAudiencesItem) GetStatusOk() (string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatus + +`func (o *MultipleAudiencesItem) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatus + +`func (o *MultipleAudiencesItem) SetStatus(v string)` + +SetStatus gets a reference to the given string and assigns it to the Status field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleCustomerProfileIntegrationRequestItem.md b/docs/MultipleCustomerProfileIntegrationRequestItem.md index 2b400f23..98949f60 100644 --- a/docs/MultipleCustomerProfileIntegrationRequestItem.md +++ b/docs/MultipleCustomerProfileIntegrationRequestItem.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] -**IntegrationId** | Pointer to **string** | The custom identifier for this profile, must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**IntegrationId** | Pointer to **string** | The identifier of this profile, set by your integration layer. It must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). | ## Methods diff --git a/docs/MultipleNewAttribute.md b/docs/MultipleNewAttribute.md new file mode 100644 index 00000000..c72808a5 --- /dev/null +++ b/docs/MultipleNewAttribute.md @@ -0,0 +1,39 @@ +# MultipleNewAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]NewAttribute**](NewAttribute.md) | | [optional] + +## Methods + +### GetAttributes + +`func (o *MultipleNewAttribute) GetAttributes() []NewAttribute` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MultipleNewAttribute) GetAttributesOk() ([]NewAttribute, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *MultipleNewAttribute) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *MultipleNewAttribute) SetAttributes(v []NewAttribute)` + +SetAttributes gets a reference to the given []NewAttribute and assigns it to the Attributes field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleNewAudiences.md b/docs/MultipleNewAudiences.md new file mode 100644 index 00000000..da39e957 --- /dev/null +++ b/docs/MultipleNewAudiences.md @@ -0,0 +1,39 @@ +# MultipleNewAudiences + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Audiences** | Pointer to [**[]NewMultipleAudiencesItem**](NewMultipleAudiencesItem.md) | | + +## Methods + +### GetAudiences + +`func (o *MultipleNewAudiences) GetAudiences() []NewMultipleAudiencesItem` + +GetAudiences returns the Audiences field if non-nil, zero value otherwise. + +### GetAudiencesOk + +`func (o *MultipleNewAudiences) GetAudiencesOk() ([]NewMultipleAudiencesItem, bool)` + +GetAudiencesOk returns a tuple with the Audiences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudiences + +`func (o *MultipleNewAudiences) HasAudiences() bool` + +HasAudiences returns a boolean if a field has been set. + +### SetAudiences + +`func (o *MultipleNewAudiences) SetAudiences(v []NewMultipleAudiencesItem)` + +SetAudiences gets a reference to the given []NewMultipleAudiencesItem and assigns it to the Audiences field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewAdditionalCost.md b/docs/NewAdditionalCost.md index 77c8645e..c3edbae2 100644 --- a/docs/NewAdditionalCost.md +++ b/docs/NewAdditionalCost.md @@ -7,7 +7,8 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. | **Title** | Pointer to **string** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | **Description** | Pointer to **string** | A description of this additional cost. | -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this additional cost | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional] +**Type** | Pointer to **string** | The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session. | [optional] [default to TYPE_SESSION] ## Methods @@ -111,6 +112,31 @@ HasSubscribedApplicationsIds returns a boolean if a field has been set. SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +### GetType + +`func (o *NewAdditionalCost) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NewAdditionalCost) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *NewAdditionalCost) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *NewAdditionalCost) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewApplication.md b/docs/NewApplication.md index 0821a095..e307ce80 100644 --- a/docs/NewApplication.md +++ b/docs/NewApplication.md @@ -7,18 +7,20 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | The name of this application. | **Description** | Pointer to **string** | A longer description of the application. | [optional] **Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | -**Currency** | Pointer to **string** | A string describing a default currency for new customer sessions. | -**CaseSensitivity** | Pointer to **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] -**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] -**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] -**DefaultDiscountScope** | Pointer to **string** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] -**EnableCascadingDiscounts** | Pointer to **bool** | Indicates if discounts should cascade for this application | [optional] -**EnableFlattenedCartItems** | Pointer to **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one | [optional] +**Currency** | Pointer to **string** | The default currency for new customer sessions. | +**CaseSensitivity** | Pointer to **string** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] +**CampaignPriority** | Pointer to **string** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional] [default to CAMPAIGN_PRIORITY_UNIVERSAL] +**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to EXCLUSIVE_CAMPAIGNS_STRATEGY_LIST_ORDER] +**DefaultDiscountScope** | Pointer to **string** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] +**EnableCascadingDiscounts** | Pointer to **bool** | Indicates if discounts should cascade for this Application. | [optional] +**EnableFlattenedCartItems** | Pointer to **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [optional] -**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox application | [optional] -**Key** | Pointer to **string** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional] +**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox Application. | [optional] +**EnablePartialDiscounts** | Pointer to **bool** | Indicates if this Application supports partial discounts. | [optional] +**DefaultDiscountAdditionalCostPerItemScope** | Pointer to **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] +**Key** | Pointer to **string** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits). | [optional] ## Methods @@ -372,6 +374,56 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetEnablePartialDiscounts + +`func (o *NewApplication) GetEnablePartialDiscounts() bool` + +GetEnablePartialDiscounts returns the EnablePartialDiscounts field if non-nil, zero value otherwise. + +### GetEnablePartialDiscountsOk + +`func (o *NewApplication) GetEnablePartialDiscountsOk() (bool, bool)` + +GetEnablePartialDiscountsOk returns a tuple with the EnablePartialDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnablePartialDiscounts + +`func (o *NewApplication) HasEnablePartialDiscounts() bool` + +HasEnablePartialDiscounts returns a boolean if a field has been set. + +### SetEnablePartialDiscounts + +`func (o *NewApplication) SetEnablePartialDiscounts(v bool)` + +SetEnablePartialDiscounts gets a reference to the given bool and assigns it to the EnablePartialDiscounts field. + +### GetDefaultDiscountAdditionalCostPerItemScope + +`func (o *NewApplication) GetDefaultDiscountAdditionalCostPerItemScope() string` + +GetDefaultDiscountAdditionalCostPerItemScope returns the DefaultDiscountAdditionalCostPerItemScope field if non-nil, zero value otherwise. + +### GetDefaultDiscountAdditionalCostPerItemScopeOk + +`func (o *NewApplication) GetDefaultDiscountAdditionalCostPerItemScopeOk() (string, bool)` + +GetDefaultDiscountAdditionalCostPerItemScopeOk returns a tuple with the DefaultDiscountAdditionalCostPerItemScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultDiscountAdditionalCostPerItemScope + +`func (o *NewApplication) HasDefaultDiscountAdditionalCostPerItemScope() bool` + +HasDefaultDiscountAdditionalCostPerItemScope returns a boolean if a field has been set. + +### SetDefaultDiscountAdditionalCostPerItemScope + +`func (o *NewApplication) SetDefaultDiscountAdditionalCostPerItemScope(v string)` + +SetDefaultDiscountAdditionalCostPerItemScope gets a reference to the given string and assigns it to the DefaultDiscountAdditionalCostPerItemScope field. + ### GetKey `func (o *NewApplication) GetKey() string` diff --git a/docs/NewApplicationApiKey.md b/docs/NewApplicationApiKey.md index 0d86077e..7e27ebb7 100644 --- a/docs/NewApplicationApiKey.md +++ b/docs/NewApplicationApiKey.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Title** | Pointer to **string** | Title for API Key | -**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | -**Platform** | Pointer to **string** | Platform the API key is valid for. | [optional] -**Id** | Pointer to **int32** | ID of the API Key | -**CreatedBy** | Pointer to **int32** | ID of user who created | -**AccountID** | Pointer to **int32** | ID of account the key is used for | -**ApplicationID** | Pointer to **int32** | ID of application the key is used for | -**Created** | Pointer to [**time.Time**](time.Time.md) | The date the API key was created | -**Key** | Pointer to **string** | Raw API Key | +**Title** | Pointer to **string** | Title for API Key. | +**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired. | +**Platform** | Pointer to **string** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional] +**Id** | Pointer to **int32** | ID of the API Key. | +**CreatedBy** | Pointer to **int32** | ID of user who created. | +**AccountID** | Pointer to **int32** | ID of account the key is used for. | +**ApplicationID** | Pointer to **int32** | ID of application the key is used for. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The date the API key was created. | +**Key** | Pointer to **string** | The API key. | ## Methods diff --git a/docs/NewAttribute.md b/docs/NewAttribute.md index 8524766d..84a72c3c 100644 --- a/docs/NewAttribute.md +++ b/docs/NewAttribute.md @@ -11,8 +11,12 @@ Name | Type | Description | Notes **Type** | Pointer to **string** | The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. | **Description** | Pointer to **string** | A description of this attribute. | **Suggestions** | Pointer to **[]string** | A list of suggestions for the attribute. | +**HasAllowedList** | Pointer to **bool** | Whether or not this attribute has an allowed list of values associated with it. | [optional] [default to false] +**RestrictedBySuggestions** | Pointer to **bool** | Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). | [optional] [default to false] **Editable** | Pointer to **bool** | Whether or not this attribute can be edited. | -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this attribute | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications where this attribute is available. | [optional] +**SubscribedCatalogsIds** | Pointer to **[]int32** | A list of the IDs of the catalogs where this attribute is available. | [optional] +**AllowedSubscriptions** | Pointer to **[]string** | A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. | [optional] ## Methods @@ -191,6 +195,56 @@ HasSuggestions returns a boolean if a field has been set. SetSuggestions gets a reference to the given []string and assigns it to the Suggestions field. +### GetHasAllowedList + +`func (o *NewAttribute) GetHasAllowedList() bool` + +GetHasAllowedList returns the HasAllowedList field if non-nil, zero value otherwise. + +### GetHasAllowedListOk + +`func (o *NewAttribute) GetHasAllowedListOk() (bool, bool)` + +GetHasAllowedListOk returns a tuple with the HasAllowedList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasAllowedList + +`func (o *NewAttribute) HasHasAllowedList() bool` + +HasHasAllowedList returns a boolean if a field has been set. + +### SetHasAllowedList + +`func (o *NewAttribute) SetHasAllowedList(v bool)` + +SetHasAllowedList gets a reference to the given bool and assigns it to the HasAllowedList field. + +### GetRestrictedBySuggestions + +`func (o *NewAttribute) GetRestrictedBySuggestions() bool` + +GetRestrictedBySuggestions returns the RestrictedBySuggestions field if non-nil, zero value otherwise. + +### GetRestrictedBySuggestionsOk + +`func (o *NewAttribute) GetRestrictedBySuggestionsOk() (bool, bool)` + +GetRestrictedBySuggestionsOk returns a tuple with the RestrictedBySuggestions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRestrictedBySuggestions + +`func (o *NewAttribute) HasRestrictedBySuggestions() bool` + +HasRestrictedBySuggestions returns a boolean if a field has been set. + +### SetRestrictedBySuggestions + +`func (o *NewAttribute) SetRestrictedBySuggestions(v bool)` + +SetRestrictedBySuggestions gets a reference to the given bool and assigns it to the RestrictedBySuggestions field. + ### GetEditable `func (o *NewAttribute) GetEditable() bool` @@ -241,6 +295,56 @@ HasSubscribedApplicationsIds returns a boolean if a field has been set. SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +### GetSubscribedCatalogsIds + +`func (o *NewAttribute) GetSubscribedCatalogsIds() []int32` + +GetSubscribedCatalogsIds returns the SubscribedCatalogsIds field if non-nil, zero value otherwise. + +### GetSubscribedCatalogsIdsOk + +`func (o *NewAttribute) GetSubscribedCatalogsIdsOk() ([]int32, bool)` + +GetSubscribedCatalogsIdsOk returns a tuple with the SubscribedCatalogsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedCatalogsIds + +`func (o *NewAttribute) HasSubscribedCatalogsIds() bool` + +HasSubscribedCatalogsIds returns a boolean if a field has been set. + +### SetSubscribedCatalogsIds + +`func (o *NewAttribute) SetSubscribedCatalogsIds(v []int32)` + +SetSubscribedCatalogsIds gets a reference to the given []int32 and assigns it to the SubscribedCatalogsIds field. + +### GetAllowedSubscriptions + +`func (o *NewAttribute) GetAllowedSubscriptions() []string` + +GetAllowedSubscriptions returns the AllowedSubscriptions field if non-nil, zero value otherwise. + +### GetAllowedSubscriptionsOk + +`func (o *NewAttribute) GetAllowedSubscriptionsOk() ([]string, bool)` + +GetAllowedSubscriptionsOk returns a tuple with the AllowedSubscriptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAllowedSubscriptions + +`func (o *NewAttribute) HasAllowedSubscriptions() bool` + +HasAllowedSubscriptions returns a boolean if a field has been set. + +### SetAllowedSubscriptions + +`func (o *NewAttribute) SetAllowedSubscriptions(v []string)` + +SetAllowedSubscriptions gets a reference to the given []string and assigns it to the AllowedSubscriptions field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewAudience.md b/docs/NewAudience.md index db33bdb1..2b930658 100644 --- a/docs/NewAudience.md +++ b/docs/NewAudience.md @@ -4,9 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The human-friendly display name for this Audience. | -**Integration** | Pointer to **string** | Integration that this audience was created in. | -**IntegrationId** | Pointer to **string** | The ID of this Audience in the third-party integration | +**Name** | Pointer to **string** | The human-friendly display name for this audience. | +**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox Application. | [optional] +**Description** | Pointer to **string** | A description of the audience. | [optional] +**Integration** | Pointer to **string** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. | [optional] +**IntegrationId** | Pointer to **string** | The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. | [optional] +**CreatedIn3rdParty** | Pointer to **bool** | Determines if this audience is a 3rd party audience or not. | [optional] ## Methods @@ -35,6 +38,56 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. +### GetSandbox + +`func (o *NewAudience) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *NewAudience) GetSandboxOk() (bool, bool)` + +GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandbox + +`func (o *NewAudience) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *NewAudience) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + +### GetDescription + +`func (o *NewAudience) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewAudience) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewAudience) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewAudience) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetIntegration `func (o *NewAudience) GetIntegration() string` @@ -85,6 +138,31 @@ HasIntegrationId returns a boolean if a field has been set. SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. +### GetCreatedIn3rdParty + +`func (o *NewAudience) GetCreatedIn3rdParty() bool` + +GetCreatedIn3rdParty returns the CreatedIn3rdParty field if non-nil, zero value otherwise. + +### GetCreatedIn3rdPartyOk + +`func (o *NewAudience) GetCreatedIn3rdPartyOk() (bool, bool)` + +GetCreatedIn3rdPartyOk returns a tuple with the CreatedIn3rdParty field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedIn3rdParty + +`func (o *NewAudience) HasCreatedIn3rdParty() bool` + +HasCreatedIn3rdParty returns a boolean if a field has been set. + +### SetCreatedIn3rdParty + +`func (o *NewAudience) SetCreatedIn3rdParty(v bool)` + +SetCreatedIn3rdParty gets a reference to the given bool and assigns it to the CreatedIn3rdParty field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md index 8743e4c2..69c4d480 100644 --- a/docs/NewCampaign.md +++ b/docs/NewCampaign.md @@ -8,15 +8,15 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A detailed description of the campaign. | [optional] **StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] **EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp the campaign will become inactive. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] **State** | Pointer to **string** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to STATE_ENABLED] -**ActiveRulesetId** | Pointer to **int32** | ID of Ruleset this campaign applies on customer session evaluation. | [optional] +**ActiveRulesetId** | Pointer to **int32** | [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] **Tags** | Pointer to **[]string** | A list of tags for the campaign. | -**Features** | Pointer to **[]string** | A list of features for the campaign. | +**Features** | Pointer to **[]string** | The features enabled in this campaign. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign | -**CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. | +**CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. | [optional] ## Methods diff --git a/docs/NewCampaignCollection.md b/docs/NewCampaignCollection.md new file mode 100644 index 00000000..cb1486f1 --- /dev/null +++ b/docs/NewCampaignCollection.md @@ -0,0 +1,65 @@ +# NewCampaignCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] +**Name** | Pointer to **string** | The name of this collection. | + +## Methods + +### GetDescription + +`func (o *NewCampaignCollection) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewCampaignCollection) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewCampaignCollection) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewCampaignCollection) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetName + +`func (o *NewCampaignCollection) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewCampaignCollection) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewCampaignCollection) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewCampaignCollection) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewCampaignGroup.md b/docs/NewCampaignGroup.md index 05b87c9b..d5ff82d7 100644 --- a/docs/NewCampaignGroup.md +++ b/docs/NewCampaignGroup.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The name of this campaign group. | **Description** | Pointer to **string** | A longer description of the campaign group. | [optional] -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for | [optional] -**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for. | [optional] +**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns. | [optional] ## Methods diff --git a/docs/NewCampaignSet.md b/docs/NewCampaignSet.md index 8d7d2159..0f9d9306 100644 --- a/docs/NewCampaignSet.md +++ b/docs/NewCampaignSet.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**Version** | Pointer to **int32** | Version of the campaign set | +**Version** | Pointer to **int32** | Version of the campaign set. | **Set** | Pointer to [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | | ## Methods diff --git a/docs/NewCampaignSetV2.md b/docs/NewCampaignSetV2.md new file mode 100644 index 00000000..36bd5e8b --- /dev/null +++ b/docs/NewCampaignSetV2.md @@ -0,0 +1,91 @@ +# NewCampaignSetV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | +**Version** | Pointer to **int32** | Version of the campaign set. | +**Set** | Pointer to [**CampaignPrioritiesV2**](CampaignPrioritiesV2.md) | | + +## Methods + +### GetApplicationId + +`func (o *NewCampaignSetV2) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *NewCampaignSetV2) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *NewCampaignSetV2) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *NewCampaignSetV2) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetVersion + +`func (o *NewCampaignSetV2) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *NewCampaignSetV2) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *NewCampaignSetV2) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *NewCampaignSetV2) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetSet + +`func (o *NewCampaignSetV2) GetSet() CampaignPrioritiesV2` + +GetSet returns the Set field if non-nil, zero value otherwise. + +### GetSetOk + +`func (o *NewCampaignSetV2) GetSetOk() (CampaignPrioritiesV2, bool)` + +GetSetOk returns a tuple with the Set field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSet + +`func (o *NewCampaignSetV2) HasSet() bool` + +HasSet returns a boolean if a field has been set. + +### SetSet + +`func (o *NewCampaignSetV2) SetSet(v CampaignPrioritiesV2)` + +SetSet gets a reference to the given CampaignPrioritiesV2 and assigns it to the Set field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewCampaignTemplate.md b/docs/NewCampaignTemplate.md index ffe6dc95..2b708146 100644 --- a/docs/NewCampaignTemplate.md +++ b/docs/NewCampaignTemplate.md @@ -14,8 +14,10 @@ Name | Type | Description | Notes **Features** | Pointer to **[]string** | A list of features for the campaign template. | [optional] **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template | [optional] +**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template. | [optional] **TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | Template parameters are fields which can be used to replace values in a rule. | [optional] +**CampaignCollections** | Pointer to [**[]CampaignTemplateCollection**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional] +**DefaultCampaignGroupId** | Pointer to **int32** | The default campaignGroupId. | [optional] ## Methods @@ -319,6 +321,56 @@ HasTemplateParams returns a boolean if a field has been set. SetTemplateParams gets a reference to the given []CampaignTemplateParams and assigns it to the TemplateParams field. +### GetCampaignCollections + +`func (o *NewCampaignTemplate) GetCampaignCollections() []CampaignTemplateCollection` + +GetCampaignCollections returns the CampaignCollections field if non-nil, zero value otherwise. + +### GetCampaignCollectionsOk + +`func (o *NewCampaignTemplate) GetCampaignCollectionsOk() ([]CampaignTemplateCollection, bool)` + +GetCampaignCollectionsOk returns a tuple with the CampaignCollections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignCollections + +`func (o *NewCampaignTemplate) HasCampaignCollections() bool` + +HasCampaignCollections returns a boolean if a field has been set. + +### SetCampaignCollections + +`func (o *NewCampaignTemplate) SetCampaignCollections(v []CampaignTemplateCollection)` + +SetCampaignCollections gets a reference to the given []CampaignTemplateCollection and assigns it to the CampaignCollections field. + +### GetDefaultCampaignGroupId + +`func (o *NewCampaignTemplate) GetDefaultCampaignGroupId() int32` + +GetDefaultCampaignGroupId returns the DefaultCampaignGroupId field if non-nil, zero value otherwise. + +### GetDefaultCampaignGroupIdOk + +`func (o *NewCampaignTemplate) GetDefaultCampaignGroupIdOk() (int32, bool)` + +GetDefaultCampaignGroupIdOk returns a tuple with the DefaultCampaignGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultCampaignGroupId + +`func (o *NewCampaignTemplate) HasDefaultCampaignGroupId() bool` + +HasDefaultCampaignGroupId returns a boolean if a field has been set. + +### SetDefaultCampaignGroupId + +`func (o *NewCampaignTemplate) SetDefaultCampaignGroupId(v int32)` + +SetDefaultCampaignGroupId gets a reference to the given int32 and assigns it to the DefaultCampaignGroupId field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewCatalog.md b/docs/NewCatalog.md new file mode 100644 index 00000000..bc7ae046 --- /dev/null +++ b/docs/NewCatalog.md @@ -0,0 +1,91 @@ +# NewCatalog + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The cart item catalog name. | +**Description** | Pointer to **string** | A description of this cart item catalog. | +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this catalog. | [optional] + +## Methods + +### GetName + +`func (o *NewCatalog) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewCatalog) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewCatalog) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewCatalog) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *NewCatalog) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewCatalog) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewCatalog) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewCatalog) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *NewCatalog) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *NewCatalog) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *NewCatalog) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *NewCatalog) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewCollection.md b/docs/NewCollection.md index d4f0cf50..ff5c773a 100644 --- a/docs/NewCollection.md +++ b/docs/NewCollection.md @@ -4,60 +4,86 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name of this collection. | **Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the Applications where this collection is enabled. | [optional] +**Name** | Pointer to **string** | The name of this collection. | ## Methods -### GetName +### GetDescription -`func (o *NewCollection) GetName() string` +`func (o *NewCollection) GetDescription() string` -GetName returns the Name field if non-nil, zero value otherwise. +GetDescription returns the Description field if non-nil, zero value otherwise. -### GetNameOk +### GetDescriptionOk -`func (o *NewCollection) GetNameOk() (string, bool)` +`func (o *NewCollection) GetDescriptionOk() (string, bool)` -GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasName +### HasDescription -`func (o *NewCollection) HasName() bool` +`func (o *NewCollection) HasDescription() bool` -HasName returns a boolean if a field has been set. +HasDescription returns a boolean if a field has been set. -### SetName +### SetDescription -`func (o *NewCollection) SetName(v string)` +`func (o *NewCollection) SetDescription(v string)` -SetName gets a reference to the given string and assigns it to the Name field. +SetDescription gets a reference to the given string and assigns it to the Description field. -### GetDescription +### GetSubscribedApplicationsIds -`func (o *NewCollection) GetDescription() string` +`func (o *NewCollection) GetSubscribedApplicationsIds() []int32` -GetDescription returns the Description field if non-nil, zero value otherwise. +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. -### GetDescriptionOk +### GetSubscribedApplicationsIdsOk -`func (o *NewCollection) GetDescriptionOk() (string, bool)` +`func (o *NewCollection) GetSubscribedApplicationsIdsOk() ([]int32, bool)` -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasDescription +### HasSubscribedApplicationsIds -`func (o *NewCollection) HasDescription() bool` +`func (o *NewCollection) HasSubscribedApplicationsIds() bool` -HasDescription returns a boolean if a field has been set. +HasSubscribedApplicationsIds returns a boolean if a field has been set. -### SetDescription +### SetSubscribedApplicationsIds -`func (o *NewCollection) SetDescription(v string)` +`func (o *NewCollection) SetSubscribedApplicationsIds(v []int32)` -SetDescription gets a reference to the given string and assigns it to the Description field. +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetName + +`func (o *NewCollection) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewCollection) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewCollection) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewCollection) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewCouponCreationJob.md b/docs/NewCouponCreationJob.md index d4e328eb..d6c9e89b 100644 --- a/docs/NewCouponCreationJob.md +++ b/docs/NewCouponCreationJob.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] **NumberOfCoupons** | Pointer to **int32** | The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons. | ## Methods diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md index f7551ce8..a08401fe 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -4,16 +4,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **NumberOfCoupons** | Pointer to **int32** | The number of new coupon codes to generate for the campaign. Must be at least 1. | -**UniquePrefix** | Pointer to **string** | A unique prefix to prepend to all generated coupons. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] -**RecipientIntegrationId** | Pointer to **string** | The integration ID for this coupon's beneficiary's profile | [optional] -**ValidCharacters** | Pointer to **[]string** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] -**CouponPattern** | Pointer to **string** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | [optional] +**UniquePrefix** | Pointer to **string** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously endpoint](https://docs.talon.one/management-api/#operation/createCouponsAsync). | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**RecipientIntegrationId** | Pointer to **string** | The integration ID for this coupon's beneficiary's profile. | [optional] +**ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] +**CouponPattern** | Pointer to **string** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] ## Methods @@ -117,6 +118,31 @@ HasExpiryDate returns a boolean if a field has been set. SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +### GetLimits + +`func (o *NewCoupons) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *NewCoupons) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *NewCoupons) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *NewCoupons) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + ### GetNumberOfCoupons `func (o *NewCoupons) GetNumberOfCoupons() int32` diff --git a/docs/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md index 30209dde..07a992ab 100644 --- a/docs/NewCouponsForMultipleRecipients.md +++ b/docs/NewCouponsForMultipleRecipients.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] -**RecipientsIntegrationIds** | Pointer to **[]string** | The integration IDs for recipients | -**ValidCharacters** | Pointer to **[]string** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] -**CouponPattern** | Pointer to **string** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**RecipientsIntegrationIds** | Pointer to **[]string** | The integration IDs for recipients. | +**ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] +**CouponPattern** | Pointer to **string** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] ## Methods diff --git a/docs/NewCustomEffect.md b/docs/NewCustomEffect.md index 6aa6e15e..42529b52 100644 --- a/docs/NewCustomEffect.md +++ b/docs/NewCustomEffect.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **Payload** | Pointer to **string** | The JSON payload of this effect. | **Description** | Pointer to **string** | The description of this effect. | [optional] **Enabled** | Pointer to **bool** | Determines if this effect is active. | -**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions. | [optional] ## Methods diff --git a/docs/NewCustomerProfile.md b/docs/NewCustomerProfile.md index 8890a627..770b892f 100644 --- a/docs/NewCustomerProfile.md +++ b/docs/NewCustomerProfile.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] ## Methods diff --git a/docs/NewCustomerSession.md b/docs/NewCustomerSession.md index 5ead149c..6fe3cb4f 100644 --- a/docs/NewCustomerSession.md +++ b/docs/NewCustomerSession.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] **Coupon** | Pointer to **string** | Any coupon code entered. | [optional] **Referral** | Pointer to **string** | Any referral code entered. | [optional] -**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entities](/docs/dev/concepts/entities#customer-session). | [optional] [default to STATE_OPEN] +**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). | [optional] [default to STATE_OPEN] **CartItems** | Pointer to [**[]CartItem**](CartItem.md) | Serialized JSON representation. | [optional] -**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. | [optional] +**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). | [optional] **Total** | Pointer to **float32** | The total sum of the cart in one session. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | [optional] diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md index 4035dde4..78e791ba 100644 --- a/docs/NewCustomerSessionV2.md +++ b/docs/NewCustomerSessionV2.md @@ -4,14 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] -**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. | [optional] -**ReferralCode** | Pointer to **string** | Any referral code entered. | [optional] -**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entites](/docs/dev/concepts/entities#customer-session). | [optional] [default to STATE_OPEN] -**CartItems** | Pointer to [**[]CartItem**](CartItem.md) | All items the customer will be purchasing in this session | [optional] -**AdditionalCosts** | Pointer to [**map[string]AdditionalCost**](AdditionalCost.md) | Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees. | [optional] -**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | [optional] +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] +**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional] +**ReferralCode** | Pointer to **string** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional] +**LoyaltyCards** | Pointer to **[]string** | Any loyalty cards used. | [optional] +**State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). | [optional] [default to STATE_OPEN] +**CartItems** | Pointer to [**[]CartItem**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional] +**AdditionalCosts** | Pointer to [**map[string]AdditionalCost**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). | [optional] +**Identifiers** | Pointer to **[]string** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains an identifier by the time you close it. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional] ## Methods @@ -90,6 +91,31 @@ HasReferralCode returns a boolean if a field has been set. SetReferralCode gets a reference to the given string and assigns it to the ReferralCode field. +### GetLoyaltyCards + +`func (o *NewCustomerSessionV2) GetLoyaltyCards() []string` + +GetLoyaltyCards returns the LoyaltyCards field if non-nil, zero value otherwise. + +### GetLoyaltyCardsOk + +`func (o *NewCustomerSessionV2) GetLoyaltyCardsOk() ([]string, bool)` + +GetLoyaltyCardsOk returns a tuple with the LoyaltyCards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyaltyCards + +`func (o *NewCustomerSessionV2) HasLoyaltyCards() bool` + +HasLoyaltyCards returns a boolean if a field has been set. + +### SetLoyaltyCards + +`func (o *NewCustomerSessionV2) SetLoyaltyCards(v []string)` + +SetLoyaltyCards gets a reference to the given []string and assigns it to the LoyaltyCards field. + ### GetState `func (o *NewCustomerSessionV2) GetState() string` diff --git a/docs/NewEvent.md b/docs/NewEvent.md index 593ef6d1..a5cb252e 100644 --- a/docs/NewEvent.md +++ b/docs/NewEvent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] +**ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] **Type** | Pointer to **string** | A string representing the event. Must not be a reserved event name. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON data associated with the event. | **SessionId** | Pointer to **string** | The ID of the session that this event occurred in. | diff --git a/docs/NewEventType.md b/docs/NewEventType.md index e93ec6ba..8eddb1b7 100644 --- a/docs/NewEventType.md +++ b/docs/NewEventType.md @@ -4,44 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | **Title** | Pointer to **string** | The human-friendly display name for this event type. Use a short, past-tense, description of the event. | **Name** | Pointer to **string** | The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created. | -**Description** | Pointer to **string** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. | -**MimeType** | Pointer to **string** | This defines how the request payload will be parsed before your handler code is run. | -**ExamplePayload** | Pointer to **string** | It is often helpful to include an example payload with the event type definition for documentation purposes. | [optional] -**Schema** | Pointer to [**map[string]interface{}**](.md) | It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. | [optional] -**HandlerLanguage** | Pointer to **string** | The language of the handler code. Currently only `\"talang\"` is supported. | [optional] -**Handler** | Pointer to **string** | Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules. | -**Version** | Pointer to **int32** | The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. | +**Description** | Pointer to **string** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. | [optional] ## Methods -### GetApplicationIds - -`func (o *NewEventType) GetApplicationIds() []int32` - -GetApplicationIds returns the ApplicationIds field if non-nil, zero value otherwise. - -### GetApplicationIdsOk - -`func (o *NewEventType) GetApplicationIdsOk() ([]int32, bool)` - -GetApplicationIdsOk returns a tuple with the ApplicationIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationIds - -`func (o *NewEventType) HasApplicationIds() bool` - -HasApplicationIds returns a boolean if a field has been set. - -### SetApplicationIds - -`func (o *NewEventType) SetApplicationIds(v []int32)` - -SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds field. - ### GetTitle `func (o *NewEventType) GetTitle() string` @@ -117,156 +85,6 @@ HasDescription returns a boolean if a field has been set. SetDescription gets a reference to the given string and assigns it to the Description field. -### GetMimeType - -`func (o *NewEventType) GetMimeType() string` - -GetMimeType returns the MimeType field if non-nil, zero value otherwise. - -### GetMimeTypeOk - -`func (o *NewEventType) GetMimeTypeOk() (string, bool)` - -GetMimeTypeOk returns a tuple with the MimeType field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasMimeType - -`func (o *NewEventType) HasMimeType() bool` - -HasMimeType returns a boolean if a field has been set. - -### SetMimeType - -`func (o *NewEventType) SetMimeType(v string)` - -SetMimeType gets a reference to the given string and assigns it to the MimeType field. - -### GetExamplePayload - -`func (o *NewEventType) GetExamplePayload() string` - -GetExamplePayload returns the ExamplePayload field if non-nil, zero value otherwise. - -### GetExamplePayloadOk - -`func (o *NewEventType) GetExamplePayloadOk() (string, bool)` - -GetExamplePayloadOk returns a tuple with the ExamplePayload field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasExamplePayload - -`func (o *NewEventType) HasExamplePayload() bool` - -HasExamplePayload returns a boolean if a field has been set. - -### SetExamplePayload - -`func (o *NewEventType) SetExamplePayload(v string)` - -SetExamplePayload gets a reference to the given string and assigns it to the ExamplePayload field. - -### GetSchema - -`func (o *NewEventType) GetSchema() map[string]interface{}` - -GetSchema returns the Schema field if non-nil, zero value otherwise. - -### GetSchemaOk - -`func (o *NewEventType) GetSchemaOk() (map[string]interface{}, bool)` - -GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSchema - -`func (o *NewEventType) HasSchema() bool` - -HasSchema returns a boolean if a field has been set. - -### SetSchema - -`func (o *NewEventType) SetSchema(v map[string]interface{})` - -SetSchema gets a reference to the given map[string]interface{} and assigns it to the Schema field. - -### GetHandlerLanguage - -`func (o *NewEventType) GetHandlerLanguage() string` - -GetHandlerLanguage returns the HandlerLanguage field if non-nil, zero value otherwise. - -### GetHandlerLanguageOk - -`func (o *NewEventType) GetHandlerLanguageOk() (string, bool)` - -GetHandlerLanguageOk returns a tuple with the HandlerLanguage field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasHandlerLanguage - -`func (o *NewEventType) HasHandlerLanguage() bool` - -HasHandlerLanguage returns a boolean if a field has been set. - -### SetHandlerLanguage - -`func (o *NewEventType) SetHandlerLanguage(v string)` - -SetHandlerLanguage gets a reference to the given string and assigns it to the HandlerLanguage field. - -### GetHandler - -`func (o *NewEventType) GetHandler() string` - -GetHandler returns the Handler field if non-nil, zero value otherwise. - -### GetHandlerOk - -`func (o *NewEventType) GetHandlerOk() (string, bool)` - -GetHandlerOk returns a tuple with the Handler field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasHandler - -`func (o *NewEventType) HasHandler() bool` - -HasHandler returns a boolean if a field has been set. - -### SetHandler - -`func (o *NewEventType) SetHandler(v string)` - -SetHandler gets a reference to the given string and assigns it to the Handler field. - -### GetVersion - -`func (o *NewEventType) GetVersion() int32` - -GetVersion returns the Version field if non-nil, zero value otherwise. - -### GetVersionOk - -`func (o *NewEventType) GetVersionOk() (int32, bool)` - -GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasVersion - -`func (o *NewEventType) HasVersion() bool` - -HasVersion returns a boolean if a field has been set. - -### SetVersion - -`func (o *NewEventType) SetVersion(v int32)` - -SetVersion gets a reference to the given int32 and assigns it to the Version field. - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewFeatureFlags.md b/docs/NewFeatureFlags.md deleted file mode 100644 index c4ef1db3..00000000 --- a/docs/NewFeatureFlags.md +++ /dev/null @@ -1,91 +0,0 @@ -# NewFeatureFlags - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Loyalty** | Pointer to **bool** | Whether the account has access to the loyalty features or not | [optional] -**CouponsWithoutCount** | Pointer to **bool** | Whether the account queries coupons with or without total result size | [optional] -**BetaEffects** | Pointer to **bool** | Whether the account can test beta effects or not | [optional] - -## Methods - -### GetLoyalty - -`func (o *NewFeatureFlags) GetLoyalty() bool` - -GetLoyalty returns the Loyalty field if non-nil, zero value otherwise. - -### GetLoyaltyOk - -`func (o *NewFeatureFlags) GetLoyaltyOk() (bool, bool)` - -GetLoyaltyOk returns a tuple with the Loyalty field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLoyalty - -`func (o *NewFeatureFlags) HasLoyalty() bool` - -HasLoyalty returns a boolean if a field has been set. - -### SetLoyalty - -`func (o *NewFeatureFlags) SetLoyalty(v bool)` - -SetLoyalty gets a reference to the given bool and assigns it to the Loyalty field. - -### GetCouponsWithoutCount - -`func (o *NewFeatureFlags) GetCouponsWithoutCount() bool` - -GetCouponsWithoutCount returns the CouponsWithoutCount field if non-nil, zero value otherwise. - -### GetCouponsWithoutCountOk - -`func (o *NewFeatureFlags) GetCouponsWithoutCountOk() (bool, bool)` - -GetCouponsWithoutCountOk returns a tuple with the CouponsWithoutCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponsWithoutCount - -`func (o *NewFeatureFlags) HasCouponsWithoutCount() bool` - -HasCouponsWithoutCount returns a boolean if a field has been set. - -### SetCouponsWithoutCount - -`func (o *NewFeatureFlags) SetCouponsWithoutCount(v bool)` - -SetCouponsWithoutCount gets a reference to the given bool and assigns it to the CouponsWithoutCount field. - -### GetBetaEffects - -`func (o *NewFeatureFlags) GetBetaEffects() bool` - -GetBetaEffects returns the BetaEffects field if non-nil, zero value otherwise. - -### GetBetaEffectsOk - -`func (o *NewFeatureFlags) GetBetaEffectsOk() (bool, bool)` - -GetBetaEffectsOk returns a tuple with the BetaEffects field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasBetaEffects - -`func (o *NewFeatureFlags) HasBetaEffects() bool` - -HasBetaEffects returns a boolean if a field has been set. - -### SetBetaEffects - -`func (o *NewFeatureFlags) SetBetaEffects(v bool)` - -SetBetaEffects gets a reference to the given bool and assigns it to the BetaEffects field. - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NewGiveawaysPool.md b/docs/NewGiveawaysPool.md index c1b8da2b..9d15d190 100644 --- a/docs/NewGiveawaysPool.md +++ b/docs/NewGiveawaysPool.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The name of this giveaways pool. | **Description** | Pointer to **string** | The description of this giveaways pool. | [optional] -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this giveaways pool is enabled for | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this giveaways pool is enabled for. | [optional] ## Methods diff --git a/docs/NewInternalAudience.md b/docs/NewInternalAudience.md new file mode 100644 index 00000000..4bc2010c --- /dev/null +++ b/docs/NewInternalAudience.md @@ -0,0 +1,91 @@ +# NewInternalAudience + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The human-friendly display name for this audience. | +**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox Application. | [optional] +**Description** | Pointer to **string** | A description of the audience. | [optional] + +## Methods + +### GetName + +`func (o *NewInternalAudience) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewInternalAudience) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewInternalAudience) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewInternalAudience) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetSandbox + +`func (o *NewInternalAudience) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *NewInternalAudience) GetSandboxOk() (bool, bool)` + +GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandbox + +`func (o *NewInternalAudience) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *NewInternalAudience) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + +### GetDescription + +`func (o *NewInternalAudience) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewInternalAudience) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewInternalAudience) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewInternalAudience) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewInvitation.md b/docs/NewInvitation.md index f6cd9fea..9376329b 100644 --- a/docs/NewInvitation.md +++ b/docs/NewInvitation.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | Name of the user being invited. | [optional] **Email** | Pointer to **string** | | -**Acl** | Pointer to **string** | a blob of acl json | -**Roles** | Pointer to **[]int32** | An array of roleIDs to assign the new user to | [optional] +**Acl** | Pointer to **string** | The `Access Control List` json defining the role of the user. This represents the actual access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` | +**Roles** | Pointer to **[]int32** | An array of roleIDs to assign the new user to. | [optional] ## Methods diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md index 6cb16029..5d1242b6 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -9,10 +9,12 @@ Name | Type | Description | Notes **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] **DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | **DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | -**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | -**Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | [optional] +**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | +**UsersPerCardLimit** | Pointer to **int32** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] **Name** | Pointer to **string** | The internal name for the Loyalty Program. This is an immutable value. | -**Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program | [optional] +**Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] +**Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | +**CardBased** | Pointer to **bool** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false] ## Methods @@ -166,30 +168,30 @@ HasAllowSubledger returns a boolean if a field has been set. SetAllowSubledger gets a reference to the given bool and assigns it to the AllowSubledger field. -### GetTimezone +### GetUsersPerCardLimit -`func (o *NewLoyaltyProgram) GetTimezone() string` +`func (o *NewLoyaltyProgram) GetUsersPerCardLimit() int32` -GetTimezone returns the Timezone field if non-nil, zero value otherwise. +GetUsersPerCardLimit returns the UsersPerCardLimit field if non-nil, zero value otherwise. -### GetTimezoneOk +### GetUsersPerCardLimitOk -`func (o *NewLoyaltyProgram) GetTimezoneOk() (string, bool)` +`func (o *NewLoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool)` -GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTimezone +### HasUsersPerCardLimit -`func (o *NewLoyaltyProgram) HasTimezone() bool` +`func (o *NewLoyaltyProgram) HasUsersPerCardLimit() bool` -HasTimezone returns a boolean if a field has been set. +HasUsersPerCardLimit returns a boolean if a field has been set. -### SetTimezone +### SetUsersPerCardLimit -`func (o *NewLoyaltyProgram) SetTimezone(v string)` +`func (o *NewLoyaltyProgram) SetUsersPerCardLimit(v int32)` -SetTimezone gets a reference to the given string and assigns it to the Timezone field. +SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. ### GetName @@ -241,6 +243,56 @@ HasTiers returns a boolean if a field has been set. SetTiers gets a reference to the given []NewLoyaltyTier and assigns it to the Tiers field. +### GetTimezone + +`func (o *NewLoyaltyProgram) GetTimezone() string` + +GetTimezone returns the Timezone field if non-nil, zero value otherwise. + +### GetTimezoneOk + +`func (o *NewLoyaltyProgram) GetTimezoneOk() (string, bool)` + +GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTimezone + +`func (o *NewLoyaltyProgram) HasTimezone() bool` + +HasTimezone returns a boolean if a field has been set. + +### SetTimezone + +`func (o *NewLoyaltyProgram) SetTimezone(v string)` + +SetTimezone gets a reference to the given string and assigns it to the Timezone field. + +### GetCardBased + +`func (o *NewLoyaltyProgram) GetCardBased() bool` + +GetCardBased returns the CardBased field if non-nil, zero value otherwise. + +### GetCardBasedOk + +`func (o *NewLoyaltyProgram) GetCardBasedOk() (bool, bool)` + +GetCardBasedOk returns a tuple with the CardBased field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardBased + +`func (o *NewLoyaltyProgram) HasCardBased() bool` + +HasCardBased returns a boolean if a field has been set. + +### SetCardBased + +`func (o *NewLoyaltyProgram) SetCardBased(v bool)` + +SetCardBased gets a reference to the given bool and assigns it to the CardBased field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewLoyaltyTier.md b/docs/NewLoyaltyTier.md index a878a2f7..da302d23 100644 --- a/docs/NewLoyaltyTier.md +++ b/docs/NewLoyaltyTier.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The name of the tier | -**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier | +**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier. | ## Methods diff --git a/docs/NewManagementKey.md b/docs/NewManagementKey.md new file mode 100644 index 00000000..479a8425 --- /dev/null +++ b/docs/NewManagementKey.md @@ -0,0 +1,221 @@ +# NewManagementKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name for management key. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | The date the management key expires. | +**Endpoints** | Pointer to [**[]Endpoint**](Endpoint.md) | The list of endpoints that can be accessed with the key | +**Id** | Pointer to **int32** | ID of the management key. | +**CreatedBy** | Pointer to **int32** | ID of the user who created it. | +**AccountID** | Pointer to **int32** | ID of account the key is used for. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The date the management key was created. | +**Key** | Pointer to **string** | The management key. | + +## Methods + +### GetName + +`func (o *NewManagementKey) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewManagementKey) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewManagementKey) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewManagementKey) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetExpiryDate + +`func (o *NewManagementKey) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *NewManagementKey) GetExpiryDateOk() (time.Time, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *NewManagementKey) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *NewManagementKey) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetEndpoints + +`func (o *NewManagementKey) GetEndpoints() []Endpoint` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *NewManagementKey) GetEndpointsOk() ([]Endpoint, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndpoints + +`func (o *NewManagementKey) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### SetEndpoints + +`func (o *NewManagementKey) SetEndpoints(v []Endpoint)` + +SetEndpoints gets a reference to the given []Endpoint and assigns it to the Endpoints field. + +### GetId + +`func (o *NewManagementKey) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NewManagementKey) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *NewManagementKey) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *NewManagementKey) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreatedBy + +`func (o *NewManagementKey) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *NewManagementKey) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *NewManagementKey) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *NewManagementKey) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetAccountID + +`func (o *NewManagementKey) GetAccountID() int32` + +GetAccountID returns the AccountID field if non-nil, zero value otherwise. + +### GetAccountIDOk + +`func (o *NewManagementKey) GetAccountIDOk() (int32, bool)` + +GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountID + +`func (o *NewManagementKey) HasAccountID() bool` + +HasAccountID returns a boolean if a field has been set. + +### SetAccountID + +`func (o *NewManagementKey) SetAccountID(v int32)` + +SetAccountID gets a reference to the given int32 and assigns it to the AccountID field. + +### GetCreated + +`func (o *NewManagementKey) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NewManagementKey) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *NewManagementKey) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *NewManagementKey) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetKey + +`func (o *NewManagementKey) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *NewManagementKey) GetKeyOk() (string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasKey + +`func (o *NewManagementKey) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKey + +`func (o *NewManagementKey) SetKey(v string)` + +SetKey gets a reference to the given string and assigns it to the Key field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewMultipleAudiencesItem.md b/docs/NewMultipleAudiencesItem.md new file mode 100644 index 00000000..6d51001e --- /dev/null +++ b/docs/NewMultipleAudiencesItem.md @@ -0,0 +1,65 @@ +# NewMultipleAudiencesItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The human-friendly display name for this audience. | +**IntegrationId** | Pointer to **string** | The ID of this audience in the third-party integration. | [optional] + +## Methods + +### GetName + +`func (o *NewMultipleAudiencesItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewMultipleAudiencesItem) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewMultipleAudiencesItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewMultipleAudiencesItem) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetIntegrationId + +`func (o *NewMultipleAudiencesItem) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *NewMultipleAudiencesItem) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *NewMultipleAudiencesItem) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *NewMultipleAudiencesItem) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewNotificationWebhook.md b/docs/NewNotificationWebhook.md new file mode 100644 index 00000000..43d9c935 --- /dev/null +++ b/docs/NewNotificationWebhook.md @@ -0,0 +1,65 @@ +# NewNotificationWebhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | Pointer to **string** | API url for this notification webhook. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for this notification webhook. | + +## Methods + +### GetUrl + +`func (o *NewNotificationWebhook) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *NewNotificationWebhook) GetUrlOk() (string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUrl + +`func (o *NewNotificationWebhook) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### SetUrl + +`func (o *NewNotificationWebhook) SetUrl(v string)` + +SetUrl gets a reference to the given string and assigns it to the Url field. + +### GetHeaders + +`func (o *NewNotificationWebhook) GetHeaders() []string` + +GetHeaders returns the Headers field if non-nil, zero value otherwise. + +### GetHeadersOk + +`func (o *NewNotificationWebhook) GetHeadersOk() ([]string, bool)` + +GetHeadersOk returns a tuple with the Headers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHeaders + +`func (o *NewNotificationWebhook) HasHeaders() bool` + +HasHeaders returns a boolean if a field has been set. + +### SetHeaders + +`func (o *NewNotificationWebhook) SetHeaders(v []string)` + +SetHeaders gets a reference to the given []string and assigns it to the Headers field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewReferral.md b/docs/NewReferral.md index 68f22f9b..a8c4f614 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] -**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional] **CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | -**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] ## Methods diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md index 3ae07d32..c5c97cc4 100644 --- a/docs/NewReferralsForMultipleAdvocates.md +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] -**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | **CampaignId** | Pointer to **int32** | The ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationIds** | Pointer to **[]string** | An array containing all the respective advocate profiles. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] -**ValidCharacters** | Pointer to **[]string** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] -**ReferralPattern** | Pointer to **string** | The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | [optional] +**ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] +**ReferralPattern** | Pointer to **string** | The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] ## Methods diff --git a/docs/NewReturn.md b/docs/NewReturn.md new file mode 100644 index 00000000..9e677a55 --- /dev/null +++ b/docs/NewReturn.md @@ -0,0 +1,39 @@ +# NewReturn + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReturnedCartItems** | Pointer to [**[]ReturnedCartItem**](ReturnedCartItem.md) | List of cart items to be returned. | + +## Methods + +### GetReturnedCartItems + +`func (o *NewReturn) GetReturnedCartItems() []ReturnedCartItem` + +GetReturnedCartItems returns the ReturnedCartItems field if non-nil, zero value otherwise. + +### GetReturnedCartItemsOk + +`func (o *NewReturn) GetReturnedCartItemsOk() ([]ReturnedCartItem, bool)` + +GetReturnedCartItemsOk returns a tuple with the ReturnedCartItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReturnedCartItems + +`func (o *NewReturn) HasReturnedCartItems() bool` + +HasReturnedCartItems returns a boolean if a field has been set. + +### SetReturnedCartItems + +`func (o *NewReturn) SetReturnedCartItems(v []ReturnedCartItem)` + +SetReturnedCartItems gets a reference to the given []ReturnedCartItem and assigns it to the ReturnedCartItems field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewRole.md b/docs/NewRole.md index a3884089..5e980f65 100644 --- a/docs/NewRole.md +++ b/docs/NewRole.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | Name of the role | -**Description** | Pointer to **string** | Description of the role | [optional] -**Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json | -**Members** | Pointer to **[]int32** | An array of user identifiers | +**Name** | Pointer to **string** | Name of the role. | +**Description** | Pointer to **string** | Description of the role. | [optional] +**Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json. | +**Members** | Pointer to **[]int32** | An array of user identifiers. | ## Methods diff --git a/docs/NewRuleset.md b/docs/NewRuleset.md index bc879813..8134cb16 100644 --- a/docs/NewRuleset.md +++ b/docs/NewRuleset.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Rules** | Pointer to [**[]Rule**](Rule.md) | Set of rules to apply. | **Bindings** | Pointer to [**[]Binding**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | -**RbVersion** | Pointer to **string** | A string indicating which version of the rulebuilder was used to create this ruleset. | [optional] -**Activate** | Pointer to **bool** | A boolean indicating whether this newly created ruleset should also be activated for the campaign that owns it | [optional] +**RbVersion** | Pointer to **string** | The version of the rulebuilder used to create this ruleset. | [optional] +**Activate** | Pointer to **bool** | Indicates whether this created ruleset should be activated for the campaign that owns it. | [optional] ## Methods diff --git a/docs/NewWebhook.md b/docs/NewWebhook.md index 2d535256..f2b363e3 100644 --- a/docs/NewWebhook.md +++ b/docs/NewWebhook.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | -**Title** | Pointer to **string** | Friendly title for this webhook | -**Verb** | Pointer to **string** | API method for this webhook | -**Url** | Pointer to **string** | API url (supports templating using parameters) for this webhook | -**Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook | -**Payload** | Pointer to **string** | API payload (supports templating using parameters) for this webhook | [optional] -**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | -**Enabled** | Pointer to **bool** | Enables or disables webhook from showing in rule builder | +**Title** | Pointer to **string** | Friendly title for this webhook. | +**Verb** | Pointer to **string** | API method for this webhook. | +**Url** | Pointer to **string** | API url (supports templating using parameters) for this webhook. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook. | +**Payload** | Pointer to **string** | API payload (supports templating using parameters) for this webhook. | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions. | +**Enabled** | Pointer to **bool** | Enables or disables webhook from showing in rule builder. | ## Methods diff --git a/docs/Notification.md b/docs/Notification.md index 253a94a2..f8070e33 100644 --- a/docs/Notification.md +++ b/docs/Notification.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | id of the notification | -**Name** | Pointer to **string** | name of the notification | -**Description** | Pointer to **string** | description of the notification | +**Id** | Pointer to **int32** | id of the notification. | +**Name** | Pointer to **string** | name of the notification. | +**Description** | Pointer to **string** | description of the notification. | ## Methods diff --git a/docs/NotificationWebhook.md b/docs/NotificationWebhook.md new file mode 100644 index 00000000..631aadf9 --- /dev/null +++ b/docs/NotificationWebhook.md @@ -0,0 +1,169 @@ +# NotificationWebhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | +**Url** | Pointer to **string** | API url for this notification webhook. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for this notification webhook. | + +## Methods + +### GetId + +`func (o *NotificationWebhook) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NotificationWebhook) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *NotificationWebhook) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *NotificationWebhook) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *NotificationWebhook) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NotificationWebhook) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *NotificationWebhook) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *NotificationWebhook) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetModified + +`func (o *NotificationWebhook) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NotificationWebhook) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *NotificationWebhook) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *NotificationWebhook) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetApplicationId + +`func (o *NotificationWebhook) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *NotificationWebhook) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *NotificationWebhook) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *NotificationWebhook) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetUrl + +`func (o *NotificationWebhook) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *NotificationWebhook) GetUrlOk() (string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUrl + +`func (o *NotificationWebhook) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### SetUrl + +`func (o *NotificationWebhook) SetUrl(v string)` + +SetUrl gets a reference to the given string and assigns it to the Url field. + +### GetHeaders + +`func (o *NotificationWebhook) GetHeaders() []string` + +GetHeaders returns the Headers field if non-nil, zero value otherwise. + +### GetHeadersOk + +`func (o *NotificationWebhook) GetHeadersOk() ([]string, bool)` + +GetHeadersOk returns a tuple with the Headers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHeaders + +`func (o *NotificationWebhook) HasHeaders() bool` + +HasHeaders returns a boolean if a field has been set. + +### SetHeaders + +`func (o *NotificationWebhook) SetHeaders(v []string)` + +SetHeaders gets a reference to the given []string and assigns it to the Headers field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PatchItemCatalogAction.md b/docs/PatchItemCatalogAction.md new file mode 100644 index 00000000..a7f6c3bb --- /dev/null +++ b/docs/PatchItemCatalogAction.md @@ -0,0 +1,117 @@ +# PatchItemCatalogAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sku** | Pointer to **string** | The unique SKU of the item to patch. | +**Price** | Pointer to **float32** | Price of the item. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | The attributes of the item to patch. | [optional] +**CreateIfNotExists** | Pointer to **bool** | Indicates whether to create an item if the SKU does not exist. | [optional] [default to false] + +## Methods + +### GetSku + +`func (o *PatchItemCatalogAction) GetSku() string` + +GetSku returns the Sku field if non-nil, zero value otherwise. + +### GetSkuOk + +`func (o *PatchItemCatalogAction) GetSkuOk() (string, bool)` + +GetSkuOk returns a tuple with the Sku field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSku + +`func (o *PatchItemCatalogAction) HasSku() bool` + +HasSku returns a boolean if a field has been set. + +### SetSku + +`func (o *PatchItemCatalogAction) SetSku(v string)` + +SetSku gets a reference to the given string and assigns it to the Sku field. + +### GetPrice + +`func (o *PatchItemCatalogAction) GetPrice() float32` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *PatchItemCatalogAction) GetPriceOk() (float32, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPrice + +`func (o *PatchItemCatalogAction) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + +### SetPrice + +`func (o *PatchItemCatalogAction) SetPrice(v float32)` + +SetPrice gets a reference to the given float32 and assigns it to the Price field. + +### GetAttributes + +`func (o *PatchItemCatalogAction) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PatchItemCatalogAction) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *PatchItemCatalogAction) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *PatchItemCatalogAction) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetCreateIfNotExists + +`func (o *PatchItemCatalogAction) GetCreateIfNotExists() bool` + +GetCreateIfNotExists returns the CreateIfNotExists field if non-nil, zero value otherwise. + +### GetCreateIfNotExistsOk + +`func (o *PatchItemCatalogAction) GetCreateIfNotExistsOk() (bool, bool)` + +GetCreateIfNotExistsOk returns a tuple with the CreateIfNotExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreateIfNotExists + +`func (o *PatchItemCatalogAction) HasCreateIfNotExists() bool` + +HasCreateIfNotExists returns a boolean if a field has been set. + +### SetCreateIfNotExists + +`func (o *PatchItemCatalogAction) SetCreateIfNotExists(v bool)` + +SetCreateIfNotExists gets a reference to the given bool and assigns it to the CreateIfNotExists field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PatchManyItemsCatalogAction.md b/docs/PatchManyItemsCatalogAction.md new file mode 100644 index 00000000..286cd807 --- /dev/null +++ b/docs/PatchManyItemsCatalogAction.md @@ -0,0 +1,91 @@ +# PatchManyItemsCatalogAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Price** | Pointer to **float32** | Price of the item. | [optional] +**Filters** | Pointer to [**[]CatalogActionFilter**](CatalogActionFilter.md) | The list of filters used to select the items to patch, joined by `AND`. **Note:** Every item in the catalog will be modified if there are no filters. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | The attributes of the items to patch. | [optional] + +## Methods + +### GetPrice + +`func (o *PatchManyItemsCatalogAction) GetPrice() float32` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *PatchManyItemsCatalogAction) GetPriceOk() (float32, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPrice + +`func (o *PatchManyItemsCatalogAction) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + +### SetPrice + +`func (o *PatchManyItemsCatalogAction) SetPrice(v float32)` + +SetPrice gets a reference to the given float32 and assigns it to the Price field. + +### GetFilters + +`func (o *PatchManyItemsCatalogAction) GetFilters() []CatalogActionFilter` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *PatchManyItemsCatalogAction) GetFiltersOk() ([]CatalogActionFilter, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFilters + +`func (o *PatchManyItemsCatalogAction) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFilters + +`func (o *PatchManyItemsCatalogAction) SetFilters(v []CatalogActionFilter)` + +SetFilters gets a reference to the given []CatalogActionFilter and assigns it to the Filters field. + +### GetAttributes + +`func (o *PatchManyItemsCatalogAction) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PatchManyItemsCatalogAction) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *PatchManyItemsCatalogAction) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *PatchManyItemsCatalogAction) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RedeemReferralEffectProps.md b/docs/RedeemReferralEffectProps.md index 8bce8021..020543dd 100644 --- a/docs/RedeemReferralEffectProps.md +++ b/docs/RedeemReferralEffectProps.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | The id of the referral code that was redeemed | -**Value** | Pointer to **string** | The referral code that was redeemed | +**Id** | Pointer to **int32** | The id of the referral code that was redeemed. | +**Value** | Pointer to **string** | The referral code that was redeemed. | ## Methods diff --git a/docs/Referral.md b/docs/Referral.md index 1a45752f..540b0e03 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -4,17 +4,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] -**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | **CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | -**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] **ImportId** | Pointer to **int32** | The ID of the Import which created this referral. | [optional] -**Code** | Pointer to **string** | The actual referral code. | +**Code** | Pointer to **string** | The referral code. | **UsageCounter** | Pointer to **int32** | The number of times this referral code has been successfully used. | **BatchId** | Pointer to **string** | The ID of the batch the referrals belong to. | [optional] diff --git a/docs/ReferralConstraints.md b/docs/ReferralConstraints.md index 5ebb2684..801bba9c 100644 --- a/docs/ReferralConstraints.md +++ b/docs/ReferralConstraints.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] -**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional] ## Methods diff --git a/docs/ReferralCreatedEffectProps.md b/docs/ReferralCreatedEffectProps.md index 620aaf05..1ce7e82f 100644 --- a/docs/ReferralCreatedEffectProps.md +++ b/docs/ReferralCreatedEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The referral code that was created | +**Value** | Pointer to **string** | The referral code that was created. | ## Methods diff --git a/docs/RejectCouponEffectProps.md b/docs/RejectCouponEffectProps.md index 1cff88c2..26f672a0 100644 --- a/docs/RejectCouponEffectProps.md +++ b/docs/RejectCouponEffectProps.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The coupon code that was rejected | -**RejectionReason** | Pointer to **string** | The reason why this coupon was rejected | -**ConditionIndex** | Pointer to **int32** | The index of the condition that caused the rejection of the coupon | [optional] -**EffectIndex** | Pointer to **int32** | The index of the effect that caused the rejection of the coupon | [optional] -**Details** | Pointer to **string** | More details about the failure | [optional] +**Value** | Pointer to **string** | The coupon code that was rejected. | +**RejectionReason** | Pointer to **string** | The reason why this coupon was rejected. | +**ConditionIndex** | Pointer to **int32** | The index of the condition that caused the rejection of the coupon. | [optional] +**EffectIndex** | Pointer to **int32** | The index of the effect that caused the rejection of the coupon. | [optional] +**Details** | Pointer to **string** | More details about the failure. | [optional] ## Methods diff --git a/docs/RejectReferralEffectProps.md b/docs/RejectReferralEffectProps.md index da91547f..6165c887 100644 --- a/docs/RejectReferralEffectProps.md +++ b/docs/RejectReferralEffectProps.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The referral code that was rejected | -**RejectionReason** | Pointer to **string** | The reason why this referral code was rejected | -**ConditionIndex** | Pointer to **int32** | The index of the condition that caused the rejection of the referral | [optional] -**EffectIndex** | Pointer to **int32** | The index of the effect that caused the rejection of the referral | [optional] -**Details** | Pointer to **string** | More details about the failure | [optional] +**Value** | Pointer to **string** | The referral code that was rejected. | +**RejectionReason** | Pointer to **string** | The reason why this referral code was rejected. | +**ConditionIndex** | Pointer to **int32** | The index of the condition that caused the rejection of the referral. | [optional] +**EffectIndex** | Pointer to **int32** | The index of the effect that caused the rejection of the referral. | [optional] +**Details** | Pointer to **string** | More details about the failure. | [optional] ## Methods diff --git a/docs/RemoveItemCatalogAction.md b/docs/RemoveItemCatalogAction.md new file mode 100644 index 00000000..c16258a5 --- /dev/null +++ b/docs/RemoveItemCatalogAction.md @@ -0,0 +1,39 @@ +# RemoveItemCatalogAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sku** | Pointer to **string** | The unique SKU of the item to remove. | + +## Methods + +### GetSku + +`func (o *RemoveItemCatalogAction) GetSku() string` + +GetSku returns the Sku field if non-nil, zero value otherwise. + +### GetSkuOk + +`func (o *RemoveItemCatalogAction) GetSkuOk() (string, bool)` + +GetSkuOk returns a tuple with the Sku field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSku + +`func (o *RemoveItemCatalogAction) HasSku() bool` + +HasSku returns a boolean if a field has been set. + +### SetSku + +`func (o *RemoveItemCatalogAction) SetSku(v string)` + +SetSku gets a reference to the given string and assigns it to the Sku field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RemoveManyItemsCatalogAction.md b/docs/RemoveManyItemsCatalogAction.md new file mode 100644 index 00000000..5d5db72a --- /dev/null +++ b/docs/RemoveManyItemsCatalogAction.md @@ -0,0 +1,39 @@ +# RemoveManyItemsCatalogAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | Pointer to [**[]CatalogActionFilter**](CatalogActionFilter.md) | The list of filters used to select the items to patch, joined by `AND`. **Note:** Every item in the catalog will be removed if there are no filters. | [optional] + +## Methods + +### GetFilters + +`func (o *RemoveManyItemsCatalogAction) GetFilters() []CatalogActionFilter` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *RemoveManyItemsCatalogAction) GetFiltersOk() ([]CatalogActionFilter, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFilters + +`func (o *RemoveManyItemsCatalogAction) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFilters + +`func (o *RemoveManyItemsCatalogAction) SetFilters(v []CatalogActionFilter)` + +SetFilters gets a reference to the given []CatalogActionFilter and assigns it to the Filters field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Return.md b/docs/Return.md new file mode 100644 index 00000000..fae44612 --- /dev/null +++ b/docs/Return.md @@ -0,0 +1,299 @@ +# Return + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**ReturnedCartItems** | Pointer to [**[]ReturnedCartItem**](ReturnedCartItem.md) | List of cart items to be returned. | +**EventId** | Pointer to **int32** | The event ID of that was generated for this return. | +**SessionId** | Pointer to **int32** | The internal ID of the session this return was requested on. | +**SessionIntegrationId** | Pointer to **string** | The integration ID of the session this return was requested on. | +**ProfileId** | Pointer to **int32** | The internal ID of the profile this return was requested on. | [optional] +**ProfileIntegrationId** | Pointer to **string** | The integration ID of the profile this return was requested on. | [optional] +**CreatedBy** | Pointer to **int32** | ID of the user who requested this return. | [optional] + +## Methods + +### GetId + +`func (o *Return) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Return) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *Return) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Return) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *Return) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Return) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *Return) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *Return) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetApplicationId + +`func (o *Return) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Return) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *Return) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *Return) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetAccountId + +`func (o *Return) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Return) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *Return) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *Return) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetReturnedCartItems + +`func (o *Return) GetReturnedCartItems() []ReturnedCartItem` + +GetReturnedCartItems returns the ReturnedCartItems field if non-nil, zero value otherwise. + +### GetReturnedCartItemsOk + +`func (o *Return) GetReturnedCartItemsOk() ([]ReturnedCartItem, bool)` + +GetReturnedCartItemsOk returns a tuple with the ReturnedCartItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReturnedCartItems + +`func (o *Return) HasReturnedCartItems() bool` + +HasReturnedCartItems returns a boolean if a field has been set. + +### SetReturnedCartItems + +`func (o *Return) SetReturnedCartItems(v []ReturnedCartItem)` + +SetReturnedCartItems gets a reference to the given []ReturnedCartItem and assigns it to the ReturnedCartItems field. + +### GetEventId + +`func (o *Return) GetEventId() int32` + +GetEventId returns the EventId field if non-nil, zero value otherwise. + +### GetEventIdOk + +`func (o *Return) GetEventIdOk() (int32, bool)` + +GetEventIdOk returns a tuple with the EventId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEventId + +`func (o *Return) HasEventId() bool` + +HasEventId returns a boolean if a field has been set. + +### SetEventId + +`func (o *Return) SetEventId(v int32)` + +SetEventId gets a reference to the given int32 and assigns it to the EventId field. + +### GetSessionId + +`func (o *Return) GetSessionId() int32` + +GetSessionId returns the SessionId field if non-nil, zero value otherwise. + +### GetSessionIdOk + +`func (o *Return) GetSessionIdOk() (int32, bool)` + +GetSessionIdOk returns a tuple with the SessionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSessionId + +`func (o *Return) HasSessionId() bool` + +HasSessionId returns a boolean if a field has been set. + +### SetSessionId + +`func (o *Return) SetSessionId(v int32)` + +SetSessionId gets a reference to the given int32 and assigns it to the SessionId field. + +### GetSessionIntegrationId + +`func (o *Return) GetSessionIntegrationId() string` + +GetSessionIntegrationId returns the SessionIntegrationId field if non-nil, zero value otherwise. + +### GetSessionIntegrationIdOk + +`func (o *Return) GetSessionIntegrationIdOk() (string, bool)` + +GetSessionIntegrationIdOk returns a tuple with the SessionIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSessionIntegrationId + +`func (o *Return) HasSessionIntegrationId() bool` + +HasSessionIntegrationId returns a boolean if a field has been set. + +### SetSessionIntegrationId + +`func (o *Return) SetSessionIntegrationId(v string)` + +SetSessionIntegrationId gets a reference to the given string and assigns it to the SessionIntegrationId field. + +### GetProfileId + +`func (o *Return) GetProfileId() int32` + +GetProfileId returns the ProfileId field if non-nil, zero value otherwise. + +### GetProfileIdOk + +`func (o *Return) GetProfileIdOk() (int32, bool)` + +GetProfileIdOk returns a tuple with the ProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileId + +`func (o *Return) HasProfileId() bool` + +HasProfileId returns a boolean if a field has been set. + +### SetProfileId + +`func (o *Return) SetProfileId(v int32)` + +SetProfileId gets a reference to the given int32 and assigns it to the ProfileId field. + +### GetProfileIntegrationId + +`func (o *Return) GetProfileIntegrationId() string` + +GetProfileIntegrationId returns the ProfileIntegrationId field if non-nil, zero value otherwise. + +### GetProfileIntegrationIdOk + +`func (o *Return) GetProfileIntegrationIdOk() (string, bool)` + +GetProfileIntegrationIdOk returns a tuple with the ProfileIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileIntegrationId + +`func (o *Return) HasProfileIntegrationId() bool` + +HasProfileIntegrationId returns a boolean if a field has been set. + +### SetProfileIntegrationId + +`func (o *Return) SetProfileIntegrationId(v string)` + +SetProfileIntegrationId gets a reference to the given string and assigns it to the ProfileIntegrationId field. + +### GetCreatedBy + +`func (o *Return) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *Return) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *Return) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *Return) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ReturnIntegrationRequest.md b/docs/ReturnIntegrationRequest.md new file mode 100644 index 00000000..dc434c0e --- /dev/null +++ b/docs/ReturnIntegrationRequest.md @@ -0,0 +1,65 @@ +# ReturnIntegrationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Return** | Pointer to [**NewReturn**](NewReturn.md) | | +**ResponseContent** | Pointer to **[]string** | Optional list of extra data that you want to get in the response. Use this property to get as much data as you need in one request instead of sending extra requests to other endpoints. **Note:** `ruleFailureReasons` is always part of the response when the [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. | [optional] + +## Methods + +### GetReturn + +`func (o *ReturnIntegrationRequest) GetReturn() NewReturn` + +GetReturn returns the Return field if non-nil, zero value otherwise. + +### GetReturnOk + +`func (o *ReturnIntegrationRequest) GetReturnOk() (NewReturn, bool)` + +GetReturnOk returns a tuple with the Return field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReturn + +`func (o *ReturnIntegrationRequest) HasReturn() bool` + +HasReturn returns a boolean if a field has been set. + +### SetReturn + +`func (o *ReturnIntegrationRequest) SetReturn(v NewReturn)` + +SetReturn gets a reference to the given NewReturn and assigns it to the Return field. + +### GetResponseContent + +`func (o *ReturnIntegrationRequest) GetResponseContent() []string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *ReturnIntegrationRequest) GetResponseContentOk() ([]string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasResponseContent + +`func (o *ReturnIntegrationRequest) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### SetResponseContent + +`func (o *ReturnIntegrationRequest) SetResponseContent(v []string)` + +SetResponseContent gets a reference to the given []string and assigns it to the ResponseContent field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ReturnedCartItem.md b/docs/ReturnedCartItem.md new file mode 100644 index 00000000..5923b33f --- /dev/null +++ b/docs/ReturnedCartItem.md @@ -0,0 +1,65 @@ +# ReturnedCartItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Position** | Pointer to **int32** | The index of the cart item in the provided customer session's `cartItems` property. | +**Quantity** | Pointer to **int32** | Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. | [optional] + +## Methods + +### GetPosition + +`func (o *ReturnedCartItem) GetPosition() int32` + +GetPosition returns the Position field if non-nil, zero value otherwise. + +### GetPositionOk + +`func (o *ReturnedCartItem) GetPositionOk() (int32, bool)` + +GetPositionOk returns a tuple with the Position field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPosition + +`func (o *ReturnedCartItem) HasPosition() bool` + +HasPosition returns a boolean if a field has been set. + +### SetPosition + +`func (o *ReturnedCartItem) SetPosition(v int32)` + +SetPosition gets a reference to the given int32 and assigns it to the Position field. + +### GetQuantity + +`func (o *ReturnedCartItem) GetQuantity() int32` + +GetQuantity returns the Quantity field if non-nil, zero value otherwise. + +### GetQuantityOk + +`func (o *ReturnedCartItem) GetQuantityOk() (int32, bool)` + +GetQuantityOk returns a tuple with the Quantity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasQuantity + +`func (o *ReturnedCartItem) HasQuantity() bool` + +HasQuantity returns a boolean if a field has been set. + +### SetQuantity + +`func (o *ReturnedCartItem) SetQuantity(v int32)` + +SetQuantity gets a reference to the given int32 and assigns it to the Quantity field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Role.md b/docs/Role.md index 3992bdd4..896e64e1 100644 --- a/docs/Role.md +++ b/docs/Role.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | -**CampaignGroupID** | Pointer to **int32** | The ID of the Campaign Group this role was created for. | [optional] -**Name** | Pointer to **string** | Name of the role | -**Description** | Pointer to **string** | Description of the role | [optional] -**Members** | Pointer to **[]int32** | A list of user identifiers assigned to this role | [optional] -**Acl** | Pointer to [**map[string]interface{}**](.md) | Role ACL Policy | +**CampaignGroupID** | Pointer to **int32** | The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this role was created for. | [optional] +**Name** | Pointer to **string** | Name of the role. | +**Description** | Pointer to **string** | Description of the role. | [optional] +**Members** | Pointer to **[]int32** | A list of user identifiers assigned to this role. | [optional] +**Acl** | Pointer to [**map[string]interface{}**](.md) | Role ACL Policy. | ## Methods diff --git a/docs/RoleAssign.md b/docs/RoleAssign.md index 4d76f0df..a42cd122 100644 --- a/docs/RoleAssign.md +++ b/docs/RoleAssign.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Users** | Pointer to **[]int32** | An array of userIDs | -**Roles** | Pointer to **[]int32** | An array of roleIDs | +**Users** | Pointer to **[]int32** | An array of userIDs. | +**Roles** | Pointer to **[]int32** | An array of roleIDs. | ## Methods diff --git a/docs/RoleMembership.md b/docs/RoleMembership.md index 830dcff6..72d9aaa1 100644 --- a/docs/RoleMembership.md +++ b/docs/RoleMembership.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**RoleID** | Pointer to **int32** | ID of role | -**UserID** | Pointer to **int32** | ID of User | +**RoleID** | Pointer to **int32** | ID of role. | +**UserID** | Pointer to **int32** | ID of User. | ## Methods diff --git a/docs/RollbackAddedLoyaltyPointsEffectProps.md b/docs/RollbackAddedLoyaltyPointsEffectProps.md index c651a260..1e9feec8 100644 --- a/docs/RollbackAddedLoyaltyPointsEffectProps.md +++ b/docs/RollbackAddedLoyaltyPointsEffectProps.md @@ -4,11 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProgramId** | Pointer to **int32** | The ID of the loyalty program where the points were originally added | -**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were originally added | -**Value** | Pointer to **float32** | The amount of points that were rolled back | -**RecipientIntegrationId** | Pointer to **string** | The user for whom these points were originally added | +**ProgramId** | Pointer to **int32** | The ID of the loyalty program where the points were originally added. | +**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were originally added. | +**Value** | Pointer to **float32** | The amount of points that were rolled back. | +**RecipientIntegrationId** | Pointer to **string** | The user for whom these points were originally added. | **TransactionUUID** | Pointer to **string** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. | +**CartItemPosition** | Pointer to **float32** | The index of the item in the cart items for which the loyalty points were rolled back. | [optional] +**CartItemSubPosition** | Pointer to **float32** | The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. | [optional] +**CardIdentifier** | Pointer to **string** | The card on which these points were originally added. | [optional] ## Methods @@ -137,6 +140,81 @@ HasTransactionUUID returns a boolean if a field has been set. SetTransactionUUID gets a reference to the given string and assigns it to the TransactionUUID field. +### GetCartItemPosition + +`func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemPosition() float32` + +GetCartItemPosition returns the CartItemPosition field if non-nil, zero value otherwise. + +### GetCartItemPositionOk + +`func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemPositionOk() (float32, bool)` + +GetCartItemPositionOk returns a tuple with the CartItemPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemPosition + +`func (o *RollbackAddedLoyaltyPointsEffectProps) HasCartItemPosition() bool` + +HasCartItemPosition returns a boolean if a field has been set. + +### SetCartItemPosition + +`func (o *RollbackAddedLoyaltyPointsEffectProps) SetCartItemPosition(v float32)` + +SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. + +### GetCartItemSubPosition + +`func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemSubPosition() float32` + +GetCartItemSubPosition returns the CartItemSubPosition field if non-nil, zero value otherwise. + +### GetCartItemSubPositionOk + +`func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemSubPositionOk() (float32, bool)` + +GetCartItemSubPositionOk returns a tuple with the CartItemSubPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemSubPosition + +`func (o *RollbackAddedLoyaltyPointsEffectProps) HasCartItemSubPosition() bool` + +HasCartItemSubPosition returns a boolean if a field has been set. + +### SetCartItemSubPosition + +`func (o *RollbackAddedLoyaltyPointsEffectProps) SetCartItemSubPosition(v float32)` + +SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. + +### GetCardIdentifier + +`func (o *RollbackAddedLoyaltyPointsEffectProps) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *RollbackAddedLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool)` + +GetCardIdentifierOk returns a tuple with the CardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardIdentifier + +`func (o *RollbackAddedLoyaltyPointsEffectProps) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *RollbackAddedLoyaltyPointsEffectProps) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RollbackCouponEffectProps.md b/docs/RollbackCouponEffectProps.md index 1f0b18dc..db151c5e 100644 --- a/docs/RollbackCouponEffectProps.md +++ b/docs/RollbackCouponEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The coupon code whose usage has been rolled back | +**Value** | Pointer to **string** | The coupon code whose usage has been rolled back. | ## Methods diff --git a/docs/RollbackDeductedLoyaltyPointsEffectProps.md b/docs/RollbackDeductedLoyaltyPointsEffectProps.md index d284b438..86fec337 100644 --- a/docs/RollbackDeductedLoyaltyPointsEffectProps.md +++ b/docs/RollbackDeductedLoyaltyPointsEffectProps.md @@ -4,13 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ProgramId** | Pointer to **int32** | The ID of the loyalty program where these points were reimbursed | -**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were reimbursed | -**Value** | Pointer to **float32** | The amount of reimbursed points that were added | -**RecipientIntegrationId** | Pointer to **string** | The user for whom these points were reimbursed | -**StartDate** | Pointer to [**time.Time**](time.Time.md) | Date after which the reimbursed points will be valid | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Date after which the reimbursed points will expire | [optional] -**TransactionUUID** | Pointer to **string** | The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back | +**ProgramId** | Pointer to **int32** | The ID of the loyalty program where these points were reimbursed. | +**SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were reimbursed. | +**Value** | Pointer to **float32** | The amount of reimbursed points that were added. | +**RecipientIntegrationId** | Pointer to **string** | The user for whom these points were reimbursed. | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Date after which the reimbursed points will be valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Date after which the reimbursed points will expire. | [optional] +**TransactionUUID** | Pointer to **string** | The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back. | +**CardIdentifier** | Pointer to **string** | The card on which these points were added. | [optional] ## Methods @@ -189,6 +190,31 @@ HasTransactionUUID returns a boolean if a field has been set. SetTransactionUUID gets a reference to the given string and assigns it to the TransactionUUID field. +### GetCardIdentifier + +`func (o *RollbackDeductedLoyaltyPointsEffectProps) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *RollbackDeductedLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool)` + +GetCardIdentifierOk returns a tuple with the CardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCardIdentifier + +`func (o *RollbackDeductedLoyaltyPointsEffectProps) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *RollbackDeductedLoyaltyPointsEffectProps) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RollbackDiscountEffectProps.md b/docs/RollbackDiscountEffectProps.md index e68f1d83..53154a7c 100644 --- a/docs/RollbackDiscountEffectProps.md +++ b/docs/RollbackDiscountEffectProps.md @@ -4,8 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name of the \"setDiscount\" effect that was rolled back | -**Value** | Pointer to **float32** | The value of the discount that was rolled back | +**Name** | Pointer to **string** | The name of the \"setDiscount\" effect that was rolled back. | +**Value** | Pointer to **float32** | The value of the discount that was rolled back. | +**CartItemPosition** | Pointer to **float32** | The index of the item in the cart items for which the discount was rolled back. | [optional] +**CartItemSubPosition** | Pointer to **float32** | The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is only returned when cart item flattening is enabled. | [optional] +**AdditionalCostId** | Pointer to **int32** | The ID of the additional cost that was rolled back. | [optional] +**AdditionalCost** | Pointer to **string** | The name of the additional cost that was rolled back. | [optional] +**Scope** | Pointer to **string** | The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` | [optional] ## Methods @@ -59,6 +64,131 @@ HasValue returns a boolean if a field has been set. SetValue gets a reference to the given float32 and assigns it to the Value field. +### GetCartItemPosition + +`func (o *RollbackDiscountEffectProps) GetCartItemPosition() float32` + +GetCartItemPosition returns the CartItemPosition field if non-nil, zero value otherwise. + +### GetCartItemPositionOk + +`func (o *RollbackDiscountEffectProps) GetCartItemPositionOk() (float32, bool)` + +GetCartItemPositionOk returns a tuple with the CartItemPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemPosition + +`func (o *RollbackDiscountEffectProps) HasCartItemPosition() bool` + +HasCartItemPosition returns a boolean if a field has been set. + +### SetCartItemPosition + +`func (o *RollbackDiscountEffectProps) SetCartItemPosition(v float32)` + +SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. + +### GetCartItemSubPosition + +`func (o *RollbackDiscountEffectProps) GetCartItemSubPosition() float32` + +GetCartItemSubPosition returns the CartItemSubPosition field if non-nil, zero value otherwise. + +### GetCartItemSubPositionOk + +`func (o *RollbackDiscountEffectProps) GetCartItemSubPositionOk() (float32, bool)` + +GetCartItemSubPositionOk returns a tuple with the CartItemSubPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemSubPosition + +`func (o *RollbackDiscountEffectProps) HasCartItemSubPosition() bool` + +HasCartItemSubPosition returns a boolean if a field has been set. + +### SetCartItemSubPosition + +`func (o *RollbackDiscountEffectProps) SetCartItemSubPosition(v float32)` + +SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. + +### GetAdditionalCostId + +`func (o *RollbackDiscountEffectProps) GetAdditionalCostId() int32` + +GetAdditionalCostId returns the AdditionalCostId field if non-nil, zero value otherwise. + +### GetAdditionalCostIdOk + +`func (o *RollbackDiscountEffectProps) GetAdditionalCostIdOk() (int32, bool)` + +GetAdditionalCostIdOk returns a tuple with the AdditionalCostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalCostId + +`func (o *RollbackDiscountEffectProps) HasAdditionalCostId() bool` + +HasAdditionalCostId returns a boolean if a field has been set. + +### SetAdditionalCostId + +`func (o *RollbackDiscountEffectProps) SetAdditionalCostId(v int32)` + +SetAdditionalCostId gets a reference to the given int32 and assigns it to the AdditionalCostId field. + +### GetAdditionalCost + +`func (o *RollbackDiscountEffectProps) GetAdditionalCost() string` + +GetAdditionalCost returns the AdditionalCost field if non-nil, zero value otherwise. + +### GetAdditionalCostOk + +`func (o *RollbackDiscountEffectProps) GetAdditionalCostOk() (string, bool)` + +GetAdditionalCostOk returns a tuple with the AdditionalCost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalCost + +`func (o *RollbackDiscountEffectProps) HasAdditionalCost() bool` + +HasAdditionalCost returns a boolean if a field has been set. + +### SetAdditionalCost + +`func (o *RollbackDiscountEffectProps) SetAdditionalCost(v string)` + +SetAdditionalCost gets a reference to the given string and assigns it to the AdditionalCost field. + +### GetScope + +`func (o *RollbackDiscountEffectProps) GetScope() string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RollbackDiscountEffectProps) GetScopeOk() (string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScope + +`func (o *RollbackDiscountEffectProps) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScope + +`func (o *RollbackDiscountEffectProps) SetScope(v string)` + +SetScope gets a reference to the given string and assigns it to the Scope field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RollbackReferralEffectProps.md b/docs/RollbackReferralEffectProps.md index 9b6f6913..65c84c6c 100644 --- a/docs/RollbackReferralEffectProps.md +++ b/docs/RollbackReferralEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **string** | The referral code whose usage has been rolled back | +**Value** | Pointer to **string** | The referral code whose usage has been rolled back. | ## Methods diff --git a/docs/RuleFailureReason.md b/docs/RuleFailureReason.md index 18287c47..3979d224 100644 --- a/docs/RuleFailureReason.md +++ b/docs/RuleFailureReason.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CampaignID** | Pointer to **int32** | The ID of the campaign that contains the rule that failed | -**CampaignName** | Pointer to **string** | The name of the campaign that contains the rule that failed | -**RulesetID** | Pointer to **int32** | The ID of the ruleset that contains the rule that failed | -**CouponID** | Pointer to **int32** | The ID of the coupon that was being evaluated at the time of the rule failure | [optional] -**CouponValue** | Pointer to **string** | The value of the coupon that was being evaluated at the time of the rule failure | [optional] -**ReferralID** | Pointer to **int32** | The ID of the referral that was being evaluated at the time of the rule failure | [optional] -**ReferralValue** | Pointer to **string** | The value of the referral that was being evaluated at the time of the rule failure | [optional] -**RuleIndex** | Pointer to **int32** | The index of the rule that failed within the ruleset | -**RuleName** | Pointer to **string** | The name of the rule that failed within the ruleset | -**ConditionIndex** | Pointer to **int32** | The index of the condition that failed | [optional] -**EffectIndex** | Pointer to **int32** | The index of the effect that failed | [optional] -**Details** | Pointer to **string** | More details about the failure | [optional] +**CampaignID** | Pointer to **int32** | The ID of the campaign that contains the rule that failed. | +**CampaignName** | Pointer to **string** | The name of the campaign that contains the rule that failed. | +**RulesetID** | Pointer to **int32** | The ID of the ruleset that contains the rule that failed. | +**CouponID** | Pointer to **int32** | The ID of the coupon that was being evaluated at the time of the rule failure. | [optional] +**CouponValue** | Pointer to **string** | The code of the coupon that was being evaluated at the time of the rule failure. | [optional] +**ReferralID** | Pointer to **int32** | The ID of the referral that was being evaluated at the time of the rule failure. | [optional] +**ReferralValue** | Pointer to **string** | The code of the referral that was being evaluated at the time of the rule failure. | [optional] +**RuleIndex** | Pointer to **int32** | The index of the rule that failed within the ruleset. | +**RuleName** | Pointer to **string** | The name of the rule that failed within the ruleset. | +**ConditionIndex** | Pointer to **int32** | The index of the condition that failed. | [optional] +**EffectIndex** | Pointer to **int32** | The index of the effect that failed. | [optional] +**Details** | Pointer to **string** | More details about the failure. | [optional] ## Methods diff --git a/docs/Ruleset.md b/docs/Ruleset.md index 450cd8a7..6cde4ca3 100644 --- a/docs/Ruleset.md +++ b/docs/Ruleset.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **UserId** | Pointer to **int32** | The ID of the account that owns this entity. | **Rules** | Pointer to [**[]Rule**](Rule.md) | Set of rules to apply. | **Bindings** | Pointer to [**[]Binding**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | -**RbVersion** | Pointer to **string** | A string indicating which version of the rulebuilder was used to create this ruleset. | [optional] -**Activate** | Pointer to **bool** | A boolean indicating whether this newly created ruleset should also be activated for the campaign that owns it | [optional] +**RbVersion** | Pointer to **string** | The version of the rulebuilder used to create this ruleset. | [optional] +**Activate** | Pointer to **bool** | Indicates whether this created ruleset should be activated for the campaign that owns it. | [optional] **CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | [optional] **TemplateId** | Pointer to **int32** | The ID of the campaign template that owns this entity. | [optional] **ActivatedAt** | Pointer to [**time.Time**](time.Time.md) | Timestamp indicating when this Ruleset was activated. | [optional] diff --git a/docs/SamlConnection.md b/docs/SamlConnection.md index 1bd7d1c6..7371892e 100644 --- a/docs/SamlConnection.md +++ b/docs/SamlConnection.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **SignOutURL** | Pointer to **string** | Single Sign-Out URL. | [optional] **MetadataURL** | Pointer to **string** | Metadata URL. | [optional] **AudienceURI** | Pointer to **string** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. | -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | ## Methods diff --git a/docs/Session.md b/docs/Session.md index 18cc052e..2d04f832 100644 --- a/docs/Session.md +++ b/docs/Session.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UserId** | Pointer to **int32** | The ID of the user of this session | +**UserId** | Pointer to **int32** | The ID of the user of this session. | **Token** | Pointer to **string** | The token to use as a bearer token to query Management API endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | Unix timestamp indicating when the session was first created. | diff --git a/docs/SetDiscountEffectProps.md b/docs/SetDiscountEffectProps.md index 96daa78f..8ec89105 100644 --- a/docs/SetDiscountEffectProps.md +++ b/docs/SetDiscountEffectProps.md @@ -4,9 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this discount | -**Value** | Pointer to **float32** | The total monetary value of the discount | -**Scope** | Pointer to **string** | The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal) | [optional] +**Name** | Pointer to **string** | The name/description of this discount. | +**Value** | Pointer to **float32** | The total monetary value of the discount. | +**Scope** | Pointer to **string** | The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal). | [optional] +**DesiredValue** | Pointer to **float32** | The original value of the discount. | [optional] ## Methods @@ -85,6 +86,31 @@ HasScope returns a boolean if a field has been set. SetScope gets a reference to the given string and assigns it to the Scope field. +### GetDesiredValue + +`func (o *SetDiscountEffectProps) GetDesiredValue() float32` + +GetDesiredValue returns the DesiredValue field if non-nil, zero value otherwise. + +### GetDesiredValueOk + +`func (o *SetDiscountEffectProps) GetDesiredValueOk() (float32, bool)` + +GetDesiredValueOk returns a tuple with the DesiredValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDesiredValue + +`func (o *SetDiscountEffectProps) HasDesiredValue() bool` + +HasDesiredValue returns a boolean if a field has been set. + +### SetDesiredValue + +`func (o *SetDiscountEffectProps) SetDesiredValue(v float32)` + +SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SetDiscountPerAdditionalCostEffectProps.md b/docs/SetDiscountPerAdditionalCostEffectProps.md index 8e42f085..d0d15a01 100644 --- a/docs/SetDiscountPerAdditionalCostEffectProps.md +++ b/docs/SetDiscountPerAdditionalCostEffectProps.md @@ -4,10 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this discount | -**AdditionalCostId** | Pointer to **int32** | The ID of the additional cost | -**AdditionalCost** | Pointer to **string** | The name of the additional cost | -**Value** | Pointer to **float32** | The total monetary value of the discount | +**Name** | Pointer to **string** | The name/description of this discount. | +**AdditionalCostId** | Pointer to **int32** | The ID of the additional cost. | +**AdditionalCost** | Pointer to **string** | The name of the additional cost. | +**Value** | Pointer to **float32** | The total monetary value of the discount. | +**DesiredValue** | Pointer to **float32** | The original value of the discount. | [optional] ## Methods @@ -111,6 +112,31 @@ HasValue returns a boolean if a field has been set. SetValue gets a reference to the given float32 and assigns it to the Value field. +### GetDesiredValue + +`func (o *SetDiscountPerAdditionalCostEffectProps) GetDesiredValue() float32` + +GetDesiredValue returns the DesiredValue field if non-nil, zero value otherwise. + +### GetDesiredValueOk + +`func (o *SetDiscountPerAdditionalCostEffectProps) GetDesiredValueOk() (float32, bool)` + +GetDesiredValueOk returns a tuple with the DesiredValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDesiredValue + +`func (o *SetDiscountPerAdditionalCostEffectProps) HasDesiredValue() bool` + +HasDesiredValue returns a boolean if a field has been set. + +### SetDesiredValue + +`func (o *SetDiscountPerAdditionalCostEffectProps) SetDesiredValue(v float32)` + +SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md new file mode 100644 index 00000000..b87939ea --- /dev/null +++ b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md @@ -0,0 +1,195 @@ +# SetDiscountPerAdditionalCostPerItemEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name/description of this discount. | +**AdditionalCostId** | Pointer to **int32** | The ID of the additional cost. | +**Value** | Pointer to **float32** | The total monetary value of the discount. | +**Position** | Pointer to **float32** | The index of the item in the cart item list containing the additional cost to be discounted. | +**SubPosition** | Pointer to **float32** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. | [optional] +**AdditionalCost** | Pointer to **string** | The name of the additional cost. | +**DesiredValue** | Pointer to **float32** | Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. | [optional] + +## Methods + +### GetName + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetAdditionalCostId + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetAdditionalCostId() int32` + +GetAdditionalCostId returns the AdditionalCostId field if non-nil, zero value otherwise. + +### GetAdditionalCostIdOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetAdditionalCostIdOk() (int32, bool)` + +GetAdditionalCostIdOk returns a tuple with the AdditionalCostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalCostId + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasAdditionalCostId() bool` + +HasAdditionalCostId returns a boolean if a field has been set. + +### SetAdditionalCostId + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetAdditionalCostId(v int32)` + +SetAdditionalCostId gets a reference to the given int32 and assigns it to the AdditionalCostId field. + +### GetValue + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetValueOk() (float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetValue(v float32)` + +SetValue gets a reference to the given float32 and assigns it to the Value field. + +### GetPosition + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetPosition() float32` + +GetPosition returns the Position field if non-nil, zero value otherwise. + +### GetPositionOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetPositionOk() (float32, bool)` + +GetPositionOk returns a tuple with the Position field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPosition + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasPosition() bool` + +HasPosition returns a boolean if a field has been set. + +### SetPosition + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetPosition(v float32)` + +SetPosition gets a reference to the given float32 and assigns it to the Position field. + +### GetSubPosition + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetSubPosition() float32` + +GetSubPosition returns the SubPosition field if non-nil, zero value otherwise. + +### GetSubPositionOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetSubPositionOk() (float32, bool)` + +GetSubPositionOk returns a tuple with the SubPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubPosition + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasSubPosition() bool` + +HasSubPosition returns a boolean if a field has been set. + +### SetSubPosition + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetSubPosition(v float32)` + +SetSubPosition gets a reference to the given float32 and assigns it to the SubPosition field. + +### GetAdditionalCost + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetAdditionalCost() string` + +GetAdditionalCost returns the AdditionalCost field if non-nil, zero value otherwise. + +### GetAdditionalCostOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetAdditionalCostOk() (string, bool)` + +GetAdditionalCostOk returns a tuple with the AdditionalCost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalCost + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasAdditionalCost() bool` + +HasAdditionalCost returns a boolean if a field has been set. + +### SetAdditionalCost + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetAdditionalCost(v string)` + +SetAdditionalCost gets a reference to the given string and assigns it to the AdditionalCost field. + +### GetDesiredValue + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetDesiredValue() float32` + +GetDesiredValue returns the DesiredValue field if non-nil, zero value otherwise. + +### GetDesiredValueOk + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetDesiredValueOk() (float32, bool)` + +GetDesiredValueOk returns a tuple with the DesiredValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDesiredValue + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasDesiredValue() bool` + +HasDesiredValue returns a boolean if a field has been set. + +### SetDesiredValue + +`func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetDesiredValue(v float32)` + +SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SetDiscountPerItemEffectProps.md b/docs/SetDiscountPerItemEffectProps.md index df4d3607..25e576e3 100644 --- a/docs/SetDiscountPerItemEffectProps.md +++ b/docs/SetDiscountPerItemEffectProps.md @@ -4,10 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this discount | -**Value** | Pointer to **float32** | The total monetary value of the discount | -**Position** | Pointer to **float32** | The index of the item in the cart items list on which this discount should be applied | -**SubPosition** | Pointer to **float32** | The sub-index of the item in an item stack on which this discount should be applied | [optional] +**Name** | Pointer to **string** | The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. | +**Value** | Pointer to **float32** | The total monetary value of the discount. | +**Position** | Pointer to **float32** | The index of the item in the cart items list on which this discount should be applied. | +**SubPosition** | Pointer to **float32** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. | [optional] +**DesiredValue** | Pointer to **float32** | The original value of the discount. | [optional] +**Scope** | Pointer to **string** | The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. | [optional] +**TotalDiscount** | Pointer to **float32** | The total discount given if this effect is a result of a prorated discount. | [optional] +**DesiredTotalDiscount** | Pointer to **float32** | The original total discount to give if this effect is a result of a prorated discount. | [optional] +**BundleIndex** | Pointer to **int32** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] +**BundleName** | Pointer to **string** | The name of the bundle binding. | [optional] ## Methods @@ -111,6 +117,156 @@ HasSubPosition returns a boolean if a field has been set. SetSubPosition gets a reference to the given float32 and assigns it to the SubPosition field. +### GetDesiredValue + +`func (o *SetDiscountPerItemEffectProps) GetDesiredValue() float32` + +GetDesiredValue returns the DesiredValue field if non-nil, zero value otherwise. + +### GetDesiredValueOk + +`func (o *SetDiscountPerItemEffectProps) GetDesiredValueOk() (float32, bool)` + +GetDesiredValueOk returns a tuple with the DesiredValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDesiredValue + +`func (o *SetDiscountPerItemEffectProps) HasDesiredValue() bool` + +HasDesiredValue returns a boolean if a field has been set. + +### SetDesiredValue + +`func (o *SetDiscountPerItemEffectProps) SetDesiredValue(v float32)` + +SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. + +### GetScope + +`func (o *SetDiscountPerItemEffectProps) GetScope() string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *SetDiscountPerItemEffectProps) GetScopeOk() (string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScope + +`func (o *SetDiscountPerItemEffectProps) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScope + +`func (o *SetDiscountPerItemEffectProps) SetScope(v string)` + +SetScope gets a reference to the given string and assigns it to the Scope field. + +### GetTotalDiscount + +`func (o *SetDiscountPerItemEffectProps) GetTotalDiscount() float32` + +GetTotalDiscount returns the TotalDiscount field if non-nil, zero value otherwise. + +### GetTotalDiscountOk + +`func (o *SetDiscountPerItemEffectProps) GetTotalDiscountOk() (float32, bool)` + +GetTotalDiscountOk returns a tuple with the TotalDiscount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalDiscount + +`func (o *SetDiscountPerItemEffectProps) HasTotalDiscount() bool` + +HasTotalDiscount returns a boolean if a field has been set. + +### SetTotalDiscount + +`func (o *SetDiscountPerItemEffectProps) SetTotalDiscount(v float32)` + +SetTotalDiscount gets a reference to the given float32 and assigns it to the TotalDiscount field. + +### GetDesiredTotalDiscount + +`func (o *SetDiscountPerItemEffectProps) GetDesiredTotalDiscount() float32` + +GetDesiredTotalDiscount returns the DesiredTotalDiscount field if non-nil, zero value otherwise. + +### GetDesiredTotalDiscountOk + +`func (o *SetDiscountPerItemEffectProps) GetDesiredTotalDiscountOk() (float32, bool)` + +GetDesiredTotalDiscountOk returns a tuple with the DesiredTotalDiscount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDesiredTotalDiscount + +`func (o *SetDiscountPerItemEffectProps) HasDesiredTotalDiscount() bool` + +HasDesiredTotalDiscount returns a boolean if a field has been set. + +### SetDesiredTotalDiscount + +`func (o *SetDiscountPerItemEffectProps) SetDesiredTotalDiscount(v float32)` + +SetDesiredTotalDiscount gets a reference to the given float32 and assigns it to the DesiredTotalDiscount field. + +### GetBundleIndex + +`func (o *SetDiscountPerItemEffectProps) GetBundleIndex() int32` + +GetBundleIndex returns the BundleIndex field if non-nil, zero value otherwise. + +### GetBundleIndexOk + +`func (o *SetDiscountPerItemEffectProps) GetBundleIndexOk() (int32, bool)` + +GetBundleIndexOk returns a tuple with the BundleIndex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBundleIndex + +`func (o *SetDiscountPerItemEffectProps) HasBundleIndex() bool` + +HasBundleIndex returns a boolean if a field has been set. + +### SetBundleIndex + +`func (o *SetDiscountPerItemEffectProps) SetBundleIndex(v int32)` + +SetBundleIndex gets a reference to the given int32 and assigns it to the BundleIndex field. + +### GetBundleName + +`func (o *SetDiscountPerItemEffectProps) GetBundleName() string` + +GetBundleName returns the BundleName field if non-nil, zero value otherwise. + +### GetBundleNameOk + +`func (o *SetDiscountPerItemEffectProps) GetBundleNameOk() (string, bool)` + +GetBundleNameOk returns a tuple with the BundleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBundleName + +`func (o *SetDiscountPerItemEffectProps) HasBundleName() bool` + +HasBundleName returns a boolean if a field has been set. + +### SetBundleName + +`func (o *SetDiscountPerItemEffectProps) SetBundleName(v string)` + +SetBundleName gets a reference to the given string and assigns it to the BundleName field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ShowBundleMetadataEffectProps.md b/docs/ShowBundleMetadataEffectProps.md index 648179c2..513d0f29 100644 --- a/docs/ShowBundleMetadataEffectProps.md +++ b/docs/ShowBundleMetadataEffectProps.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Description** | Pointer to **string** | Description of the product bundle | -**BundleAttributes** | Pointer to **[]string** | The cart item attributes that determined which items are being bundled together | -**ItemsIndices** | Pointer to **[]float32** | The indices in the cart items array of the bundled items | +**Description** | Pointer to **string** | Description of the product bundle. | +**BundleAttributes** | Pointer to **[]string** | The cart item attributes that determined which items are being bundled together. | +**ItemsIndices** | Pointer to **[]float32** | The indices in the cart items array of the bundled items. | ## Methods diff --git a/docs/ShowNotificationEffectProps.md b/docs/ShowNotificationEffectProps.md index 6d275fdf..22aa686d 100644 --- a/docs/ShowNotificationEffectProps.md +++ b/docs/ShowNotificationEffectProps.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NotificationType** | Pointer to **string** | The type of notification that should be shown (e.g. error/warning/info) | -**Title** | Pointer to **string** | Title of the notification | -**Body** | Pointer to **string** | Body of the notification | +**NotificationType** | Pointer to **string** | The type of notification that should be shown (e.g. error/warning/info). | +**Title** | Pointer to **string** | Title of the notification. | +**Body** | Pointer to **string** | Body of the notification. | ## Methods diff --git a/docs/TemplateDef.md b/docs/TemplateDef.md index c403c882..a70452ae 100644 --- a/docs/TemplateDef.md +++ b/docs/TemplateDef.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **Title** | Pointer to **string** | Campaigner-friendly name for the template that will be shown in the rule editor. | diff --git a/docs/TemplateLimitConfig.md b/docs/TemplateLimitConfig.md index 3844edc6..80435128 100644 --- a/docs/TemplateLimitConfig.md +++ b/docs/TemplateLimitConfig.md @@ -4,11 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Action** | Pointer to **string** | The limitable action to which this limit will be applied | -**Limit** | Pointer to **float32** | The value to set for the limit | -**Period** | Pointer to **string** | The period on which the budget limit recurs | [optional] -**Entities** | Pointer to **[]string** | The entities that make the address of this limit | -**Description** | Pointer to **string** | The description of this budget configuration | +**Action** | Pointer to **string** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` | +**Limit** | Pointer to **float32** | The value to set for the limit. | +**Period** | Pointer to **string** | The period on which the budget limit recurs. | [optional] +**Entities** | Pointer to **[]string** | The entity that this limit applies to. | ## Methods @@ -112,31 +111,6 @@ HasEntities returns a boolean if a field has been set. SetEntities gets a reference to the given []string and assigns it to the Entities field. -### GetDescription - -`func (o *TemplateLimitConfig) GetDescription() string` - -GetDescription returns the Description field if non-nil, zero value otherwise. - -### GetDescriptionOk - -`func (o *TemplateLimitConfig) GetDescriptionOk() (string, bool)` - -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDescription - -`func (o *TemplateLimitConfig) HasDescription() bool` - -HasDescription returns a boolean if a field has been set. - -### SetDescription - -`func (o *TemplateLimitConfig) SetDescription(v string)` - -SetDescription gets a reference to the given string and assigns it to the Description field. - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Tier.md b/docs/Tier.md index 82aaac3f..e805623b 100644 --- a/docs/Tier.md +++ b/docs/Tier.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | The internal ID of the tier | -**Name** | Pointer to **string** | The name of the tier | +**Id** | Pointer to **int32** | The internal ID of the tier. | +**Name** | Pointer to **string** | The name of the tier. | ## Methods diff --git a/docs/TriggerWebhookEffectProps.md b/docs/TriggerWebhookEffectProps.md index d80381d0..344555db 100644 --- a/docs/TriggerWebhookEffectProps.md +++ b/docs/TriggerWebhookEffectProps.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**WebhookId** | Pointer to **float32** | The ID of the webhook that was triggered | -**WebhookName** | Pointer to **string** | The name of the webhook that was triggered | +**WebhookId** | Pointer to **float32** | The ID of the webhook that was triggered. | +**WebhookName** | Pointer to **string** | The name of the webhook that was triggered. | ## Methods diff --git a/docs/UpdateAccount.md b/docs/UpdateAccount.md index b8e99fea..2ab04a9d 100644 --- a/docs/UpdateAccount.md +++ b/docs/UpdateAccount.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] **CompanyName** | Pointer to **string** | Name of your company. | **BillingEmail** | Pointer to **string** | The billing email address associated with your company account. | -**State** | Pointer to **string** | State of the account (active, deactivated) | [optional] +**State** | Pointer to **string** | State of the account (active, deactivated). | [optional] **PlanExpires** | Pointer to [**time.Time**](time.Time.md) | The point in time at which your current plan expires. | [optional] ## Methods diff --git a/docs/UpdateApplication.md b/docs/UpdateApplication.md index e07784f3..6d54a7be 100644 --- a/docs/UpdateApplication.md +++ b/docs/UpdateApplication.md @@ -7,17 +7,19 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | The name of this application. | **Description** | Pointer to **string** | A longer description of the application. | [optional] **Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | -**Currency** | Pointer to **string** | A string describing a default currency for new customer sessions. | -**CaseSensitivity** | Pointer to **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] -**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] -**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] -**DefaultDiscountScope** | Pointer to **string** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] -**EnableCascadingDiscounts** | Pointer to **bool** | Indicates if discounts should cascade for this application | [optional] -**EnableFlattenedCartItems** | Pointer to **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one | [optional] +**Currency** | Pointer to **string** | The default currency for new customer sessions. | +**CaseSensitivity** | Pointer to **string** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] +**CampaignPriority** | Pointer to **string** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional] [default to CAMPAIGN_PRIORITY_UNIVERSAL] +**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to EXCLUSIVE_CAMPAIGNS_STRATEGY_LIST_ORDER] +**DefaultDiscountScope** | Pointer to **string** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] +**EnableCascadingDiscounts** | Pointer to **bool** | Indicates if discounts should cascade for this Application. | [optional] +**EnableFlattenedCartItems** | Pointer to **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [optional] -**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox application | [optional] +**Sandbox** | Pointer to **bool** | Indicates if this is a live or sandbox Application. | [optional] +**EnablePartialDiscounts** | Pointer to **bool** | Indicates if this Application supports partial discounts. | [optional] +**DefaultDiscountAdditionalCostPerItemScope** | Pointer to **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] ## Methods @@ -371,6 +373,56 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetEnablePartialDiscounts + +`func (o *UpdateApplication) GetEnablePartialDiscounts() bool` + +GetEnablePartialDiscounts returns the EnablePartialDiscounts field if non-nil, zero value otherwise. + +### GetEnablePartialDiscountsOk + +`func (o *UpdateApplication) GetEnablePartialDiscountsOk() (bool, bool)` + +GetEnablePartialDiscountsOk returns a tuple with the EnablePartialDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnablePartialDiscounts + +`func (o *UpdateApplication) HasEnablePartialDiscounts() bool` + +HasEnablePartialDiscounts returns a boolean if a field has been set. + +### SetEnablePartialDiscounts + +`func (o *UpdateApplication) SetEnablePartialDiscounts(v bool)` + +SetEnablePartialDiscounts gets a reference to the given bool and assigns it to the EnablePartialDiscounts field. + +### GetDefaultDiscountAdditionalCostPerItemScope + +`func (o *UpdateApplication) GetDefaultDiscountAdditionalCostPerItemScope() string` + +GetDefaultDiscountAdditionalCostPerItemScope returns the DefaultDiscountAdditionalCostPerItemScope field if non-nil, zero value otherwise. + +### GetDefaultDiscountAdditionalCostPerItemScopeOk + +`func (o *UpdateApplication) GetDefaultDiscountAdditionalCostPerItemScopeOk() (string, bool)` + +GetDefaultDiscountAdditionalCostPerItemScopeOk returns a tuple with the DefaultDiscountAdditionalCostPerItemScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultDiscountAdditionalCostPerItemScope + +`func (o *UpdateApplication) HasDefaultDiscountAdditionalCostPerItemScope() bool` + +HasDefaultDiscountAdditionalCostPerItemScope returns a boolean if a field has been set. + +### SetDefaultDiscountAdditionalCostPerItemScope + +`func (o *UpdateApplication) SetDefaultDiscountAdditionalCostPerItemScope(v string)` + +SetDefaultDiscountAdditionalCostPerItemScope gets a reference to the given string and assigns it to the DefaultDiscountAdditionalCostPerItemScope field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateAttributeEffectProps.md b/docs/UpdateAttributeEffectProps.md index ecfbe4eb..66899e9a 100644 --- a/docs/UpdateAttributeEffectProps.md +++ b/docs/UpdateAttributeEffectProps.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Path** | Pointer to **string** | The exact path of the attribute that was updated | -**Value** | Pointer to [**map[string]interface{}**](.md) | The new value of this attribute. Value can be any of the following types (time, string, number, location, boolean) or a list of any of those types | +**Path** | Pointer to **string** | The exact path of the attribute that was updated. | +**Value** | Pointer to [**map[string]interface{}**](.md) | The new value of this attribute. The value can be of the following types: - boolean - location - number - string - time - list of any of those types | ## Methods diff --git a/docs/UpdateAudience.md b/docs/UpdateAudience.md index 822969a2..c98b2ffe 100644 --- a/docs/UpdateAudience.md +++ b/docs/UpdateAudience.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The human-friendly display name for this Audience. | +**Name** | Pointer to **string** | The human-friendly display name for this audience. | ## Methods diff --git a/docs/UpdateCampaign.md b/docs/UpdateCampaign.md index 42d34fd7..41aae072 100644 --- a/docs/UpdateCampaign.md +++ b/docs/UpdateCampaign.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A detailed description of the campaign. | [optional] **StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] **EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] **State** | Pointer to **string** | A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to STATE_ENABLED] **ActiveRulesetId** | Pointer to **int32** | ID of Ruleset this campaign applies on customer session evaluation. | [optional] **Tags** | Pointer to **[]string** | A list of tags for the campaign. | **Features** | Pointer to **[]string** | A list of features for the campaign. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign | +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign. | **CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] ## Methods diff --git a/docs/UpdateCampaignCollection.md b/docs/UpdateCampaignCollection.md new file mode 100644 index 00000000..750dec75 --- /dev/null +++ b/docs/UpdateCampaignCollection.md @@ -0,0 +1,39 @@ +# UpdateCampaignCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] + +## Methods + +### GetDescription + +`func (o *UpdateCampaignCollection) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UpdateCampaignCollection) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *UpdateCampaignCollection) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *UpdateCampaignCollection) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateCampaignGroup.md b/docs/UpdateCampaignGroup.md index 5edb3d02..e4c808d2 100644 --- a/docs/UpdateCampaignGroup.md +++ b/docs/UpdateCampaignGroup.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The name of this campaign group. | **Description** | Pointer to **string** | A longer description of the campaign group. | [optional] -**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for | [optional] -**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for. | [optional] +**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns. | [optional] ## Methods diff --git a/docs/UpdateCampaignTemplate.md b/docs/UpdateCampaignTemplate.md index f9bca033..c45042a9 100644 --- a/docs/UpdateCampaignTemplate.md +++ b/docs/UpdateCampaignTemplate.md @@ -15,9 +15,11 @@ Name | Type | Description | Notes **Features** | Pointer to **[]string** | A list of features for the campaign template. | [optional] **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template | [optional] +**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template. | [optional] **TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | Template parameters are fields which can be used to replace values in a rule. | [optional] -**ApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this campaign template | +**ApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this campaign template. | +**CampaignCollections** | Pointer to [**[]CampaignTemplateCollection**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional] +**DefaultCampaignGroupId** | Pointer to **int32** | The default campaignGroupId. | [optional] ## Methods @@ -371,6 +373,56 @@ HasApplicationsIds returns a boolean if a field has been set. SetApplicationsIds gets a reference to the given []int32 and assigns it to the ApplicationsIds field. +### GetCampaignCollections + +`func (o *UpdateCampaignTemplate) GetCampaignCollections() []CampaignTemplateCollection` + +GetCampaignCollections returns the CampaignCollections field if non-nil, zero value otherwise. + +### GetCampaignCollectionsOk + +`func (o *UpdateCampaignTemplate) GetCampaignCollectionsOk() ([]CampaignTemplateCollection, bool)` + +GetCampaignCollectionsOk returns a tuple with the CampaignCollections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignCollections + +`func (o *UpdateCampaignTemplate) HasCampaignCollections() bool` + +HasCampaignCollections returns a boolean if a field has been set. + +### SetCampaignCollections + +`func (o *UpdateCampaignTemplate) SetCampaignCollections(v []CampaignTemplateCollection)` + +SetCampaignCollections gets a reference to the given []CampaignTemplateCollection and assigns it to the CampaignCollections field. + +### GetDefaultCampaignGroupId + +`func (o *UpdateCampaignTemplate) GetDefaultCampaignGroupId() int32` + +GetDefaultCampaignGroupId returns the DefaultCampaignGroupId field if non-nil, zero value otherwise. + +### GetDefaultCampaignGroupIdOk + +`func (o *UpdateCampaignTemplate) GetDefaultCampaignGroupIdOk() (int32, bool)` + +GetDefaultCampaignGroupIdOk returns a tuple with the DefaultCampaignGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultCampaignGroupId + +`func (o *UpdateCampaignTemplate) HasDefaultCampaignGroupId() bool` + +HasDefaultCampaignGroupId returns a boolean if a field has been set. + +### SetDefaultCampaignGroupId + +`func (o *UpdateCampaignTemplate) SetDefaultCampaignGroupId(v int32)` + +SetDefaultCampaignGroupId gets a reference to the given int32 and assigns it to the DefaultCampaignGroupId field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateCatalog.md b/docs/UpdateCatalog.md new file mode 100644 index 00000000..17399b21 --- /dev/null +++ b/docs/UpdateCatalog.md @@ -0,0 +1,91 @@ +# UpdateCatalog + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | A description of this cart item catalog. | [optional] +**Name** | Pointer to **string** | Name of this cart item catalog. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this catalog. | [optional] + +## Methods + +### GetDescription + +`func (o *UpdateCatalog) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UpdateCatalog) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *UpdateCatalog) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *UpdateCatalog) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetName + +`func (o *UpdateCatalog) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateCatalog) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *UpdateCatalog) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *UpdateCatalog) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetSubscribedApplicationsIds + +`func (o *UpdateCatalog) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *UpdateCatalog) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *UpdateCatalog) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *UpdateCatalog) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateCollection.md b/docs/UpdateCollection.md index 77860d14..5c9b1e7b 100644 --- a/docs/UpdateCollection.md +++ b/docs/UpdateCollection.md @@ -4,60 +4,60 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name of this collection. | **Description** | Pointer to **string** | A short description of the purpose of this collection. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the Applications where this collection is enabled. | [optional] ## Methods -### GetName +### GetDescription -`func (o *UpdateCollection) GetName() string` +`func (o *UpdateCollection) GetDescription() string` -GetName returns the Name field if non-nil, zero value otherwise. +GetDescription returns the Description field if non-nil, zero value otherwise. -### GetNameOk +### GetDescriptionOk -`func (o *UpdateCollection) GetNameOk() (string, bool)` +`func (o *UpdateCollection) GetDescriptionOk() (string, bool)` -GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasName +### HasDescription -`func (o *UpdateCollection) HasName() bool` +`func (o *UpdateCollection) HasDescription() bool` -HasName returns a boolean if a field has been set. +HasDescription returns a boolean if a field has been set. -### SetName +### SetDescription -`func (o *UpdateCollection) SetName(v string)` +`func (o *UpdateCollection) SetDescription(v string)` -SetName gets a reference to the given string and assigns it to the Name field. +SetDescription gets a reference to the given string and assigns it to the Description field. -### GetDescription +### GetSubscribedApplicationsIds -`func (o *UpdateCollection) GetDescription() string` +`func (o *UpdateCollection) GetSubscribedApplicationsIds() []int32` -GetDescription returns the Description field if non-nil, zero value otherwise. +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. -### GetDescriptionOk +### GetSubscribedApplicationsIdsOk -`func (o *UpdateCollection) GetDescriptionOk() (string, bool)` +`func (o *UpdateCollection) GetSubscribedApplicationsIdsOk() ([]int32, bool)` -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasDescription +### HasSubscribedApplicationsIds -`func (o *UpdateCollection) HasDescription() bool` +`func (o *UpdateCollection) HasSubscribedApplicationsIds() bool` -HasDescription returns a boolean if a field has been set. +HasSubscribedApplicationsIds returns a boolean if a field has been set. -### SetDescription +### SetSubscribedApplicationsIds -`func (o *UpdateCollection) SetDescription(v string)` +`func (o *UpdateCollection) SetSubscribedApplicationsIds(v []int32)` -SetDescription gets a reference to the given string and assigns it to the Description field. +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index 3f52cb30..aec3aba7 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -4,12 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional] **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] -**RecipientIntegrationId** | Pointer to **string** | The integration ID for this coupon's beneficiary's profile | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] +**RecipientIntegrationId** | Pointer to **string** | The integration ID for this coupon's beneficiary's profile. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] ## Methods @@ -113,6 +114,31 @@ HasExpiryDate returns a boolean if a field has been set. SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +### GetLimits + +`func (o *UpdateCoupon) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *UpdateCoupon) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *UpdateCoupon) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *UpdateCoupon) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + ### GetRecipientIntegrationId `func (o *UpdateCoupon) GetRecipientIntegrationId() string` diff --git a/docs/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index a5fbb604..88a064de 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional] **DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] -**BatchID** | Pointer to **string** | The id of the batch the coupon belongs to. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**BatchID** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] ## Methods diff --git a/docs/UpdateCustomEffect.md b/docs/UpdateCustomEffect.md index 5befd324..5472782f 100644 --- a/docs/UpdateCustomEffect.md +++ b/docs/UpdateCustomEffect.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **Payload** | Pointer to **string** | The JSON payload of this effect. | **Description** | Pointer to **string** | The description of this effect. | [optional] **Enabled** | Pointer to **bool** | Determines if this effect is active. | -**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions. | [optional] ## Methods diff --git a/docs/UpdateLoyaltyCard.md b/docs/UpdateLoyaltyCard.md new file mode 100644 index 00000000..6a557acb --- /dev/null +++ b/docs/UpdateLoyaltyCard.md @@ -0,0 +1,39 @@ +# UpdateLoyaltyCard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'disabled'] | + +## Methods + +### GetStatus + +`func (o *UpdateLoyaltyCard) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *UpdateLoyaltyCard) GetStatusOk() (string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatus + +`func (o *UpdateLoyaltyCard) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatus + +`func (o *UpdateLoyaltyCard) SetStatus(v string)` + +SetStatus gets a reference to the given string and assigns it to the Status field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index 5ff05ddf..6a9ef6c1 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -9,9 +9,9 @@ Name | Type | Description | Notes **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] **DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | [optional] **DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | [optional] -**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | [optional] -**Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | [optional] -**Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program | [optional] +**AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | [optional] +**UsersPerCardLimit** | Pointer to **int32** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] +**Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] ## Methods @@ -165,30 +165,30 @@ HasAllowSubledger returns a boolean if a field has been set. SetAllowSubledger gets a reference to the given bool and assigns it to the AllowSubledger field. -### GetTimezone +### GetUsersPerCardLimit -`func (o *UpdateLoyaltyProgram) GetTimezone() string` +`func (o *UpdateLoyaltyProgram) GetUsersPerCardLimit() int32` -GetTimezone returns the Timezone field if non-nil, zero value otherwise. +GetUsersPerCardLimit returns the UsersPerCardLimit field if non-nil, zero value otherwise. -### GetTimezoneOk +### GetUsersPerCardLimitOk -`func (o *UpdateLoyaltyProgram) GetTimezoneOk() (string, bool)` +`func (o *UpdateLoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool)` -GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTimezone +### HasUsersPerCardLimit -`func (o *UpdateLoyaltyProgram) HasTimezone() bool` +`func (o *UpdateLoyaltyProgram) HasUsersPerCardLimit() bool` -HasTimezone returns a boolean if a field has been set. +HasUsersPerCardLimit returns a boolean if a field has been set. -### SetTimezone +### SetUsersPerCardLimit -`func (o *UpdateLoyaltyProgram) SetTimezone(v string)` +`func (o *UpdateLoyaltyProgram) SetUsersPerCardLimit(v int32)` -SetTimezone gets a reference to the given string and assigns it to the Timezone field. +SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. ### GetTiers diff --git a/docs/UpdateLoyaltyTier.md b/docs/UpdateLoyaltyTier.md deleted file mode 100644 index 1c40e77d..00000000 --- a/docs/UpdateLoyaltyTier.md +++ /dev/null @@ -1,65 +0,0 @@ -# UpdateLoyaltyTier - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name of the tier | -**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier | - -## Methods - -### GetName - -`func (o *UpdateLoyaltyTier) GetName() string` - -GetName returns the Name field if non-nil, zero value otherwise. - -### GetNameOk - -`func (o *UpdateLoyaltyTier) GetNameOk() (string, bool)` - -GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasName - -`func (o *UpdateLoyaltyTier) HasName() bool` - -HasName returns a boolean if a field has been set. - -### SetName - -`func (o *UpdateLoyaltyTier) SetName(v string)` - -SetName gets a reference to the given string and assigns it to the Name field. - -### GetMinPoints - -`func (o *UpdateLoyaltyTier) GetMinPoints() float32` - -GetMinPoints returns the MinPoints field if non-nil, zero value otherwise. - -### GetMinPointsOk - -`func (o *UpdateLoyaltyTier) GetMinPointsOk() (float32, bool)` - -GetMinPointsOk returns a tuple with the MinPoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasMinPoints - -`func (o *UpdateLoyaltyTier) HasMinPoints() bool` - -HasMinPoints returns a boolean if a field has been set. - -### SetMinPoints - -`func (o *UpdateLoyaltyTier) SetMinPoints(v float32)` - -SetMinPoints gets a reference to the given float32 and assigns it to the MinPoints field. - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateReferral.md b/docs/UpdateReferral.md index ac80a797..eea50498 100644 --- a/docs/UpdateReferral.md +++ b/docs/UpdateReferral.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] ## Methods diff --git a/docs/UpdateReferralBatch.md b/docs/UpdateReferralBatch.md index 05973e06..08536243 100644 --- a/docs/UpdateReferralBatch.md +++ b/docs/UpdateReferralBatch.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] **BatchID** | Pointer to **string** | The id of the batch the referral belongs to. | **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] diff --git a/docs/UpdateRole.md b/docs/UpdateRole.md index b59cd0d7..8b7bd8c7 100644 --- a/docs/UpdateRole.md +++ b/docs/UpdateRole.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | Name of the role | [optional] -**Description** | Pointer to **string** | Description of the role | [optional] -**Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json | [optional] -**Members** | Pointer to **[]int32** | An array of user identifiers | [optional] +**Name** | Pointer to **string** | Name of the role. | [optional] +**Description** | Pointer to **string** | Description of the role. | [optional] +**Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json. | [optional] +**Members** | Pointer to **[]int32** | An array of user identifiers. | [optional] ## Methods diff --git a/docs/UpdateUser.md b/docs/UpdateUser.md index 73fa46ef..d57e3944 100644 --- a/docs/UpdateUser.md +++ b/docs/UpdateUser.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | Your name. | [optional] -**Policy** | Pointer to **string** | a blob of acl json | [optional] +**Name** | Pointer to **string** | The user name. | [optional] +**Policy** | Pointer to **string** | ACL Json. | [optional] **State** | Pointer to **string** | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional] -**Roles** | Pointer to **[]int32** | Update | [optional] +**Roles** | Pointer to **[]int32** | List of roles to assign to the user. | [optional] **ApplicationNotificationSubscriptions** | Pointer to [**map[string]interface{}**](.md) | | [optional] ## Methods diff --git a/docs/UpdateUserLatestFeedTimestamp.md b/docs/UpdateUserLatestFeedTimestamp.md index 268d4060..ad73dde9 100644 --- a/docs/UpdateUserLatestFeedTimestamp.md +++ b/docs/UpdateUserLatestFeedTimestamp.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NewLatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | New timestamp to update for the current user | +**NewLatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | New timestamp to update for the current user. | ## Methods diff --git a/docs/User.md b/docs/User.md index b22880d9..1da4bdeb 100644 --- a/docs/User.md +++ b/docs/User.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | **Email** | Pointer to **string** | The email address associated with your account. | @@ -14,9 +14,9 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | Full name | **Policy** | Pointer to [**map[string]interface{}**](.md) | User ACL Policy | **LatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | Latest timestamp the user has been notified for feed. | [optional] -**Roles** | Pointer to **[]int32** | Contains a list of all roles the user is a member of | [optional] +**Roles** | Pointer to **[]int32** | Contains a list of all roles the user is a member of. | [optional] **ApplicationNotificationSubscriptions** | Pointer to [**map[string]interface{}**](.md) | | [optional] -**AuthMethod** | Pointer to **string** | The Authentication method for this user | [optional] +**AuthMethod** | Pointer to **string** | The Authentication method for this user. | [optional] ## Methods diff --git a/docs/UserFeedNotifications.md b/docs/UserFeedNotifications.md index 7cc4f520..7ebdfe3e 100644 --- a/docs/UserFeedNotifications.md +++ b/docs/UserFeedNotifications.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**LastUpdate** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the last request for this list | -**Notifications** | Pointer to [**[]FeedNotification**](FeedNotification.md) | List of all notifications to notify the user about | +**LastUpdate** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the last request for this list. | +**Notifications** | Pointer to [**[]FeedNotification**](FeedNotification.md) | List of all notifications to notify the user about. | ## Methods diff --git a/docs/Webhook.md b/docs/Webhook.md index f6e068eb..2fba63c4 100644 --- a/docs/Webhook.md +++ b/docs/Webhook.md @@ -4,17 +4,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | **ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. The IDs of the applications that are related to this entity. | -**Title** | Pointer to **string** | Friendly title for this webhook | -**Verb** | Pointer to **string** | API method for this webhook | -**Url** | Pointer to **string** | API url (supports templating using parameters) for this webhook | -**Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook | -**Payload** | Pointer to **string** | API payload (supports templating using parameters) for this webhook | [optional] -**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | -**Enabled** | Pointer to **bool** | Enables or disables webhook from showing in rule builder | +**Title** | Pointer to **string** | Friendly title for this webhook. | +**Verb** | Pointer to **string** | API method for this webhook. | +**Url** | Pointer to **string** | API url (supports templating using parameters) for this webhook. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook. | +**Payload** | Pointer to **string** | API payload (supports templating using parameters) for this webhook. | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions. | +**Enabled** | Pointer to **bool** | Enables or disables webhook from showing in rule builder. | ## Methods diff --git a/docs/WebhookActivationLogEntry.md b/docs/WebhookActivationLogEntry.md index 387a28f1..b3612ce2 100644 --- a/docs/WebhookActivationLogEntry.md +++ b/docs/WebhookActivationLogEntry.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationRequestUuid** | Pointer to **string** | UUID reference of the integration request that triggered the effect with the webhook | -**WebhookId** | Pointer to **int32** | ID of the webhook that triggered the request | -**ApplicationId** | Pointer to **int32** | ID of the application that triggered the webhook | -**CampaignId** | Pointer to **int32** | ID of the campaign that triggered the webhook | +**IntegrationRequestUuid** | Pointer to **string** | UUID reference of the integration request that triggered the effect with the webhook. | +**WebhookId** | Pointer to **int32** | ID of the webhook that triggered the request. | +**ApplicationId** | Pointer to **int32** | ID of the application that triggered the webhook. | +**CampaignId** | Pointer to **int32** | ID of the campaign that triggered the webhook. | **Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of request | ## Methods diff --git a/docs/WebhookLogEntry.md b/docs/WebhookLogEntry.md index a2fb4e88..00bb0e10 100644 --- a/docs/WebhookLogEntry.md +++ b/docs/WebhookLogEntry.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | Pointer to **string** | UUID reference of the webhook request | -**IntegrationRequestUuid** | Pointer to **string** | UUID reference of the integration request linked to this webhook request | -**WebhookId** | Pointer to **int32** | ID of the webhook that triggered the request | -**ApplicationId** | Pointer to **int32** | ID of the application that triggered the webhook | [optional] +**Id** | Pointer to **string** | UUID reference of the webhook request. | +**IntegrationRequestUuid** | Pointer to **string** | UUID reference of the integration request linked to this webhook request. | +**WebhookId** | Pointer to **int32** | ID of the webhook that triggered the request. | +**ApplicationId** | Pointer to **int32** | ID of the application that triggered the webhook. | [optional] **Url** | Pointer to **string** | Target url of request | **Request** | Pointer to **string** | Request message | **Response** | Pointer to **string** | Response message | [optional] -**Status** | Pointer to **int32** | HTTP status code of response | [optional] +**Status** | Pointer to **int32** | HTTP status code of response. | [optional] **RequestTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp of request | **ResponseTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp of response | [optional] diff --git a/model_accept_coupon_effect_props.go b/model_accept_coupon_effect_props.go index ec26ea8b..3e3d73d1 100644 --- a/model_accept_coupon_effect_props.go +++ b/model_accept_coupon_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // AcceptCouponEffectProps The properties specific to the \"acceptCoupon\" effect. This gets triggered whenever the coupon is valid and all other conditions in the rules of its campaign are met. type AcceptCouponEffectProps struct { - // The coupon code that was accepted + // The coupon code that was accepted. Value string `json:"value"` } diff --git a/model_accept_referral_effect_props.go b/model_accept_referral_effect_props.go index d075e1d8..4ca677be 100644 --- a/model_accept_referral_effect_props.go +++ b/model_accept_referral_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // AcceptReferralEffectProps The properties specific to the \"acceptReferral\" effect. TThis gets triggered whenever the referral code is valid and all other conditions in the rules of its campaign are met. type AcceptReferralEffectProps struct { - // The referral code that was accepted + // The referral code that was accepted. Value string `json:"value"` } diff --git a/model_access_log_entry.go b/model_access_log_entry.go index 77b65286..edc43ea8 100644 --- a/model_access_log_entry.go +++ b/model_access_log_entry.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,13 +15,13 @@ import ( "time" ) -// AccessLogEntry Log of application accesses +// AccessLogEntry Log of application accesses. type AccessLogEntry struct { - // UUID reference of request + // UUID reference of request. Uuid string `json:"uuid"` - // HTTP status code of response + // HTTP status code of response. Status int32 `json:"status"` - // HTTP method of request + // HTTP method of request. Method string `json:"method"` // target URI of request RequestUri string `json:"requestUri"` diff --git a/model_account.go b/model_account.go index b3ed64be..067014f5 100644 --- a/model_account.go +++ b/model_account.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,16 +17,16 @@ import ( // Account type Account struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The exact moment this entity was last modified. Modified time.Time `json:"modified"` CompanyName string `json:"companyName"` - // Subdomain Name for yourcompany.talon.one + // Subdomain Name for yourcompany.talon.one. DomainName string `json:"domainName"` - // State of the account (active, deactivated) + // State of the account (active, deactivated). State string `json:"state"` // The billing email address associated with your company account. BillingEmail string `json:"billingEmail"` @@ -50,7 +50,7 @@ type Account struct { CampaignsActiveCount int32 `json:"campaignsActiveCount"` // The current number of inactive Campaigns in your account. CampaignsInactiveCount int32 `json:"campaignsInactiveCount"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` } diff --git a/model_account_additional_cost.go b/model_account_additional_cost.go index 88e2e0a2..b61a9b5d 100644 --- a/model_account_additional_cost.go +++ b/model_account_additional_cost.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // AccountAdditionalCost type AccountAdditionalCost struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -29,8 +29,10 @@ type AccountAdditionalCost struct { Title string `json:"title"` // A description of this additional cost. Description string `json:"description"` - // A list of the IDs of the applications that are subscribed to this additional cost + // A list of the IDs of the applications that are subscribed to this additional cost. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session. + Type *string `json:"type,omitempty"` } // GetId returns the Id field value @@ -156,6 +158,39 @@ func (o *AccountAdditionalCost) SetSubscribedApplicationsIds(v []int32) { o.SubscribedApplicationsIds = &v } +// GetType returns the Type field value if set, zero value otherwise. +func (o *AccountAdditionalCost) GetType() string { + if o == nil || o.Type == nil { + var ret string + return ret + } + return *o.Type +} + +// GetTypeOk returns a tuple with the Type field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AccountAdditionalCost) GetTypeOk() (string, bool) { + if o == nil || o.Type == nil { + var ret string + return ret, false + } + return *o.Type, true +} + +// HasType returns a boolean if a field has been set. +func (o *AccountAdditionalCost) HasType() bool { + if o != nil && o.Type != nil { + return true + } + + return false +} + +// SetType gets a reference to the given string and assigns it to the Type field. +func (o *AccountAdditionalCost) SetType(v string) { + o.Type = &v +} + type NullableAccountAdditionalCost struct { Value AccountAdditionalCost ExplicitNull bool diff --git a/model_account_analytics.go b/model_account_analytics.go index 0b1bcc82..7f0c420b 100644 --- a/model_account_analytics.go +++ b/model_account_analytics.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,42 +16,44 @@ import ( // AccountAnalytics struct for AccountAnalytics type AccountAnalytics struct { - // Total number of applications in the account + // Total number of applications in the account. Applications int32 `json:"applications"` - // Total number of live applications in the account + // Total number of live applications in the account. LiveApplications int32 `json:"liveApplications"` - // Total number of sandbox applications in the account + // Total number of sandbox applications in the account. SandboxApplications int32 `json:"sandboxApplications"` - // Total number of campaigns in the account + // Total number of campaigns in the account. Campaigns int32 `json:"campaigns"` - // Total number of active campaigns in the account + // Total number of active campaigns in the account. ActiveCampaigns int32 `json:"activeCampaigns"` - // Total number of active campaigns in live applications in the account + // Total number of active campaigns in live applications in the account. LiveActiveCampaigns int32 `json:"liveActiveCampaigns"` - // Total number of coupons in the account + // Total number of coupons in the account. Coupons int32 `json:"coupons"` - // Total number of active coupons in the account + // Total number of active coupons in the account. ActiveCoupons int32 `json:"activeCoupons"` - // Total number of expired coupons in the account + // Total number of expired coupons in the account. ExpiredCoupons int32 `json:"expiredCoupons"` - // Total number of referral codes in the account + // Total number of referral codes in the account. ReferralCodes int32 `json:"referralCodes"` - // Total number of active referral codes in the account + // Total number of active referral codes in the account. ActiveReferralCodes int32 `json:"activeReferralCodes"` - // Total number of expired referral codes in the account + // Total number of expired referral codes in the account. ExpiredReferralCodes int32 `json:"expiredReferralCodes"` - // Total number of active rules in the account + // Total number of active rules in the account. ActiveRules int32 `json:"activeRules"` - // Total number of users in the account + // Total number of users in the account. Users int32 `json:"users"` - // Total number of roles in the account + // Total number of roles in the account. Roles int32 `json:"roles"` - // Total number of custom attributes in the account + // Total number of custom attributes in the account. CustomAttributes int32 `json:"customAttributes"` - // Total number of webhooks in the account + // Total number of webhooks in the account. Webhooks int32 `json:"webhooks"` - // Total number of loyalty programs in the account + // Total number of all loyalty programs in the account. LoyaltyPrograms int32 `json:"loyaltyPrograms"` + // Total number of live loyalty programs in the account. + LiveLoyaltyPrograms int32 `json:"liveLoyaltyPrograms"` } // GetApplications returns the Applications field value @@ -324,6 +326,21 @@ func (o *AccountAnalytics) SetLoyaltyPrograms(v int32) { o.LoyaltyPrograms = v } +// GetLiveLoyaltyPrograms returns the LiveLoyaltyPrograms field value +func (o *AccountAnalytics) GetLiveLoyaltyPrograms() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.LiveLoyaltyPrograms +} + +// SetLiveLoyaltyPrograms sets field value +func (o *AccountAnalytics) SetLiveLoyaltyPrograms(v int32) { + o.LiveLoyaltyPrograms = v +} + type NullableAccountAnalytics struct { Value AccountAnalytics ExplicitNull bool diff --git a/model_account_entity.go b/model_account_entity.go index c121f855..a8730b1c 100644 --- a/model_account_entity.go +++ b/model_account_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_account_limits.go b/model_account_limits.go index 5623fb68..163a2d06 100644 --- a/model_account_limits.go +++ b/model_account_limits.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // AccountLimits struct for AccountLimits type AccountLimits struct { - // Total number of allowed live applications in the account + // Total number of allowed live applications in the account. LiveApplications int32 `json:"liveApplications"` - // Total number of allowed sandbox applications in the account + // Total number of allowed sandbox applications in the account. SandboxApplications int32 `json:"sandboxApplications"` - // Total number of allowed active campaigns in live applications in the account + // Total number of allowed active campaigns in live applications in the account. ActiveCampaigns int32 `json:"activeCampaigns"` - // Total number of allowed coupons in the account + // Total number of allowed coupons in the account. Coupons int32 `json:"coupons"` - // Total number of allowed referral codes in the account + // Total number of allowed referral codes in the account. ReferralCodes int32 `json:"referralCodes"` - // Total number of allowed active rulesets in the account + // Total number of allowed active rulesets in the account. ActiveRules int32 `json:"activeRules"` - // Total number of allowed live loyalty programs in the account + // Total number of allowed live loyalty programs in the account. LiveLoyaltyPrograms int32 `json:"liveLoyaltyPrograms"` - // Total number of allowed sandbox loyalty programs in the account + // Total number of allowed sandbox loyalty programs in the account. SandboxLoyaltyPrograms int32 `json:"sandboxLoyaltyPrograms"` - // Total number of allowed webhooks in the account + // Total number of allowed webhooks in the account. Webhooks int32 `json:"webhooks"` - // Total number of allowed users in the account + // Total number of allowed users in the account. Users int32 `json:"users"` - // Allowed volume of API requests to the account + // Allowed volume of API requests to the account. ApiVolume int32 `json:"apiVolume"` - // Array of promotion types that are employed in the account + // Array of promotion types that are employed in the account. PromotionTypes []string `json:"promotionTypes"` } diff --git a/model_add_free_item_effect_props.go b/model_add_free_item_effect_props.go index 7fefe3d1..45aae92b 100644 --- a/model_add_free_item_effect_props.go +++ b/model_add_free_item_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // AddFreeItemEffectProps The properties specific to the \"addFreeItem\" effect. This gets triggered whenever a validated rule contained an \"add free item\" effect. type AddFreeItemEffectProps struct { - // SKU of the item that needs to be added + // SKU of the item that needs to be added. Sku string `json:"sku"` - // The name/description of the effect + // The name/description of the effect. Name string `json:"name"` } diff --git a/model_add_item_catalog_action.go b/model_add_item_catalog_action.go new file mode 100644 index 00000000..871232fa --- /dev/null +++ b/model_add_item_catalog_action.go @@ -0,0 +1,164 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AddItemCatalogAction The specific properties of the \"ADD\" catalog sync action. +type AddItemCatalogAction struct { + // The unique SKU of the item to add. + Sku string `json:"sku"` + // Price of the item. + Price *float32 `json:"price,omitempty"` + // The attributes of the item to add. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Indicates whether to replace the attributes of the item if the same SKU exists. + ReplaceIfExists *bool `json:"replaceIfExists,omitempty"` +} + +// GetSku returns the Sku field value +func (o *AddItemCatalogAction) GetSku() string { + if o == nil { + var ret string + return ret + } + + return o.Sku +} + +// SetSku sets field value +func (o *AddItemCatalogAction) SetSku(v string) { + o.Sku = v +} + +// GetPrice returns the Price field value if set, zero value otherwise. +func (o *AddItemCatalogAction) GetPrice() float32 { + if o == nil || o.Price == nil { + var ret float32 + return ret + } + return *o.Price +} + +// GetPriceOk returns a tuple with the Price field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddItemCatalogAction) GetPriceOk() (float32, bool) { + if o == nil || o.Price == nil { + var ret float32 + return ret, false + } + return *o.Price, true +} + +// HasPrice returns a boolean if a field has been set. +func (o *AddItemCatalogAction) HasPrice() bool { + if o != nil && o.Price != nil { + return true + } + + return false +} + +// SetPrice gets a reference to the given float32 and assigns it to the Price field. +func (o *AddItemCatalogAction) SetPrice(v float32) { + o.Price = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *AddItemCatalogAction) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddItemCatalogAction) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *AddItemCatalogAction) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *AddItemCatalogAction) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetReplaceIfExists returns the ReplaceIfExists field value if set, zero value otherwise. +func (o *AddItemCatalogAction) GetReplaceIfExists() bool { + if o == nil || o.ReplaceIfExists == nil { + var ret bool + return ret + } + return *o.ReplaceIfExists +} + +// GetReplaceIfExistsOk returns a tuple with the ReplaceIfExists field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddItemCatalogAction) GetReplaceIfExistsOk() (bool, bool) { + if o == nil || o.ReplaceIfExists == nil { + var ret bool + return ret, false + } + return *o.ReplaceIfExists, true +} + +// HasReplaceIfExists returns a boolean if a field has been set. +func (o *AddItemCatalogAction) HasReplaceIfExists() bool { + if o != nil && o.ReplaceIfExists != nil { + return true + } + + return false +} + +// SetReplaceIfExists gets a reference to the given bool and assigns it to the ReplaceIfExists field. +func (o *AddItemCatalogAction) SetReplaceIfExists(v bool) { + o.ReplaceIfExists = &v +} + +type NullableAddItemCatalogAction struct { + Value AddItemCatalogAction + ExplicitNull bool +} + +func (v NullableAddItemCatalogAction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAddItemCatalogAction) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_add_loyalty_points_effect_props.go b/model_add_loyalty_points_effect_props.go index ca30cf60..ccfbf726 100644 --- a/model_add_loyalty_points_effect_props.go +++ b/model_add_loyalty_points_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,22 +17,30 @@ import ( // AddLoyaltyPointsEffectProps The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One. type AddLoyaltyPointsEffectProps struct { - // The name/description of this loyalty point addition + // The reason of the point addition. Name string `json:"name"` - // The ID of the loyalty program where these points were added + // The ID of the loyalty program where these points were added. ProgramId int32 `json:"programId"` - // The ID of the subledger within the loyalty program where these points were added + // The ID of the subledger within the loyalty program where these points were added. SubLedgerId string `json:"subLedgerId"` - // The amount of points that were added + // The amount of points that were added. Value float32 `json:"value"` - // The user for whom these points were added + // The original amount of loyalty points to be awarded. + DesiredValue *float32 `json:"desiredValue,omitempty"` + // The user for whom these points were added. RecipientIntegrationId string `json:"recipientIntegrationId"` - // Date after which points will be valid + // Date after which points will be valid. StartDate *time.Time `json:"startDate,omitempty"` - // Date after which points will expire + // Date after which points will expire. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The identifier of this addition in the loyalty ledger + // The identifier of this addition in the loyalty ledger. TransactionUUID string `json:"transactionUUID"` + // The index of the item in the cart items list on which the loyal points addition should be applied. + CartItemPosition *float32 `json:"cartItemPosition,omitempty"` + // The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. + CartItemSubPosition *float32 `json:"cartItemSubPosition,omitempty"` + // The card on which these points were added. + CardIdentifier *string `json:"cardIdentifier,omitempty"` } // GetName returns the Name field value @@ -95,6 +103,39 @@ func (o *AddLoyaltyPointsEffectProps) SetValue(v float32) { o.Value = v } +// GetDesiredValue returns the DesiredValue field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) GetDesiredValue() float32 { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret + } + return *o.DesiredValue +} + +// GetDesiredValueOk returns a tuple with the DesiredValue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPointsEffectProps) GetDesiredValueOk() (float32, bool) { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret, false + } + return *o.DesiredValue, true +} + +// HasDesiredValue returns a boolean if a field has been set. +func (o *AddLoyaltyPointsEffectProps) HasDesiredValue() bool { + if o != nil && o.DesiredValue != nil { + return true + } + + return false +} + +// SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. +func (o *AddLoyaltyPointsEffectProps) SetDesiredValue(v float32) { + o.DesiredValue = &v +} + // GetRecipientIntegrationId returns the RecipientIntegrationId field value func (o *AddLoyaltyPointsEffectProps) GetRecipientIntegrationId() string { if o == nil { @@ -191,6 +232,105 @@ func (o *AddLoyaltyPointsEffectProps) SetTransactionUUID(v string) { o.TransactionUUID = v } +// GetCartItemPosition returns the CartItemPosition field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) GetCartItemPosition() float32 { + if o == nil || o.CartItemPosition == nil { + var ret float32 + return ret + } + return *o.CartItemPosition +} + +// GetCartItemPositionOk returns a tuple with the CartItemPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPointsEffectProps) GetCartItemPositionOk() (float32, bool) { + if o == nil || o.CartItemPosition == nil { + var ret float32 + return ret, false + } + return *o.CartItemPosition, true +} + +// HasCartItemPosition returns a boolean if a field has been set. +func (o *AddLoyaltyPointsEffectProps) HasCartItemPosition() bool { + if o != nil && o.CartItemPosition != nil { + return true + } + + return false +} + +// SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. +func (o *AddLoyaltyPointsEffectProps) SetCartItemPosition(v float32) { + o.CartItemPosition = &v +} + +// GetCartItemSubPosition returns the CartItemSubPosition field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) GetCartItemSubPosition() float32 { + if o == nil || o.CartItemSubPosition == nil { + var ret float32 + return ret + } + return *o.CartItemSubPosition +} + +// GetCartItemSubPositionOk returns a tuple with the CartItemSubPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPointsEffectProps) GetCartItemSubPositionOk() (float32, bool) { + if o == nil || o.CartItemSubPosition == nil { + var ret float32 + return ret, false + } + return *o.CartItemSubPosition, true +} + +// HasCartItemSubPosition returns a boolean if a field has been set. +func (o *AddLoyaltyPointsEffectProps) HasCartItemSubPosition() bool { + if o != nil && o.CartItemSubPosition != nil { + return true + } + + return false +} + +// SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. +func (o *AddLoyaltyPointsEffectProps) SetCartItemSubPosition(v float32) { + o.CartItemSubPosition = &v +} + +// GetCardIdentifier returns the CardIdentifier field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) GetCardIdentifier() string { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret + } + return *o.CardIdentifier +} + +// GetCardIdentifierOk returns a tuple with the CardIdentifier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool) { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret, false + } + return *o.CardIdentifier, true +} + +// HasCardIdentifier returns a boolean if a field has been set. +func (o *AddLoyaltyPointsEffectProps) HasCardIdentifier() bool { + if o != nil && o.CardIdentifier != nil { + return true + } + + return false +} + +// SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. +func (o *AddLoyaltyPointsEffectProps) SetCardIdentifier(v string) { + o.CardIdentifier = &v +} + type NullableAddLoyaltyPointsEffectProps struct { Value AddLoyaltyPointsEffectProps ExplicitNull bool diff --git a/model_additional_cost.go b/model_additional_cost.go index f845b701..23c9f6c3 100644 --- a/model_additional_cost.go +++ b/model_additional_cost.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_api_error.go b/model_api_error.go index 4705ff96..7026e122 100644 --- a/model_api_error.go +++ b/model_api_error.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_application.go b/model_application.go index 5927e887..28d5f390 100644 --- a/model_application.go +++ b/model_application.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Application type Application struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -31,28 +31,32 @@ type Application struct { Description *string `json:"description,omitempty"` // A string containing an IANA timezone descriptor. Timezone string `json:"timezone"` - // A string describing a default currency for new customer sessions. + // The default currency for new customer sessions. Currency string `json:"currency"` - // A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. + // The case sensitivity behavior to check coupon codes in the campaigns of this Application. CaseSensitivity *string `json:"caseSensitivity,omitempty"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // Default limits for campaigns created in this application + // Default limits for campaigns created in this application. Limits *[]LimitConfig `json:"limits,omitempty"` - // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" + // Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. CampaignPriority *string `json:"campaignPriority,omitempty"` - // The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" + // The strategy used when choosing exclusive campaigns for evaluation. ExclusiveCampaignsStrategy *string `json:"exclusiveCampaignsStrategy,omitempty"` - // The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. + // The default scope to apply `setDiscount` effects on if no scope was provided with the effect. DefaultDiscountScope *string `json:"defaultDiscountScope,omitempty"` - // Indicates if discounts should cascade for this application + // Indicates if discounts should cascade for this Application. EnableCascadingDiscounts *bool `json:"enableCascadingDiscounts,omitempty"` - // Indicates if cart items of quantity larger than one should be separated into different items of quantity one + // Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` - // Indicates if this is a live or sandbox application + // Indicates if this is a live or sandbox Application. Sandbox *bool `json:"sandbox,omitempty"` - // An array containing all the loyalty programs to which this application is subscribed + // Indicates if this Application supports partial discounts. + EnablePartialDiscounts *bool `json:"enablePartialDiscounts,omitempty"` + // The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. + DefaultDiscountAdditionalCostPerItemScope *string `json:"defaultDiscountAdditionalCostPerItemScope,omitempty"` + // An array containing all the loyalty programs to which this application is subscribed. LoyaltyPrograms []LoyaltyProgram `json:"loyaltyPrograms"` } @@ -524,6 +528,72 @@ func (o *Application) SetSandbox(v bool) { o.Sandbox = &v } +// GetEnablePartialDiscounts returns the EnablePartialDiscounts field value if set, zero value otherwise. +func (o *Application) GetEnablePartialDiscounts() bool { + if o == nil || o.EnablePartialDiscounts == nil { + var ret bool + return ret + } + return *o.EnablePartialDiscounts +} + +// GetEnablePartialDiscountsOk returns a tuple with the EnablePartialDiscounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetEnablePartialDiscountsOk() (bool, bool) { + if o == nil || o.EnablePartialDiscounts == nil { + var ret bool + return ret, false + } + return *o.EnablePartialDiscounts, true +} + +// HasEnablePartialDiscounts returns a boolean if a field has been set. +func (o *Application) HasEnablePartialDiscounts() bool { + if o != nil && o.EnablePartialDiscounts != nil { + return true + } + + return false +} + +// SetEnablePartialDiscounts gets a reference to the given bool and assigns it to the EnablePartialDiscounts field. +func (o *Application) SetEnablePartialDiscounts(v bool) { + o.EnablePartialDiscounts = &v +} + +// GetDefaultDiscountAdditionalCostPerItemScope returns the DefaultDiscountAdditionalCostPerItemScope field value if set, zero value otherwise. +func (o *Application) GetDefaultDiscountAdditionalCostPerItemScope() string { + if o == nil || o.DefaultDiscountAdditionalCostPerItemScope == nil { + var ret string + return ret + } + return *o.DefaultDiscountAdditionalCostPerItemScope +} + +// GetDefaultDiscountAdditionalCostPerItemScopeOk returns a tuple with the DefaultDiscountAdditionalCostPerItemScope field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetDefaultDiscountAdditionalCostPerItemScopeOk() (string, bool) { + if o == nil || o.DefaultDiscountAdditionalCostPerItemScope == nil { + var ret string + return ret, false + } + return *o.DefaultDiscountAdditionalCostPerItemScope, true +} + +// HasDefaultDiscountAdditionalCostPerItemScope returns a boolean if a field has been set. +func (o *Application) HasDefaultDiscountAdditionalCostPerItemScope() bool { + if o != nil && o.DefaultDiscountAdditionalCostPerItemScope != nil { + return true + } + + return false +} + +// SetDefaultDiscountAdditionalCostPerItemScope gets a reference to the given string and assigns it to the DefaultDiscountAdditionalCostPerItemScope field. +func (o *Application) SetDefaultDiscountAdditionalCostPerItemScope(v string) { + o.DefaultDiscountAdditionalCostPerItemScope = &v +} + // GetLoyaltyPrograms returns the LoyaltyPrograms field value func (o *Application) GetLoyaltyPrograms() []LoyaltyProgram { if o == nil { diff --git a/model_application_api_health.go b/model_application_api_health.go index 1738fcb5..b9d55bd1 100644 --- a/model_application_api_health.go +++ b/model_application_api_health.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,11 +15,11 @@ import ( "time" ) -// ApplicationApiHealth Report of health of the API connection of an application +// ApplicationApiHealth Report of health of the API connection of an application. type ApplicationApiHealth struct { - // One-word summary of the health of the API connection of an application + // One-word summary of the health of the API connection of an application. Summary string `json:"summary"` - // time of last request relevant to the API health test + // time of last request relevant to the API health test. LastUsed time.Time `json:"lastUsed"` } diff --git a/model_application_api_key.go b/model_application_api_key.go index dd244cff..4dd2dd17 100644 --- a/model_application_api_key.go +++ b/model_application_api_key.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,21 +17,21 @@ import ( // ApplicationApiKey type ApplicationApiKey struct { - // Title for API Key + // Title for API Key. Title string `json:"title"` - // The date the API key expired + // The date the API key expired. Expires time.Time `json:"expires"` - // Platform the API key is valid for. + // The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. Platform *string `json:"platform,omitempty"` - // ID of the API Key + // ID of the API Key. Id int32 `json:"id"` - // ID of user who created + // ID of user who created. CreatedBy int32 `json:"createdBy"` - // ID of account the key is used for + // ID of account the key is used for. AccountID int32 `json:"accountID"` - // ID of application the key is used for + // ID of application the key is used for. ApplicationID int32 `json:"applicationID"` - // The date the API key was created + // The date the API key was created. Created time.Time `json:"created"` } diff --git a/model_application_campaign_stats.go b/model_application_campaign_stats.go index f3c9de20..7487e2f9 100644 --- a/model_application_campaign_stats.go +++ b/model_application_campaign_stats.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,19 +14,19 @@ import ( "encoding/json" ) -// ApplicationCampaignStats Provides statistics regarding an application's campaigns +// ApplicationCampaignStats Provides statistics regarding an application's campaigns. type ApplicationCampaignStats struct { - // Number of draft campaigns + // Number of draft campaigns. Draft int32 `json:"draft"` - // Number of disabled campaigns + // Number of disabled campaigns. Disabled int32 `json:"disabled"` - // Number of scheduled campaigns + // Number of scheduled campaigns. Scheduled int32 `json:"scheduled"` - // Number of running campaigns + // Number of running campaigns. Running int32 `json:"running"` - // Number of expired campaigns + // Number of expired campaigns. Expired int32 `json:"expired"` - // Number of archived campaigns + // Number of archived campaigns. Archived int32 `json:"archived"` } diff --git a/model_application_customer.go b/model_application_customer.go index 269b6f7a..73a4e0bd 100644 --- a/model_application_customer.go +++ b/model_application_customer.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,25 +17,25 @@ import ( // ApplicationCustomer type ApplicationCustomer struct { - // Unique ID for this entity. Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. Created time.Time `json:"created"` - // The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. + // The integration ID set by your integration layer. The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes map[string]interface{} `json:"attributes"` // The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. AccountId int32 `json:"accountId"` // The total amount of closed sessions by a customer. A closed session is a successful purchase. ClosedSessions int32 `json:"closedSessions"` - // Sum of all purchases made by this customer + // Sum of all purchases made by this customer. TotalSales float32 `json:"totalSales"` - // A list of loyalty programs joined by the customer + // **DEPRECATED** A list of loyalty programs joined by the customer. LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` - // A list of audiences the customer belongs to + // A list of audiences the customer belongs to. AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` - // Timestamp of the most recent event received from this customer + // Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. LastActivity time.Time `json:"lastActivity"` // The Integration ID of the Customer Profile that referred this Customer in the Application. AdvocateIntegrationId *string `json:"advocateIntegrationId,omitempty"` diff --git a/model_application_customer_entity.go b/model_application_customer_entity.go index dacdfbc0..b70bf802 100644 --- a/model_application_customer_entity.go +++ b/model_application_customer_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_application_customer_search.go b/model_application_customer_search.go deleted file mode 100644 index 6357cf1d..00000000 --- a/model_application_customer_search.go +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Talon.One API - * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put - * - * API version: 1.0.0 - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCustomerSearch struct for ApplicationCustomerSearch -type ApplicationCustomerSearch struct { - // Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes - Attributes *map[string]interface{} `json:"attributes,omitempty"` - IntegrationIDs *[]string `json:"integrationIDs,omitempty"` - ProfileIDs *[]int32 `json:"profileIDs,omitempty"` -} - -// GetAttributes returns the Attributes field value if set, zero value otherwise. -func (o *ApplicationCustomerSearch) GetAttributes() map[string]interface{} { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret - } - return *o.Attributes -} - -// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCustomerSearch) GetAttributesOk() (map[string]interface{}, bool) { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Attributes, true -} - -// HasAttributes returns a boolean if a field has been set. -func (o *ApplicationCustomerSearch) HasAttributes() bool { - if o != nil && o.Attributes != nil { - return true - } - - return false -} - -// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. -func (o *ApplicationCustomerSearch) SetAttributes(v map[string]interface{}) { - o.Attributes = &v -} - -// GetIntegrationIDs returns the IntegrationIDs field value if set, zero value otherwise. -func (o *ApplicationCustomerSearch) GetIntegrationIDs() []string { - if o == nil || o.IntegrationIDs == nil { - var ret []string - return ret - } - return *o.IntegrationIDs -} - -// GetIntegrationIDsOk returns a tuple with the IntegrationIDs field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCustomerSearch) GetIntegrationIDsOk() ([]string, bool) { - if o == nil || o.IntegrationIDs == nil { - var ret []string - return ret, false - } - return *o.IntegrationIDs, true -} - -// HasIntegrationIDs returns a boolean if a field has been set. -func (o *ApplicationCustomerSearch) HasIntegrationIDs() bool { - if o != nil && o.IntegrationIDs != nil { - return true - } - - return false -} - -// SetIntegrationIDs gets a reference to the given []string and assigns it to the IntegrationIDs field. -func (o *ApplicationCustomerSearch) SetIntegrationIDs(v []string) { - o.IntegrationIDs = &v -} - -// GetProfileIDs returns the ProfileIDs field value if set, zero value otherwise. -func (o *ApplicationCustomerSearch) GetProfileIDs() []int32 { - if o == nil || o.ProfileIDs == nil { - var ret []int32 - return ret - } - return *o.ProfileIDs -} - -// GetProfileIDsOk returns a tuple with the ProfileIDs field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCustomerSearch) GetProfileIDsOk() ([]int32, bool) { - if o == nil || o.ProfileIDs == nil { - var ret []int32 - return ret, false - } - return *o.ProfileIDs, true -} - -// HasProfileIDs returns a boolean if a field has been set. -func (o *ApplicationCustomerSearch) HasProfileIDs() bool { - if o != nil && o.ProfileIDs != nil { - return true - } - - return false -} - -// SetProfileIDs gets a reference to the given []int32 and assigns it to the ProfileIDs field. -func (o *ApplicationCustomerSearch) SetProfileIDs(v []int32) { - o.ProfileIDs = &v -} - -type NullableApplicationCustomerSearch struct { - Value ApplicationCustomerSearch - ExplicitNull bool -} - -func (v NullableApplicationCustomerSearch) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCustomerSearch) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_entity.go b/model_application_entity.go index a84023a8..434ddff5 100644 --- a/model_application_entity.go +++ b/model_application_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_application_event.go b/model_application_event.go index 18038bf9..9f231f60 100644 --- a/model_application_event.go +++ b/model_application_event.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // ApplicationEvent type ApplicationEvent struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_application_notification.go b/model_application_notification.go new file mode 100644 index 00000000..fb8a6efd --- /dev/null +++ b/model_application_notification.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ApplicationNotification struct for ApplicationNotification +type ApplicationNotification struct { + // Event type. It can be one of the following: ['campaign_priorities_changed'] + Event string `json:"event"` +} + +// GetEvent returns the Event field value +func (o *ApplicationNotification) GetEvent() string { + if o == nil { + var ret string + return ret + } + + return o.Event +} + +// SetEvent sets field value +func (o *ApplicationNotification) SetEvent(v string) { + o.Event = v +} + +type NullableApplicationNotification struct { + Value ApplicationNotification + ExplicitNull bool +} + +func (v NullableApplicationNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableApplicationNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_application_referee.go b/model_application_referee.go index 80da5ccd..b2676af3 100644 --- a/model_application_referee.go +++ b/model_application_referee.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -19,15 +19,15 @@ import ( type ApplicationReferee struct { // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` - // Integration ID of the session in which the customer redeemed the referral + // Integration ID of the session in which the customer redeemed the referral. SessionId string `json:"sessionId"` - // Integration ID of the Advocate's Profile + // Integration ID of the Advocate's Profile. AdvocateIntegrationId string `json:"advocateIntegrationId"` - // Integration ID of the Friend's Profile + // Integration ID of the Friend's Profile. FriendIntegrationId string `json:"friendIntegrationId"` // Advocate's referral code. Code string `json:"code"` - // Timestamp of the moment the customer redeemed the referral + // Timestamp of the moment the customer redeemed the referral. Created time.Time `json:"created"` } diff --git a/model_application_session.go b/model_application_session.go index 45503d96..732d7dac 100644 --- a/model_application_session.go +++ b/model_application_session.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // ApplicationSession type ApplicationSession struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. The exact moment this entity was created. Created time.Time `json:"created"` @@ -25,7 +25,7 @@ type ApplicationSession struct { ApplicationId int32 `json:"applicationId"` // The globally unique Talon.One ID of the customer that created this entity. ProfileId *int32 `json:"profileId,omitempty"` - // The integration ID for this entity sent to and used in the Talon.One system. + // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` // Integration ID of the customer for the session. Profileintegrationid *string `json:"profileintegrationid,omitempty"` @@ -33,15 +33,17 @@ type ApplicationSession struct { Coupon string `json:"coupon"` // Any referral code entered. Referral string `json:"referral"` - // Indicating if the customer session is in progress (`open`), `closed`, or `cancelled`. For more information about customer sessions, see [Customer sessions](/docs/dev/concepts/entities#customer-session-states) in the docs. + // Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). State string `json:"state"` // Serialized JSON representation. CartItems []CartItem `json:"cartItems"` - // A map of labelled discount values, in the same currency as the session. + // **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. Discounts map[string]float32 `json:"discounts"` + // The total sum of the discounts applied to this session. + TotalDiscounts float32 `json:"totalDiscounts"` // The total sum of the session before any discounts applied. Total float32 `json:"total"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` } @@ -246,6 +248,21 @@ func (o *ApplicationSession) SetDiscounts(v map[string]float32) { o.Discounts = v } +// GetTotalDiscounts returns the TotalDiscounts field value +func (o *ApplicationSession) GetTotalDiscounts() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalDiscounts +} + +// SetTotalDiscounts sets field value +func (o *ApplicationSession) SetTotalDiscounts(v float32) { + o.TotalDiscounts = v +} + // GetTotal returns the Total field value func (o *ApplicationSession) GetTotal() float32 { if o == nil { diff --git a/model_application_session_entity.go b/model_application_session_entity.go index 1f86ebb2..6c54acd7 100644 --- a/model_application_session_entity.go +++ b/model_application_session_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_async_coupon_creation_response.go b/model_async_coupon_creation_response.go new file mode 100644 index 00000000..6861329a --- /dev/null +++ b/model_async_coupon_creation_response.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AsyncCouponCreationResponse struct for AsyncCouponCreationResponse +type AsyncCouponCreationResponse struct { + // The batch ID that all coupons created by the request will have. + BatchId string `json:"batchId"` +} + +// GetBatchId returns the BatchId field value +func (o *AsyncCouponCreationResponse) GetBatchId() string { + if o == nil { + var ret string + return ret + } + + return o.BatchId +} + +// SetBatchId sets field value +func (o *AsyncCouponCreationResponse) SetBatchId(v string) { + o.BatchId = v +} + +type NullableAsyncCouponCreationResponse struct { + Value AsyncCouponCreationResponse + ExplicitNull bool +} + +func (v NullableAsyncCouponCreationResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAsyncCouponCreationResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_attribute.go b/model_attribute.go index 66a57a73..f9647de3 100644 --- a/model_attribute.go +++ b/model_attribute.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Attribute type Attribute struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -36,10 +36,19 @@ type Attribute struct { Description string `json:"description"` // A list of suggestions for the attribute. Suggestions []string `json:"suggestions"` + // Whether or not this attribute has an allowed list of values associated with it. + HasAllowedList *bool `json:"hasAllowedList,omitempty"` + // Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). + RestrictedBySuggestions *bool `json:"restrictedBySuggestions,omitempty"` // Whether or not this attribute can be edited. Editable bool `json:"editable"` - // A list of the IDs of the applications that are subscribed to this attribute + // A list of the IDs of the applications where this attribute is available. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // A list of the IDs of the catalogs where this attribute is available. + SubscribedCatalogsIds *[]int32 `json:"subscribedCatalogsIds,omitempty"` + // A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. + AllowedSubscriptions *[]string `json:"allowedSubscriptions,omitempty"` + EventTypeId *int32 `json:"eventTypeId,omitempty"` } // GetId returns the Id field value @@ -210,6 +219,72 @@ func (o *Attribute) SetSuggestions(v []string) { o.Suggestions = v } +// GetHasAllowedList returns the HasAllowedList field value if set, zero value otherwise. +func (o *Attribute) GetHasAllowedList() bool { + if o == nil || o.HasAllowedList == nil { + var ret bool + return ret + } + return *o.HasAllowedList +} + +// GetHasAllowedListOk returns a tuple with the HasAllowedList field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Attribute) GetHasAllowedListOk() (bool, bool) { + if o == nil || o.HasAllowedList == nil { + var ret bool + return ret, false + } + return *o.HasAllowedList, true +} + +// HasHasAllowedList returns a boolean if a field has been set. +func (o *Attribute) HasHasAllowedList() bool { + if o != nil && o.HasAllowedList != nil { + return true + } + + return false +} + +// SetHasAllowedList gets a reference to the given bool and assigns it to the HasAllowedList field. +func (o *Attribute) SetHasAllowedList(v bool) { + o.HasAllowedList = &v +} + +// GetRestrictedBySuggestions returns the RestrictedBySuggestions field value if set, zero value otherwise. +func (o *Attribute) GetRestrictedBySuggestions() bool { + if o == nil || o.RestrictedBySuggestions == nil { + var ret bool + return ret + } + return *o.RestrictedBySuggestions +} + +// GetRestrictedBySuggestionsOk returns a tuple with the RestrictedBySuggestions field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Attribute) GetRestrictedBySuggestionsOk() (bool, bool) { + if o == nil || o.RestrictedBySuggestions == nil { + var ret bool + return ret, false + } + return *o.RestrictedBySuggestions, true +} + +// HasRestrictedBySuggestions returns a boolean if a field has been set. +func (o *Attribute) HasRestrictedBySuggestions() bool { + if o != nil && o.RestrictedBySuggestions != nil { + return true + } + + return false +} + +// SetRestrictedBySuggestions gets a reference to the given bool and assigns it to the RestrictedBySuggestions field. +func (o *Attribute) SetRestrictedBySuggestions(v bool) { + o.RestrictedBySuggestions = &v +} + // GetEditable returns the Editable field value func (o *Attribute) GetEditable() bool { if o == nil { @@ -258,6 +333,105 @@ func (o *Attribute) SetSubscribedApplicationsIds(v []int32) { o.SubscribedApplicationsIds = &v } +// GetSubscribedCatalogsIds returns the SubscribedCatalogsIds field value if set, zero value otherwise. +func (o *Attribute) GetSubscribedCatalogsIds() []int32 { + if o == nil || o.SubscribedCatalogsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedCatalogsIds +} + +// GetSubscribedCatalogsIdsOk returns a tuple with the SubscribedCatalogsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Attribute) GetSubscribedCatalogsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedCatalogsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedCatalogsIds, true +} + +// HasSubscribedCatalogsIds returns a boolean if a field has been set. +func (o *Attribute) HasSubscribedCatalogsIds() bool { + if o != nil && o.SubscribedCatalogsIds != nil { + return true + } + + return false +} + +// SetSubscribedCatalogsIds gets a reference to the given []int32 and assigns it to the SubscribedCatalogsIds field. +func (o *Attribute) SetSubscribedCatalogsIds(v []int32) { + o.SubscribedCatalogsIds = &v +} + +// GetAllowedSubscriptions returns the AllowedSubscriptions field value if set, zero value otherwise. +func (o *Attribute) GetAllowedSubscriptions() []string { + if o == nil || o.AllowedSubscriptions == nil { + var ret []string + return ret + } + return *o.AllowedSubscriptions +} + +// GetAllowedSubscriptionsOk returns a tuple with the AllowedSubscriptions field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Attribute) GetAllowedSubscriptionsOk() ([]string, bool) { + if o == nil || o.AllowedSubscriptions == nil { + var ret []string + return ret, false + } + return *o.AllowedSubscriptions, true +} + +// HasAllowedSubscriptions returns a boolean if a field has been set. +func (o *Attribute) HasAllowedSubscriptions() bool { + if o != nil && o.AllowedSubscriptions != nil { + return true + } + + return false +} + +// SetAllowedSubscriptions gets a reference to the given []string and assigns it to the AllowedSubscriptions field. +func (o *Attribute) SetAllowedSubscriptions(v []string) { + o.AllowedSubscriptions = &v +} + +// GetEventTypeId returns the EventTypeId field value if set, zero value otherwise. +func (o *Attribute) GetEventTypeId() int32 { + if o == nil || o.EventTypeId == nil { + var ret int32 + return ret + } + return *o.EventTypeId +} + +// GetEventTypeIdOk returns a tuple with the EventTypeId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Attribute) GetEventTypeIdOk() (int32, bool) { + if o == nil || o.EventTypeId == nil { + var ret int32 + return ret, false + } + return *o.EventTypeId, true +} + +// HasEventTypeId returns a boolean if a field has been set. +func (o *Attribute) HasEventTypeId() bool { + if o != nil && o.EventTypeId != nil { + return true + } + + return false +} + +// SetEventTypeId gets a reference to the given int32 and assigns it to the EventTypeId field. +func (o *Attribute) SetEventTypeId(v int32) { + o.EventTypeId = &v +} + type NullableAttribute struct { Value Attribute ExplicitNull bool diff --git a/model_attributes_mandatory.go b/model_attributes_mandatory.go index 083e327f..796ef840 100644 --- a/model_attributes_mandatory.go +++ b/model_attributes_mandatory.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_attributes_settings.go b/model_attributes_settings.go index ee739fdc..2bc834ee 100644 --- a/model_attributes_settings.go +++ b/model_attributes_settings.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_audience.go b/model_audience.go index 453d7251..7347ad7b 100644 --- a/model_audience.go +++ b/model_audience.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -19,16 +19,22 @@ import ( type Audience struct { // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` - // The human-friendly display name for this Audience. + // The human-friendly display name for this audience. Name string `json:"name"` - // Integration that this audience was created in. - Integration string `json:"integration"` - // The ID of this Audience in the third-party integration - IntegrationId string `json:"integrationId"` + // Indicates if this is a live or sandbox Application. + Sandbox *bool `json:"sandbox,omitempty"` + // A description of the audience. + Description *string `json:"description,omitempty"` + // The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. + Integration *string `json:"integration,omitempty"` + // The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. + IntegrationId *string `json:"integrationId,omitempty"` + // Determines if this audience is a 3rd party audience or not. + CreatedIn3rdParty *bool `json:"createdIn3rdParty,omitempty"` } // GetAccountId returns the AccountId field value @@ -91,34 +97,169 @@ func (o *Audience) SetName(v string) { o.Name = v } -// GetIntegration returns the Integration field value +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *Audience) GetSandbox() bool { + if o == nil || o.Sandbox == nil { + var ret bool + return ret + } + return *o.Sandbox +} + +// GetSandboxOk returns a tuple with the Sandbox field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Audience) GetSandboxOk() (bool, bool) { + if o == nil || o.Sandbox == nil { + var ret bool + return ret, false + } + return *o.Sandbox, true +} + +// HasSandbox returns a boolean if a field has been set. +func (o *Audience) HasSandbox() bool { + if o != nil && o.Sandbox != nil { + return true + } + + return false +} + +// SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +func (o *Audience) SetSandbox(v bool) { + o.Sandbox = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *Audience) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Audience) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *Audience) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *Audience) SetDescription(v string) { + o.Description = &v +} + +// GetIntegration returns the Integration field value if set, zero value otherwise. func (o *Audience) GetIntegration() string { - if o == nil { + if o == nil || o.Integration == nil { var ret string return ret } + return *o.Integration +} + +// GetIntegrationOk returns a tuple with the Integration field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Audience) GetIntegrationOk() (string, bool) { + if o == nil || o.Integration == nil { + var ret string + return ret, false + } + return *o.Integration, true +} + +// HasIntegration returns a boolean if a field has been set. +func (o *Audience) HasIntegration() bool { + if o != nil && o.Integration != nil { + return true + } - return o.Integration + return false } -// SetIntegration sets field value +// SetIntegration gets a reference to the given string and assigns it to the Integration field. func (o *Audience) SetIntegration(v string) { - o.Integration = v + o.Integration = &v } -// GetIntegrationId returns the IntegrationId field value +// GetIntegrationId returns the IntegrationId field value if set, zero value otherwise. func (o *Audience) GetIntegrationId() string { - if o == nil { + if o == nil || o.IntegrationId == nil { var ret string return ret } + return *o.IntegrationId +} + +// GetIntegrationIdOk returns a tuple with the IntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Audience) GetIntegrationIdOk() (string, bool) { + if o == nil || o.IntegrationId == nil { + var ret string + return ret, false + } + return *o.IntegrationId, true +} + +// HasIntegrationId returns a boolean if a field has been set. +func (o *Audience) HasIntegrationId() bool { + if o != nil && o.IntegrationId != nil { + return true + } - return o.IntegrationId + return false } -// SetIntegrationId sets field value +// SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. func (o *Audience) SetIntegrationId(v string) { - o.IntegrationId = v + o.IntegrationId = &v +} + +// GetCreatedIn3rdParty returns the CreatedIn3rdParty field value if set, zero value otherwise. +func (o *Audience) GetCreatedIn3rdParty() bool { + if o == nil || o.CreatedIn3rdParty == nil { + var ret bool + return ret + } + return *o.CreatedIn3rdParty +} + +// GetCreatedIn3rdPartyOk returns a tuple with the CreatedIn3rdParty field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Audience) GetCreatedIn3rdPartyOk() (bool, bool) { + if o == nil || o.CreatedIn3rdParty == nil { + var ret bool + return ret, false + } + return *o.CreatedIn3rdParty, true +} + +// HasCreatedIn3rdParty returns a boolean if a field has been set. +func (o *Audience) HasCreatedIn3rdParty() bool { + if o != nil && o.CreatedIn3rdParty != nil { + return true + } + + return false +} + +// SetCreatedIn3rdParty gets a reference to the given bool and assigns it to the CreatedIn3rdParty field. +func (o *Audience) SetCreatedIn3rdParty(v bool) { + o.CreatedIn3rdParty = &v } type NullableAudience struct { diff --git a/model_audience_analytics.go b/model_audience_analytics.go new file mode 100644 index 00000000..4994a4e8 --- /dev/null +++ b/model_audience_analytics.go @@ -0,0 +1,112 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AudienceAnalytics The audiences and their members count. +type AudienceAnalytics struct { + // The ID of the audience. + AudienceId *int32 `json:"audienceId,omitempty"` + // The count of members under a single audience. + MembersCount *int32 `json:"membersCount,omitempty"` +} + +// GetAudienceId returns the AudienceId field value if set, zero value otherwise. +func (o *AudienceAnalytics) GetAudienceId() int32 { + if o == nil || o.AudienceId == nil { + var ret int32 + return ret + } + return *o.AudienceId +} + +// GetAudienceIdOk returns a tuple with the AudienceId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceAnalytics) GetAudienceIdOk() (int32, bool) { + if o == nil || o.AudienceId == nil { + var ret int32 + return ret, false + } + return *o.AudienceId, true +} + +// HasAudienceId returns a boolean if a field has been set. +func (o *AudienceAnalytics) HasAudienceId() bool { + if o != nil && o.AudienceId != nil { + return true + } + + return false +} + +// SetAudienceId gets a reference to the given int32 and assigns it to the AudienceId field. +func (o *AudienceAnalytics) SetAudienceId(v int32) { + o.AudienceId = &v +} + +// GetMembersCount returns the MembersCount field value if set, zero value otherwise. +func (o *AudienceAnalytics) GetMembersCount() int32 { + if o == nil || o.MembersCount == nil { + var ret int32 + return ret + } + return *o.MembersCount +} + +// GetMembersCountOk returns a tuple with the MembersCount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceAnalytics) GetMembersCountOk() (int32, bool) { + if o == nil || o.MembersCount == nil { + var ret int32 + return ret, false + } + return *o.MembersCount, true +} + +// HasMembersCount returns a boolean if a field has been set. +func (o *AudienceAnalytics) HasMembersCount() bool { + if o != nil && o.MembersCount != nil { + return true + } + + return false +} + +// SetMembersCount gets a reference to the given int32 and assigns it to the MembersCount field. +func (o *AudienceAnalytics) SetMembersCount(v int32) { + o.MembersCount = &v +} + +type NullableAudienceAnalytics struct { + Value AudienceAnalytics + ExplicitNull bool +} + +func (v NullableAudienceAnalytics) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAudienceAnalytics) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_audience_integration_id.go b/model_audience_integration_id.go new file mode 100644 index 00000000..0638c1b8 --- /dev/null +++ b/model_audience_integration_id.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AudienceIntegrationId struct for AudienceIntegrationId +type AudienceIntegrationId struct { + // The ID of this audience in the third-party integration. + IntegrationId *string `json:"integrationId,omitempty"` +} + +// GetIntegrationId returns the IntegrationId field value if set, zero value otherwise. +func (o *AudienceIntegrationId) GetIntegrationId() string { + if o == nil || o.IntegrationId == nil { + var ret string + return ret + } + return *o.IntegrationId +} + +// GetIntegrationIdOk returns a tuple with the IntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceIntegrationId) GetIntegrationIdOk() (string, bool) { + if o == nil || o.IntegrationId == nil { + var ret string + return ret, false + } + return *o.IntegrationId, true +} + +// HasIntegrationId returns a boolean if a field has been set. +func (o *AudienceIntegrationId) HasIntegrationId() bool { + if o != nil && o.IntegrationId != nil { + return true + } + + return false +} + +// SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. +func (o *AudienceIntegrationId) SetIntegrationId(v string) { + o.IntegrationId = &v +} + +type NullableAudienceIntegrationId struct { + Value AudienceIntegrationId + ExplicitNull bool +} + +func (v NullableAudienceIntegrationId) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAudienceIntegrationId) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_audience_membership.go b/model_audience_membership.go index 0f50f93d..d67282fe 100644 --- a/model_audience_membership.go +++ b/model_audience_membership.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_award_giveaway_effect_props.go b/model_award_giveaway_effect_props.go index 0896843e..0dc3400c 100644 --- a/model_award_giveaway_effect_props.go +++ b/model_award_giveaway_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_base_loyalty_program.go b/model_base_loyalty_program.go index 72cbad03..dcd64f6b 100644 --- a/model_base_loyalty_program.go +++ b/model_base_loyalty_program.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -26,10 +26,10 @@ type BaseLoyaltyProgram struct { DefaultValidity *string `json:"defaultValidity,omitempty"` // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. DefaultPending *string `json:"defaultPending,omitempty"` - // Indicates if this program supports subledgers inside the program + // Indicates if this program supports subledgers inside the program. AllowSubledger *bool `json:"allowSubledger,omitempty"` - // A string containing an IANA timezone descriptor. - Timezone *string `json:"timezone,omitempty"` + // The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. + UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` } // GetTitle returns the Title field value if set, zero value otherwise. @@ -230,37 +230,37 @@ func (o *BaseLoyaltyProgram) SetAllowSubledger(v bool) { o.AllowSubledger = &v } -// GetTimezone returns the Timezone field value if set, zero value otherwise. -func (o *BaseLoyaltyProgram) GetTimezone() string { - if o == nil || o.Timezone == nil { - var ret string +// GetUsersPerCardLimit returns the UsersPerCardLimit field value if set, zero value otherwise. +func (o *BaseLoyaltyProgram) GetUsersPerCardLimit() int32 { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret } - return *o.Timezone + return *o.UsersPerCardLimit } -// GetTimezoneOk returns a tuple with the Timezone field value if set, zero value otherwise +// GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *BaseLoyaltyProgram) GetTimezoneOk() (string, bool) { - if o == nil || o.Timezone == nil { - var ret string +func (o *BaseLoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool) { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret, false } - return *o.Timezone, true + return *o.UsersPerCardLimit, true } -// HasTimezone returns a boolean if a field has been set. -func (o *BaseLoyaltyProgram) HasTimezone() bool { - if o != nil && o.Timezone != nil { +// HasUsersPerCardLimit returns a boolean if a field has been set. +func (o *BaseLoyaltyProgram) HasUsersPerCardLimit() bool { + if o != nil && o.UsersPerCardLimit != nil { return true } return false } -// SetTimezone gets a reference to the given string and assigns it to the Timezone field. -func (o *BaseLoyaltyProgram) SetTimezone(v string) { - o.Timezone = &v +// SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +func (o *BaseLoyaltyProgram) SetUsersPerCardLimit(v int32) { + o.UsersPerCardLimit = &v } type NullableBaseLoyaltyProgram struct { diff --git a/model_base_saml_connection.go b/model_base_saml_connection.go index 6355ee8f..3e49714c 100644 --- a/model_base_saml_connection.go +++ b/model_base_saml_connection.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_binding.go b/model_binding.go index b74d778f..0a66e725 100644 --- a/model_binding.go +++ b/model_binding.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -18,10 +18,12 @@ import ( type Binding struct { // A descriptive name for the value to be bound. Name string `json:"name"` - // The kind of binding. Possible values are cartItemFilter, subledgerBalance. + // The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` Type *string `json:"type,omitempty"` // A Talang expression that will be evaluated and its result attached to the name of the binding. Expression []interface{} `json:"expression"` + // Can be one of the following: - `string` - `number` - `boolean` + ValueType *string `json:"valueType,omitempty"` } // GetName returns the Name field value @@ -87,6 +89,39 @@ func (o *Binding) SetExpression(v []interface{}) { o.Expression = v } +// GetValueType returns the ValueType field value if set, zero value otherwise. +func (o *Binding) GetValueType() string { + if o == nil || o.ValueType == nil { + var ret string + return ret + } + return *o.ValueType +} + +// GetValueTypeOk returns a tuple with the ValueType field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Binding) GetValueTypeOk() (string, bool) { + if o == nil || o.ValueType == nil { + var ret string + return ret, false + } + return *o.ValueType, true +} + +// HasValueType returns a boolean if a field has been set. +func (o *Binding) HasValueType() bool { + if o != nil && o.ValueType != nil { + return true + } + + return false +} + +// SetValueType gets a reference to the given string and assigns it to the ValueType field. +func (o *Binding) SetValueType(v string) { + o.ValueType = &v +} + type NullableBinding struct { Value Binding ExplicitNull bool diff --git a/model_bulk_application_notification.go b/model_bulk_application_notification.go new file mode 100644 index 00000000..b5ed8526 --- /dev/null +++ b/model_bulk_application_notification.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// BulkApplicationNotification struct for BulkApplicationNotification +type BulkApplicationNotification struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []ApplicationNotification `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *BulkApplicationNotification) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *BulkApplicationNotification) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *BulkApplicationNotification) GetData() []ApplicationNotification { + if o == nil { + var ret []ApplicationNotification + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *BulkApplicationNotification) SetData(v []ApplicationNotification) { + o.Data = v +} + +type NullableBulkApplicationNotification struct { + Value BulkApplicationNotification + ExplicitNull bool +} + +func (v NullableBulkApplicationNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableBulkApplicationNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_bulk_campaign_notification.go b/model_bulk_campaign_notification.go new file mode 100644 index 00000000..8ba020e7 --- /dev/null +++ b/model_bulk_campaign_notification.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// BulkCampaignNotification struct for BulkCampaignNotification +type BulkCampaignNotification struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []CampaignNotification `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *BulkCampaignNotification) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *BulkCampaignNotification) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *BulkCampaignNotification) GetData() []CampaignNotification { + if o == nil { + var ret []CampaignNotification + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *BulkCampaignNotification) SetData(v []CampaignNotification) { + o.Data = v +} + +type NullableBulkCampaignNotification struct { + Value BulkCampaignNotification + ExplicitNull bool +} + +func (v NullableBulkCampaignNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableBulkCampaignNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign.go b/model_campaign.go index d47a54b7..d5b38d5f 100644 --- a/model_campaign.go +++ b/model_campaign.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -33,21 +33,21 @@ type Campaign struct { StartTime *time.Time `json:"startTime,omitempty"` // Timestamp the campaign will become inactive. EndTime *time.Time `json:"endTime,omitempty"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` // A disabled or archived campaign is not evaluated for rules or coupons. State string `json:"state"` - // ID of Ruleset this campaign applies on customer session evaluation. + // [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this campaign applies on customer session evaluation. ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` // A list of tags for the campaign. Tags []string `json:"tags"` - // A list of features for the campaign. + // The features enabled in this campaign. Features []string `json:"features"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of limits that will operate for this campaign + // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. Limits []LimitConfig `json:"limits"` - // The IDs of the campaign groups that own this entity. + // The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` // Number of coupons redeemed in the campaign. CouponRedemptionCount *int32 `json:"couponRedemptionCount,omitempty"` @@ -59,8 +59,12 @@ type Campaign struct { DiscountEffectCount *int32 `json:"discountEffectCount,omitempty"` // Total number of coupons created by rules in this campaign. CouponCreationCount *int32 `json:"couponCreationCount,omitempty"` + // Total number of custom effects triggered by rules in this campaign. + CustomEffectCount *int32 `json:"customEffectCount,omitempty"` // Total number of referrals created by rules in this campaign. ReferralCreationCount *int32 `json:"referralCreationCount,omitempty"` + // Total number of times triggering add free item effext is allowed in this campaign. + AddFreeItemEffectCount *int32 `json:"addFreeItemEffectCount,omitempty"` // Total number of giveaways awarded by rules in this campaign. AwardedGiveawaysCount *int32 `json:"awardedGiveawaysCount,omitempty"` // Total number of loyalty points created by rules in this campaign. @@ -71,9 +75,11 @@ type Campaign struct { RedeemedLoyaltyPointsCount *float32 `json:"redeemedLoyaltyPointsCount,omitempty"` // Total number of loyalty point redemption effects triggered by rules in this campaign. RedeemedLoyaltyPointsEffectCount *int32 `json:"redeemedLoyaltyPointsEffectCount,omitempty"` + // Total number of webhook triggered by rules in this campaign. + CallApiEffectCount *int32 `json:"callApiEffectCount,omitempty"` // Timestamp of the most recent event received by this campaign. LastActivity *time.Time `json:"lastActivity,omitempty"` - // Timestamp of the most recent update to the campaign or any of its elements. + // Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. Updated *time.Time `json:"updated,omitempty"` // Name of the user who created this campaign if available. CreatedBy *string `json:"createdBy,omitempty"` @@ -629,6 +635,39 @@ func (o *Campaign) SetCouponCreationCount(v int32) { o.CouponCreationCount = &v } +// GetCustomEffectCount returns the CustomEffectCount field value if set, zero value otherwise. +func (o *Campaign) GetCustomEffectCount() int32 { + if o == nil || o.CustomEffectCount == nil { + var ret int32 + return ret + } + return *o.CustomEffectCount +} + +// GetCustomEffectCountOk returns a tuple with the CustomEffectCount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetCustomEffectCountOk() (int32, bool) { + if o == nil || o.CustomEffectCount == nil { + var ret int32 + return ret, false + } + return *o.CustomEffectCount, true +} + +// HasCustomEffectCount returns a boolean if a field has been set. +func (o *Campaign) HasCustomEffectCount() bool { + if o != nil && o.CustomEffectCount != nil { + return true + } + + return false +} + +// SetCustomEffectCount gets a reference to the given int32 and assigns it to the CustomEffectCount field. +func (o *Campaign) SetCustomEffectCount(v int32) { + o.CustomEffectCount = &v +} + // GetReferralCreationCount returns the ReferralCreationCount field value if set, zero value otherwise. func (o *Campaign) GetReferralCreationCount() int32 { if o == nil || o.ReferralCreationCount == nil { @@ -662,6 +701,39 @@ func (o *Campaign) SetReferralCreationCount(v int32) { o.ReferralCreationCount = &v } +// GetAddFreeItemEffectCount returns the AddFreeItemEffectCount field value if set, zero value otherwise. +func (o *Campaign) GetAddFreeItemEffectCount() int32 { + if o == nil || o.AddFreeItemEffectCount == nil { + var ret int32 + return ret + } + return *o.AddFreeItemEffectCount +} + +// GetAddFreeItemEffectCountOk returns a tuple with the AddFreeItemEffectCount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetAddFreeItemEffectCountOk() (int32, bool) { + if o == nil || o.AddFreeItemEffectCount == nil { + var ret int32 + return ret, false + } + return *o.AddFreeItemEffectCount, true +} + +// HasAddFreeItemEffectCount returns a boolean if a field has been set. +func (o *Campaign) HasAddFreeItemEffectCount() bool { + if o != nil && o.AddFreeItemEffectCount != nil { + return true + } + + return false +} + +// SetAddFreeItemEffectCount gets a reference to the given int32 and assigns it to the AddFreeItemEffectCount field. +func (o *Campaign) SetAddFreeItemEffectCount(v int32) { + o.AddFreeItemEffectCount = &v +} + // GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field value if set, zero value otherwise. func (o *Campaign) GetAwardedGiveawaysCount() int32 { if o == nil || o.AwardedGiveawaysCount == nil { @@ -827,6 +899,39 @@ func (o *Campaign) SetRedeemedLoyaltyPointsEffectCount(v int32) { o.RedeemedLoyaltyPointsEffectCount = &v } +// GetCallApiEffectCount returns the CallApiEffectCount field value if set, zero value otherwise. +func (o *Campaign) GetCallApiEffectCount() int32 { + if o == nil || o.CallApiEffectCount == nil { + var ret int32 + return ret + } + return *o.CallApiEffectCount +} + +// GetCallApiEffectCountOk returns a tuple with the CallApiEffectCount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetCallApiEffectCountOk() (int32, bool) { + if o == nil || o.CallApiEffectCount == nil { + var ret int32 + return ret, false + } + return *o.CallApiEffectCount, true +} + +// HasCallApiEffectCount returns a boolean if a field has been set. +func (o *Campaign) HasCallApiEffectCount() bool { + if o != nil && o.CallApiEffectCount != nil { + return true + } + + return false +} + +// SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. +func (o *Campaign) SetCallApiEffectCount(v int32) { + o.CallApiEffectCount = &v +} + // GetLastActivity returns the LastActivity field value if set, zero value otherwise. func (o *Campaign) GetLastActivity() time.Time { if o == nil || o.LastActivity == nil { diff --git a/model_campaign_activation_request.go b/model_campaign_activation_request.go new file mode 100644 index 00000000..aff58ce9 --- /dev/null +++ b/model_campaign_activation_request.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignActivationRequest struct for CampaignActivationRequest +type CampaignActivationRequest struct { + // The list of IDs of the users who will receive the activation request. + UserIds []int32 `json:"userIds"` +} + +// GetUserIds returns the UserIds field value +func (o *CampaignActivationRequest) GetUserIds() []int32 { + if o == nil { + var ret []int32 + return ret + } + + return o.UserIds +} + +// SetUserIds sets field value +func (o *CampaignActivationRequest) SetUserIds(v []int32) { + o.UserIds = v +} + +type NullableCampaignActivationRequest struct { + Value CampaignActivationRequest + ExplicitNull bool +} + +func (v NullableCampaignActivationRequest) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignActivationRequest) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_analytics.go b/model_campaign_analytics.go index db19c3d7..348ee80b 100644 --- a/model_campaign_analytics.go +++ b/model_campaign_analytics.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_campaign_collection.go b/model_campaign_collection.go new file mode 100644 index 00000000..dd9cdc12 --- /dev/null +++ b/model_campaign_collection.go @@ -0,0 +1,320 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CampaignCollection +type CampaignCollection struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // A short description of the purpose of this collection. + Description *string `json:"description,omitempty"` + // The name of this collection. + Name string `json:"name"` + // ID of the user who last updated this effect if available. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // ID of the user who created this effect. + CreatedBy int32 `json:"createdBy"` + // The ID of the Application that owns this entity. + ApplicationId *int32 `json:"applicationId,omitempty"` + // The ID of the campaign that owns this entity. + CampaignId *int32 `json:"campaignId,omitempty"` + // The content of the collection. + Payload *[]string `json:"payload,omitempty"` +} + +// GetId returns the Id field value +func (o *CampaignCollection) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CampaignCollection) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CampaignCollection) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CampaignCollection) SetCreated(v time.Time) { + o.Created = v +} + +// GetAccountId returns the AccountId field value +func (o *CampaignCollection) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *CampaignCollection) SetAccountId(v int32) { + o.AccountId = v +} + +// GetModified returns the Modified field value +func (o *CampaignCollection) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *CampaignCollection) SetModified(v time.Time) { + o.Modified = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CampaignCollection) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollection) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CampaignCollection) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CampaignCollection) SetDescription(v string) { + o.Description = &v +} + +// GetName returns the Name field value +func (o *CampaignCollection) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CampaignCollection) SetName(v string) { + o.Name = v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *CampaignCollection) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollection) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *CampaignCollection) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *CampaignCollection) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *CampaignCollection) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *CampaignCollection) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *CampaignCollection) GetApplicationId() int32 { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret + } + return *o.ApplicationId +} + +// GetApplicationIdOk returns a tuple with the ApplicationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollection) GetApplicationIdOk() (int32, bool) { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret, false + } + return *o.ApplicationId, true +} + +// HasApplicationId returns a boolean if a field has been set. +func (o *CampaignCollection) HasApplicationId() bool { + if o != nil && o.ApplicationId != nil { + return true + } + + return false +} + +// SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. +func (o *CampaignCollection) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +// GetCampaignId returns the CampaignId field value if set, zero value otherwise. +func (o *CampaignCollection) GetCampaignId() int32 { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret + } + return *o.CampaignId +} + +// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollection) GetCampaignIdOk() (int32, bool) { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret, false + } + return *o.CampaignId, true +} + +// HasCampaignId returns a boolean if a field has been set. +func (o *CampaignCollection) HasCampaignId() bool { + if o != nil && o.CampaignId != nil { + return true + } + + return false +} + +// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +func (o *CampaignCollection) SetCampaignId(v int32) { + o.CampaignId = &v +} + +// GetPayload returns the Payload field value if set, zero value otherwise. +func (o *CampaignCollection) GetPayload() []string { + if o == nil || o.Payload == nil { + var ret []string + return ret + } + return *o.Payload +} + +// GetPayloadOk returns a tuple with the Payload field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollection) GetPayloadOk() ([]string, bool) { + if o == nil || o.Payload == nil { + var ret []string + return ret, false + } + return *o.Payload, true +} + +// HasPayload returns a boolean if a field has been set. +func (o *CampaignCollection) HasPayload() bool { + if o != nil && o.Payload != nil { + return true + } + + return false +} + +// SetPayload gets a reference to the given []string and assigns it to the Payload field. +func (o *CampaignCollection) SetPayload(v []string) { + o.Payload = &v +} + +type NullableCampaignCollection struct { + Value CampaignCollection + ExplicitNull bool +} + +func (v NullableCampaignCollection) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignCollection) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_collection_without_payload.go b/model_campaign_collection_without_payload.go new file mode 100644 index 00000000..d8ae2de8 --- /dev/null +++ b/model_campaign_collection_without_payload.go @@ -0,0 +1,285 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CampaignCollectionWithoutPayload +type CampaignCollectionWithoutPayload struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // A short description of the purpose of this collection. + Description *string `json:"description,omitempty"` + // The name of this collection. + Name string `json:"name"` + // ID of the user who last updated this effect if available. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // ID of the user who created this effect. + CreatedBy int32 `json:"createdBy"` + // The ID of the Application that owns this entity. + ApplicationId *int32 `json:"applicationId,omitempty"` + // The ID of the campaign that owns this entity. + CampaignId *int32 `json:"campaignId,omitempty"` +} + +// GetId returns the Id field value +func (o *CampaignCollectionWithoutPayload) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CampaignCollectionWithoutPayload) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CampaignCollectionWithoutPayload) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CampaignCollectionWithoutPayload) SetCreated(v time.Time) { + o.Created = v +} + +// GetAccountId returns the AccountId field value +func (o *CampaignCollectionWithoutPayload) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *CampaignCollectionWithoutPayload) SetAccountId(v int32) { + o.AccountId = v +} + +// GetModified returns the Modified field value +func (o *CampaignCollectionWithoutPayload) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *CampaignCollectionWithoutPayload) SetModified(v time.Time) { + o.Modified = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CampaignCollectionWithoutPayload) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollectionWithoutPayload) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CampaignCollectionWithoutPayload) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CampaignCollectionWithoutPayload) SetDescription(v string) { + o.Description = &v +} + +// GetName returns the Name field value +func (o *CampaignCollectionWithoutPayload) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CampaignCollectionWithoutPayload) SetName(v string) { + o.Name = v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *CampaignCollectionWithoutPayload) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollectionWithoutPayload) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *CampaignCollectionWithoutPayload) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *CampaignCollectionWithoutPayload) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *CampaignCollectionWithoutPayload) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *CampaignCollectionWithoutPayload) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *CampaignCollectionWithoutPayload) GetApplicationId() int32 { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret + } + return *o.ApplicationId +} + +// GetApplicationIdOk returns a tuple with the ApplicationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollectionWithoutPayload) GetApplicationIdOk() (int32, bool) { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret, false + } + return *o.ApplicationId, true +} + +// HasApplicationId returns a boolean if a field has been set. +func (o *CampaignCollectionWithoutPayload) HasApplicationId() bool { + if o != nil && o.ApplicationId != nil { + return true + } + + return false +} + +// SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. +func (o *CampaignCollectionWithoutPayload) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +// GetCampaignId returns the CampaignId field value if set, zero value otherwise. +func (o *CampaignCollectionWithoutPayload) GetCampaignId() int32 { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret + } + return *o.CampaignId +} + +// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollectionWithoutPayload) GetCampaignIdOk() (int32, bool) { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret, false + } + return *o.CampaignId, true +} + +// HasCampaignId returns a boolean if a field has been set. +func (o *CampaignCollectionWithoutPayload) HasCampaignId() bool { + if o != nil && o.CampaignId != nil { + return true + } + + return false +} + +// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +func (o *CampaignCollectionWithoutPayload) SetCampaignId(v int32) { + o.CampaignId = &v +} + +type NullableCampaignCollectionWithoutPayload struct { + Value CampaignCollectionWithoutPayload + ExplicitNull bool +} + +func (v NullableCampaignCollectionWithoutPayload) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignCollectionWithoutPayload) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_copy.go b/model_campaign_copy.go index 3cf11fb7..2a7363dd 100644 --- a/model_campaign_copy.go +++ b/model_campaign_copy.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,9 +17,9 @@ import ( // CampaignCopy struct for CampaignCopy type CampaignCopy struct { - // Name of the copied campaign (Defaults to \"Copy of original campaign name\") + // Name of the copied campaign (Defaults to \"Copy of original campaign name\"). Name *string `json:"name,omitempty"` - // Application IDs of the applications to which a campaign should be copied to + // Application IDs of the applications to which a campaign should be copied to. ApplicationIds []int32 `json:"applicationIds"` // A detailed description of the campaign. Description *string `json:"description,omitempty"` diff --git a/model_campaign_created_notification.go b/model_campaign_created_notification.go new file mode 100644 index 00000000..04d52d69 --- /dev/null +++ b/model_campaign_created_notification.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignCreatedNotification A notification regarding a campaign that was created. +type CampaignCreatedNotification struct { + Campaign Campaign `json:"campaign"` +} + +// GetCampaign returns the Campaign field value +func (o *CampaignCreatedNotification) GetCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.Campaign +} + +// SetCampaign sets field value +func (o *CampaignCreatedNotification) SetCampaign(v Campaign) { + o.Campaign = v +} + +type NullableCampaignCreatedNotification struct { + Value CampaignCreatedNotification + ExplicitNull bool +} + +func (v NullableCampaignCreatedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignCreatedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_deleted_notification.go b/model_campaign_deleted_notification.go new file mode 100644 index 00000000..dfb2123f --- /dev/null +++ b/model_campaign_deleted_notification.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignDeletedNotification A notification regarding a campaign that was deleted. +type CampaignDeletedNotification struct { + Campaign Campaign `json:"campaign"` +} + +// GetCampaign returns the Campaign field value +func (o *CampaignDeletedNotification) GetCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.Campaign +} + +// SetCampaign sets field value +func (o *CampaignDeletedNotification) SetCampaign(v Campaign) { + o.Campaign = v +} + +type NullableCampaignDeletedNotification struct { + Value CampaignDeletedNotification + ExplicitNull bool +} + +func (v NullableCampaignDeletedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignDeletedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_edited_notification.go b/model_campaign_edited_notification.go new file mode 100644 index 00000000..a8ccef3b --- /dev/null +++ b/model_campaign_edited_notification.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignEditedNotification A notification regarding a campaign which was edited. +type CampaignEditedNotification struct { + Campaign Campaign `json:"campaign"` + OldCampaign Campaign `json:"oldCampaign"` +} + +// GetCampaign returns the Campaign field value +func (o *CampaignEditedNotification) GetCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.Campaign +} + +// SetCampaign sets field value +func (o *CampaignEditedNotification) SetCampaign(v Campaign) { + o.Campaign = v +} + +// GetOldCampaign returns the OldCampaign field value +func (o *CampaignEditedNotification) GetOldCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.OldCampaign +} + +// SetOldCampaign sets field value +func (o *CampaignEditedNotification) SetOldCampaign(v Campaign) { + o.OldCampaign = v +} + +type NullableCampaignEditedNotification struct { + Value CampaignEditedNotification + ExplicitNull bool +} + +func (v NullableCampaignEditedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignEditedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_entity.go b/model_campaign_entity.go index 128d5a6a..2f55d43c 100644 --- a/model_campaign_entity.go +++ b/model_campaign_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_campaign_group.go b/model_campaign_group.go index 514552b7..13d179b1 100644 --- a/model_campaign_group.go +++ b/model_campaign_group.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // CampaignGroup type CampaignGroup struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -29,9 +29,9 @@ type CampaignGroup struct { Name string `json:"name"` // A longer description of the campaign group. Description *string `json:"description,omitempty"` - // A list of the IDs of the applications that this campaign group is enabled for + // A list of the IDs of the applications that this campaign group is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` - // A list of the IDs of the campaigns that this campaign group owns + // A list of the IDs of the campaigns that this campaign group owns. CampaignIds *[]int32 `json:"campaignIds,omitempty"` } diff --git a/model_campaign_group_entity.go b/model_campaign_group_entity.go index fa78254e..0a4d8870 100644 --- a/model_campaign_group_entity.go +++ b/model_campaign_group_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_campaign_notification.go b/model_campaign_notification.go new file mode 100644 index 00000000..4af418b0 --- /dev/null +++ b/model_campaign_notification.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignNotification struct for CampaignNotification +type CampaignNotification struct { + // The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] + Event string `json:"event"` +} + +// GetEvent returns the Event field value +func (o *CampaignNotification) GetEvent() string { + if o == nil { + var ret string + return ret + } + + return o.Event +} + +// SetEvent sets field value +func (o *CampaignNotification) SetEvent(v string) { + o.Event = v +} + +type NullableCampaignNotification struct { + Value CampaignNotification + ExplicitNull bool +} + +func (v NullableCampaignNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_priorities_changed_notification.go b/model_campaign_priorities_changed_notification.go new file mode 100644 index 00000000..f24566a0 --- /dev/null +++ b/model_campaign_priorities_changed_notification.go @@ -0,0 +1,110 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignPrioritiesChangedNotification Notification about an Application whose campaigns' priorities changed. +type CampaignPrioritiesChangedNotification struct { + Application Application `json:"application"` + // Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] + OldPriorities *map[string][]int32 `json:"oldPriorities,omitempty"` + // Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] + Priorities map[string][]int32 `json:"priorities"` +} + +// GetApplication returns the Application field value +func (o *CampaignPrioritiesChangedNotification) GetApplication() Application { + if o == nil { + var ret Application + return ret + } + + return o.Application +} + +// SetApplication sets field value +func (o *CampaignPrioritiesChangedNotification) SetApplication(v Application) { + o.Application = v +} + +// GetOldPriorities returns the OldPriorities field value if set, zero value otherwise. +func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() map[string][]int32 { + if o == nil || o.OldPriorities == nil { + var ret map[string][]int32 + return ret + } + return *o.OldPriorities +} + +// GetOldPrioritiesOk returns a tuple with the OldPriorities field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (map[string][]int32, bool) { + if o == nil || o.OldPriorities == nil { + var ret map[string][]int32 + return ret, false + } + return *o.OldPriorities, true +} + +// HasOldPriorities returns a boolean if a field has been set. +func (o *CampaignPrioritiesChangedNotification) HasOldPriorities() bool { + if o != nil && o.OldPriorities != nil { + return true + } + + return false +} + +// SetOldPriorities gets a reference to the given map[string][]int32 and assigns it to the OldPriorities field. +func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v map[string][]int32) { + o.OldPriorities = &v +} + +// GetPriorities returns the Priorities field value +func (o *CampaignPrioritiesChangedNotification) GetPriorities() map[string][]int32 { + if o == nil { + var ret map[string][]int32 + return ret + } + + return o.Priorities +} + +// SetPriorities sets field value +func (o *CampaignPrioritiesChangedNotification) SetPriorities(v map[string][]int32) { + o.Priorities = v +} + +type NullableCampaignPrioritiesChangedNotification struct { + Value CampaignPrioritiesChangedNotification + ExplicitNull bool +} + +func (v NullableCampaignPrioritiesChangedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignPrioritiesChangedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_priorities_v2.go b/model_campaign_priorities_v2.go new file mode 100644 index 00000000..4d352f0d --- /dev/null +++ b/model_campaign_priorities_v2.go @@ -0,0 +1,144 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignPrioritiesV2 struct for CampaignPrioritiesV2 +type CampaignPrioritiesV2 struct { + Exclusive *[]CampaignSetIDs `json:"exclusive,omitempty"` + Stackable *[]CampaignSetIDs `json:"stackable,omitempty"` + Universal *[]CampaignSetIDs `json:"universal,omitempty"` +} + +// GetExclusive returns the Exclusive field value if set, zero value otherwise. +func (o *CampaignPrioritiesV2) GetExclusive() []CampaignSetIDs { + if o == nil || o.Exclusive == nil { + var ret []CampaignSetIDs + return ret + } + return *o.Exclusive +} + +// GetExclusiveOk returns a tuple with the Exclusive field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignPrioritiesV2) GetExclusiveOk() ([]CampaignSetIDs, bool) { + if o == nil || o.Exclusive == nil { + var ret []CampaignSetIDs + return ret, false + } + return *o.Exclusive, true +} + +// HasExclusive returns a boolean if a field has been set. +func (o *CampaignPrioritiesV2) HasExclusive() bool { + if o != nil && o.Exclusive != nil { + return true + } + + return false +} + +// SetExclusive gets a reference to the given []CampaignSetIDs and assigns it to the Exclusive field. +func (o *CampaignPrioritiesV2) SetExclusive(v []CampaignSetIDs) { + o.Exclusive = &v +} + +// GetStackable returns the Stackable field value if set, zero value otherwise. +func (o *CampaignPrioritiesV2) GetStackable() []CampaignSetIDs { + if o == nil || o.Stackable == nil { + var ret []CampaignSetIDs + return ret + } + return *o.Stackable +} + +// GetStackableOk returns a tuple with the Stackable field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignPrioritiesV2) GetStackableOk() ([]CampaignSetIDs, bool) { + if o == nil || o.Stackable == nil { + var ret []CampaignSetIDs + return ret, false + } + return *o.Stackable, true +} + +// HasStackable returns a boolean if a field has been set. +func (o *CampaignPrioritiesV2) HasStackable() bool { + if o != nil && o.Stackable != nil { + return true + } + + return false +} + +// SetStackable gets a reference to the given []CampaignSetIDs and assigns it to the Stackable field. +func (o *CampaignPrioritiesV2) SetStackable(v []CampaignSetIDs) { + o.Stackable = &v +} + +// GetUniversal returns the Universal field value if set, zero value otherwise. +func (o *CampaignPrioritiesV2) GetUniversal() []CampaignSetIDs { + if o == nil || o.Universal == nil { + var ret []CampaignSetIDs + return ret + } + return *o.Universal +} + +// GetUniversalOk returns a tuple with the Universal field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignPrioritiesV2) GetUniversalOk() ([]CampaignSetIDs, bool) { + if o == nil || o.Universal == nil { + var ret []CampaignSetIDs + return ret, false + } + return *o.Universal, true +} + +// HasUniversal returns a boolean if a field has been set. +func (o *CampaignPrioritiesV2) HasUniversal() bool { + if o != nil && o.Universal != nil { + return true + } + + return false +} + +// SetUniversal gets a reference to the given []CampaignSetIDs and assigns it to the Universal field. +func (o *CampaignPrioritiesV2) SetUniversal(v []CampaignSetIDs) { + o.Universal = &v +} + +type NullableCampaignPrioritiesV2 struct { + Value CampaignPrioritiesV2 + ExplicitNull bool +} + +func (v NullableCampaignPrioritiesV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignPrioritiesV2) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_ruleset_changed_notification.go b/model_campaign_ruleset_changed_notification.go new file mode 100644 index 00000000..4f061709 --- /dev/null +++ b/model_campaign_ruleset_changed_notification.go @@ -0,0 +1,108 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignRulesetChangedNotification A notification regarding a campaign whose ruleset was changed. +type CampaignRulesetChangedNotification struct { + Campaign Campaign `json:"campaign"` + OldRuleset *Ruleset `json:"oldRuleset,omitempty"` + Ruleset Ruleset `json:"ruleset"` +} + +// GetCampaign returns the Campaign field value +func (o *CampaignRulesetChangedNotification) GetCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.Campaign +} + +// SetCampaign sets field value +func (o *CampaignRulesetChangedNotification) SetCampaign(v Campaign) { + o.Campaign = v +} + +// GetOldRuleset returns the OldRuleset field value if set, zero value otherwise. +func (o *CampaignRulesetChangedNotification) GetOldRuleset() Ruleset { + if o == nil || o.OldRuleset == nil { + var ret Ruleset + return ret + } + return *o.OldRuleset +} + +// GetOldRulesetOk returns a tuple with the OldRuleset field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignRulesetChangedNotification) GetOldRulesetOk() (Ruleset, bool) { + if o == nil || o.OldRuleset == nil { + var ret Ruleset + return ret, false + } + return *o.OldRuleset, true +} + +// HasOldRuleset returns a boolean if a field has been set. +func (o *CampaignRulesetChangedNotification) HasOldRuleset() bool { + if o != nil && o.OldRuleset != nil { + return true + } + + return false +} + +// SetOldRuleset gets a reference to the given Ruleset and assigns it to the OldRuleset field. +func (o *CampaignRulesetChangedNotification) SetOldRuleset(v Ruleset) { + o.OldRuleset = &v +} + +// GetRuleset returns the Ruleset field value +func (o *CampaignRulesetChangedNotification) GetRuleset() Ruleset { + if o == nil { + var ret Ruleset + return ret + } + + return o.Ruleset +} + +// SetRuleset sets field value +func (o *CampaignRulesetChangedNotification) SetRuleset(v Ruleset) { + o.Ruleset = v +} + +type NullableCampaignRulesetChangedNotification struct { + Value CampaignRulesetChangedNotification + ExplicitNull bool +} + +func (v NullableCampaignRulesetChangedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignRulesetChangedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_search.go b/model_campaign_search.go index 7063cf17..2d866760 100644 --- a/model_campaign_search.go +++ b/model_campaign_search.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CampaignSearch struct for CampaignSearch type CampaignSearch struct { - // Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes + // Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes. Attributes map[string]interface{} `json:"attributes"` } diff --git a/model_campaign_set.go b/model_campaign_set.go index 994b4dd5..b7edab9f 100644 --- a/model_campaign_set.go +++ b/model_campaign_set.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,13 +17,13 @@ import ( // CampaignSet type CampaignSet struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` - // Version of the campaign set + // Version of the campaign set. Version int32 `json:"version"` Set CampaignSetBranchNode `json:"set"` } diff --git a/model_campaign_set_branch_node.go b/model_campaign_set_branch_node.go index 09712eb7..d699bcd4 100644 --- a/model_campaign_set_branch_node.go +++ b/model_campaign_set_branch_node.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,13 +16,13 @@ import ( // CampaignSetBranchNode struct for CampaignSetBranchNode type CampaignSetBranchNode struct { - // Indicates the node type + // Indicates the node type. Type string `json:"type"` // Name of the set Name string `json:"name"` - // How does the set operates on its elements + // How does the set operates on its elements. Operator string `json:"operator"` - // Child elements of this set + // Child elements of this set. Elements []CampaignSetNode `json:"elements"` } diff --git a/model_campaign_set_i_ds.go b/model_campaign_set_i_ds.go new file mode 100644 index 00000000..6902128f --- /dev/null +++ b/model_campaign_set_i_ds.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignSetIDs Campaign IDs for each priority. +type CampaignSetIDs struct { + // ID of the campaign + CampaignId *int32 `json:"campaignId,omitempty"` +} + +// GetCampaignId returns the CampaignId field value if set, zero value otherwise. +func (o *CampaignSetIDs) GetCampaignId() int32 { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret + } + return *o.CampaignId +} + +// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignSetIDs) GetCampaignIdOk() (int32, bool) { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret, false + } + return *o.CampaignId, true +} + +// HasCampaignId returns a boolean if a field has been set. +func (o *CampaignSetIDs) HasCampaignId() bool { + if o != nil && o.CampaignId != nil { + return true + } + + return false +} + +// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +func (o *CampaignSetIDs) SetCampaignId(v int32) { + o.CampaignId = &v +} + +type NullableCampaignSetIDs struct { + Value CampaignSetIDs + ExplicitNull bool +} + +func (v NullableCampaignSetIDs) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignSetIDs) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_set_leaf_node.go b/model_campaign_set_leaf_node.go index 8efca704..ae03bffb 100644 --- a/model_campaign_set_leaf_node.go +++ b/model_campaign_set_leaf_node.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CampaignSetLeafNode struct for CampaignSetLeafNode type CampaignSetLeafNode struct { - // Indicates the node type + // Indicates the node type. Type string `json:"type"` // ID of the campaign CampaignId int32 `json:"campaignId"` diff --git a/model_campaign_set_node.go b/model_campaign_set_node.go index 153da83d..71347c70 100644 --- a/model_campaign_set_node.go +++ b/model_campaign_set_node.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_campaign_set_v2.go b/model_campaign_set_v2.go new file mode 100644 index 00000000..fc1144cf --- /dev/null +++ b/model_campaign_set_v2.go @@ -0,0 +1,127 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CampaignSetV2 +type CampaignSetV2 struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` + // Version of the campaign set. + Version int32 `json:"version"` + Set CampaignPrioritiesV2 `json:"set"` +} + +// GetId returns the Id field value +func (o *CampaignSetV2) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CampaignSetV2) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CampaignSetV2) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CampaignSetV2) SetCreated(v time.Time) { + o.Created = v +} + +// GetApplicationId returns the ApplicationId field value +func (o *CampaignSetV2) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *CampaignSetV2) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetVersion returns the Version field value +func (o *CampaignSetV2) GetVersion() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Version +} + +// SetVersion sets field value +func (o *CampaignSetV2) SetVersion(v int32) { + o.Version = v +} + +// GetSet returns the Set field value +func (o *CampaignSetV2) GetSet() CampaignPrioritiesV2 { + if o == nil { + var ret CampaignPrioritiesV2 + return ret + } + + return o.Set +} + +// SetSet sets field value +func (o *CampaignSetV2) SetSet(v CampaignPrioritiesV2) { + o.Set = v +} + +type NullableCampaignSetV2 struct { + Value CampaignSetV2 + ExplicitNull bool +} + +func (v NullableCampaignSetV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignSetV2) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_state_changed_notification.go b/model_campaign_state_changed_notification.go new file mode 100644 index 00000000..e764c6ea --- /dev/null +++ b/model_campaign_state_changed_notification.go @@ -0,0 +1,92 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignStateChangedNotification A notification regarding a campaign whose state changed. +type CampaignStateChangedNotification struct { + Campaign Campaign `json:"campaign"` + // The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + OldState string `json:"oldState"` + // The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + NewState string `json:"newState"` +} + +// GetCampaign returns the Campaign field value +func (o *CampaignStateChangedNotification) GetCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.Campaign +} + +// SetCampaign sets field value +func (o *CampaignStateChangedNotification) SetCampaign(v Campaign) { + o.Campaign = v +} + +// GetOldState returns the OldState field value +func (o *CampaignStateChangedNotification) GetOldState() string { + if o == nil { + var ret string + return ret + } + + return o.OldState +} + +// SetOldState sets field value +func (o *CampaignStateChangedNotification) SetOldState(v string) { + o.OldState = v +} + +// GetNewState returns the NewState field value +func (o *CampaignStateChangedNotification) GetNewState() string { + if o == nil { + var ret string + return ret + } + + return o.NewState +} + +// SetNewState sets field value +func (o *CampaignStateChangedNotification) SetNewState(v string) { + o.NewState = v +} + +type NullableCampaignStateChangedNotification struct { + Value CampaignStateChangedNotification + ExplicitNull bool +} + +func (v NullableCampaignStateChangedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignStateChangedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_template.go b/model_campaign_template.go index d3165b22..426081ab 100644 --- a/model_campaign_template.go +++ b/model_campaign_template.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // CampaignTemplate type CampaignTemplate struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -45,12 +45,16 @@ type CampaignTemplate struct { Features *[]string `json:"features,omitempty"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of limits that will operate for this campaign template + // The set of limits that will operate for this campaign template. Limits *[]TemplateLimitConfig `json:"limits,omitempty"` // Template parameters are fields which can be used to replace values in a rule. TemplateParams *[]CampaignTemplateParams `json:"templateParams,omitempty"` - // A list of the IDs of the applications that are subscribed to this campaign template A list of the IDs of the applications that are subscribed to this campaign template + // A list of the IDs of the applications that are subscribed to this campaign template. A list of the IDs of the applications that are subscribed to this campaign template. ApplicationsIds []int32 `json:"applicationsIds"` + // The campaign collections from the blueprint campaign for the template. + CampaignCollections *[]CampaignTemplateCollection `json:"campaignCollections,omitempty"` + // The default campaignGroupId. + DefaultCampaignGroupId *int32 `json:"defaultCampaignGroupId,omitempty"` // Timestamp of the most recent update to the campaign template or any of its elements. Updated *time.Time `json:"updated,omitempty"` // Name of the user who last updated this campaign template if available. @@ -491,6 +495,72 @@ func (o *CampaignTemplate) SetApplicationsIds(v []int32) { o.ApplicationsIds = v } +// GetCampaignCollections returns the CampaignCollections field value if set, zero value otherwise. +func (o *CampaignTemplate) GetCampaignCollections() []CampaignTemplateCollection { + if o == nil || o.CampaignCollections == nil { + var ret []CampaignTemplateCollection + return ret + } + return *o.CampaignCollections +} + +// GetCampaignCollectionsOk returns a tuple with the CampaignCollections field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignTemplate) GetCampaignCollectionsOk() ([]CampaignTemplateCollection, bool) { + if o == nil || o.CampaignCollections == nil { + var ret []CampaignTemplateCollection + return ret, false + } + return *o.CampaignCollections, true +} + +// HasCampaignCollections returns a boolean if a field has been set. +func (o *CampaignTemplate) HasCampaignCollections() bool { + if o != nil && o.CampaignCollections != nil { + return true + } + + return false +} + +// SetCampaignCollections gets a reference to the given []CampaignTemplateCollection and assigns it to the CampaignCollections field. +func (o *CampaignTemplate) SetCampaignCollections(v []CampaignTemplateCollection) { + o.CampaignCollections = &v +} + +// GetDefaultCampaignGroupId returns the DefaultCampaignGroupId field value if set, zero value otherwise. +func (o *CampaignTemplate) GetDefaultCampaignGroupId() int32 { + if o == nil || o.DefaultCampaignGroupId == nil { + var ret int32 + return ret + } + return *o.DefaultCampaignGroupId +} + +// GetDefaultCampaignGroupIdOk returns a tuple with the DefaultCampaignGroupId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignTemplate) GetDefaultCampaignGroupIdOk() (int32, bool) { + if o == nil || o.DefaultCampaignGroupId == nil { + var ret int32 + return ret, false + } + return *o.DefaultCampaignGroupId, true +} + +// HasDefaultCampaignGroupId returns a boolean if a field has been set. +func (o *CampaignTemplate) HasDefaultCampaignGroupId() bool { + if o != nil && o.DefaultCampaignGroupId != nil { + return true + } + + return false +} + +// SetDefaultCampaignGroupId gets a reference to the given int32 and assigns it to the DefaultCampaignGroupId field. +func (o *CampaignTemplate) SetDefaultCampaignGroupId(v int32) { + o.DefaultCampaignGroupId = &v +} + // GetUpdated returns the Updated field value if set, zero value otherwise. func (o *CampaignTemplate) GetUpdated() time.Time { if o == nil || o.Updated == nil { diff --git a/model_campaign_template_collection.go b/model_campaign_template_collection.go new file mode 100644 index 00000000..7eceee97 --- /dev/null +++ b/model_campaign_template_collection.go @@ -0,0 +1,94 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignTemplateCollection struct for CampaignTemplateCollection +type CampaignTemplateCollection struct { + // The name of this collection. + Name string `json:"name"` + // A short description of the purpose of this collection. + Description *string `json:"description,omitempty"` +} + +// GetName returns the Name field value +func (o *CampaignTemplateCollection) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CampaignTemplateCollection) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CampaignTemplateCollection) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignTemplateCollection) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CampaignTemplateCollection) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CampaignTemplateCollection) SetDescription(v string) { + o.Description = &v +} + +type NullableCampaignTemplateCollection struct { + Value CampaignTemplateCollection + ExplicitNull bool +} + +func (v NullableCampaignTemplateCollection) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignTemplateCollection) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_template_params.go b/model_campaign_template_params.go index 8de2085f..d596c0c9 100644 --- a/model_campaign_template_params.go +++ b/model_campaign_template_params.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -18,10 +18,12 @@ import ( type CampaignTemplateParams struct { // Name of the campaign template parameter. Name string `json:"name"` - // Can be one of the following three ['string','number','boolean'] + // Defines the type of parameter value. Type string `json:"type"` // Explains the meaning of this template parameter and the placeholder value that will define it. It is used on campaign creation from this template. Description string `json:"description"` + // ID of the corresponding attribute. + AttributeId *int32 `json:"attributeId,omitempty"` } // GetName returns the Name field value @@ -69,6 +71,39 @@ func (o *CampaignTemplateParams) SetDescription(v string) { o.Description = v } +// GetAttributeId returns the AttributeId field value if set, zero value otherwise. +func (o *CampaignTemplateParams) GetAttributeId() int32 { + if o == nil || o.AttributeId == nil { + var ret int32 + return ret + } + return *o.AttributeId +} + +// GetAttributeIdOk returns a tuple with the AttributeId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignTemplateParams) GetAttributeIdOk() (int32, bool) { + if o == nil || o.AttributeId == nil { + var ret int32 + return ret, false + } + return *o.AttributeId, true +} + +// HasAttributeId returns a boolean if a field has been set. +func (o *CampaignTemplateParams) HasAttributeId() bool { + if o != nil && o.AttributeId != nil { + return true + } + + return false +} + +// SetAttributeId gets a reference to the given int32 and assigns it to the AttributeId field. +func (o *CampaignTemplateParams) SetAttributeId(v int32) { + o.AttributeId = &v +} + type NullableCampaignTemplateParams struct { Value CampaignTemplateParams ExplicitNull bool diff --git a/model_card_ledger_transaction_log_entry.go b/model_card_ledger_transaction_log_entry.go new file mode 100644 index 00000000..a1a39672 --- /dev/null +++ b/model_card_ledger_transaction_log_entry.go @@ -0,0 +1,300 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CardLedgerTransactionLogEntry Log entry for a given loyalty card transaction. +type CardLedgerTransactionLogEntry struct { + // Date and time the loyalty card transaction occurred. + Created time.Time `json:"created"` + // ID of the loyalty program. + ProgramId int32 `json:"programId"` + // Identifier of the loyalty card. + CardIdentifier string `json:"cardIdentifier"` + // The ID of the Application that owns this entity. + ApplicationId *int32 `json:"applicationId,omitempty"` + // The **internal** ID of the session. + SessionId *int32 `json:"sessionId,omitempty"` + // ID of the customer session where the transaction occurred. + CustomerSessionId string `json:"customerSessionId"` + // Type of transaction. Possible values are: - `addition`: Points were added. - `subtraction`: Points were subtracted. + Type string `json:"type"` + // Name or reason of the loyalty ledger transaction. + Name string `json:"name"` + // Date when points become active. Possible values are: - `immediate`: Points are active immediately. - `timestamp value`: Points become active from the given date. + StartDate string `json:"startDate"` + // Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points become active from the given date. + ExpiryDate string `json:"expiryDate"` + // ID of the subledger. + SubledgerId string `json:"subledgerId"` + // Amount of loyalty points added or deducted in the transaction. + Amount float32 `json:"amount"` + // ID of the loyalty ledger entry. + Id int32 `json:"id"` +} + +// GetCreated returns the Created field value +func (o *CardLedgerTransactionLogEntry) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CardLedgerTransactionLogEntry) SetCreated(v time.Time) { + o.Created = v +} + +// GetProgramId returns the ProgramId field value +func (o *CardLedgerTransactionLogEntry) GetProgramId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramId +} + +// SetProgramId sets field value +func (o *CardLedgerTransactionLogEntry) SetProgramId(v int32) { + o.ProgramId = v +} + +// GetCardIdentifier returns the CardIdentifier field value +func (o *CardLedgerTransactionLogEntry) GetCardIdentifier() string { + if o == nil { + var ret string + return ret + } + + return o.CardIdentifier +} + +// SetCardIdentifier sets field value +func (o *CardLedgerTransactionLogEntry) SetCardIdentifier(v string) { + o.CardIdentifier = v +} + +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *CardLedgerTransactionLogEntry) GetApplicationId() int32 { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret + } + return *o.ApplicationId +} + +// GetApplicationIdOk returns a tuple with the ApplicationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CardLedgerTransactionLogEntry) GetApplicationIdOk() (int32, bool) { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret, false + } + return *o.ApplicationId, true +} + +// HasApplicationId returns a boolean if a field has been set. +func (o *CardLedgerTransactionLogEntry) HasApplicationId() bool { + if o != nil && o.ApplicationId != nil { + return true + } + + return false +} + +// SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. +func (o *CardLedgerTransactionLogEntry) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +// GetSessionId returns the SessionId field value if set, zero value otherwise. +func (o *CardLedgerTransactionLogEntry) GetSessionId() int32 { + if o == nil || o.SessionId == nil { + var ret int32 + return ret + } + return *o.SessionId +} + +// GetSessionIdOk returns a tuple with the SessionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CardLedgerTransactionLogEntry) GetSessionIdOk() (int32, bool) { + if o == nil || o.SessionId == nil { + var ret int32 + return ret, false + } + return *o.SessionId, true +} + +// HasSessionId returns a boolean if a field has been set. +func (o *CardLedgerTransactionLogEntry) HasSessionId() bool { + if o != nil && o.SessionId != nil { + return true + } + + return false +} + +// SetSessionId gets a reference to the given int32 and assigns it to the SessionId field. +func (o *CardLedgerTransactionLogEntry) SetSessionId(v int32) { + o.SessionId = &v +} + +// GetCustomerSessionId returns the CustomerSessionId field value +func (o *CardLedgerTransactionLogEntry) GetCustomerSessionId() string { + if o == nil { + var ret string + return ret + } + + return o.CustomerSessionId +} + +// SetCustomerSessionId sets field value +func (o *CardLedgerTransactionLogEntry) SetCustomerSessionId(v string) { + o.CustomerSessionId = v +} + +// GetType returns the Type field value +func (o *CardLedgerTransactionLogEntry) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *CardLedgerTransactionLogEntry) SetType(v string) { + o.Type = v +} + +// GetName returns the Name field value +func (o *CardLedgerTransactionLogEntry) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CardLedgerTransactionLogEntry) SetName(v string) { + o.Name = v +} + +// GetStartDate returns the StartDate field value +func (o *CardLedgerTransactionLogEntry) GetStartDate() string { + if o == nil { + var ret string + return ret + } + + return o.StartDate +} + +// SetStartDate sets field value +func (o *CardLedgerTransactionLogEntry) SetStartDate(v string) { + o.StartDate = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *CardLedgerTransactionLogEntry) GetExpiryDate() string { + if o == nil { + var ret string + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *CardLedgerTransactionLogEntry) SetExpiryDate(v string) { + o.ExpiryDate = v +} + +// GetSubledgerId returns the SubledgerId field value +func (o *CardLedgerTransactionLogEntry) GetSubledgerId() string { + if o == nil { + var ret string + return ret + } + + return o.SubledgerId +} + +// SetSubledgerId sets field value +func (o *CardLedgerTransactionLogEntry) SetSubledgerId(v string) { + o.SubledgerId = v +} + +// GetAmount returns the Amount field value +func (o *CardLedgerTransactionLogEntry) GetAmount() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Amount +} + +// SetAmount sets field value +func (o *CardLedgerTransactionLogEntry) SetAmount(v float32) { + o.Amount = v +} + +// GetId returns the Id field value +func (o *CardLedgerTransactionLogEntry) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CardLedgerTransactionLogEntry) SetId(v int32) { + o.Id = v +} + +type NullableCardLedgerTransactionLogEntry struct { + Value CardLedgerTransactionLogEntry + ExplicitNull bool +} + +func (v NullableCardLedgerTransactionLogEntry) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCardLedgerTransactionLogEntry) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_card_ledger_transaction_log_entry_integration_api.go b/model_card_ledger_transaction_log_entry_integration_api.go new file mode 100644 index 00000000..8f908e77 --- /dev/null +++ b/model_card_ledger_transaction_log_entry_integration_api.go @@ -0,0 +1,300 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CardLedgerTransactionLogEntryIntegrationApi Log entry for a given loyalty card transaction. +type CardLedgerTransactionLogEntryIntegrationApi struct { + // Date and time the loyalty card transaction occurred. + Created time.Time `json:"created"` + // ID of the loyalty program. + ProgramId int32 `json:"programId"` + // Identifier of the loyalty card. + CardIdentifier string `json:"cardIdentifier"` + // ID of the customer session where the transaction occurred. + CustomerSessionId string `json:"customerSessionId"` + // Type of transaction. Possible values are: - `addition`: Points were added. - `subtraction`: Points were subtracted. + Type string `json:"type"` + // Name or reason of the loyalty ledger transaction. + Name string `json:"name"` + // Date when points become active. Possible values are: - `immediate`: Points are active immediately. - `timestamp value`: Points become active from the given date. + StartDate string `json:"startDate"` + // Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date. + ExpiryDate string `json:"expiryDate"` + // ID of the subledger. + SubledgerId string `json:"subledgerId"` + // Amount of loyalty points added or deducted in the transaction. + Amount float32 `json:"amount"` + // ID of the loyalty ledger transaction. + Id int32 `json:"id"` + // The ID of the ruleset containing the rule that triggered this effect. + RulesetId *int32 `json:"rulesetId,omitempty"` + // The name of the rule that triggered this effect. + RuleName *string `json:"ruleName,omitempty"` +} + +// GetCreated returns the Created field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCreated(v time.Time) { + o.Created = v +} + +// GetProgramId returns the ProgramId field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetProgramId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramId +} + +// SetProgramId sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetProgramId(v int32) { + o.ProgramId = v +} + +// GetCardIdentifier returns the CardIdentifier field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCardIdentifier() string { + if o == nil { + var ret string + return ret + } + + return o.CardIdentifier +} + +// SetCardIdentifier sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCardIdentifier(v string) { + o.CardIdentifier = v +} + +// GetCustomerSessionId returns the CustomerSessionId field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCustomerSessionId() string { + if o == nil { + var ret string + return ret + } + + return o.CustomerSessionId +} + +// SetCustomerSessionId sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCustomerSessionId(v string) { + o.CustomerSessionId = v +} + +// GetType returns the Type field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetType(v string) { + o.Type = v +} + +// GetName returns the Name field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetName(v string) { + o.Name = v +} + +// GetStartDate returns the StartDate field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetStartDate() string { + if o == nil { + var ret string + return ret + } + + return o.StartDate +} + +// SetStartDate sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetStartDate(v string) { + o.StartDate = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetExpiryDate() string { + if o == nil { + var ret string + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetExpiryDate(v string) { + o.ExpiryDate = v +} + +// GetSubledgerId returns the SubledgerId field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetSubledgerId() string { + if o == nil { + var ret string + return ret + } + + return o.SubledgerId +} + +// SetSubledgerId sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetSubledgerId(v string) { + o.SubledgerId = v +} + +// GetAmount returns the Amount field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetAmount() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Amount +} + +// SetAmount sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetAmount(v float32) { + o.Amount = v +} + +// GetId returns the Id field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetId(v int32) { + o.Id = v +} + +// GetRulesetId returns the RulesetId field value if set, zero value otherwise. +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRulesetId() int32 { + if o == nil || o.RulesetId == nil { + var ret int32 + return ret + } + return *o.RulesetId +} + +// GetRulesetIdOk returns a tuple with the RulesetId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRulesetIdOk() (int32, bool) { + if o == nil || o.RulesetId == nil { + var ret int32 + return ret, false + } + return *o.RulesetId, true +} + +// HasRulesetId returns a boolean if a field has been set. +func (o *CardLedgerTransactionLogEntryIntegrationApi) HasRulesetId() bool { + if o != nil && o.RulesetId != nil { + return true + } + + return false +} + +// SetRulesetId gets a reference to the given int32 and assigns it to the RulesetId field. +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetRulesetId(v int32) { + o.RulesetId = &v +} + +// GetRuleName returns the RuleName field value if set, zero value otherwise. +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRuleName() string { + if o == nil || o.RuleName == nil { + var ret string + return ret + } + return *o.RuleName +} + +// GetRuleNameOk returns a tuple with the RuleName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetRuleNameOk() (string, bool) { + if o == nil || o.RuleName == nil { + var ret string + return ret, false + } + return *o.RuleName, true +} + +// HasRuleName returns a boolean if a field has been set. +func (o *CardLedgerTransactionLogEntryIntegrationApi) HasRuleName() bool { + if o != nil && o.RuleName != nil { + return true + } + + return false +} + +// SetRuleName gets a reference to the given string and assigns it to the RuleName field. +func (o *CardLedgerTransactionLogEntryIntegrationApi) SetRuleName(v string) { + o.RuleName = &v +} + +type NullableCardLedgerTransactionLogEntryIntegrationApi struct { + Value CardLedgerTransactionLogEntryIntegrationApi + ExplicitNull bool +} + +func (v NullableCardLedgerTransactionLogEntryIntegrationApi) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCardLedgerTransactionLogEntryIntegrationApi) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_cart_item.go b/model_cart_item.go index 7e91ee1c..b11942cb 100644 --- a/model_cart_item.go +++ b/model_cart_item.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,28 +16,36 @@ import ( // CartItem struct for CartItem type CartItem struct { - // Name of item + // Name of item. Name string `json:"name"` - // Stock keeping unit of item + // Stock keeping unit of item. Sku string `json:"sku"` - // Quantity of item. **Important:** If you enabled [cart item flattening](https://help.talon.one/hc/en-us/articles/360016036899-Flattening-Cart-Items), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. + // Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. Quantity int32 `json:"quantity"` - // Price of item + // Number of returned items, calculated internally based on returns of this item. + ReturnedQuantity *int32 `json:"returnedQuantity,omitempty"` + // Remaining quantity of the item, calculated internally based on returns of this item. + RemainingQuantity *int32 `json:"remainingQuantity,omitempty"` + // Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/). If it is part of a catalog, setting a price here overrides the price from the catalog. Price float32 `json:"price"` - // Type, group or model of the item + // Type, group or model of the item. Category *string `json:"category,omitempty"` - // Weight of item in grams + // Weight of item in grams. Weight *float32 `json:"weight,omitempty"` - // Height of item in mm + // Height of item in mm. Height *float32 `json:"height,omitempty"` - // Width of item in mm + // Width of item in mm. Width *float32 `json:"width,omitempty"` - // Length of item in mm + // Length of item in mm. Length *float32 `json:"length,omitempty"` - // Position of the Cart Item in the Cart (calculated internally) + // Position of the Cart Item in the Cart (calculated internally). Position *float32 `json:"position,omitempty"` - // Arbitrary properties associated with this item. You can use built-in attributes or create your own. See [Attributes](https://docs.talon.one/docs/dev/concepts/attributes). + // Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). + AdditionalCosts *map[string]AdditionalCost `json:"additionalCosts,omitempty"` + // The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-cart-item-catalogs). + CatalogItemID *int32 `json:"catalogItemID,omitempty"` } // GetName returns the Name field value @@ -85,6 +93,72 @@ func (o *CartItem) SetQuantity(v int32) { o.Quantity = v } +// GetReturnedQuantity returns the ReturnedQuantity field value if set, zero value otherwise. +func (o *CartItem) GetReturnedQuantity() int32 { + if o == nil || o.ReturnedQuantity == nil { + var ret int32 + return ret + } + return *o.ReturnedQuantity +} + +// GetReturnedQuantityOk returns a tuple with the ReturnedQuantity field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CartItem) GetReturnedQuantityOk() (int32, bool) { + if o == nil || o.ReturnedQuantity == nil { + var ret int32 + return ret, false + } + return *o.ReturnedQuantity, true +} + +// HasReturnedQuantity returns a boolean if a field has been set. +func (o *CartItem) HasReturnedQuantity() bool { + if o != nil && o.ReturnedQuantity != nil { + return true + } + + return false +} + +// SetReturnedQuantity gets a reference to the given int32 and assigns it to the ReturnedQuantity field. +func (o *CartItem) SetReturnedQuantity(v int32) { + o.ReturnedQuantity = &v +} + +// GetRemainingQuantity returns the RemainingQuantity field value if set, zero value otherwise. +func (o *CartItem) GetRemainingQuantity() int32 { + if o == nil || o.RemainingQuantity == nil { + var ret int32 + return ret + } + return *o.RemainingQuantity +} + +// GetRemainingQuantityOk returns a tuple with the RemainingQuantity field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CartItem) GetRemainingQuantityOk() (int32, bool) { + if o == nil || o.RemainingQuantity == nil { + var ret int32 + return ret, false + } + return *o.RemainingQuantity, true +} + +// HasRemainingQuantity returns a boolean if a field has been set. +func (o *CartItem) HasRemainingQuantity() bool { + if o != nil && o.RemainingQuantity != nil { + return true + } + + return false +} + +// SetRemainingQuantity gets a reference to the given int32 and assigns it to the RemainingQuantity field. +func (o *CartItem) SetRemainingQuantity(v int32) { + o.RemainingQuantity = &v +} + // GetPrice returns the Price field value func (o *CartItem) GetPrice() float32 { if o == nil { @@ -331,6 +405,72 @@ func (o *CartItem) SetAttributes(v map[string]interface{}) { o.Attributes = &v } +// GetAdditionalCosts returns the AdditionalCosts field value if set, zero value otherwise. +func (o *CartItem) GetAdditionalCosts() map[string]AdditionalCost { + if o == nil || o.AdditionalCosts == nil { + var ret map[string]AdditionalCost + return ret + } + return *o.AdditionalCosts +} + +// GetAdditionalCostsOk returns a tuple with the AdditionalCosts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CartItem) GetAdditionalCostsOk() (map[string]AdditionalCost, bool) { + if o == nil || o.AdditionalCosts == nil { + var ret map[string]AdditionalCost + return ret, false + } + return *o.AdditionalCosts, true +} + +// HasAdditionalCosts returns a boolean if a field has been set. +func (o *CartItem) HasAdditionalCosts() bool { + if o != nil && o.AdditionalCosts != nil { + return true + } + + return false +} + +// SetAdditionalCosts gets a reference to the given map[string]AdditionalCost and assigns it to the AdditionalCosts field. +func (o *CartItem) SetAdditionalCosts(v map[string]AdditionalCost) { + o.AdditionalCosts = &v +} + +// GetCatalogItemID returns the CatalogItemID field value if set, zero value otherwise. +func (o *CartItem) GetCatalogItemID() int32 { + if o == nil || o.CatalogItemID == nil { + var ret int32 + return ret + } + return *o.CatalogItemID +} + +// GetCatalogItemIDOk returns a tuple with the CatalogItemID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CartItem) GetCatalogItemIDOk() (int32, bool) { + if o == nil || o.CatalogItemID == nil { + var ret int32 + return ret, false + } + return *o.CatalogItemID, true +} + +// HasCatalogItemID returns a boolean if a field has been set. +func (o *CartItem) HasCatalogItemID() bool { + if o != nil && o.CatalogItemID != nil { + return true + } + + return false +} + +// SetCatalogItemID gets a reference to the given int32 and assigns it to the CatalogItemID field. +func (o *CartItem) SetCatalogItemID(v int32) { + o.CatalogItemID = &v +} + type NullableCartItem struct { Value CartItem ExplicitNull bool diff --git a/model_catalog.go b/model_catalog.go new file mode 100644 index 00000000..74844ddb --- /dev/null +++ b/model_catalog.go @@ -0,0 +1,214 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// Catalog +type Catalog struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // The cart item catalog name. + Name string `json:"name"` + // A description of this cart item catalog. + Description string `json:"description"` + // A list of the IDs of the applications that are subscribed to this catalog. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // The current version of this catalog. + Version int32 `json:"version"` + // The ID of user who created this catalog. + CreatedBy int32 `json:"createdBy"` +} + +// GetId returns the Id field value +func (o *Catalog) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *Catalog) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *Catalog) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Catalog) SetCreated(v time.Time) { + o.Created = v +} + +// GetAccountId returns the AccountId field value +func (o *Catalog) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *Catalog) SetAccountId(v int32) { + o.AccountId = v +} + +// GetModified returns the Modified field value +func (o *Catalog) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *Catalog) SetModified(v time.Time) { + o.Modified = v +} + +// GetName returns the Name field value +func (o *Catalog) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *Catalog) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value +func (o *Catalog) GetDescription() string { + if o == nil { + var ret string + return ret + } + + return o.Description +} + +// SetDescription sets field value +func (o *Catalog) SetDescription(v string) { + o.Description = v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *Catalog) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Catalog) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *Catalog) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *Catalog) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetVersion returns the Version field value +func (o *Catalog) GetVersion() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Version +} + +// SetVersion sets field value +func (o *Catalog) SetVersion(v int32) { + o.Version = v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *Catalog) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *Catalog) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +type NullableCatalog struct { + Value Catalog + ExplicitNull bool +} + +func (v NullableCatalog) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCatalog) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_catalog_action.go b/model_catalog_action.go new file mode 100644 index 00000000..e84b2a7f --- /dev/null +++ b/model_catalog_action.go @@ -0,0 +1,75 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CatalogAction Definition of all the properties that are needed for a single catalog sync action. +type CatalogAction struct { + // The type of sync action. + Type string `json:"type"` + Payload map[string]interface{} `json:"payload"` +} + +// GetType returns the Type field value +func (o *CatalogAction) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *CatalogAction) SetType(v string) { + o.Type = v +} + +// GetPayload returns the Payload field value +func (o *CatalogAction) GetPayload() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *CatalogAction) SetPayload(v map[string]interface{}) { + o.Payload = v +} + +type NullableCatalogAction struct { + Value CatalogAction + ExplicitNull bool +} + +func (v NullableCatalogAction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCatalogAction) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_catalog_action_filter.go b/model_catalog_action_filter.go new file mode 100644 index 00000000..48c8303c --- /dev/null +++ b/model_catalog_action_filter.go @@ -0,0 +1,93 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CatalogActionFilter The properties for a single filtering condition in a catalog sync action. +type CatalogActionFilter struct { + // The name of the attribute to filter on. + Attr string `json:"attr"` + // The filtering operator. + Op string `json:"op"` + // The value to filter for. + Value map[string]interface{} `json:"value"` +} + +// GetAttr returns the Attr field value +func (o *CatalogActionFilter) GetAttr() string { + if o == nil { + var ret string + return ret + } + + return o.Attr +} + +// SetAttr sets field value +func (o *CatalogActionFilter) SetAttr(v string) { + o.Attr = v +} + +// GetOp returns the Op field value +func (o *CatalogActionFilter) GetOp() string { + if o == nil { + var ret string + return ret + } + + return o.Op +} + +// SetOp sets field value +func (o *CatalogActionFilter) SetOp(v string) { + o.Op = v +} + +// GetValue returns the Value field value +func (o *CatalogActionFilter) GetValue() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *CatalogActionFilter) SetValue(v map[string]interface{}) { + o.Value = v +} + +type NullableCatalogActionFilter struct { + Value CatalogActionFilter + ExplicitNull bool +} + +func (v NullableCatalogActionFilter) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCatalogActionFilter) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_catalog_item.go b/model_catalog_item.go new file mode 100644 index 00000000..238799e6 --- /dev/null +++ b/model_catalog_item.go @@ -0,0 +1,197 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CatalogItem +type CatalogItem struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The stock keeping unit of the item. + Sku string `json:"sku"` + // Price of the item. + Price *float32 `json:"price,omitempty"` + // The ID of the catalog the item belongs to. + Catalogid int32 `json:"catalogid"` + // The version of the catalog item. + Version int32 `json:"version"` + Attributes *[]ItemAttribute `json:"attributes,omitempty"` +} + +// GetId returns the Id field value +func (o *CatalogItem) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CatalogItem) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CatalogItem) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CatalogItem) SetCreated(v time.Time) { + o.Created = v +} + +// GetSku returns the Sku field value +func (o *CatalogItem) GetSku() string { + if o == nil { + var ret string + return ret + } + + return o.Sku +} + +// SetSku sets field value +func (o *CatalogItem) SetSku(v string) { + o.Sku = v +} + +// GetPrice returns the Price field value if set, zero value otherwise. +func (o *CatalogItem) GetPrice() float32 { + if o == nil || o.Price == nil { + var ret float32 + return ret + } + return *o.Price +} + +// GetPriceOk returns a tuple with the Price field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CatalogItem) GetPriceOk() (float32, bool) { + if o == nil || o.Price == nil { + var ret float32 + return ret, false + } + return *o.Price, true +} + +// HasPrice returns a boolean if a field has been set. +func (o *CatalogItem) HasPrice() bool { + if o != nil && o.Price != nil { + return true + } + + return false +} + +// SetPrice gets a reference to the given float32 and assigns it to the Price field. +func (o *CatalogItem) SetPrice(v float32) { + o.Price = &v +} + +// GetCatalogid returns the Catalogid field value +func (o *CatalogItem) GetCatalogid() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Catalogid +} + +// SetCatalogid sets field value +func (o *CatalogItem) SetCatalogid(v int32) { + o.Catalogid = v +} + +// GetVersion returns the Version field value +func (o *CatalogItem) GetVersion() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Version +} + +// SetVersion sets field value +func (o *CatalogItem) SetVersion(v int32) { + o.Version = v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *CatalogItem) GetAttributes() []ItemAttribute { + if o == nil || o.Attributes == nil { + var ret []ItemAttribute + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CatalogItem) GetAttributesOk() ([]ItemAttribute, bool) { + if o == nil || o.Attributes == nil { + var ret []ItemAttribute + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *CatalogItem) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given []ItemAttribute and assigns it to the Attributes field. +func (o *CatalogItem) SetAttributes(v []ItemAttribute) { + o.Attributes = &v +} + +type NullableCatalogItem struct { + Value CatalogItem + ExplicitNull bool +} + +func (v NullableCatalogItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCatalogItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_catalog_sync_request.go b/model_catalog_sync_request.go new file mode 100644 index 00000000..b8261c77 --- /dev/null +++ b/model_catalog_sync_request.go @@ -0,0 +1,93 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CatalogSyncRequest struct for CatalogSyncRequest +type CatalogSyncRequest struct { + Actions []CatalogAction `json:"actions"` + // The version number of the catalog to apply the actions on. + Version *int32 `json:"version,omitempty"` +} + +// GetActions returns the Actions field value +func (o *CatalogSyncRequest) GetActions() []CatalogAction { + if o == nil { + var ret []CatalogAction + return ret + } + + return o.Actions +} + +// SetActions sets field value +func (o *CatalogSyncRequest) SetActions(v []CatalogAction) { + o.Actions = v +} + +// GetVersion returns the Version field value if set, zero value otherwise. +func (o *CatalogSyncRequest) GetVersion() int32 { + if o == nil || o.Version == nil { + var ret int32 + return ret + } + return *o.Version +} + +// GetVersionOk returns a tuple with the Version field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CatalogSyncRequest) GetVersionOk() (int32, bool) { + if o == nil || o.Version == nil { + var ret int32 + return ret, false + } + return *o.Version, true +} + +// HasVersion returns a boolean if a field has been set. +func (o *CatalogSyncRequest) HasVersion() bool { + if o != nil && o.Version != nil { + return true + } + + return false +} + +// SetVersion gets a reference to the given int32 and assigns it to the Version field. +func (o *CatalogSyncRequest) SetVersion(v int32) { + o.Version = &v +} + +type NullableCatalogSyncRequest struct { + Value CatalogSyncRequest + ExplicitNull bool +} + +func (v NullableCatalogSyncRequest) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCatalogSyncRequest) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_change.go b/model_change.go index ddabed48..0fe341c5 100644 --- a/model_change.go +++ b/model_change.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,13 +17,13 @@ import ( // Change type Change struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the account that owns this entity. UserId int32 `json:"userId"` - // ID of application associated with change + // ID of application associated with change. ApplicationId *int32 `json:"applicationId,omitempty"` // API endpoint on which the change was initiated. Entity string `json:"entity"` diff --git a/model_change_profile_password.go b/model_change_profile_password.go index e169bd5f..72403741 100644 --- a/model_change_profile_password.go +++ b/model_change_profile_password.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_code_generator_settings.go b/model_code_generator_settings.go index 3726d679..3758de7c 100644 --- a/model_code_generator_settings.go +++ b/model_code_generator_settings.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // CodeGeneratorSettings struct for CodeGeneratorSettings type CodeGeneratorSettings struct { - // Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + // List of characters used to generate the random parts of a code. Defaults to a list equivalent to the `[A-Z, 0-9]` regexp. ValidCharacters []string `json:"validCharacters"` - // The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + // The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. CouponPattern string `json:"couponPattern"` } diff --git a/model_collection.go b/model_collection.go index 790b597d..c255ee3f 100644 --- a/model_collection.go +++ b/model_collection.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,28 +17,30 @@ import ( // Collection type Collection struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // The ID of the application that owns this entity. - ApplicationId int32 `json:"applicationId"` - // The ID of the campaign that owns this entity. - CampaignId int32 `json:"campaignId"` // The exact moment this entity was last modified. Modified time.Time `json:"modified"` - // The name of this collection. - Name string `json:"name"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` - // Payload contains limited amount of collection items - Payload *[]string `json:"payload,omitempty"` + // A list of the IDs of the Applications where this collection is enabled. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // The name of this collection. + Name string `json:"name"` // ID of the user who last updated this effect if available. ModifiedBy *int32 `json:"modifiedBy,omitempty"` // ID of the user who created this effect. CreatedBy int32 `json:"createdBy"` + // The ID of the Application that owns this entity. + ApplicationId *int32 `json:"applicationId,omitempty"` + // The ID of the campaign that owns this entity. + CampaignId *int32 `json:"campaignId,omitempty"` + // The content of the collection. + Payload *[]string `json:"payload,omitempty"` } // GetId returns the Id field value @@ -86,36 +88,6 @@ func (o *Collection) SetAccountId(v int32) { o.AccountId = v } -// GetApplicationId returns the ApplicationId field value -func (o *Collection) GetApplicationId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.ApplicationId -} - -// SetApplicationId sets field value -func (o *Collection) SetApplicationId(v int32) { - o.ApplicationId = v -} - -// GetCampaignId returns the CampaignId field value -func (o *Collection) GetCampaignId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.CampaignId -} - -// SetCampaignId sets field value -func (o *Collection) SetCampaignId(v int32) { - o.CampaignId = v -} - // GetModified returns the Modified field value func (o *Collection) GetModified() time.Time { if o == nil { @@ -131,21 +103,6 @@ func (o *Collection) SetModified(v time.Time) { o.Modified = v } -// GetName returns the Name field value -func (o *Collection) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *Collection) SetName(v string) { - o.Name = v -} - // GetDescription returns the Description field value if set, zero value otherwise. func (o *Collection) GetDescription() string { if o == nil || o.Description == nil { @@ -179,37 +136,52 @@ func (o *Collection) SetDescription(v string) { o.Description = &v } -// GetPayload returns the Payload field value if set, zero value otherwise. -func (o *Collection) GetPayload() []string { - if o == nil || o.Payload == nil { - var ret []string +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *Collection) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 return ret } - return *o.Payload + return *o.SubscribedApplicationsIds } -// GetPayloadOk returns a tuple with the Payload field value if set, zero value otherwise +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *Collection) GetPayloadOk() ([]string, bool) { - if o == nil || o.Payload == nil { - var ret []string +func (o *Collection) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 return ret, false } - return *o.Payload, true + return *o.SubscribedApplicationsIds, true } -// HasPayload returns a boolean if a field has been set. -func (o *Collection) HasPayload() bool { - if o != nil && o.Payload != nil { +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *Collection) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { return true } return false } -// SetPayload gets a reference to the given []string and assigns it to the Payload field. -func (o *Collection) SetPayload(v []string) { - o.Payload = &v +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *Collection) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetName returns the Name field value +func (o *Collection) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *Collection) SetName(v string) { + o.Name = v } // GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. @@ -260,6 +232,105 @@ func (o *Collection) SetCreatedBy(v int32) { o.CreatedBy = v } +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *Collection) GetApplicationId() int32 { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret + } + return *o.ApplicationId +} + +// GetApplicationIdOk returns a tuple with the ApplicationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Collection) GetApplicationIdOk() (int32, bool) { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret, false + } + return *o.ApplicationId, true +} + +// HasApplicationId returns a boolean if a field has been set. +func (o *Collection) HasApplicationId() bool { + if o != nil && o.ApplicationId != nil { + return true + } + + return false +} + +// SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. +func (o *Collection) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +// GetCampaignId returns the CampaignId field value if set, zero value otherwise. +func (o *Collection) GetCampaignId() int32 { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret + } + return *o.CampaignId +} + +// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Collection) GetCampaignIdOk() (int32, bool) { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret, false + } + return *o.CampaignId, true +} + +// HasCampaignId returns a boolean if a field has been set. +func (o *Collection) HasCampaignId() bool { + if o != nil && o.CampaignId != nil { + return true + } + + return false +} + +// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +func (o *Collection) SetCampaignId(v int32) { + o.CampaignId = &v +} + +// GetPayload returns the Payload field value if set, zero value otherwise. +func (o *Collection) GetPayload() []string { + if o == nil || o.Payload == nil { + var ret []string + return ret + } + return *o.Payload +} + +// GetPayloadOk returns a tuple with the Payload field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Collection) GetPayloadOk() ([]string, bool) { + if o == nil || o.Payload == nil { + var ret []string + return ret, false + } + return *o.Payload, true +} + +// HasPayload returns a boolean if a field has been set. +func (o *Collection) HasPayload() bool { + if o != nil && o.Payload != nil { + return true + } + + return false +} + +// SetPayload gets a reference to the given []string and assigns it to the Payload field. +func (o *Collection) SetPayload(v []string) { + o.Payload = &v +} + type NullableCollection struct { Value Collection ExplicitNull bool diff --git a/model_collection_item.go b/model_collection_item.go new file mode 100644 index 00000000..4e6cd6c5 --- /dev/null +++ b/model_collection_item.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CollectionItem +type CollectionItem struct { + Item string `json:"item"` +} + +// GetItem returns the Item field value +func (o *CollectionItem) GetItem() string { + if o == nil { + var ret string + return ret + } + + return o.Item +} + +// SetItem sets field value +func (o *CollectionItem) SetItem(v string) { + o.Item = v +} + +type NullableCollectionItem struct { + Value CollectionItem + ExplicitNull bool +} + +func (v NullableCollectionItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCollectionItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_collection_without_payload.go b/model_collection_without_payload.go new file mode 100644 index 00000000..f30b2a8e --- /dev/null +++ b/model_collection_without_payload.go @@ -0,0 +1,320 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CollectionWithoutPayload +type CollectionWithoutPayload struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // A short description of the purpose of this collection. + Description *string `json:"description,omitempty"` + // A list of the IDs of the Applications where this collection is enabled. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // The name of this collection. + Name string `json:"name"` + // ID of the user who last updated this effect if available. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // ID of the user who created this effect. + CreatedBy int32 `json:"createdBy"` + // The ID of the Application that owns this entity. + ApplicationId *int32 `json:"applicationId,omitempty"` + // The ID of the campaign that owns this entity. + CampaignId *int32 `json:"campaignId,omitempty"` +} + +// GetId returns the Id field value +func (o *CollectionWithoutPayload) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CollectionWithoutPayload) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CollectionWithoutPayload) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CollectionWithoutPayload) SetCreated(v time.Time) { + o.Created = v +} + +// GetAccountId returns the AccountId field value +func (o *CollectionWithoutPayload) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *CollectionWithoutPayload) SetAccountId(v int32) { + o.AccountId = v +} + +// GetModified returns the Modified field value +func (o *CollectionWithoutPayload) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *CollectionWithoutPayload) SetModified(v time.Time) { + o.Modified = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CollectionWithoutPayload) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CollectionWithoutPayload) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CollectionWithoutPayload) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CollectionWithoutPayload) SetDescription(v string) { + o.Description = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *CollectionWithoutPayload) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CollectionWithoutPayload) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *CollectionWithoutPayload) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *CollectionWithoutPayload) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetName returns the Name field value +func (o *CollectionWithoutPayload) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CollectionWithoutPayload) SetName(v string) { + o.Name = v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *CollectionWithoutPayload) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CollectionWithoutPayload) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *CollectionWithoutPayload) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *CollectionWithoutPayload) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *CollectionWithoutPayload) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *CollectionWithoutPayload) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *CollectionWithoutPayload) GetApplicationId() int32 { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret + } + return *o.ApplicationId +} + +// GetApplicationIdOk returns a tuple with the ApplicationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CollectionWithoutPayload) GetApplicationIdOk() (int32, bool) { + if o == nil || o.ApplicationId == nil { + var ret int32 + return ret, false + } + return *o.ApplicationId, true +} + +// HasApplicationId returns a boolean if a field has been set. +func (o *CollectionWithoutPayload) HasApplicationId() bool { + if o != nil && o.ApplicationId != nil { + return true + } + + return false +} + +// SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. +func (o *CollectionWithoutPayload) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +// GetCampaignId returns the CampaignId field value if set, zero value otherwise. +func (o *CollectionWithoutPayload) GetCampaignId() int32 { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret + } + return *o.CampaignId +} + +// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CollectionWithoutPayload) GetCampaignIdOk() (int32, bool) { + if o == nil || o.CampaignId == nil { + var ret int32 + return ret, false + } + return *o.CampaignId, true +} + +// HasCampaignId returns a boolean if a field has been set. +func (o *CollectionWithoutPayload) HasCampaignId() bool { + if o != nil && o.CampaignId != nil { + return true + } + + return false +} + +// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +func (o *CollectionWithoutPayload) SetCampaignId(v int32) { + o.CampaignId = &v +} + +type NullableCollectionWithoutPayload struct { + Value CollectionWithoutPayload + ExplicitNull bool +} + +func (v NullableCollectionWithoutPayload) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCollectionWithoutPayload) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_coupon.go b/model_coupon.go index 19b36ab0..3a046897 100644 --- a/model_coupon.go +++ b/model_coupon.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,15 +17,15 @@ import ( // Coupon type Coupon struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the campaign that owns this entity. CampaignId int32 `json:"campaignId"` - // The actual coupon code. + // The coupon code. Value string `json:"value"` - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -33,13 +33,15 @@ type Coupon struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. + Limits *[]LimitConfig `json:"limits,omitempty"` // The number of times this coupon has been successfully used. UsageCounter int32 `json:"usageCounter"` // The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. DiscountCounter *float32 `json:"discountCounter,omitempty"` // The remaining discount this coupon can give. DiscountRemainder *float32 `json:"discountRemainder,omitempty"` - // Arbitrary properties associated with this item + // Custom attributes associated with this coupon. Attributes *map[string]interface{} `json:"attributes,omitempty"` // The integration ID of the referring customer (if any) for whom this coupon was created as an effect. ReferralId *int32 `json:"referralId,omitempty"` @@ -47,7 +49,7 @@ type Coupon struct { RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` // The ID of the Import which created this coupon. ImportId *int32 `json:"importId,omitempty"` - // This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. + // Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation endpoint](/integration-api/#operation/createCouponReservation). - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons endpoint](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients endpoint](/management-api/#operation/createCouponsForMultipleRecipients). Reservation *bool `json:"reservation,omitempty"` // The id of the batch the coupon belongs to. BatchId *string `json:"batchId,omitempty"` @@ -227,6 +229,39 @@ func (o *Coupon) SetExpiryDate(v time.Time) { o.ExpiryDate = &v } +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *Coupon) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Coupon) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *Coupon) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *Coupon) SetLimits(v []LimitConfig) { + o.Limits = &v +} + // GetUsageCounter returns the UsageCounter field value func (o *Coupon) GetUsageCounter() int32 { if o == nil { diff --git a/model_coupon_constraints.go b/model_coupon_constraints.go index cdff800f..1c9755f2 100644 --- a/model_coupon_constraints.go +++ b/model_coupon_constraints.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // CouponConstraints struct for CouponConstraints type CouponConstraints struct { - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` diff --git a/model_coupon_created_effect_props.go b/model_coupon_created_effect_props.go index 1fd74020..d5269dbe 100644 --- a/model_coupon_created_effect_props.go +++ b/model_coupon_created_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // CouponCreatedEffectProps The properties specific to the \"couponCreated\" effect. This gets triggered whenever a validated rule contained a \"create coupon\" effect, and a coupon was created for a customer. See \"createdCoupons\" on the response for all details of this coupon. type CouponCreatedEffectProps struct { - // The coupon code that was created + // The coupon code that was created. Value string `json:"value"` - // The integration identifier of the customer for whom this coupon was created + // The integration identifier of the customer for whom this coupon was created. ProfileId string `json:"profileId"` } diff --git a/model_coupon_creation_job.go b/model_coupon_creation_job.go index 9be8a709..7c702fd1 100644 --- a/model_coupon_creation_job.go +++ b/model_coupon_creation_job.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // CouponCreationJob type CouponCreationJob struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -27,7 +27,7 @@ type CouponCreationJob struct { ApplicationId int32 `json:"applicationId"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -38,24 +38,26 @@ type CouponCreationJob struct { // The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. NumberOfCoupons int32 `json:"numberOfCoupons"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` - // Arbitrary properties associated with coupons + // Arbitrary properties associated with coupons. Attributes map[string]interface{} `json:"attributes"` - // The batch ID coupons created by this job will bear + // The batch ID coupons created by this job will bear. BatchId string `json:"batchId"` - // The current status of this request. The value should be either 'pending', 'completed' or 'failed' + // The current status of this request. Possible values: - `pending` - `completed` - `failed` - `coupon pattern full` Status string `json:"status"` - // The number of coupon codes that were already created for this request + // The number of coupon codes that were already created for this request. CreatedAmount int32 `json:"createdAmount"` - // The number of times this job failed + // The number of times this job failed. FailCount int32 `json:"failCount"` // An array of individual problems encountered during the request. Errors []string `json:"errors"` // ID of the user who created this effect. CreatedBy int32 `json:"createdBy"` - // Whether or not the user that created this job was notified of its final state + // Whether or not the user that created this job was notified of its final state. Communicated bool `json:"communicated"` - // The number of times an attempt to create a batch of coupons was made during the processing of the job - BatchExecutionCount int32 `json:"batchExecutionCount"` + // The number of times an attempt to create a chunk of coupons was made during the processing of the job. + ChunkExecutionCount int32 `json:"chunkExecutionCount"` + // The number of coupons that will be created in a single transactions. Coupons will be created in chunks until arriving at the requested amount. + ChunkSize *int32 `json:"chunkSize,omitempty"` } // GetId returns the Id field value @@ -415,19 +417,52 @@ func (o *CouponCreationJob) SetCommunicated(v bool) { o.Communicated = v } -// GetBatchExecutionCount returns the BatchExecutionCount field value -func (o *CouponCreationJob) GetBatchExecutionCount() int32 { +// GetChunkExecutionCount returns the ChunkExecutionCount field value +func (o *CouponCreationJob) GetChunkExecutionCount() int32 { if o == nil { var ret int32 return ret } - return o.BatchExecutionCount + return o.ChunkExecutionCount } -// SetBatchExecutionCount sets field value -func (o *CouponCreationJob) SetBatchExecutionCount(v int32) { - o.BatchExecutionCount = v +// SetChunkExecutionCount sets field value +func (o *CouponCreationJob) SetChunkExecutionCount(v int32) { + o.ChunkExecutionCount = v +} + +// GetChunkSize returns the ChunkSize field value if set, zero value otherwise. +func (o *CouponCreationJob) GetChunkSize() int32 { + if o == nil || o.ChunkSize == nil { + var ret int32 + return ret + } + return *o.ChunkSize +} + +// GetChunkSizeOk returns a tuple with the ChunkSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponCreationJob) GetChunkSizeOk() (int32, bool) { + if o == nil || o.ChunkSize == nil { + var ret int32 + return ret, false + } + return *o.ChunkSize, true +} + +// HasChunkSize returns a boolean if a field has been set. +func (o *CouponCreationJob) HasChunkSize() bool { + if o != nil && o.ChunkSize != nil { + return true + } + + return false +} + +// SetChunkSize gets a reference to the given int32 and assigns it to the ChunkSize field. +func (o *CouponCreationJob) SetChunkSize(v int32) { + o.ChunkSize = &v } type NullableCouponCreationJob struct { diff --git a/model_coupon_limit_configs.go b/model_coupon_limit_configs.go new file mode 100644 index 00000000..3bbaf08e --- /dev/null +++ b/model_coupon_limit_configs.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CouponLimitConfigs struct for CouponLimitConfigs +type CouponLimitConfigs struct { + // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. + Limits *[]LimitConfig `json:"limits,omitempty"` +} + +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *CouponLimitConfigs) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponLimitConfigs) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *CouponLimitConfigs) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *CouponLimitConfigs) SetLimits(v []LimitConfig) { + o.Limits = &v +} + +type NullableCouponLimitConfigs struct { + Value CouponLimitConfigs + ExplicitNull bool +} + +func (v NullableCouponLimitConfigs) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCouponLimitConfigs) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_coupon_rejection_reason.go b/model_coupon_rejection_reason.go index be2c6f12..40f5f582 100644 --- a/model_coupon_rejection_reason.go +++ b/model_coupon_rejection_reason.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_coupon_reservations.go b/model_coupon_reservations.go index e90ae4c2..6afaac5c 100644 --- a/model_coupon_reservations.go +++ b/model_coupon_reservations.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CouponReservations struct for CouponReservations type CouponReservations struct { - // List of Integration IDs + // List of customer integration IDs. IntegrationIDs []string `json:"integrationIDs"` } diff --git a/model_coupon_search.go b/model_coupon_search.go index 348aa531..331f52fa 100644 --- a/model_coupon_search.go +++ b/model_coupon_search.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CouponSearch struct for CouponSearch type CouponSearch struct { - // Properties to match against a coupon. All provided attributes will be exactly matched against attributes + // Properties to match against a coupon. All provided attributes will be exactly matched against attributes. Attributes map[string]interface{} `json:"attributes"` } diff --git a/model_coupon_value.go b/model_coupon_value.go index 1e843752..073ff252 100644 --- a/model_coupon_value.go +++ b/model_coupon_value.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CouponValue struct for CouponValue type CouponValue struct { - // The actual coupon code. + // The coupon code. Value *string `json:"value,omitempty"` } diff --git a/model_create_application_api_key.go b/model_create_application_api_key.go index 33dc0ac2..acc202ee 100644 --- a/model_create_application_api_key.go +++ b/model_create_application_api_key.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,11 +17,11 @@ import ( // CreateApplicationApiKey struct for CreateApplicationApiKey type CreateApplicationApiKey struct { - // Title for API Key + // Title for API Key. Title string `json:"title"` - // The date the API key expired + // The date the API key expired. Expires time.Time `json:"expires"` - // Platform the API key is valid for. + // The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. Platform *string `json:"platform,omitempty"` } diff --git a/model_create_management_key.go b/model_create_management_key.go new file mode 100644 index 00000000..88d6d8ae --- /dev/null +++ b/model_create_management_key.go @@ -0,0 +1,94 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CreateManagementKey struct for CreateManagementKey +type CreateManagementKey struct { + // Name for management key. + Name string `json:"name"` + // The date the management key expires. + ExpiryDate time.Time `json:"expiryDate"` + // The list of endpoints that can be accessed with the key + Endpoints []Endpoint `json:"endpoints"` +} + +// GetName returns the Name field value +func (o *CreateManagementKey) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CreateManagementKey) SetName(v string) { + o.Name = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *CreateManagementKey) GetExpiryDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *CreateManagementKey) SetExpiryDate(v time.Time) { + o.ExpiryDate = v +} + +// GetEndpoints returns the Endpoints field value +func (o *CreateManagementKey) GetEndpoints() []Endpoint { + if o == nil { + var ret []Endpoint + return ret + } + + return o.Endpoints +} + +// SetEndpoints sets field value +func (o *CreateManagementKey) SetEndpoints(v []Endpoint) { + o.Endpoints = v +} + +type NullableCreateManagementKey struct { + Value CreateManagementKey + ExplicitNull bool +} + +func (v NullableCreateManagementKey) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCreateManagementKey) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_create_template_campaign.go b/model_create_template_campaign.go index 13ff8ee9..a10724c2 100644 --- a/model_create_template_campaign.go +++ b/model_create_template_campaign.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -22,12 +22,16 @@ type CreateTemplateCampaign struct { Description *string `json:"description,omitempty"` // The ID of the Campaign Template which will be used in order to create the Campaign. TemplateId int32 `json:"templateId"` - // Custom Campaign Attributes. If the the Campaign Template defines the same values, they will be overridden. + // Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden. CampaignAttributesOverrides *map[string]interface{} `json:"campaignAttributesOverrides,omitempty"` // Actual values to replace the template placeholder values in the Ruleset bindings. Values for all Template Parameters must be provided. TemplateParamValues *[]Binding `json:"templateParamValues,omitempty"` // Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden. LimitOverrides *[]LimitConfig `json:"limitOverrides,omitempty"` + // The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` + // A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list. + Tags *[]string `json:"tags,omitempty"` } // GetName returns the Name field value @@ -192,6 +196,72 @@ func (o *CreateTemplateCampaign) SetLimitOverrides(v []LimitConfig) { o.LimitOverrides = &v } +// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. +func (o *CreateTemplateCampaign) GetCampaignGroups() []int32 { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret + } + return *o.CampaignGroups +} + +// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CreateTemplateCampaign) GetCampaignGroupsOk() ([]int32, bool) { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret, false + } + return *o.CampaignGroups, true +} + +// HasCampaignGroups returns a boolean if a field has been set. +func (o *CreateTemplateCampaign) HasCampaignGroups() bool { + if o != nil && o.CampaignGroups != nil { + return true + } + + return false +} + +// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. +func (o *CreateTemplateCampaign) SetCampaignGroups(v []int32) { + o.CampaignGroups = &v +} + +// GetTags returns the Tags field value if set, zero value otherwise. +func (o *CreateTemplateCampaign) GetTags() []string { + if o == nil || o.Tags == nil { + var ret []string + return ret + } + return *o.Tags +} + +// GetTagsOk returns a tuple with the Tags field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CreateTemplateCampaign) GetTagsOk() ([]string, bool) { + if o == nil || o.Tags == nil { + var ret []string + return ret, false + } + return *o.Tags, true +} + +// HasTags returns a boolean if a field has been set. +func (o *CreateTemplateCampaign) HasTags() bool { + if o != nil && o.Tags != nil { + return true + } + + return false +} + +// SetTags gets a reference to the given []string and assigns it to the Tags field. +func (o *CreateTemplateCampaign) SetTags(v []string) { + o.Tags = &v +} + type NullableCreateTemplateCampaign struct { Value CreateTemplateCampaign ExplicitNull bool diff --git a/model_create_template_campaign_response.go b/model_create_template_campaign_response.go index 9b962c68..3261797a 100644 --- a/model_create_template_campaign_response.go +++ b/model_create_template_campaign_response.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,9 @@ import ( // CreateTemplateCampaignResponse struct for CreateTemplateCampaignResponse type CreateTemplateCampaignResponse struct { - Campaign Campaign `json:"campaign"` - Ruleset Ruleset `json:"ruleset"` + Campaign Campaign `json:"campaign"` + Ruleset Ruleset `json:"ruleset"` + Collections *[]Collection `json:"collections,omitempty"` } // GetCampaign returns the Campaign field value @@ -50,6 +51,39 @@ func (o *CreateTemplateCampaignResponse) SetRuleset(v Ruleset) { o.Ruleset = v } +// GetCollections returns the Collections field value if set, zero value otherwise. +func (o *CreateTemplateCampaignResponse) GetCollections() []Collection { + if o == nil || o.Collections == nil { + var ret []Collection + return ret + } + return *o.Collections +} + +// GetCollectionsOk returns a tuple with the Collections field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CreateTemplateCampaignResponse) GetCollectionsOk() ([]Collection, bool) { + if o == nil || o.Collections == nil { + var ret []Collection + return ret, false + } + return *o.Collections, true +} + +// HasCollections returns a boolean if a field has been set. +func (o *CreateTemplateCampaignResponse) HasCollections() bool { + if o != nil && o.Collections != nil { + return true + } + + return false +} + +// SetCollections gets a reference to the given []Collection and assigns it to the Collections field. +func (o *CreateTemplateCampaignResponse) SetCollections(v []Collection) { + o.Collections = &v +} + type NullableCreateTemplateCampaignResponse struct { Value CreateTemplateCampaignResponse ExplicitNull bool diff --git a/model_custom_effect.go b/model_custom_effect.go index 77458939..969423f7 100644 --- a/model_custom_effect.go +++ b/model_custom_effect.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // CustomEffect type CustomEffect struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -37,7 +37,7 @@ type CustomEffect struct { Description *string `json:"description,omitempty"` // Determines if this effect is active. Enabled bool `json:"enabled"` - // Array of template argument definitions + // Array of template argument definitions. Params *[]TemplateArgDef `json:"params,omitempty"` // ID of the user who last updated this effect if available. ModifiedBy *int32 `json:"modifiedBy,omitempty"` diff --git a/model_custom_effect_props.go b/model_custom_effect_props.go index 71de7057..d55bca5e 100644 --- a/model_custom_effect_props.go +++ b/model_custom_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CustomEffectProps Effect containing custom payload. type CustomEffectProps struct { - // The ID of the custom effect that was triggered + // The ID of the custom effect that was triggered. EffectId int32 `json:"effectId"` // The type of the custom effect. Name string `json:"name"` diff --git a/model_customer_activity_report.go b/model_customer_activity_report.go index 0975a4e0..0ea4b3c8 100644 --- a/model_customer_activity_report.go +++ b/model_customer_activity_report.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,9 +15,9 @@ import ( "time" ) -// CustomerActivityReport +// CustomerActivityReport A summary report of customer activity for a given time range. type CustomerActivityReport struct { - // The integration ID for this entity sent to and used in the Talon.One system. + // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_customer_analytics.go b/model_customer_analytics.go index 7e7ebb97..fc847aa4 100644 --- a/model_customer_analytics.go +++ b/model_customer_analytics.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,21 +14,21 @@ import ( "encoding/json" ) -// CustomerAnalytics +// CustomerAnalytics A summary report of customer activity for a given time range. type CustomerAnalytics struct { - // Total accepted coupons for this customer + // Total accepted coupons for this customer. AcceptedCoupons int32 `json:"acceptedCoupons"` - // Total created coupons for this customer + // Total created coupons for this customer. CreatedCoupons int32 `json:"createdCoupons"` - // Total free items given to this customer + // Total free items given to this customer. FreeItems int32 `json:"freeItems"` - // Total orders made by this customer + // Total orders made by this customer. TotalOrders int32 `json:"totalOrders"` - // Total orders made by this customer that had a discount + // Total orders made by this customer that had a discount. TotalDiscountedOrders int32 `json:"totalDiscountedOrders"` - // Total Revenue across all closed sessions + // Total Revenue across all closed sessions. TotalRevenue float32 `json:"totalRevenue"` - // The sum of discounts that were given across all closed sessions + // The sum of discounts that were given across all closed sessions. TotalDiscounts float32 `json:"totalDiscounts"` } diff --git a/model_customer_inventory.go b/model_customer_inventory.go index 4ef231cf..f87867a3 100644 --- a/model_customer_inventory.go +++ b/model_customer_inventory.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,10 @@ import ( // CustomerInventory struct for CustomerInventory type CustomerInventory struct { - Profile *CustomerProfile `json:"profile,omitempty"` - Loyalty *Loyalty `json:"loyalty,omitempty"` - Referrals *[]Referral `json:"referrals,omitempty"` + Profile *CustomerProfile `json:"profile,omitempty"` + Loyalty *Loyalty `json:"loyalty,omitempty"` + Referrals *[]InventoryReferral `json:"referrals,omitempty"` + // The coupons reserved by this profile. This array includes hard and soft reservations. See each coupon's `reservation` property. Coupons *[]InventoryCoupon `json:"coupons,omitempty"` Giveaways *[]Giveaway `json:"giveaways,omitempty"` } @@ -90,9 +91,9 @@ func (o *CustomerInventory) SetLoyalty(v Loyalty) { } // GetReferrals returns the Referrals field value if set, zero value otherwise. -func (o *CustomerInventory) GetReferrals() []Referral { +func (o *CustomerInventory) GetReferrals() []InventoryReferral { if o == nil || o.Referrals == nil { - var ret []Referral + var ret []InventoryReferral return ret } return *o.Referrals @@ -100,9 +101,9 @@ func (o *CustomerInventory) GetReferrals() []Referral { // GetReferralsOk returns a tuple with the Referrals field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *CustomerInventory) GetReferralsOk() ([]Referral, bool) { +func (o *CustomerInventory) GetReferralsOk() ([]InventoryReferral, bool) { if o == nil || o.Referrals == nil { - var ret []Referral + var ret []InventoryReferral return ret, false } return *o.Referrals, true @@ -117,8 +118,8 @@ func (o *CustomerInventory) HasReferrals() bool { return false } -// SetReferrals gets a reference to the given []Referral and assigns it to the Referrals field. -func (o *CustomerInventory) SetReferrals(v []Referral) { +// SetReferrals gets a reference to the given []InventoryReferral and assigns it to the Referrals field. +func (o *CustomerInventory) SetReferrals(v []InventoryReferral) { o.Referrals = &v } diff --git a/model_customer_profile.go b/model_customer_profile.go index ae3b65d2..9149c007 100644 --- a/model_customer_profile.go +++ b/model_customer_profile.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,25 +17,25 @@ import ( // CustomerProfile type CustomerProfile struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. The exact moment this entity was created. Created time.Time `json:"created"` - // The integration ID for this entity sent to and used in the Talon.One system. + // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes map[string]interface{} `json:"attributes"` // The ID of the Talon.One account that owns this profile. AccountId int32 `json:"accountId"` // The total amount of closed sessions by a customer. A closed session is a successful purchase. ClosedSessions int32 `json:"closedSessions"` - // Sum of all purchases made by this customer + // Sum of all purchases made by this customer. TotalSales float32 `json:"totalSales"` - // A list of loyalty programs joined by the customer + // **DEPRECATED** A list of loyalty programs joined by the customer. LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` - // A list of audiences the customer belongs to + // A list of audiences the customer belongs to. AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` - // Timestamp of the most recent event received from this customer + // Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. LastActivity time.Time `json:"lastActivity"` } diff --git a/model_customer_profile_audience_request.go b/model_customer_profile_audience_request.go index f9b3b0ba..f081b6bf 100644 --- a/model_customer_profile_audience_request.go +++ b/model_customer_profile_audience_request.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_customer_profile_audience_request_item.go b/model_customer_profile_audience_request_item.go index 81c67511..3a1f3772 100644 --- a/model_customer_profile_audience_request_item.go +++ b/model_customer_profile_audience_request_item.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,9 @@ import ( // CustomerProfileAudienceRequestItem struct for CustomerProfileAudienceRequestItem type CustomerProfileAudienceRequestItem struct { + // Defines the action to perform: - `add`: Adds the customer profile to the audience. - `delete`: Removes the customer profile from the audience. Action string `json:"action"` - // The ID of this audience in the third-party integration. + // The ID of this customer profile in the third-party integration. ProfileIntegrationId string `json:"profileIntegrationId"` // The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). AudienceId int32 `json:"audienceId"` diff --git a/model_customer_profile_integration_request_v2.go b/model_customer_profile_integration_request_v2.go index 344273b7..30c2ad9f 100644 --- a/model_customer_profile_integration_request_v2.go +++ b/model_customer_profile_integration_request_v2.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,10 +16,10 @@ import ( // CustomerProfileIntegrationRequestV2 type CustomerProfileIntegrationRequestV2 struct { - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` AudiencesChanges *ProfileAudiencesChanges `json:"audiencesChanges,omitempty"` - // Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. + // Optional list of extra data that you want to get in the response. Use this property to get as much data as you need in one request instead of sending extra requests to other endpoints. **Note:** `ruleFailureReasons` is always part of the response when the [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. ResponseContent *[]string `json:"responseContent,omitempty"` } diff --git a/model_customer_profile_search_query.go b/model_customer_profile_search_query.go index 0cdf0f54..176c6800 100644 --- a/model_customer_profile_search_query.go +++ b/model_customer_profile_search_query.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // CustomerProfileSearchQuery struct for CustomerProfileSearchQuery type CustomerProfileSearchQuery struct { - // Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes + // Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes. Attributes *map[string]interface{} `json:"attributes,omitempty"` IntegrationIDs *[]string `json:"integrationIDs,omitempty"` ProfileIDs *[]int32 `json:"profileIDs,omitempty"` diff --git a/model_customer_session.go b/model_customer_session.go index c301867e..e577bf60 100644 --- a/model_customer_session.go +++ b/model_customer_session.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,23 +17,23 @@ import ( // CustomerSession type CustomerSession struct { - // The integration ID for this entity sent to and used in the Talon.One system. + // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId string `json:"profileId"` // Any coupon code entered. Coupon string `json:"coupon"` // Any referral code entered. Referral string `json:"referral"` - // Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entities](/docs/dev/concepts/entities#customer-session). + // Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). State string `json:"state"` // Serialized JSON representation. CartItems []CartItem `json:"cartItems"` - // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. + // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). Identifiers *[]string `json:"identifiers,omitempty"` // The total sum of the cart in one session. Total float32 `json:"total"` @@ -43,7 +43,7 @@ type CustomerSession struct { FirstSession bool `json:"firstSession"` // A map of labelled discount values, values will be in the same currency as the application associated with the session. Discounts map[string]float32 `json:"discounts"` - // Timestamp of the most recent event received on this session + // Timestamp of the most recent event received on this session. Updated time.Time `json:"updated"` } diff --git a/model_customer_session_v2.go b/model_customer_session_v2.go index dd480d03..3050a735 100644 --- a/model_customer_session_v2.go +++ b/model_customer_session_v2.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,53 +17,57 @@ import ( // CustomerSessionV2 type CustomerSessionV2 struct { - // The integration ID for this entity sent to and used in the Talon.One system. - IntegrationId string `json:"integrationId"` - // The exact moment this entity was created. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. The exact moment this entity was created. Created time.Time `json:"created"` + // The integration ID set by your integration layer. + IntegrationId string `json:"integrationId"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId string `json:"profileId"` - // Any coupon codes entered. + // Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. CouponCodes *[]string `json:"couponCodes,omitempty"` - // Any referral code entered. + // Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. ReferralCode *string `json:"referralCode,omitempty"` - // Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entites](/docs/dev/concepts/entities#customer-session). + // Any loyalty cards used. + LoyaltyCards *[]string `json:"loyaltyCards,omitempty"` + // Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). State string `json:"state"` - // All items the customer will be purchasing in this session + // The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. CartItems []CartItem `json:"cartItems"` - // Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees. + // Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). AdditionalCosts *map[string]AdditionalCost `json:"additionalCosts,omitempty"` - // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. + // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains an identifier by the time you close it. Identifiers *[]string `json:"identifiers,omitempty"` - // A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. + // Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. Attributes map[string]interface{} `json:"attributes"` // Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. FirstSession bool `json:"firstSession"` - // The total sum of cart-items, as well as additional costs, before any discounts applied + // The total sum of cart-items, as well as additional costs, before any discounts applied. Total float32 `json:"total"` - // The total sum of cart-items before any discounts applied + // The total sum of cart-items before any discounts applied. CartItemTotal float32 `json:"cartItemTotal"` - // The total sum of additional costs before any discounts applied + // The total sum of additional costs before any discounts applied. AdditionalCostTotal float32 `json:"additionalCostTotal"` - // Timestamp of the most recent event received on this session + // Timestamp of the most recent event received on this session. Updated time.Time `json:"updated"` } -// GetIntegrationId returns the IntegrationId field value -func (o *CustomerSessionV2) GetIntegrationId() string { +// GetId returns the Id field value +func (o *CustomerSessionV2) GetId() int32 { if o == nil { - var ret string + var ret int32 return ret } - return o.IntegrationId + return o.Id } -// SetIntegrationId sets field value -func (o *CustomerSessionV2) SetIntegrationId(v string) { - o.IntegrationId = v +// SetId sets field value +func (o *CustomerSessionV2) SetId(v int32) { + o.Id = v } // GetCreated returns the Created field value @@ -81,6 +85,21 @@ func (o *CustomerSessionV2) SetCreated(v time.Time) { o.Created = v } +// GetIntegrationId returns the IntegrationId field value +func (o *CustomerSessionV2) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *CustomerSessionV2) SetIntegrationId(v string) { + o.IntegrationId = v +} + // GetApplicationId returns the ApplicationId field value func (o *CustomerSessionV2) GetApplicationId() int32 { if o == nil { @@ -177,6 +196,39 @@ func (o *CustomerSessionV2) SetReferralCode(v string) { o.ReferralCode = &v } +// GetLoyaltyCards returns the LoyaltyCards field value if set, zero value otherwise. +func (o *CustomerSessionV2) GetLoyaltyCards() []string { + if o == nil || o.LoyaltyCards == nil { + var ret []string + return ret + } + return *o.LoyaltyCards +} + +// GetLoyaltyCardsOk returns a tuple with the LoyaltyCards field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerSessionV2) GetLoyaltyCardsOk() ([]string, bool) { + if o == nil || o.LoyaltyCards == nil { + var ret []string + return ret, false + } + return *o.LoyaltyCards, true +} + +// HasLoyaltyCards returns a boolean if a field has been set. +func (o *CustomerSessionV2) HasLoyaltyCards() bool { + if o != nil && o.LoyaltyCards != nil { + return true + } + + return false +} + +// SetLoyaltyCards gets a reference to the given []string and assigns it to the LoyaltyCards field. +func (o *CustomerSessionV2) SetLoyaltyCards(v []string) { + o.LoyaltyCards = &v +} + // GetState returns the State field value func (o *CustomerSessionV2) GetState() string { if o == nil { diff --git a/model_deduct_loyalty_points_effect_props.go b/model_deduct_loyalty_points_effect_props.go index 900e2b61..44dbd7c8 100644 --- a/model_deduct_loyalty_points_effect_props.go +++ b/model_deduct_loyalty_points_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,18 +16,20 @@ import ( // DeductLoyaltyPointsEffectProps The properties specific to the \"deductLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained a condition to only trigger when the given number of loyalty points could be deduced. These points are automatically stored and managed inside Talon.One. type DeductLoyaltyPointsEffectProps struct { - // The title of the rule that contained triggered this points deduction + // The title of the rule that contained triggered this points deduction. RuleTitle string `json:"ruleTitle"` - // The ID of the loyalty program where these points were added + // The ID of the loyalty program where these points were added. ProgramId int32 `json:"programId"` - // The ID of the subledger within the loyalty program where these points were added + // The ID of the subledger within the loyalty program where these points were added. SubLedgerId string `json:"subLedgerId"` - // The amount of points that were deducted + // The amount of points that were deducted. Value float32 `json:"value"` - // The identifier of this deduction in the loyalty ledger + // The identifier of this deduction in the loyalty ledger. TransactionUUID string `json:"transactionUUID"` // The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. Name string `json:"name"` + // The card on which these points were added. + CardIdentifier *string `json:"cardIdentifier,omitempty"` } // GetRuleTitle returns the RuleTitle field value @@ -120,6 +122,39 @@ func (o *DeductLoyaltyPointsEffectProps) SetName(v string) { o.Name = v } +// GetCardIdentifier returns the CardIdentifier field value if set, zero value otherwise. +func (o *DeductLoyaltyPointsEffectProps) GetCardIdentifier() string { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret + } + return *o.CardIdentifier +} + +// GetCardIdentifierOk returns a tuple with the CardIdentifier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *DeductLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool) { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret, false + } + return *o.CardIdentifier, true +} + +// HasCardIdentifier returns a boolean if a field has been set. +func (o *DeductLoyaltyPointsEffectProps) HasCardIdentifier() bool { + if o != nil && o.CardIdentifier != nil { + return true + } + + return false +} + +// SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. +func (o *DeductLoyaltyPointsEffectProps) SetCardIdentifier(v string) { + o.CardIdentifier = &v +} + type NullableDeductLoyaltyPointsEffectProps struct { Value DeductLoyaltyPointsEffectProps ExplicitNull bool diff --git a/model_effect.go b/model_effect.go index e946a310..b776a215 100644 --- a/model_effect.go +++ b/model_effect.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,19 +16,21 @@ import ( // Effect type Effect struct { - // The ID of the campaign that triggered this effect + // The ID of the campaign that triggered this effect. CampaignId int32 `json:"campaignId"` - // The ID of the ruleset that was active in the campaign when this effect was triggered + // The ID of the ruleset that was active in the campaign when this effect was triggered. RulesetId int32 `json:"rulesetId"` - // The position of the rule that triggered this effect within the ruleset + // The position of the rule that triggered this effect within the ruleset. RuleIndex int32 `json:"ruleIndex"` - // The name of the rule that triggered this effect + // The name of the rule that triggered this effect. RuleName string `json:"ruleName"` - // The type of effect that was triggered + // The type of effect that was triggered. EffectType string `json:"effectType"` - // The ID of the coupon that was being evaluated when this effect was triggered - TriggeredByCoupon *int32 `json:"triggeredByCoupon,omitempty"` - Props map[string]interface{} `json:"props"` + // The ID of the coupon that was being evaluated when this effect was triggered. + TriggeredByCoupon *int32 `json:"triggeredByCoupon,omitempty"` + // The ID of the catalog item that was being evaluated when this effect was triggered. + TriggeredForCatalogItem *int32 `json:"triggeredForCatalogItem,omitempty"` + Props map[string]interface{} `json:"props"` } // GetCampaignId returns the CampaignId field value @@ -139,6 +141,39 @@ func (o *Effect) SetTriggeredByCoupon(v int32) { o.TriggeredByCoupon = &v } +// GetTriggeredForCatalogItem returns the TriggeredForCatalogItem field value if set, zero value otherwise. +func (o *Effect) GetTriggeredForCatalogItem() int32 { + if o == nil || o.TriggeredForCatalogItem == nil { + var ret int32 + return ret + } + return *o.TriggeredForCatalogItem +} + +// GetTriggeredForCatalogItemOk returns a tuple with the TriggeredForCatalogItem field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Effect) GetTriggeredForCatalogItemOk() (int32, bool) { + if o == nil || o.TriggeredForCatalogItem == nil { + var ret int32 + return ret, false + } + return *o.TriggeredForCatalogItem, true +} + +// HasTriggeredForCatalogItem returns a boolean if a field has been set. +func (o *Effect) HasTriggeredForCatalogItem() bool { + if o != nil && o.TriggeredForCatalogItem != nil { + return true + } + + return false +} + +// SetTriggeredForCatalogItem gets a reference to the given int32 and assigns it to the TriggeredForCatalogItem field. +func (o *Effect) SetTriggeredForCatalogItem(v int32) { + o.TriggeredForCatalogItem = &v +} + // GetProps returns the Props field value func (o *Effect) GetProps() map[string]interface{} { if o == nil { diff --git a/model_effect_entity.go b/model_effect_entity.go index 914703a4..709b27b7 100644 --- a/model_effect_entity.go +++ b/model_effect_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,20 +14,22 @@ import ( "encoding/json" ) -// EffectEntity Definition of all properties that are present on all effects, independent of their type +// EffectEntity Definition of all properties that are present on all effects, independent of their type. type EffectEntity struct { - // The ID of the campaign that triggered this effect + // The ID of the campaign that triggered this effect. CampaignId int32 `json:"campaignId"` - // The ID of the ruleset that was active in the campaign when this effect was triggered + // The ID of the ruleset that was active in the campaign when this effect was triggered. RulesetId int32 `json:"rulesetId"` - // The position of the rule that triggered this effect within the ruleset + // The position of the rule that triggered this effect within the ruleset. RuleIndex int32 `json:"ruleIndex"` - // The name of the rule that triggered this effect + // The name of the rule that triggered this effect. RuleName string `json:"ruleName"` - // The type of effect that was triggered + // The type of effect that was triggered. EffectType string `json:"effectType"` - // The ID of the coupon that was being evaluated when this effect was triggered + // The ID of the coupon that was being evaluated when this effect was triggered. TriggeredByCoupon *int32 `json:"triggeredByCoupon,omitempty"` + // The ID of the catalog item that was being evaluated when this effect was triggered. + TriggeredForCatalogItem *int32 `json:"triggeredForCatalogItem,omitempty"` } // GetCampaignId returns the CampaignId field value @@ -138,6 +140,39 @@ func (o *EffectEntity) SetTriggeredByCoupon(v int32) { o.TriggeredByCoupon = &v } +// GetTriggeredForCatalogItem returns the TriggeredForCatalogItem field value if set, zero value otherwise. +func (o *EffectEntity) GetTriggeredForCatalogItem() int32 { + if o == nil || o.TriggeredForCatalogItem == nil { + var ret int32 + return ret + } + return *o.TriggeredForCatalogItem +} + +// GetTriggeredForCatalogItemOk returns a tuple with the TriggeredForCatalogItem field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EffectEntity) GetTriggeredForCatalogItemOk() (int32, bool) { + if o == nil || o.TriggeredForCatalogItem == nil { + var ret int32 + return ret, false + } + return *o.TriggeredForCatalogItem, true +} + +// HasTriggeredForCatalogItem returns a boolean if a field has been set. +func (o *EffectEntity) HasTriggeredForCatalogItem() bool { + if o != nil && o.TriggeredForCatalogItem != nil { + return true + } + + return false +} + +// SetTriggeredForCatalogItem gets a reference to the given int32 and assigns it to the TriggeredForCatalogItem field. +func (o *EffectEntity) SetTriggeredForCatalogItem(v int32) { + o.TriggeredForCatalogItem = &v +} + type NullableEffectEntity struct { Value EffectEntity ExplicitNull bool diff --git a/model_email_entity.go b/model_email_entity.go index 28b6885c..a37c5c2d 100644 --- a/model_email_entity.go +++ b/model_email_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_endpoint.go b/model_endpoint.go new file mode 100644 index 00000000..8e4cd05e --- /dev/null +++ b/model_endpoint.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// Endpoint struct for Endpoint +type Endpoint struct { + // allowed endpoint + Path string `json:"path"` +} + +// GetPath returns the Path field value +func (o *Endpoint) GetPath() string { + if o == nil { + var ret string + return ret + } + + return o.Path +} + +// SetPath sets field value +func (o *Endpoint) SetPath(v string) { + o.Path = v +} + +type NullableEndpoint struct { + Value Endpoint + ExplicitNull bool +} + +func (v NullableEndpoint) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableEndpoint) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_entity.go b/model_entity.go index b3c29d99..79f9d595 100644 --- a/model_entity.go +++ b/model_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Entity struct for Entity type Entity struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_entity_with_talang_visible_id.go b/model_entity_with_talang_visible_id.go index aed104b3..95df1e4d 100644 --- a/model_entity_with_talang_visible_id.go +++ b/model_entity_with_talang_visible_id.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_environment.go b/model_environment.go index 8ddf6b1f..5f8c844b 100644 --- a/model_environment.go +++ b/model_environment.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Environment type Environment struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -29,7 +29,7 @@ type Environment struct { Functions []FunctionDef `json:"functions"` // The templates defined for this application. Templates []TemplateDef `json:"templates"` - // A stringified version of the environment's Talang variables scope + // A stringified version of the environment's Talang variables scope. Variables string `json:"variables"` // The giveaways pools that the application is subscribed to. GiveawaysPools *[]GiveawaysPool `json:"giveawaysPools,omitempty"` @@ -41,6 +41,8 @@ type Environment struct { AdditionalCosts *[]AccountAdditionalCost `json:"additionalCosts,omitempty"` // The audiences contained in the account which the application belongs to. Audiences *[]Audience `json:"audiences,omitempty"` + // The account-level collections that the application is subscribed to. + Collections *[]Collection `json:"collections,omitempty"` } // GetId returns the Id field value @@ -313,6 +315,39 @@ func (o *Environment) SetAudiences(v []Audience) { o.Audiences = &v } +// GetCollections returns the Collections field value if set, zero value otherwise. +func (o *Environment) GetCollections() []Collection { + if o == nil || o.Collections == nil { + var ret []Collection + return ret + } + return *o.Collections +} + +// GetCollectionsOk returns a tuple with the Collections field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetCollectionsOk() ([]Collection, bool) { + if o == nil || o.Collections == nil { + var ret []Collection + return ret, false + } + return *o.Collections, true +} + +// HasCollections returns a boolean if a field has been set. +func (o *Environment) HasCollections() bool { + if o != nil && o.Collections != nil { + return true + } + + return false +} + +// SetCollections gets a reference to the given []Collection and assigns it to the Collections field. +func (o *Environment) SetCollections(v []Collection) { + o.Collections = &v +} + type NullableEnvironment struct { Value Environment ExplicitNull bool diff --git a/model_error_effect_props.go b/model_error_effect_props.go index 9a589ae6..84c1abe4 100644 --- a/model_error_effect_props.go +++ b/model_error_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_error_response.go b/model_error_response.go index 473a07c0..e7dbd383 100644 --- a/model_error_response.go +++ b/model_error_response.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_error_response_with_status.go b/model_error_response_with_status.go new file mode 100644 index 00000000..7caa9c51 --- /dev/null +++ b/model_error_response_with_status.go @@ -0,0 +1,146 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ErrorResponseWithStatus struct for ErrorResponseWithStatus +type ErrorResponseWithStatus struct { + Message *string `json:"message,omitempty"` + // An array of individual problems encountered during the request. + Errors *[]ApiError `json:"errors,omitempty"` + // The error code + StatusCode *int32 `json:"StatusCode,omitempty"` +} + +// GetMessage returns the Message field value if set, zero value otherwise. +func (o *ErrorResponseWithStatus) GetMessage() string { + if o == nil || o.Message == nil { + var ret string + return ret + } + return *o.Message +} + +// GetMessageOk returns a tuple with the Message field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ErrorResponseWithStatus) GetMessageOk() (string, bool) { + if o == nil || o.Message == nil { + var ret string + return ret, false + } + return *o.Message, true +} + +// HasMessage returns a boolean if a field has been set. +func (o *ErrorResponseWithStatus) HasMessage() bool { + if o != nil && o.Message != nil { + return true + } + + return false +} + +// SetMessage gets a reference to the given string and assigns it to the Message field. +func (o *ErrorResponseWithStatus) SetMessage(v string) { + o.Message = &v +} + +// GetErrors returns the Errors field value if set, zero value otherwise. +func (o *ErrorResponseWithStatus) GetErrors() []ApiError { + if o == nil || o.Errors == nil { + var ret []ApiError + return ret + } + return *o.Errors +} + +// GetErrorsOk returns a tuple with the Errors field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ErrorResponseWithStatus) GetErrorsOk() ([]ApiError, bool) { + if o == nil || o.Errors == nil { + var ret []ApiError + return ret, false + } + return *o.Errors, true +} + +// HasErrors returns a boolean if a field has been set. +func (o *ErrorResponseWithStatus) HasErrors() bool { + if o != nil && o.Errors != nil { + return true + } + + return false +} + +// SetErrors gets a reference to the given []ApiError and assigns it to the Errors field. +func (o *ErrorResponseWithStatus) SetErrors(v []ApiError) { + o.Errors = &v +} + +// GetStatusCode returns the StatusCode field value if set, zero value otherwise. +func (o *ErrorResponseWithStatus) GetStatusCode() int32 { + if o == nil || o.StatusCode == nil { + var ret int32 + return ret + } + return *o.StatusCode +} + +// GetStatusCodeOk returns a tuple with the StatusCode field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ErrorResponseWithStatus) GetStatusCodeOk() (int32, bool) { + if o == nil || o.StatusCode == nil { + var ret int32 + return ret, false + } + return *o.StatusCode, true +} + +// HasStatusCode returns a boolean if a field has been set. +func (o *ErrorResponseWithStatus) HasStatusCode() bool { + if o != nil && o.StatusCode != nil { + return true + } + + return false +} + +// SetStatusCode gets a reference to the given int32 and assigns it to the StatusCode field. +func (o *ErrorResponseWithStatus) SetStatusCode(v int32) { + o.StatusCode = &v +} + +type NullableErrorResponseWithStatus struct { + Value ErrorResponseWithStatus + ExplicitNull bool +} + +func (v NullableErrorResponseWithStatus) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableErrorResponseWithStatus) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_error_source.go b/model_error_source.go index 5cb16918..e83de672 100644 --- a/model_error_source.go +++ b/model_error_source.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -22,7 +22,7 @@ type ErrorSource struct { Parameter *string `json:"parameter,omitempty"` // Line number in uploaded multipart file that caused this error. 'N/A' if unknown. Line *string `json:"line,omitempty"` - // Pointer to the resource that caused this error + // Pointer to the resource that caused this error. Resource *string `json:"resource,omitempty"` } diff --git a/model_event.go b/model_event.go index 51645a2c..fb2b76ea 100644 --- a/model_event.go +++ b/model_event.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,13 +17,13 @@ import ( // Event type Event struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId *string `json:"profileId,omitempty"` // A string representing the event. Must not be a reserved event name. Type string `json:"type"` @@ -31,7 +31,7 @@ type Event struct { Attributes map[string]interface{} `json:"attributes"` // The ID of the session that this event occurred in. SessionId *string `json:"sessionId,omitempty"` - // An array of \"effects\" that must be applied in response to this event. Example effects include `addItemToCart` or `setDiscount`. + // An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](/docs/dev/integration-api/api-effects). Effects [][]interface{} `json:"effects"` // Ledger entries for the event. LedgerEntries []LedgerEntry `json:"ledgerEntries"` diff --git a/model_event_type.go b/model_event_type.go index ce0d6e7e..000e785f 100644 --- a/model_event_type.go +++ b/model_event_type.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,30 +17,16 @@ import ( // EventType type EventType struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` - // The IDs of the applications that are related to this entity. - ApplicationIds []int32 `json:"applicationIds"` // The human-friendly display name for this event type. Use a short, past-tense, description of the event. Title string `json:"title"` // The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created. Name string `json:"name"` // An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. - Description string `json:"description"` - // This defines how the request payload will be parsed before your handler code is run. - MimeType string `json:"mimeType"` - // It is often helpful to include an example payload with the event type definition for documentation purposes. - ExamplePayload *string `json:"examplePayload,omitempty"` - // It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. - Schema *map[string]interface{} `json:"schema,omitempty"` - // The language of the handler code. Currently only `\"talang\"` is supported. - HandlerLanguage *string `json:"handlerLanguage,omitempty"` - // Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules. - Handler string `json:"handler"` - // The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. - Version int32 `json:"version"` + Description *string `json:"description,omitempty"` } // GetId returns the Id field value @@ -73,21 +59,6 @@ func (o *EventType) SetCreated(v time.Time) { o.Created = v } -// GetApplicationIds returns the ApplicationIds field value -func (o *EventType) GetApplicationIds() []int32 { - if o == nil { - var ret []int32 - return ret - } - - return o.ApplicationIds -} - -// SetApplicationIds sets field value -func (o *EventType) SetApplicationIds(v []int32) { - o.ApplicationIds = v -} - // GetTitle returns the Title field value func (o *EventType) GetTitle() string { if o == nil { @@ -118,163 +89,37 @@ func (o *EventType) SetName(v string) { o.Name = v } -// GetDescription returns the Description field value +// GetDescription returns the Description field value if set, zero value otherwise. func (o *EventType) GetDescription() string { - if o == nil { - var ret string - return ret - } - - return o.Description -} - -// SetDescription sets field value -func (o *EventType) SetDescription(v string) { - o.Description = v -} - -// GetMimeType returns the MimeType field value -func (o *EventType) GetMimeType() string { - if o == nil { - var ret string - return ret - } - - return o.MimeType -} - -// SetMimeType sets field value -func (o *EventType) SetMimeType(v string) { - o.MimeType = v -} - -// GetExamplePayload returns the ExamplePayload field value if set, zero value otherwise. -func (o *EventType) GetExamplePayload() string { - if o == nil || o.ExamplePayload == nil { - var ret string - return ret - } - return *o.ExamplePayload -} - -// GetExamplePayloadOk returns a tuple with the ExamplePayload field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *EventType) GetExamplePayloadOk() (string, bool) { - if o == nil || o.ExamplePayload == nil { - var ret string - return ret, false - } - return *o.ExamplePayload, true -} - -// HasExamplePayload returns a boolean if a field has been set. -func (o *EventType) HasExamplePayload() bool { - if o != nil && o.ExamplePayload != nil { - return true - } - - return false -} - -// SetExamplePayload gets a reference to the given string and assigns it to the ExamplePayload field. -func (o *EventType) SetExamplePayload(v string) { - o.ExamplePayload = &v -} - -// GetSchema returns the Schema field value if set, zero value otherwise. -func (o *EventType) GetSchema() map[string]interface{} { - if o == nil || o.Schema == nil { - var ret map[string]interface{} - return ret - } - return *o.Schema -} - -// GetSchemaOk returns a tuple with the Schema field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *EventType) GetSchemaOk() (map[string]interface{}, bool) { - if o == nil || o.Schema == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Schema, true -} - -// HasSchema returns a boolean if a field has been set. -func (o *EventType) HasSchema() bool { - if o != nil && o.Schema != nil { - return true - } - - return false -} - -// SetSchema gets a reference to the given map[string]interface{} and assigns it to the Schema field. -func (o *EventType) SetSchema(v map[string]interface{}) { - o.Schema = &v -} - -// GetHandlerLanguage returns the HandlerLanguage field value if set, zero value otherwise. -func (o *EventType) GetHandlerLanguage() string { - if o == nil || o.HandlerLanguage == nil { + if o == nil || o.Description == nil { var ret string return ret } - return *o.HandlerLanguage + return *o.Description } -// GetHandlerLanguageOk returns a tuple with the HandlerLanguage field value if set, zero value otherwise +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *EventType) GetHandlerLanguageOk() (string, bool) { - if o == nil || o.HandlerLanguage == nil { +func (o *EventType) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { var ret string return ret, false } - return *o.HandlerLanguage, true + return *o.Description, true } -// HasHandlerLanguage returns a boolean if a field has been set. -func (o *EventType) HasHandlerLanguage() bool { - if o != nil && o.HandlerLanguage != nil { +// HasDescription returns a boolean if a field has been set. +func (o *EventType) HasDescription() bool { + if o != nil && o.Description != nil { return true } return false } -// SetHandlerLanguage gets a reference to the given string and assigns it to the HandlerLanguage field. -func (o *EventType) SetHandlerLanguage(v string) { - o.HandlerLanguage = &v -} - -// GetHandler returns the Handler field value -func (o *EventType) GetHandler() string { - if o == nil { - var ret string - return ret - } - - return o.Handler -} - -// SetHandler sets field value -func (o *EventType) SetHandler(v string) { - o.Handler = v -} - -// GetVersion returns the Version field value -func (o *EventType) GetVersion() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Version -} - -// SetVersion sets field value -func (o *EventType) SetVersion(v int32) { - o.Version = v +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *EventType) SetDescription(v string) { + o.Description = &v } type NullableEventType struct { diff --git a/model_event_v2.go b/model_event_v2.go new file mode 100644 index 00000000..e740fbda --- /dev/null +++ b/model_event_v2.go @@ -0,0 +1,129 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// EventV2 +type EventV2 struct { + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. + ProfileId *string `json:"profileId,omitempty"` + // A string representing the event. Must not be a reserved event name. + Type string `json:"type"` + // Arbitrary additional JSON data associated with the event. + Attributes *map[string]interface{} `json:"attributes,omitempty"` +} + +// GetProfileId returns the ProfileId field value if set, zero value otherwise. +func (o *EventV2) GetProfileId() string { + if o == nil || o.ProfileId == nil { + var ret string + return ret + } + return *o.ProfileId +} + +// GetProfileIdOk returns a tuple with the ProfileId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EventV2) GetProfileIdOk() (string, bool) { + if o == nil || o.ProfileId == nil { + var ret string + return ret, false + } + return *o.ProfileId, true +} + +// HasProfileId returns a boolean if a field has been set. +func (o *EventV2) HasProfileId() bool { + if o != nil && o.ProfileId != nil { + return true + } + + return false +} + +// SetProfileId gets a reference to the given string and assigns it to the ProfileId field. +func (o *EventV2) SetProfileId(v string) { + o.ProfileId = &v +} + +// GetType returns the Type field value +func (o *EventV2) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *EventV2) SetType(v string) { + o.Type = v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *EventV2) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EventV2) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *EventV2) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *EventV2) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +type NullableEventV2 struct { + Value EventV2 + ExplicitNull bool +} + +func (v NullableEventV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableEventV2) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_export.go b/model_export.go index d203bb09..1164904f 100644 --- a/model_export.go +++ b/model_export.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Export type Export struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -27,7 +27,7 @@ type Export struct { UserId int32 `json:"userId"` // The name of the entity that was exported. Entity string `json:"entity"` - // Map of keys and values that were used to filter the exported rows + // Map of keys and values that were used to filter the exported rows. Filter map[string]interface{} `json:"filter"` } diff --git a/model_feature_flag.go b/model_feature_flag.go index b97c9b2f..d37d5143 100644 --- a/model_feature_flag.go +++ b/model_feature_flag.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,9 +17,9 @@ import ( // FeatureFlag struct for FeatureFlag type FeatureFlag struct { - // The name for the featureflag + // The name for the featureflag. Name string `json:"name"` - // The value for the featureflag + // The value for the featureflag. Value string `json:"value"` // The exact moment this entity was last created. Created *time.Time `json:"created,omitempty"` diff --git a/model_feature_flags.go b/model_feature_flags.go deleted file mode 100644 index c0435b0a..00000000 --- a/model_feature_flags.go +++ /dev/null @@ -1,164 +0,0 @@ -/* - * Talon.One API - * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put - * - * API version: 1.0.0 - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// FeatureFlags -type FeatureFlags struct { - // The ID of the account that owns this entity. - AccountId int32 `json:"accountId"` - // Whether the account has access to the loyalty features or not - Loyalty *bool `json:"loyalty,omitempty"` - // Whether the account queries coupons with or without total result size - CouponsWithoutCount *bool `json:"coupons_without_count,omitempty"` - // Whether the account can test beta effects or not - BetaEffects *bool `json:"betaEffects,omitempty"` -} - -// GetAccountId returns the AccountId field value -func (o *FeatureFlags) GetAccountId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.AccountId -} - -// SetAccountId sets field value -func (o *FeatureFlags) SetAccountId(v int32) { - o.AccountId = v -} - -// GetLoyalty returns the Loyalty field value if set, zero value otherwise. -func (o *FeatureFlags) GetLoyalty() bool { - if o == nil || o.Loyalty == nil { - var ret bool - return ret - } - return *o.Loyalty -} - -// GetLoyaltyOk returns a tuple with the Loyalty field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *FeatureFlags) GetLoyaltyOk() (bool, bool) { - if o == nil || o.Loyalty == nil { - var ret bool - return ret, false - } - return *o.Loyalty, true -} - -// HasLoyalty returns a boolean if a field has been set. -func (o *FeatureFlags) HasLoyalty() bool { - if o != nil && o.Loyalty != nil { - return true - } - - return false -} - -// SetLoyalty gets a reference to the given bool and assigns it to the Loyalty field. -func (o *FeatureFlags) SetLoyalty(v bool) { - o.Loyalty = &v -} - -// GetCouponsWithoutCount returns the CouponsWithoutCount field value if set, zero value otherwise. -func (o *FeatureFlags) GetCouponsWithoutCount() bool { - if o == nil || o.CouponsWithoutCount == nil { - var ret bool - return ret - } - return *o.CouponsWithoutCount -} - -// GetCouponsWithoutCountOk returns a tuple with the CouponsWithoutCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *FeatureFlags) GetCouponsWithoutCountOk() (bool, bool) { - if o == nil || o.CouponsWithoutCount == nil { - var ret bool - return ret, false - } - return *o.CouponsWithoutCount, true -} - -// HasCouponsWithoutCount returns a boolean if a field has been set. -func (o *FeatureFlags) HasCouponsWithoutCount() bool { - if o != nil && o.CouponsWithoutCount != nil { - return true - } - - return false -} - -// SetCouponsWithoutCount gets a reference to the given bool and assigns it to the CouponsWithoutCount field. -func (o *FeatureFlags) SetCouponsWithoutCount(v bool) { - o.CouponsWithoutCount = &v -} - -// GetBetaEffects returns the BetaEffects field value if set, zero value otherwise. -func (o *FeatureFlags) GetBetaEffects() bool { - if o == nil || o.BetaEffects == nil { - var ret bool - return ret - } - return *o.BetaEffects -} - -// GetBetaEffectsOk returns a tuple with the BetaEffects field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *FeatureFlags) GetBetaEffectsOk() (bool, bool) { - if o == nil || o.BetaEffects == nil { - var ret bool - return ret, false - } - return *o.BetaEffects, true -} - -// HasBetaEffects returns a boolean if a field has been set. -func (o *FeatureFlags) HasBetaEffects() bool { - if o != nil && o.BetaEffects != nil { - return true - } - - return false -} - -// SetBetaEffects gets a reference to the given bool and assigns it to the BetaEffects field. -func (o *FeatureFlags) SetBetaEffects(v bool) { - o.BetaEffects = &v -} - -type NullableFeatureFlags struct { - Value FeatureFlags - ExplicitNull bool -} - -func (v NullableFeatureFlags) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableFeatureFlags) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_features_feed.go b/model_features_feed.go index f4b71927..674ba2f2 100644 --- a/model_features_feed.go +++ b/model_features_feed.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_feed_notification.go b/model_feed_notification.go index a3aa3051..53017e5d 100644 --- a/model_feed_notification.go +++ b/model_feed_notification.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,19 +15,19 @@ import ( "time" ) -// FeedNotification A feed notification for CAMA users +// FeedNotification A feed notification for CAMA users. type FeedNotification struct { - // Title of the feed notification + // Title of the feed notification. Title string `json:"title"` - // Timestamp of the moment this feed notification was created + // Timestamp of the moment this feed notification was created. Created time.Time `json:"created"` - // Timestamp of the moment this feed notification was last updated + // Timestamp of the moment this feed notification was last updated. Updated time.Time `json:"updated"` - // URL to the feed notification in the help center + // URL to the feed notification in the help center. ArticleUrl string `json:"articleUrl"` - // The type of the feed notification + // The type of the feed notification. Type string `json:"type"` - // Body of the feed notification + // Body of the feed notification. Body string `json:"body"` } diff --git a/model_func_arg_def.go b/model_func_arg_def.go index 79b0341a..2b494b8a 100644 --- a/model_func_arg_def.go +++ b/model_func_arg_def.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_function_def.go b/model_function_def.go index d189061c..0b697e2c 100644 --- a/model_function_def.go +++ b/model_function_def.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_giveaway.go b/model_giveaway.go index 025cf5b0..35d033a7 100644 --- a/model_giveaway.go +++ b/model_giveaway.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Giveaway type Giveaway struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_giveaways_pool.go b/model_giveaways_pool.go index 4a178e56..31a7d4e6 100644 --- a/model_giveaways_pool.go +++ b/model_giveaways_pool.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,9 +15,9 @@ import ( "time" ) -// GiveawaysPool +// GiveawaysPool Giveaways pools is an entity for managing multiple similar giveaways. type GiveawaysPool struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -27,7 +27,7 @@ type GiveawaysPool struct { Name string `json:"name"` // The description of this giveaways pool. Description *string `json:"description,omitempty"` - // A list of the IDs of the applications that this giveaways pool is enabled for + // A list of the IDs of the applications that this giveaways pool is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` // Timestamp of the most recent update to the giveaways pool. Modified *time.Time `json:"modified,omitempty"` diff --git a/model_import.go b/model_import.go index 413de71c..8b8be80e 100644 --- a/model_import.go +++ b/model_import.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Import type Import struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -25,9 +25,9 @@ type Import struct { AccountId int32 `json:"accountId"` // The ID of the account that owns this entity. UserId int32 `json:"userId"` - // The name of the entity that was imported. Possible values are Coupons and LoyaltyPoints. + // The name of the entity that was imported. Entity string `json:"entity"` - // The number of members that imported. + // The number of values that were imported. Amount int32 `json:"amount"` } diff --git a/model_import_entity.go b/model_import_entity.go index 2b785697..b3e6db24 100644 --- a/model_import_entity.go +++ b/model_import_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_inline_response_200.go b/model_inline_response_200.go index 9c43905e..d909e5b0 100644 --- a/model_inline_response_200.go +++ b/model_inline_response_200.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_inline_response_200_1.go b/model_inline_response_200_1.go index 451779d4..55a612ce 100644 --- a/model_inline_response_200_1.go +++ b/model_inline_response_200_1.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_inline_response_200_10.go b/model_inline_response_200_10.go index 2bcd21d5..00658f33 100644 --- a/model_inline_response_200_10.go +++ b/model_inline_response_200_10.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse20010 struct for InlineResponse20010 type InlineResponse20010 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []CampaignAnalytics `json:"data"` + HasMore bool `json:"hasMore"` + Data []CollectionItem `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20010) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20010) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse20010) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20010) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20010) GetData() []CampaignAnalytics { +func (o *InlineResponse20010) GetData() []CollectionItem { if o == nil { - var ret []CampaignAnalytics + var ret []CollectionItem return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20010) GetData() []CampaignAnalytics { } // SetData sets field value -func (o *InlineResponse20010) SetData(v []CampaignAnalytics) { +func (o *InlineResponse20010) SetData(v []CollectionItem) { o.Data = v } diff --git a/model_inline_response_200_11.go b/model_inline_response_200_11.go index a440dd91..11c9fc5d 100644 --- a/model_inline_response_200_11.go +++ b/model_inline_response_200_11.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,81 +16,81 @@ import ( // InlineResponse20011 struct for InlineResponse20011 type InlineResponse20011 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - HasMore *bool `json:"hasMore,omitempty"` - Data []ApplicationCustomer `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []Collection `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. -func (o *InlineResponse20011) GetTotalResultSize() int32 { - if o == nil || o.TotalResultSize == nil { - var ret int32 +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20011) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool return ret } - return *o.TotalResultSize + return *o.HasMore } -// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *InlineResponse20011) GetTotalResultSizeOk() (int32, bool) { - if o == nil || o.TotalResultSize == nil { - var ret int32 +func (o *InlineResponse20011) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool return ret, false } - return *o.TotalResultSize, true + return *o.HasMore, true } -// HasTotalResultSize returns a boolean if a field has been set. -func (o *InlineResponse20011) HasTotalResultSize() bool { - if o != nil && o.TotalResultSize != nil { +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20011) HasHasMore() bool { + if o != nil && o.HasMore != nil { return true } return false } -// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. -func (o *InlineResponse20011) SetTotalResultSize(v int32) { - o.TotalResultSize = &v +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20011) SetHasMore(v bool) { + o.HasMore = &v } -// GetHasMore returns the HasMore field value if set, zero value otherwise. -func (o *InlineResponse20011) GetHasMore() bool { - if o == nil || o.HasMore == nil { - var ret bool +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +func (o *InlineResponse20011) GetTotalResultSize() int32 { + if o == nil || o.TotalResultSize == nil { + var ret int32 return ret } - return *o.HasMore + return *o.TotalResultSize } -// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *InlineResponse20011) GetHasMoreOk() (bool, bool) { - if o == nil || o.HasMore == nil { - var ret bool +func (o *InlineResponse20011) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 return ret, false } - return *o.HasMore, true + return *o.TotalResultSize, true } -// HasHasMore returns a boolean if a field has been set. -func (o *InlineResponse20011) HasHasMore() bool { - if o != nil && o.HasMore != nil { +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse20011) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { return true } return false } -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -func (o *InlineResponse20011) SetHasMore(v bool) { - o.HasMore = &v +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +func (o *InlineResponse20011) SetTotalResultSize(v int32) { + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20011) GetData() []ApplicationCustomer { +func (o *InlineResponse20011) GetData() []Collection { if o == nil { - var ret []ApplicationCustomer + var ret []Collection return ret } @@ -98,7 +98,7 @@ func (o *InlineResponse20011) GetData() []ApplicationCustomer { } // SetData sets field value -func (o *InlineResponse20011) SetData(v []ApplicationCustomer) { +func (o *InlineResponse20011) SetData(v []Collection) { o.Data = v } diff --git a/model_inline_response_200_12.go b/model_inline_response_200_12.go index 11b364d9..a856fff9 100644 --- a/model_inline_response_200_12.go +++ b/model_inline_response_200_12.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20012 struct for InlineResponse20012 type InlineResponse20012 struct { - HasMore bool `json:"hasMore"` - Data []ApplicationCustomer `json:"data"` + HasMore bool `json:"hasMore"` + Data []AccessLogEntry `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,9 +36,9 @@ func (o *InlineResponse20012) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse20012) GetData() []ApplicationCustomer { +func (o *InlineResponse20012) GetData() []AccessLogEntry { if o == nil { - var ret []ApplicationCustomer + var ret []AccessLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20012) GetData() []ApplicationCustomer { } // SetData sets field value -func (o *InlineResponse20012) SetData(v []ApplicationCustomer) { +func (o *InlineResponse20012) SetData(v []AccessLogEntry) { o.Data = v } diff --git a/model_inline_response_200_13.go b/model_inline_response_200_13.go index 0e288d7b..8390877a 100644 --- a/model_inline_response_200_13.go +++ b/model_inline_response_200_13.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse20013 struct for InlineResponse20013 type InlineResponse20013 struct { - HasMore bool `json:"hasMore"` - Data []CustomerProfile `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []AccessLogEntry `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20013) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20013) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse20013) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20013) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20013) GetData() []CustomerProfile { +func (o *InlineResponse20013) GetData() []AccessLogEntry { if o == nil { - var ret []CustomerProfile + var ret []AccessLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20013) GetData() []CustomerProfile { } // SetData sets field value -func (o *InlineResponse20013) SetData(v []CustomerProfile) { +func (o *InlineResponse20013) SetData(v []AccessLogEntry) { o.Data = v } diff --git a/model_inline_response_200_14.go b/model_inline_response_200_14.go index 4dd7d55a..998002a6 100644 --- a/model_inline_response_200_14.go +++ b/model_inline_response_200_14.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse20014 struct for InlineResponse20014 type InlineResponse20014 struct { - HasMore bool `json:"hasMore"` - Data []CustomerActivityReport `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []CampaignAnalytics `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20014) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20014) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse20014) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20014) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20014) GetData() []CustomerActivityReport { +func (o *InlineResponse20014) GetData() []CampaignAnalytics { if o == nil { - var ret []CustomerActivityReport + var ret []CampaignAnalytics return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20014) GetData() []CustomerActivityReport { } // SetData sets field value -func (o *InlineResponse20014) SetData(v []CustomerActivityReport) { +func (o *InlineResponse20014) SetData(v []CampaignAnalytics) { o.Data = v } diff --git a/model_inline_response_200_15.go b/model_inline_response_200_15.go index 69110639..cb60e869 100644 --- a/model_inline_response_200_15.go +++ b/model_inline_response_200_15.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,42 @@ import ( // InlineResponse20015 struct for InlineResponse20015 type InlineResponse20015 struct { - HasMore *bool `json:"hasMore,omitempty"` - Data []ApplicationSession `json:"data"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + HasMore *bool `json:"hasMore,omitempty"` + Data []ApplicationCustomer `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +func (o *InlineResponse20015) GetTotalResultSize() int32 { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret + } + return *o.TotalResultSize +} + +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20015) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret, false + } + return *o.TotalResultSize, true +} + +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse20015) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } + + return false +} + +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +func (o *InlineResponse20015) SetTotalResultSize(v int32) { + o.TotalResultSize = &v } // GetHasMore returns the HasMore field value if set, zero value otherwise. @@ -54,9 +88,9 @@ func (o *InlineResponse20015) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse20015) GetData() []ApplicationSession { +func (o *InlineResponse20015) GetData() []ApplicationCustomer { if o == nil { - var ret []ApplicationSession + var ret []ApplicationCustomer return ret } @@ -64,7 +98,7 @@ func (o *InlineResponse20015) GetData() []ApplicationSession { } // SetData sets field value -func (o *InlineResponse20015) SetData(v []ApplicationSession) { +func (o *InlineResponse20015) SetData(v []ApplicationCustomer) { o.Data = v } diff --git a/model_inline_response_200_16.go b/model_inline_response_200_16.go index 4e6d86af..794f2d41 100644 --- a/model_inline_response_200_16.go +++ b/model_inline_response_200_16.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20016 struct for InlineResponse20016 type InlineResponse20016 struct { - HasMore bool `json:"hasMore"` - Data []ApplicationEvent `json:"data"` + HasMore bool `json:"hasMore"` + Data []ApplicationCustomer `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,9 +36,9 @@ func (o *InlineResponse20016) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse20016) GetData() []ApplicationEvent { +func (o *InlineResponse20016) GetData() []ApplicationCustomer { if o == nil { - var ret []ApplicationEvent + var ret []ApplicationCustomer return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20016) GetData() []ApplicationEvent { } // SetData sets field value -func (o *InlineResponse20016) SetData(v []ApplicationEvent) { +func (o *InlineResponse20016) SetData(v []ApplicationCustomer) { o.Data = v } diff --git a/model_inline_response_200_17.go b/model_inline_response_200_17.go index 787cff98..4694460b 100644 --- a/model_inline_response_200_17.go +++ b/model_inline_response_200_17.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse20017 struct for InlineResponse20017 type InlineResponse20017 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []string `json:"data"` + HasMore bool `json:"hasMore"` + Data []CustomerProfile `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20017) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20017) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse20017) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20017) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20017) GetData() []string { +func (o *InlineResponse20017) GetData() []CustomerProfile { if o == nil { - var ret []string + var ret []CustomerProfile return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20017) GetData() []string { } // SetData sets field value -func (o *InlineResponse20017) SetData(v []string) { +func (o *InlineResponse20017) SetData(v []CustomerProfile) { o.Data = v } diff --git a/model_inline_response_200_18.go b/model_inline_response_200_18.go index 3f0524d0..c8b27d30 100644 --- a/model_inline_response_200_18.go +++ b/model_inline_response_200_18.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,81 +16,29 @@ import ( // InlineResponse20018 struct for InlineResponse20018 type InlineResponse20018 struct { - HasMore *bool `json:"hasMore,omitempty"` - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - Data []Audience `json:"data"` + HasMore bool `json:"hasMore"` + Data []CustomerActivityReport `json:"data"` } -// GetHasMore returns the HasMore field value if set, zero value otherwise. +// GetHasMore returns the HasMore field value func (o *InlineResponse20018) GetHasMore() bool { - if o == nil || o.HasMore == nil { + if o == nil { var ret bool return ret } - return *o.HasMore -} -// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20018) GetHasMoreOk() (bool, bool) { - if o == nil || o.HasMore == nil { - var ret bool - return ret, false - } - return *o.HasMore, true + return o.HasMore } -// HasHasMore returns a boolean if a field has been set. -func (o *InlineResponse20018) HasHasMore() bool { - if o != nil && o.HasMore != nil { - return true - } - - return false -} - -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +// SetHasMore sets field value func (o *InlineResponse20018) SetHasMore(v bool) { - o.HasMore = &v -} - -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. -func (o *InlineResponse20018) GetTotalResultSize() int32 { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret - } - return *o.TotalResultSize -} - -// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20018) GetTotalResultSizeOk() (int32, bool) { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret, false - } - return *o.TotalResultSize, true -} - -// HasTotalResultSize returns a boolean if a field has been set. -func (o *InlineResponse20018) HasTotalResultSize() bool { - if o != nil && o.TotalResultSize != nil { - return true - } - - return false -} - -// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. -func (o *InlineResponse20018) SetTotalResultSize(v int32) { - o.TotalResultSize = &v + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20018) GetData() []Audience { +func (o *InlineResponse20018) GetData() []CustomerActivityReport { if o == nil { - var ret []Audience + var ret []CustomerActivityReport return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20018) GetData() []Audience { } // SetData sets field value -func (o *InlineResponse20018) SetData(v []Audience) { +func (o *InlineResponse20018) SetData(v []CustomerActivityReport) { o.Data = v } diff --git a/model_inline_response_200_19.go b/model_inline_response_200_19.go index 2dc2f7c2..1b803ade 100644 --- a/model_inline_response_200_19.go +++ b/model_inline_response_200_19.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,45 +16,47 @@ import ( // InlineResponse20019 struct for InlineResponse20019 type InlineResponse20019 struct { - HasMore bool `json:"hasMore"` - TotalResultSize int32 `json:"totalResultSize"` - Data []ApplicationReferee `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + Data []ApplicationSession `json:"data"` } -// GetHasMore returns the HasMore field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. func (o *InlineResponse20019) GetHasMore() bool { - if o == nil { + if o == nil || o.HasMore == nil { var ret bool return ret } - - return o.HasMore + return *o.HasMore } -// SetHasMore sets field value -func (o *InlineResponse20019) SetHasMore(v bool) { - o.HasMore = v +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20019) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20019) GetTotalResultSize() int32 { - if o == nil { - var ret int32 - return ret +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20019) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true } - return o.TotalResultSize + return false } -// SetTotalResultSize sets field value -func (o *InlineResponse20019) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20019) SetHasMore(v bool) { + o.HasMore = &v } // GetData returns the Data field value -func (o *InlineResponse20019) GetData() []ApplicationReferee { +func (o *InlineResponse20019) GetData() []ApplicationSession { if o == nil { - var ret []ApplicationReferee + var ret []ApplicationSession return ret } @@ -62,7 +64,7 @@ func (o *InlineResponse20019) GetData() []ApplicationReferee { } // SetData sets field value -func (o *InlineResponse20019) SetData(v []ApplicationReferee) { +func (o *InlineResponse20019) SetData(v []ApplicationSession) { o.Data = v } diff --git a/model_inline_response_200_2.go b/model_inline_response_200_2.go index 3564410c..1cdb6e52 100644 --- a/model_inline_response_200_2.go +++ b/model_inline_response_200_2.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_inline_response_200_20.go b/model_inline_response_200_20.go index c89de4d6..bbd09dfc 100644 --- a/model_inline_response_200_20.go +++ b/model_inline_response_200_20.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse20020 struct for InlineResponse20020 type InlineResponse20020 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Attribute `json:"data"` + HasMore bool `json:"hasMore"` + Data []ApplicationEvent `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20020) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20020) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse20020) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20020) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20020) GetData() []Attribute { +func (o *InlineResponse20020) GetData() []ApplicationEvent { if o == nil { - var ret []Attribute + var ret []ApplicationEvent return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20020) GetData() []Attribute { } // SetData sets field value -func (o *InlineResponse20020) SetData(v []Attribute) { +func (o *InlineResponse20020) SetData(v []ApplicationEvent) { o.Data = v } diff --git a/model_inline_response_200_21.go b/model_inline_response_200_21.go index f3435f5d..274971a4 100644 --- a/model_inline_response_200_21.go +++ b/model_inline_response_200_21.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20021 struct for InlineResponse20021 type InlineResponse20021 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []AccountAdditionalCost `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []string `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20021) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20021) GetData() []AccountAdditionalCost { +func (o *InlineResponse20021) GetData() []string { if o == nil { - var ret []AccountAdditionalCost + var ret []string return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20021) GetData() []AccountAdditionalCost { } // SetData sets field value -func (o *InlineResponse20021) SetData(v []AccountAdditionalCost) { +func (o *InlineResponse20021) SetData(v []string) { o.Data = v } diff --git a/model_inline_response_200_22.go b/model_inline_response_200_22.go index ba594dc3..d8197bcb 100644 --- a/model_inline_response_200_22.go +++ b/model_inline_response_200_22.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,81 @@ import ( // InlineResponse20022 struct for InlineResponse20022 type InlineResponse20022 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Webhook `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []Audience `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20022) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + return ret + } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20022) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20022) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } + + return false +} + +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20022) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20022) GetTotalResultSize() int32 { - if o == nil { + if o == nil || o.TotalResultSize == nil { var ret int32 return ret } + return *o.TotalResultSize +} + +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20022) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret, false + } + return *o.TotalResultSize, true +} + +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse20022) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } - return o.TotalResultSize + return false } -// SetTotalResultSize sets field value +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. func (o *InlineResponse20022) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20022) GetData() []Webhook { +func (o *InlineResponse20022) GetData() []Audience { if o == nil { - var ret []Webhook + var ret []Audience return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20022) GetData() []Webhook { } // SetData sets field value -func (o *InlineResponse20022) SetData(v []Webhook) { +func (o *InlineResponse20022) SetData(v []Audience) { o.Data = v } diff --git a/model_inline_response_200_23.go b/model_inline_response_200_23.go index be0960bf..be5e51e0 100644 --- a/model_inline_response_200_23.go +++ b/model_inline_response_200_23.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,24 @@ import ( // InlineResponse20023 struct for InlineResponse20023 type InlineResponse20023 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []WebhookActivationLogEntry `json:"data"` + HasMore bool `json:"hasMore"` + TotalResultSize int32 `json:"totalResultSize"` + Data []ApplicationReferee `json:"data"` +} + +// GetHasMore returns the HasMore field value +func (o *InlineResponse20023) GetHasMore() bool { + if o == nil { + var ret bool + return ret + } + + return o.HasMore +} + +// SetHasMore sets field value +func (o *InlineResponse20023) SetHasMore(v bool) { + o.HasMore = v } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +52,9 @@ func (o *InlineResponse20023) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20023) GetData() []WebhookActivationLogEntry { +func (o *InlineResponse20023) GetData() []ApplicationReferee { if o == nil { - var ret []WebhookActivationLogEntry + var ret []ApplicationReferee return ret } @@ -46,7 +62,7 @@ func (o *InlineResponse20023) GetData() []WebhookActivationLogEntry { } // SetData sets field value -func (o *InlineResponse20023) SetData(v []WebhookActivationLogEntry) { +func (o *InlineResponse20023) SetData(v []ApplicationReferee) { o.Data = v } diff --git a/model_inline_response_200_24.go b/model_inline_response_200_24.go index 47251011..cfb1f868 100644 --- a/model_inline_response_200_24.go +++ b/model_inline_response_200_24.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20024 struct for InlineResponse20024 type InlineResponse20024 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []WebhookLogEntry `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Attribute `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20024) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20024) GetData() []WebhookLogEntry { +func (o *InlineResponse20024) GetData() []Attribute { if o == nil { - var ret []WebhookLogEntry + var ret []Attribute return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20024) GetData() []WebhookLogEntry { } // SetData sets field value -func (o *InlineResponse20024) SetData(v []WebhookLogEntry) { +func (o *InlineResponse20024) SetData(v []Attribute) { o.Data = v } diff --git a/model_inline_response_200_25.go b/model_inline_response_200_25.go index dc10f93c..2b726a57 100644 --- a/model_inline_response_200_25.go +++ b/model_inline_response_200_25.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20025 struct for InlineResponse20025 type InlineResponse20025 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []EventType `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []AccountAdditionalCost `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20025) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20025) GetData() []EventType { +func (o *InlineResponse20025) GetData() []AccountAdditionalCost { if o == nil { - var ret []EventType + var ret []AccountAdditionalCost return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20025) GetData() []EventType { } // SetData sets field value -func (o *InlineResponse20025) SetData(v []EventType) { +func (o *InlineResponse20025) SetData(v []AccountAdditionalCost) { o.Data = v } diff --git a/model_inline_response_200_26.go b/model_inline_response_200_26.go index 0c7e1ecf..cb61680b 100644 --- a/model_inline_response_200_26.go +++ b/model_inline_response_200_26.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20026 struct for InlineResponse20026 type InlineResponse20026 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []User `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Webhook `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20026) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20026) GetData() []User { +func (o *InlineResponse20026) GetData() []Webhook { if o == nil { - var ret []User + var ret []Webhook return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20026) GetData() []User { } // SetData sets field value -func (o *InlineResponse20026) SetData(v []User) { +func (o *InlineResponse20026) SetData(v []Webhook) { o.Data = v } diff --git a/model_inline_response_200_27.go b/model_inline_response_200_27.go index b4ca4eda..f863526c 100644 --- a/model_inline_response_200_27.go +++ b/model_inline_response_200_27.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,81 +16,29 @@ import ( // InlineResponse20027 struct for InlineResponse20027 type InlineResponse20027 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - HasMore *bool `json:"hasMore,omitempty"` - Data []Change `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []WebhookActivationLogEntry `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +// GetTotalResultSize returns the TotalResultSize field value func (o *InlineResponse20027) GetTotalResultSize() int32 { - if o == nil || o.TotalResultSize == nil { + if o == nil { var ret int32 return ret } - return *o.TotalResultSize -} -// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20027) GetTotalResultSizeOk() (int32, bool) { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret, false - } - return *o.TotalResultSize, true + return o.TotalResultSize } -// HasTotalResultSize returns a boolean if a field has been set. -func (o *InlineResponse20027) HasTotalResultSize() bool { - if o != nil && o.TotalResultSize != nil { - return true - } - - return false -} - -// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +// SetTotalResultSize sets field value func (o *InlineResponse20027) SetTotalResultSize(v int32) { - o.TotalResultSize = &v -} - -// GetHasMore returns the HasMore field value if set, zero value otherwise. -func (o *InlineResponse20027) GetHasMore() bool { - if o == nil || o.HasMore == nil { - var ret bool - return ret - } - return *o.HasMore -} - -// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20027) GetHasMoreOk() (bool, bool) { - if o == nil || o.HasMore == nil { - var ret bool - return ret, false - } - return *o.HasMore, true -} - -// HasHasMore returns a boolean if a field has been set. -func (o *InlineResponse20027) HasHasMore() bool { - if o != nil && o.HasMore != nil { - return true - } - - return false -} - -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -func (o *InlineResponse20027) SetHasMore(v bool) { - o.HasMore = &v + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20027) GetData() []Change { +func (o *InlineResponse20027) GetData() []WebhookActivationLogEntry { if o == nil { - var ret []Change + var ret []WebhookActivationLogEntry return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20027) GetData() []Change { } // SetData sets field value -func (o *InlineResponse20027) SetData(v []Change) { +func (o *InlineResponse20027) SetData(v []WebhookActivationLogEntry) { o.Data = v } diff --git a/model_inline_response_200_28.go b/model_inline_response_200_28.go index 369911c6..2a8a7af7 100644 --- a/model_inline_response_200_28.go +++ b/model_inline_response_200_28.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20028 struct for InlineResponse20028 type InlineResponse20028 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Export `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []WebhookLogEntry `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20028) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20028) GetData() []Export { +func (o *InlineResponse20028) GetData() []WebhookLogEntry { if o == nil { - var ret []Export + var ret []WebhookLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20028) GetData() []Export { } // SetData sets field value -func (o *InlineResponse20028) SetData(v []Export) { +func (o *InlineResponse20028) SetData(v []WebhookLogEntry) { o.Data = v } diff --git a/model_inline_response_200_29.go b/model_inline_response_200_29.go index d4bee651..da067efe 100644 --- a/model_inline_response_200_29.go +++ b/model_inline_response_200_29.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse20029 struct for InlineResponse20029 type InlineResponse20029 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Role `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []EventType `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20029) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20029) GetData() []Role { +func (o *InlineResponse20029) GetData() []EventType { if o == nil { - var ret []Role + var ret []EventType return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20029) GetData() []Role { } // SetData sets field value -func (o *InlineResponse20029) SetData(v []Role) { +func (o *InlineResponse20029) SetData(v []EventType) { o.Data = v } diff --git a/model_inline_response_200_3.go b/model_inline_response_200_3.go index 04adcc7d..09c72683 100644 --- a/model_inline_response_200_3.go +++ b/model_inline_response_200_3.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse2003 struct for InlineResponse2003 type InlineResponse2003 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Ruleset `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []NotificationWebhook `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse2003) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse2003) GetData() []Ruleset { +func (o *InlineResponse2003) GetData() []NotificationWebhook { if o == nil { - var ret []Ruleset + var ret []NotificationWebhook return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2003) GetData() []Ruleset { } // SetData sets field value -func (o *InlineResponse2003) SetData(v []Ruleset) { +func (o *InlineResponse2003) SetData(v []NotificationWebhook) { o.Data = v } diff --git a/model_inline_response_200_30.go b/model_inline_response_200_30.go new file mode 100644 index 00000000..1ae9790f --- /dev/null +++ b/model_inline_response_200_30.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20030 struct for InlineResponse20030 +type InlineResponse20030 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []User `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20030) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20030) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20030) GetData() []User { + if o == nil { + var ret []User + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20030) SetData(v []User) { + o.Data = v +} + +type NullableInlineResponse20030 struct { + Value InlineResponse20030 + ExplicitNull bool +} + +func (v NullableInlineResponse20030) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20030) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_inline_response_200_31.go b/model_inline_response_200_31.go new file mode 100644 index 00000000..abf4237f --- /dev/null +++ b/model_inline_response_200_31.go @@ -0,0 +1,126 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20031 struct for InlineResponse20031 +type InlineResponse20031 struct { + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + HasMore *bool `json:"hasMore,omitempty"` + Data []Change `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +func (o *InlineResponse20031) GetTotalResultSize() int32 { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret + } + return *o.TotalResultSize +} + +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20031) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret, false + } + return *o.TotalResultSize, true +} + +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse20031) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } + + return false +} + +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +func (o *InlineResponse20031) SetTotalResultSize(v int32) { + o.TotalResultSize = &v +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20031) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + return ret + } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20031) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20031) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } + + return false +} + +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20031) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetData returns the Data field value +func (o *InlineResponse20031) GetData() []Change { + if o == nil { + var ret []Change + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20031) SetData(v []Change) { + o.Data = v +} + +type NullableInlineResponse20031 struct { + Value InlineResponse20031 + ExplicitNull bool +} + +func (v NullableInlineResponse20031) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20031) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_inline_response_200_32.go b/model_inline_response_200_32.go new file mode 100644 index 00000000..96a44a42 --- /dev/null +++ b/model_inline_response_200_32.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20032 struct for InlineResponse20032 +type InlineResponse20032 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []Export `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20032) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20032) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20032) GetData() []Export { + if o == nil { + var ret []Export + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20032) SetData(v []Export) { + o.Data = v +} + +type NullableInlineResponse20032 struct { + Value InlineResponse20032 + ExplicitNull bool +} + +func (v NullableInlineResponse20032) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20032) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_inline_response_200_33.go b/model_inline_response_200_33.go new file mode 100644 index 00000000..70dbfbcf --- /dev/null +++ b/model_inline_response_200_33.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20033 struct for InlineResponse20033 +type InlineResponse20033 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []Role `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20033) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20033) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20033) GetData() []Role { + if o == nil { + var ret []Role + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20033) SetData(v []Role) { + o.Data = v +} + +type NullableInlineResponse20033 struct { + Value InlineResponse20033 + ExplicitNull bool +} + +func (v NullableInlineResponse20033) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20033) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_inline_response_200_4.go b/model_inline_response_200_4.go index c8bba2b1..9bb88055 100644 --- a/model_inline_response_200_4.go +++ b/model_inline_response_200_4.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse2004 struct for InlineResponse2004 type InlineResponse2004 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Coupon `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Ruleset `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse2004) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse2004) GetData() []Coupon { +func (o *InlineResponse2004) GetData() []Ruleset { if o == nil { - var ret []Coupon + var ret []Ruleset return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2004) GetData() []Coupon { } // SetData sets field value -func (o *InlineResponse2004) SetData(v []Coupon) { +func (o *InlineResponse2004) SetData(v []Ruleset) { o.Data = v } diff --git a/model_inline_response_200_5.go b/model_inline_response_200_5.go index 7bf32e89..61480ede 100644 --- a/model_inline_response_200_5.go +++ b/model_inline_response_200_5.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,23 +16,23 @@ import ( // InlineResponse2005 struct for InlineResponse2005 type InlineResponse2005 struct { - HasMore bool `json:"hasMore"` - Data []Coupon `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Coupon `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse2005) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse2005) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse2005) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse2005) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value diff --git a/model_inline_response_200_6.go b/model_inline_response_200_6.go index 9d9afa70..42ddbd44 100644 --- a/model_inline_response_200_6.go +++ b/model_inline_response_200_6.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,8 +16,8 @@ import ( // InlineResponse2006 struct for InlineResponse2006 type InlineResponse2006 struct { - HasMore bool `json:"hasMore"` - Data []Referral `json:"data"` + HasMore bool `json:"hasMore"` + Data []Coupon `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,9 +36,9 @@ func (o *InlineResponse2006) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse2006) GetData() []Referral { +func (o *InlineResponse2006) GetData() []Coupon { if o == nil { - var ret []Referral + var ret []Coupon return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2006) GetData() []Referral { } // SetData sets field value -func (o *InlineResponse2006) SetData(v []Referral) { +func (o *InlineResponse2006) SetData(v []Coupon) { o.Data = v } diff --git a/model_inline_response_200_7.go b/model_inline_response_200_7.go index baf46b8b..ad515fed 100644 --- a/model_inline_response_200_7.go +++ b/model_inline_response_200_7.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse2007 struct for InlineResponse2007 type InlineResponse2007 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []LoyaltyProgram `json:"data"` + HasMore bool `json:"hasMore"` + Data []Referral `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse2007) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse2007) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse2007) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse2007) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse2007) GetData() []LoyaltyProgram { +func (o *InlineResponse2007) GetData() []Referral { if o == nil { - var ret []LoyaltyProgram + var ret []Referral return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2007) GetData() []LoyaltyProgram { } // SetData sets field value -func (o *InlineResponse2007) SetData(v []LoyaltyProgram) { +func (o *InlineResponse2007) SetData(v []Referral) { o.Data = v } diff --git a/model_inline_response_200_8.go b/model_inline_response_200_8.go index 35d1723d..26d8985c 100644 --- a/model_inline_response_200_8.go +++ b/model_inline_response_200_8.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // InlineResponse2008 struct for InlineResponse2008 type InlineResponse2008 struct { - HasMore bool `json:"hasMore"` - Data []AccessLogEntry `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []LoyaltyProgram `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse2008) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse2008) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse2008) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse2008) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse2008) GetData() []AccessLogEntry { +func (o *InlineResponse2008) GetData() []LoyaltyProgram { if o == nil { - var ret []AccessLogEntry + var ret []LoyaltyProgram return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2008) GetData() []AccessLogEntry { } // SetData sets field value -func (o *InlineResponse2008) SetData(v []AccessLogEntry) { +func (o *InlineResponse2008) SetData(v []LoyaltyProgram) { o.Data = v } diff --git a/model_inline_response_200_9.go b/model_inline_response_200_9.go index 2c79c2bf..e3ec8663 100644 --- a/model_inline_response_200_9.go +++ b/model_inline_response_200_9.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,81 @@ import ( // InlineResponse2009 struct for InlineResponse2009 type InlineResponse2009 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []AccessLogEntry `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []CollectionWithoutPayload `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse2009) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + return ret + } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse2009) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse2009) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } + + return false +} + +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse2009) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse2009) GetTotalResultSize() int32 { - if o == nil { + if o == nil || o.TotalResultSize == nil { var ret int32 return ret } + return *o.TotalResultSize +} + +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse2009) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret, false + } + return *o.TotalResultSize, true +} + +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse2009) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } - return o.TotalResultSize + return false } -// SetTotalResultSize sets field value +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. func (o *InlineResponse2009) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse2009) GetData() []AccessLogEntry { +func (o *InlineResponse2009) GetData() []CollectionWithoutPayload { if o == nil { - var ret []AccessLogEntry + var ret []CollectionWithoutPayload return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse2009) GetData() []AccessLogEntry { } // SetData sets field value -func (o *InlineResponse2009) SetData(v []AccessLogEntry) { +func (o *InlineResponse2009) SetData(v []CollectionWithoutPayload) { o.Data = v } diff --git a/model_inline_response_201.go b/model_inline_response_201.go index 57ee26bc..30b87ce7 100644 --- a/model_inline_response_201.go +++ b/model_inline_response_201.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_integration_customer_session_response.go b/model_integration_customer_session_response.go new file mode 100644 index 00000000..dba352af --- /dev/null +++ b/model_integration_customer_session_response.go @@ -0,0 +1,110 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// IntegrationCustomerSessionResponse struct for IntegrationCustomerSessionResponse +type IntegrationCustomerSessionResponse struct { + CustomerSession *CustomerSessionV2 `json:"customerSession,omitempty"` + Effects *[]Effect `json:"effects,omitempty"` +} + +// GetCustomerSession returns the CustomerSession field value if set, zero value otherwise. +func (o *IntegrationCustomerSessionResponse) GetCustomerSession() CustomerSessionV2 { + if o == nil || o.CustomerSession == nil { + var ret CustomerSessionV2 + return ret + } + return *o.CustomerSession +} + +// GetCustomerSessionOk returns a tuple with the CustomerSession field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCustomerSessionResponse) GetCustomerSessionOk() (CustomerSessionV2, bool) { + if o == nil || o.CustomerSession == nil { + var ret CustomerSessionV2 + return ret, false + } + return *o.CustomerSession, true +} + +// HasCustomerSession returns a boolean if a field has been set. +func (o *IntegrationCustomerSessionResponse) HasCustomerSession() bool { + if o != nil && o.CustomerSession != nil { + return true + } + + return false +} + +// SetCustomerSession gets a reference to the given CustomerSessionV2 and assigns it to the CustomerSession field. +func (o *IntegrationCustomerSessionResponse) SetCustomerSession(v CustomerSessionV2) { + o.CustomerSession = &v +} + +// GetEffects returns the Effects field value if set, zero value otherwise. +func (o *IntegrationCustomerSessionResponse) GetEffects() []Effect { + if o == nil || o.Effects == nil { + var ret []Effect + return ret + } + return *o.Effects +} + +// GetEffectsOk returns a tuple with the Effects field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCustomerSessionResponse) GetEffectsOk() ([]Effect, bool) { + if o == nil || o.Effects == nil { + var ret []Effect + return ret, false + } + return *o.Effects, true +} + +// HasEffects returns a boolean if a field has been set. +func (o *IntegrationCustomerSessionResponse) HasEffects() bool { + if o != nil && o.Effects != nil { + return true + } + + return false +} + +// SetEffects gets a reference to the given []Effect and assigns it to the Effects field. +func (o *IntegrationCustomerSessionResponse) SetEffects(v []Effect) { + o.Effects = &v +} + +type NullableIntegrationCustomerSessionResponse struct { + Value IntegrationCustomerSessionResponse + ExplicitNull bool +} + +func (v NullableIntegrationCustomerSessionResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableIntegrationCustomerSessionResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_integration_entity.go b/model_integration_entity.go index 746dc7d6..275fab16 100644 --- a/model_integration_entity.go +++ b/model_integration_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // IntegrationEntity struct for IntegrationEntity type IntegrationEntity struct { - // The integration ID for this entity sent to and used in the Talon.One system. + // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_integration_event.go b/model_integration_event.go index 05a680d8..ab161637 100644 --- a/model_integration_event.go +++ b/model_integration_event.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // IntegrationEvent type IntegrationEvent struct { - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId *string `json:"profileId,omitempty"` // A string representing the event. Must not be a reserved event name. Type string `json:"type"` diff --git a/model_integration_event_v2_request.go b/model_integration_event_v2_request.go new file mode 100644 index 00000000..8ce0c9aa --- /dev/null +++ b/model_integration_event_v2_request.go @@ -0,0 +1,164 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// IntegrationEventV2Request +type IntegrationEventV2Request struct { + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. + ProfileId *string `json:"profileId,omitempty"` + // A string representing the event. Must not be a reserved event name. + Type string `json:"type"` + // Arbitrary additional JSON data associated with the event. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Optional list of requested information to be present on the response related to the tracking custom event. + ResponseContent *[]string `json:"responseContent,omitempty"` +} + +// GetProfileId returns the ProfileId field value if set, zero value otherwise. +func (o *IntegrationEventV2Request) GetProfileId() string { + if o == nil || o.ProfileId == nil { + var ret string + return ret + } + return *o.ProfileId +} + +// GetProfileIdOk returns a tuple with the ProfileId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationEventV2Request) GetProfileIdOk() (string, bool) { + if o == nil || o.ProfileId == nil { + var ret string + return ret, false + } + return *o.ProfileId, true +} + +// HasProfileId returns a boolean if a field has been set. +func (o *IntegrationEventV2Request) HasProfileId() bool { + if o != nil && o.ProfileId != nil { + return true + } + + return false +} + +// SetProfileId gets a reference to the given string and assigns it to the ProfileId field. +func (o *IntegrationEventV2Request) SetProfileId(v string) { + o.ProfileId = &v +} + +// GetType returns the Type field value +func (o *IntegrationEventV2Request) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *IntegrationEventV2Request) SetType(v string) { + o.Type = v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *IntegrationEventV2Request) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationEventV2Request) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *IntegrationEventV2Request) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *IntegrationEventV2Request) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *IntegrationEventV2Request) GetResponseContent() []string { + if o == nil || o.ResponseContent == nil { + var ret []string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationEventV2Request) GetResponseContentOk() ([]string, bool) { + if o == nil || o.ResponseContent == nil { + var ret []string + return ret, false + } + return *o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *IntegrationEventV2Request) HasResponseContent() bool { + if o != nil && o.ResponseContent != nil { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given []string and assigns it to the ResponseContent field. +func (o *IntegrationEventV2Request) SetResponseContent(v []string) { + o.ResponseContent = &v +} + +type NullableIntegrationEventV2Request struct { + Value IntegrationEventV2Request + ExplicitNull bool +} + +func (v NullableIntegrationEventV2Request) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableIntegrationEventV2Request) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_integration_profile_entity.go b/model_integration_profile_entity.go index f3df6fa9..ec11d277 100644 --- a/model_integration_profile_entity.go +++ b/model_integration_profile_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // IntegrationProfileEntity struct for IntegrationProfileEntity type IntegrationProfileEntity struct { - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId *string `json:"profileId,omitempty"` } diff --git a/model_integration_request.go b/model_integration_request.go index 7f0bd772..598bc9e6 100644 --- a/model_integration_request.go +++ b/model_integration_request.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // IntegrationRequest The body of a V2 integration API request (customer session update). Next to the customer session details, this contains an optional listing of extra properties that should be returned in the response. type IntegrationRequest struct { CustomerSession NewCustomerSessionV2 `json:"customerSession"` - // Optional list of requested information to be present on the response related to the customer session update. **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. + // Optional list of extra data that you want to get in the response. Use this property to get as much data as you need in one request instead of sending extra requests to other endpoints. **Note:** `ruleFailureReasons` is always part of the response when the [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. ResponseContent *[]string `json:"responseContent,omitempty"` } diff --git a/model_integration_state.go b/model_integration_state.go index 6d0bb7c3..96a2c3b6 100644 --- a/model_integration_state.go +++ b/model_integration_state.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_integration_state_v2.go b/model_integration_state_v2.go index 65989e5f..1c295184 100644 --- a/model_integration_state_v2.go +++ b/model_integration_state_v2.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -20,7 +20,7 @@ type IntegrationStateV2 struct { CustomerProfile *CustomerProfile `json:"customerProfile,omitempty"` Event *Event `json:"event,omitempty"` Loyalty *Loyalty `json:"loyalty,omitempty"` - Referral *Referral `json:"referral,omitempty"` + Referral *InventoryReferral `json:"referral,omitempty"` Coupons *[]Coupon `json:"coupons,omitempty"` TriggeredCampaigns *[]Campaign `json:"triggeredCampaigns,omitempty"` Effects []Effect `json:"effects"` @@ -28,6 +28,8 @@ type IntegrationStateV2 struct { CreatedCoupons []Coupon `json:"createdCoupons"` CreatedReferrals []Referral `json:"createdReferrals"` AwardedGiveaways *[]Giveaway `json:"awardedGiveaways,omitempty"` + Return *Return `json:"return,omitempty"` + PreviousReturns *[]Return `json:"previousReturns,omitempty"` } // GetCustomerSession returns the CustomerSession field value if set, zero value otherwise. @@ -163,9 +165,9 @@ func (o *IntegrationStateV2) SetLoyalty(v Loyalty) { } // GetReferral returns the Referral field value if set, zero value otherwise. -func (o *IntegrationStateV2) GetReferral() Referral { +func (o *IntegrationStateV2) GetReferral() InventoryReferral { if o == nil || o.Referral == nil { - var ret Referral + var ret InventoryReferral return ret } return *o.Referral @@ -173,9 +175,9 @@ func (o *IntegrationStateV2) GetReferral() Referral { // GetReferralOk returns a tuple with the Referral field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *IntegrationStateV2) GetReferralOk() (Referral, bool) { +func (o *IntegrationStateV2) GetReferralOk() (InventoryReferral, bool) { if o == nil || o.Referral == nil { - var ret Referral + var ret InventoryReferral return ret, false } return *o.Referral, true @@ -190,8 +192,8 @@ func (o *IntegrationStateV2) HasReferral() bool { return false } -// SetReferral gets a reference to the given Referral and assigns it to the Referral field. -func (o *IntegrationStateV2) SetReferral(v Referral) { +// SetReferral gets a reference to the given InventoryReferral and assigns it to the Referral field. +func (o *IntegrationStateV2) SetReferral(v InventoryReferral) { o.Referral = &v } @@ -372,6 +374,72 @@ func (o *IntegrationStateV2) SetAwardedGiveaways(v []Giveaway) { o.AwardedGiveaways = &v } +// GetReturn returns the Return field value if set, zero value otherwise. +func (o *IntegrationStateV2) GetReturn() Return { + if o == nil || o.Return == nil { + var ret Return + return ret + } + return *o.Return +} + +// GetReturnOk returns a tuple with the Return field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationStateV2) GetReturnOk() (Return, bool) { + if o == nil || o.Return == nil { + var ret Return + return ret, false + } + return *o.Return, true +} + +// HasReturn returns a boolean if a field has been set. +func (o *IntegrationStateV2) HasReturn() bool { + if o != nil && o.Return != nil { + return true + } + + return false +} + +// SetReturn gets a reference to the given Return and assigns it to the Return field. +func (o *IntegrationStateV2) SetReturn(v Return) { + o.Return = &v +} + +// GetPreviousReturns returns the PreviousReturns field value if set, zero value otherwise. +func (o *IntegrationStateV2) GetPreviousReturns() []Return { + if o == nil || o.PreviousReturns == nil { + var ret []Return + return ret + } + return *o.PreviousReturns +} + +// GetPreviousReturnsOk returns a tuple with the PreviousReturns field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationStateV2) GetPreviousReturnsOk() ([]Return, bool) { + if o == nil || o.PreviousReturns == nil { + var ret []Return + return ret, false + } + return *o.PreviousReturns, true +} + +// HasPreviousReturns returns a boolean if a field has been set. +func (o *IntegrationStateV2) HasPreviousReturns() bool { + if o != nil && o.PreviousReturns != nil { + return true + } + + return false +} + +// SetPreviousReturns gets a reference to the given []Return and assigns it to the PreviousReturns field. +func (o *IntegrationStateV2) SetPreviousReturns(v []Return) { + o.PreviousReturns = &v +} + type NullableIntegrationStateV2 struct { Value IntegrationStateV2 ExplicitNull bool diff --git a/model_inventory_coupon.go b/model_inventory_coupon.go index f9f994e0..e8506255 100644 --- a/model_inventory_coupon.go +++ b/model_inventory_coupon.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,15 +17,15 @@ import ( // InventoryCoupon type InventoryCoupon struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` // The ID of the campaign that owns this entity. CampaignId int32 `json:"campaignId"` - // The actual coupon code. + // The coupon code. Value string `json:"value"` - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -33,13 +33,15 @@ type InventoryCoupon struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. + Limits *[]LimitConfig `json:"limits,omitempty"` // The number of times this coupon has been successfully used. UsageCounter int32 `json:"usageCounter"` // The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. DiscountCounter *float32 `json:"discountCounter,omitempty"` // The remaining discount this coupon can give. DiscountRemainder *float32 `json:"discountRemainder,omitempty"` - // Arbitrary properties associated with this item + // Custom attributes associated with this coupon. Attributes *map[string]interface{} `json:"attributes,omitempty"` // The integration ID of the referring customer (if any) for whom this coupon was created as an effect. ReferralId *int32 `json:"referralId,omitempty"` @@ -47,13 +49,13 @@ type InventoryCoupon struct { RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` // The ID of the Import which created this coupon. ImportId *int32 `json:"importId,omitempty"` - // This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. + // Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation endpoint](/integration-api/#operation/createCouponReservation). - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the [Create coupons endpoint](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients endpoint](/management-api/#operation/createCouponsForMultipleRecipients). Reservation *bool `json:"reservation,omitempty"` // The id of the batch the coupon belongs to. BatchId *string `json:"batchId,omitempty"` // The number of times the coupon was redeemed by the profile. ProfileRedemptionCount int32 `json:"profileRedemptionCount"` - // Can be either active, used, expired, pending or disabled. active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. pending: coupons that have a start date in the future. disabled: coupons of non-active campaigns. + // Can be: - `active`: The coupon can be used. It is a reserved coupon that is neither pending, used nor expired, and has a non-exhausted limit counter. - `used`: The coupon has been redeemed and cannot be used again. It is not pending and has reached its redemption limit or was redeemed by the profile before expiration. - `expired`: The coupon was never redeemed and it is now expired. It is non-pending, non-active and non-used by the profile. - `pending`: The coupon will be usable in the future. - `disabled`: The coupon is part of a non-active campaign. State string `json:"state"` } @@ -231,6 +233,39 @@ func (o *InventoryCoupon) SetExpiryDate(v time.Time) { o.ExpiryDate = &v } +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *InventoryCoupon) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *InventoryCoupon) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *InventoryCoupon) SetLimits(v []LimitConfig) { + o.Limits = &v +} + // GetUsageCounter returns the UsageCounter field value func (o *InventoryCoupon) GetUsageCounter() int32 { if o == nil { diff --git a/model_inventory_referral.go b/model_inventory_referral.go new file mode 100644 index 00000000..36afa9bd --- /dev/null +++ b/model_inventory_referral.go @@ -0,0 +1,389 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// InventoryReferral +type InventoryReferral struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // Timestamp at which point the referral code becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. + UsageLimit int32 `json:"usageLimit"` + // ID of the campaign from which the referral received the referral code. + CampaignId int32 `json:"campaignId"` + // The Integration ID of the Advocate's Profile. + AdvocateProfileIntegrationId string `json:"advocateProfileIntegrationId"` + // An optional Integration ID of the Friend's Profile. + FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` + // Arbitrary properties associated with this item. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // The ID of the Import which created this referral. + ImportId *int32 `json:"importId,omitempty"` + // The referral code. + Code string `json:"code"` + // The number of times this referral code has been successfully used. + UsageCounter int32 `json:"usageCounter"` + // The ID of the batch the referrals belong to. + BatchId *string `json:"batchId,omitempty"` + // An array of referred customers. + ReferredCustomers []string `json:"referredCustomers"` +} + +// GetId returns the Id field value +func (o *InventoryReferral) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *InventoryReferral) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *InventoryReferral) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *InventoryReferral) SetCreated(v time.Time) { + o.Created = v +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *InventoryReferral) GetStartDate() time.Time { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret + } + return *o.StartDate +} + +// GetStartDateOk returns a tuple with the StartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryReferral) GetStartDateOk() (time.Time, bool) { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret, false + } + return *o.StartDate, true +} + +// HasStartDate returns a boolean if a field has been set. +func (o *InventoryReferral) HasStartDate() bool { + if o != nil && o.StartDate != nil { + return true + } + + return false +} + +// SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. +func (o *InventoryReferral) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *InventoryReferral) GetExpiryDate() time.Time { + if o == nil || o.ExpiryDate == nil { + var ret time.Time + return ret + } + return *o.ExpiryDate +} + +// GetExpiryDateOk returns a tuple with the ExpiryDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryReferral) GetExpiryDateOk() (time.Time, bool) { + if o == nil || o.ExpiryDate == nil { + var ret time.Time + return ret, false + } + return *o.ExpiryDate, true +} + +// HasExpiryDate returns a boolean if a field has been set. +func (o *InventoryReferral) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *InventoryReferral) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageLimit returns the UsageLimit field value +func (o *InventoryReferral) GetUsageLimit() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageLimit +} + +// SetUsageLimit sets field value +func (o *InventoryReferral) SetUsageLimit(v int32) { + o.UsageLimit = v +} + +// GetCampaignId returns the CampaignId field value +func (o *InventoryReferral) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *InventoryReferral) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetAdvocateProfileIntegrationId returns the AdvocateProfileIntegrationId field value +func (o *InventoryReferral) GetAdvocateProfileIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.AdvocateProfileIntegrationId +} + +// SetAdvocateProfileIntegrationId sets field value +func (o *InventoryReferral) SetAdvocateProfileIntegrationId(v string) { + o.AdvocateProfileIntegrationId = v +} + +// GetFriendProfileIntegrationId returns the FriendProfileIntegrationId field value if set, zero value otherwise. +func (o *InventoryReferral) GetFriendProfileIntegrationId() string { + if o == nil || o.FriendProfileIntegrationId == nil { + var ret string + return ret + } + return *o.FriendProfileIntegrationId +} + +// GetFriendProfileIntegrationIdOk returns a tuple with the FriendProfileIntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryReferral) GetFriendProfileIntegrationIdOk() (string, bool) { + if o == nil || o.FriendProfileIntegrationId == nil { + var ret string + return ret, false + } + return *o.FriendProfileIntegrationId, true +} + +// HasFriendProfileIntegrationId returns a boolean if a field has been set. +func (o *InventoryReferral) HasFriendProfileIntegrationId() bool { + if o != nil && o.FriendProfileIntegrationId != nil { + return true + } + + return false +} + +// SetFriendProfileIntegrationId gets a reference to the given string and assigns it to the FriendProfileIntegrationId field. +func (o *InventoryReferral) SetFriendProfileIntegrationId(v string) { + o.FriendProfileIntegrationId = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *InventoryReferral) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryReferral) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *InventoryReferral) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *InventoryReferral) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *InventoryReferral) GetImportId() int32 { + if o == nil || o.ImportId == nil { + var ret int32 + return ret + } + return *o.ImportId +} + +// GetImportIdOk returns a tuple with the ImportId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryReferral) GetImportIdOk() (int32, bool) { + if o == nil || o.ImportId == nil { + var ret int32 + return ret, false + } + return *o.ImportId, true +} + +// HasImportId returns a boolean if a field has been set. +func (o *InventoryReferral) HasImportId() bool { + if o != nil && o.ImportId != nil { + return true + } + + return false +} + +// SetImportId gets a reference to the given int32 and assigns it to the ImportId field. +func (o *InventoryReferral) SetImportId(v int32) { + o.ImportId = &v +} + +// GetCode returns the Code field value +func (o *InventoryReferral) GetCode() string { + if o == nil { + var ret string + return ret + } + + return o.Code +} + +// SetCode sets field value +func (o *InventoryReferral) SetCode(v string) { + o.Code = v +} + +// GetUsageCounter returns the UsageCounter field value +func (o *InventoryReferral) GetUsageCounter() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageCounter +} + +// SetUsageCounter sets field value +func (o *InventoryReferral) SetUsageCounter(v int32) { + o.UsageCounter = v +} + +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *InventoryReferral) GetBatchId() string { + if o == nil || o.BatchId == nil { + var ret string + return ret + } + return *o.BatchId +} + +// GetBatchIdOk returns a tuple with the BatchId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryReferral) GetBatchIdOk() (string, bool) { + if o == nil || o.BatchId == nil { + var ret string + return ret, false + } + return *o.BatchId, true +} + +// HasBatchId returns a boolean if a field has been set. +func (o *InventoryReferral) HasBatchId() bool { + if o != nil && o.BatchId != nil { + return true + } + + return false +} + +// SetBatchId gets a reference to the given string and assigns it to the BatchId field. +func (o *InventoryReferral) SetBatchId(v string) { + o.BatchId = &v +} + +// GetReferredCustomers returns the ReferredCustomers field value +func (o *InventoryReferral) GetReferredCustomers() []string { + if o == nil { + var ret []string + return ret + } + + return o.ReferredCustomers +} + +// SetReferredCustomers sets field value +func (o *InventoryReferral) SetReferredCustomers(v []string) { + o.ReferredCustomers = v +} + +type NullableInventoryReferral struct { + Value InventoryReferral + ExplicitNull bool +} + +func (v NullableInventoryReferral) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInventoryReferral) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_item_attribute.go b/model_item_attribute.go new file mode 100644 index 00000000..95b1210d --- /dev/null +++ b/model_item_attribute.go @@ -0,0 +1,93 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ItemAttribute +type ItemAttribute struct { + // The ID of the attribute of the item. + Attributeid int32 `json:"attributeid"` + // The name of the attribute. + Name string `json:"name"` + // The value of the attribute. + Value map[string]interface{} `json:"value"` +} + +// GetAttributeid returns the Attributeid field value +func (o *ItemAttribute) GetAttributeid() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Attributeid +} + +// SetAttributeid sets field value +func (o *ItemAttribute) SetAttributeid(v int32) { + o.Attributeid = v +} + +// GetName returns the Name field value +func (o *ItemAttribute) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *ItemAttribute) SetName(v string) { + o.Name = v +} + +// GetValue returns the Value field value +func (o *ItemAttribute) GetValue() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *ItemAttribute) SetValue(v map[string]interface{}) { + o.Value = v +} + +type NullableItemAttribute struct { + Value ItemAttribute + ExplicitNull bool +} + +func (v NullableItemAttribute) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableItemAttribute) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_ledger_entry.go b/model_ledger_entry.go index 9488e45f..0ab8f159 100644 --- a/model_ledger_entry.go +++ b/model_ledger_entry.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,25 +17,25 @@ import ( // LedgerEntry type LedgerEntry struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId string `json:"profileId"` // The ID of the Talon.One account that owns this profile. AccountId int32 `json:"accountId"` - // ID of the ledger + // ID of the ledger. LoyaltyProgramId int32 `json:"loyaltyProgramId"` - // ID of the related event + // ID of the related event. EventId int32 `json:"eventId"` - // Amount of loyalty points + // Amount of loyalty points. Amount int32 `json:"amount"` - // reason for awarding/deducting points + // reason for awarding/deducting points. Reason string `json:"reason"` - // Expiry date of the points + // Expiry date of the points. ExpiryDate time.Time `json:"expiryDate"` - // The ID of the balancing ledgerEntry + // The ID of the balancing ledgerEntry. ReferenceId *int32 `json:"referenceId,omitempty"` } diff --git a/model_ledger_info.go b/model_ledger_info.go index feac74c2..04794fde 100644 --- a/model_ledger_info.go +++ b/model_ledger_info.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,19 +16,20 @@ import ( // LedgerInfo type LedgerInfo struct { - // Sum of current active points amounts + // Sum of currently active points. CurrentBalance float32 `json:"currentBalance"` - // Sum of pending points amounts + // Sum of pending points. PendingBalance float32 `json:"pendingBalance"` - // Sum of expired points amounts + // Sum of expired points. ExpiredBalance float32 `json:"expiredBalance"` - // Sum of spent points amounts + // Sum of spent points. SpentBalance float32 `json:"spentBalance"` - // Sum of current active points amounts, including additions and deductions on open sessions + // Sum of currently active points, including points added and deducted in open sessions. TentativeCurrentBalance float32 `json:"tentativeCurrentBalance"` CurrentTier *Tier `json:"currentTier,omitempty"` // Points required to move up a tier. - PointsToNextTier *float32 `json:"pointsToNextTier,omitempty"` + PointsToNextTier *float32 `json:"pointsToNextTier,omitempty"` + Projection *LoyaltyProjection `json:"projection,omitempty"` } // GetCurrentBalance returns the CurrentBalance field value @@ -172,6 +173,39 @@ func (o *LedgerInfo) SetPointsToNextTier(v float32) { o.PointsToNextTier = &v } +// GetProjection returns the Projection field value if set, zero value otherwise. +func (o *LedgerInfo) GetProjection() LoyaltyProjection { + if o == nil || o.Projection == nil { + var ret LoyaltyProjection + return ret + } + return *o.Projection +} + +// GetProjectionOk returns a tuple with the Projection field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LedgerInfo) GetProjectionOk() (LoyaltyProjection, bool) { + if o == nil || o.Projection == nil { + var ret LoyaltyProjection + return ret, false + } + return *o.Projection, true +} + +// HasProjection returns a boolean if a field has been set. +func (o *LedgerInfo) HasProjection() bool { + if o != nil && o.Projection != nil { + return true + } + + return false +} + +// SetProjection gets a reference to the given LoyaltyProjection and assigns it to the Projection field. +func (o *LedgerInfo) SetProjection(v LoyaltyProjection) { + o.Projection = &v +} + type NullableLedgerInfo struct { Value LedgerInfo ExplicitNull bool diff --git a/model_ledger_transaction_log_entry_integration_api.go b/model_ledger_transaction_log_entry_integration_api.go new file mode 100644 index 00000000..e9434ae4 --- /dev/null +++ b/model_ledger_transaction_log_entry_integration_api.go @@ -0,0 +1,283 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// LedgerTransactionLogEntryIntegrationApi Log entry for a given loyalty card transaction. +type LedgerTransactionLogEntryIntegrationApi struct { + // Date and time the loyalty card transaction occurred. + Created time.Time `json:"created"` + // ID of the loyalty program. + ProgramId int32 `json:"programId"` + // ID of the customer session where the transaction occurred. + CustomerSessionId string `json:"customerSessionId"` + // Type of transaction. Possible values are: - `addition`: Points were added. - `subtraction`: Points were subtracted. + Type string `json:"type"` + // Name or reason of the loyalty ledger transaction. + Name string `json:"name"` + // Date when points become active. Possible values are: - `immediate`: Points are active immediately. - `timestamp value`: Points become active from the given date. + StartDate string `json:"startDate"` + // Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date. + ExpiryDate string `json:"expiryDate"` + // ID of the subledger. + SubledgerId string `json:"subledgerId"` + // Amount of loyalty points added or deducted in the transaction. + Amount float32 `json:"amount"` + // ID of the loyalty ledger transaction. + Id int32 `json:"id"` + // The ID of the ruleset containing the rule that triggered this effect. + RulesetId *int32 `json:"rulesetId,omitempty"` + // The name of the rule that triggered this effect. + RuleName *string `json:"ruleName,omitempty"` +} + +// GetCreated returns the Created field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetCreated(v time.Time) { + o.Created = v +} + +// GetProgramId returns the ProgramId field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetProgramId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramId +} + +// SetProgramId sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetProgramId(v int32) { + o.ProgramId = v +} + +// GetCustomerSessionId returns the CustomerSessionId field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetCustomerSessionId() string { + if o == nil { + var ret string + return ret + } + + return o.CustomerSessionId +} + +// SetCustomerSessionId sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetCustomerSessionId(v string) { + o.CustomerSessionId = v +} + +// GetType returns the Type field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetType(v string) { + o.Type = v +} + +// GetName returns the Name field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetName(v string) { + o.Name = v +} + +// GetStartDate returns the StartDate field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetStartDate() string { + if o == nil { + var ret string + return ret + } + + return o.StartDate +} + +// SetStartDate sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetStartDate(v string) { + o.StartDate = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetExpiryDate() string { + if o == nil { + var ret string + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetExpiryDate(v string) { + o.ExpiryDate = v +} + +// GetSubledgerId returns the SubledgerId field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetSubledgerId() string { + if o == nil { + var ret string + return ret + } + + return o.SubledgerId +} + +// SetSubledgerId sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetSubledgerId(v string) { + o.SubledgerId = v +} + +// GetAmount returns the Amount field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetAmount() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Amount +} + +// SetAmount sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetAmount(v float32) { + o.Amount = v +} + +// GetId returns the Id field value +func (o *LedgerTransactionLogEntryIntegrationApi) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *LedgerTransactionLogEntryIntegrationApi) SetId(v int32) { + o.Id = v +} + +// GetRulesetId returns the RulesetId field value if set, zero value otherwise. +func (o *LedgerTransactionLogEntryIntegrationApi) GetRulesetId() int32 { + if o == nil || o.RulesetId == nil { + var ret int32 + return ret + } + return *o.RulesetId +} + +// GetRulesetIdOk returns a tuple with the RulesetId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LedgerTransactionLogEntryIntegrationApi) GetRulesetIdOk() (int32, bool) { + if o == nil || o.RulesetId == nil { + var ret int32 + return ret, false + } + return *o.RulesetId, true +} + +// HasRulesetId returns a boolean if a field has been set. +func (o *LedgerTransactionLogEntryIntegrationApi) HasRulesetId() bool { + if o != nil && o.RulesetId != nil { + return true + } + + return false +} + +// SetRulesetId gets a reference to the given int32 and assigns it to the RulesetId field. +func (o *LedgerTransactionLogEntryIntegrationApi) SetRulesetId(v int32) { + o.RulesetId = &v +} + +// GetRuleName returns the RuleName field value if set, zero value otherwise. +func (o *LedgerTransactionLogEntryIntegrationApi) GetRuleName() string { + if o == nil || o.RuleName == nil { + var ret string + return ret + } + return *o.RuleName +} + +// GetRuleNameOk returns a tuple with the RuleName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LedgerTransactionLogEntryIntegrationApi) GetRuleNameOk() (string, bool) { + if o == nil || o.RuleName == nil { + var ret string + return ret, false + } + return *o.RuleName, true +} + +// HasRuleName returns a boolean if a field has been set. +func (o *LedgerTransactionLogEntryIntegrationApi) HasRuleName() bool { + if o != nil && o.RuleName != nil { + return true + } + + return false +} + +// SetRuleName gets a reference to the given string and assigns it to the RuleName field. +func (o *LedgerTransactionLogEntryIntegrationApi) SetRuleName(v string) { + o.RuleName = &v +} + +type NullableLedgerTransactionLogEntryIntegrationApi struct { + Value LedgerTransactionLogEntryIntegrationApi + ExplicitNull bool +} + +func (v NullableLedgerTransactionLogEntryIntegrationApi) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLedgerTransactionLogEntryIntegrationApi) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_library_attribute.go b/model_library_attribute.go index f2a1c173..5dac061b 100644 --- a/model_library_attribute.go +++ b/model_library_attribute.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_limit_config.go b/model_limit_config.go index e37ad04c..14970e02 100644 --- a/model_limit_config.go +++ b/model_limit_config.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,13 +16,13 @@ import ( // LimitConfig struct for LimitConfig type LimitConfig struct { - // The limitable action to which this limit will be applied + // The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` Action string `json:"action"` - // The value to set for the limit + // The value to set for the limit. Limit float32 `json:"limit"` - // The period on which the budget limit recurs + // The period on which the budget limit recurs. Period *string `json:"period,omitempty"` - // The entities that make the address of this limit + // The entity that this limit applies to. Entities []string `json:"entities"` } diff --git a/model_limit_counter.go b/model_limit_counter.go index 7679b6a1..fbffe7e6 100644 --- a/model_limit_counter.go +++ b/model_limit_counter.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_login_params.go b/model_login_params.go index 342bcba9..eeb0bb1a 100644 --- a/model_login_params.go +++ b/model_login_params.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty.go b/model_loyalty.go index 43b48a26..687603b2 100644 --- a/model_loyalty.go +++ b/model_loyalty.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,10 +16,45 @@ import ( // Loyalty Customer specific information about loyalty points. type Loyalty struct { - // A map holding information about the loyalty programs balance + // Displays information about the balances of the loyalty cards. + Cards *[]LoyaltyCard `json:"cards,omitempty"` + // Displays information about point balances in profile-based programs. Programs map[string]LoyaltyProgramLedgers `json:"programs"` } +// GetCards returns the Cards field value if set, zero value otherwise. +func (o *Loyalty) GetCards() []LoyaltyCard { + if o == nil || o.Cards == nil { + var ret []LoyaltyCard + return ret + } + return *o.Cards +} + +// GetCardsOk returns a tuple with the Cards field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Loyalty) GetCardsOk() ([]LoyaltyCard, bool) { + if o == nil || o.Cards == nil { + var ret []LoyaltyCard + return ret, false + } + return *o.Cards, true +} + +// HasCards returns a boolean if a field has been set. +func (o *Loyalty) HasCards() bool { + if o != nil && o.Cards != nil { + return true + } + + return false +} + +// SetCards gets a reference to the given []LoyaltyCard and assigns it to the Cards field. +func (o *Loyalty) SetCards(v []LoyaltyCard) { + o.Cards = &v +} + // GetPrograms returns the Programs field value func (o *Loyalty) GetPrograms() map[string]LoyaltyProgramLedgers { if o == nil { diff --git a/model_loyalty_balance.go b/model_loyalty_balance.go new file mode 100644 index 00000000..76c8ac02 --- /dev/null +++ b/model_loyalty_balance.go @@ -0,0 +1,182 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyBalance Point balance of a ledger in the Loyalty Program. +type LoyaltyBalance struct { + // Total amount of points awarded to this customer and available to spend. + ActivePoints *float32 `json:"activePoints,omitempty"` + // Total amount of points awarded to this customer but not available until their start date. + PendingPoints *float32 `json:"pendingPoints,omitempty"` + // Total amount of points already spent by this customer. + SpentPoints *float32 `json:"spentPoints,omitempty"` + // Total amount of points awarded but never redeemed. They cannot be used anymore. + ExpiredPoints *float32 `json:"expiredPoints,omitempty"` +} + +// GetActivePoints returns the ActivePoints field value if set, zero value otherwise. +func (o *LoyaltyBalance) GetActivePoints() float32 { + if o == nil || o.ActivePoints == nil { + var ret float32 + return ret + } + return *o.ActivePoints +} + +// GetActivePointsOk returns a tuple with the ActivePoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalance) GetActivePointsOk() (float32, bool) { + if o == nil || o.ActivePoints == nil { + var ret float32 + return ret, false + } + return *o.ActivePoints, true +} + +// HasActivePoints returns a boolean if a field has been set. +func (o *LoyaltyBalance) HasActivePoints() bool { + if o != nil && o.ActivePoints != nil { + return true + } + + return false +} + +// SetActivePoints gets a reference to the given float32 and assigns it to the ActivePoints field. +func (o *LoyaltyBalance) SetActivePoints(v float32) { + o.ActivePoints = &v +} + +// GetPendingPoints returns the PendingPoints field value if set, zero value otherwise. +func (o *LoyaltyBalance) GetPendingPoints() float32 { + if o == nil || o.PendingPoints == nil { + var ret float32 + return ret + } + return *o.PendingPoints +} + +// GetPendingPointsOk returns a tuple with the PendingPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalance) GetPendingPointsOk() (float32, bool) { + if o == nil || o.PendingPoints == nil { + var ret float32 + return ret, false + } + return *o.PendingPoints, true +} + +// HasPendingPoints returns a boolean if a field has been set. +func (o *LoyaltyBalance) HasPendingPoints() bool { + if o != nil && o.PendingPoints != nil { + return true + } + + return false +} + +// SetPendingPoints gets a reference to the given float32 and assigns it to the PendingPoints field. +func (o *LoyaltyBalance) SetPendingPoints(v float32) { + o.PendingPoints = &v +} + +// GetSpentPoints returns the SpentPoints field value if set, zero value otherwise. +func (o *LoyaltyBalance) GetSpentPoints() float32 { + if o == nil || o.SpentPoints == nil { + var ret float32 + return ret + } + return *o.SpentPoints +} + +// GetSpentPointsOk returns a tuple with the SpentPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalance) GetSpentPointsOk() (float32, bool) { + if o == nil || o.SpentPoints == nil { + var ret float32 + return ret, false + } + return *o.SpentPoints, true +} + +// HasSpentPoints returns a boolean if a field has been set. +func (o *LoyaltyBalance) HasSpentPoints() bool { + if o != nil && o.SpentPoints != nil { + return true + } + + return false +} + +// SetSpentPoints gets a reference to the given float32 and assigns it to the SpentPoints field. +func (o *LoyaltyBalance) SetSpentPoints(v float32) { + o.SpentPoints = &v +} + +// GetExpiredPoints returns the ExpiredPoints field value if set, zero value otherwise. +func (o *LoyaltyBalance) GetExpiredPoints() float32 { + if o == nil || o.ExpiredPoints == nil { + var ret float32 + return ret + } + return *o.ExpiredPoints +} + +// GetExpiredPointsOk returns a tuple with the ExpiredPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalance) GetExpiredPointsOk() (float32, bool) { + if o == nil || o.ExpiredPoints == nil { + var ret float32 + return ret, false + } + return *o.ExpiredPoints, true +} + +// HasExpiredPoints returns a boolean if a field has been set. +func (o *LoyaltyBalance) HasExpiredPoints() bool { + if o != nil && o.ExpiredPoints != nil { + return true + } + + return false +} + +// SetExpiredPoints gets a reference to the given float32 and assigns it to the ExpiredPoints field. +func (o *LoyaltyBalance) SetExpiredPoints(v float32) { + o.ExpiredPoints = &v +} + +type NullableLoyaltyBalance struct { + Value LoyaltyBalance + ExplicitNull bool +} + +func (v NullableLoyaltyBalance) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyBalance) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_balances.go b/model_loyalty_balances.go new file mode 100644 index 00000000..97599a2d --- /dev/null +++ b/model_loyalty_balances.go @@ -0,0 +1,111 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyBalances List of loyalty balances for a ledger and its subledgers. +type LoyaltyBalances struct { + Balance *LoyaltyBalance `json:"balance,omitempty"` + // Map of the loyalty balances of the subledgers of a ledger. + SubledgerBalances *map[string]LoyaltyBalance `json:"subledgerBalances,omitempty"` +} + +// GetBalance returns the Balance field value if set, zero value otherwise. +func (o *LoyaltyBalances) GetBalance() LoyaltyBalance { + if o == nil || o.Balance == nil { + var ret LoyaltyBalance + return ret + } + return *o.Balance +} + +// GetBalanceOk returns a tuple with the Balance field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalances) GetBalanceOk() (LoyaltyBalance, bool) { + if o == nil || o.Balance == nil { + var ret LoyaltyBalance + return ret, false + } + return *o.Balance, true +} + +// HasBalance returns a boolean if a field has been set. +func (o *LoyaltyBalances) HasBalance() bool { + if o != nil && o.Balance != nil { + return true + } + + return false +} + +// SetBalance gets a reference to the given LoyaltyBalance and assigns it to the Balance field. +func (o *LoyaltyBalances) SetBalance(v LoyaltyBalance) { + o.Balance = &v +} + +// GetSubledgerBalances returns the SubledgerBalances field value if set, zero value otherwise. +func (o *LoyaltyBalances) GetSubledgerBalances() map[string]LoyaltyBalance { + if o == nil || o.SubledgerBalances == nil { + var ret map[string]LoyaltyBalance + return ret + } + return *o.SubledgerBalances +} + +// GetSubledgerBalancesOk returns a tuple with the SubledgerBalances field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalances) GetSubledgerBalancesOk() (map[string]LoyaltyBalance, bool) { + if o == nil || o.SubledgerBalances == nil { + var ret map[string]LoyaltyBalance + return ret, false + } + return *o.SubledgerBalances, true +} + +// HasSubledgerBalances returns a boolean if a field has been set. +func (o *LoyaltyBalances) HasSubledgerBalances() bool { + if o != nil && o.SubledgerBalances != nil { + return true + } + + return false +} + +// SetSubledgerBalances gets a reference to the given map[string]LoyaltyBalance and assigns it to the SubledgerBalances field. +func (o *LoyaltyBalances) SetSubledgerBalances(v map[string]LoyaltyBalance) { + o.SubledgerBalances = &v +} + +type NullableLoyaltyBalances struct { + Value LoyaltyBalances + ExplicitNull bool +} + +func (v NullableLoyaltyBalances) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyBalances) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_card.go b/model_loyalty_card.go new file mode 100644 index 00000000..3bcb57aa --- /dev/null +++ b/model_loyalty_card.go @@ -0,0 +1,284 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// LoyaltyCard +type LoyaltyCard struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the loyalty program that owns this entity. + ProgramID int32 `json:"programID"` + // Status of the loyalty card. Can be one of: ['active', 'disabled'] + Status string `json:"status"` + // The alphanumeric identifier of the loyalty card. + Identifier string `json:"identifier"` + // The max amount of user profiles a card can be shared with. 0 means unlimited. + UsersPerCardLimit int32 `json:"usersPerCardLimit"` + // Integration IDs of the customers associated with the card. + Profiles *[]LoyaltyCardProfileRegistration `json:"profiles,omitempty"` + Ledger *LedgerInfo `json:"ledger,omitempty"` + // Displays point balances of the card in the subledgers of the loyalty program. + Subledgers *map[string]LedgerInfo `json:"subledgers,omitempty"` + // Timestamp of the most recent update of the loyalty card. + Modified *time.Time `json:"modified,omitempty"` +} + +// GetId returns the Id field value +func (o *LoyaltyCard) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *LoyaltyCard) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *LoyaltyCard) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *LoyaltyCard) SetCreated(v time.Time) { + o.Created = v +} + +// GetProgramID returns the ProgramID field value +func (o *LoyaltyCard) GetProgramID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramID +} + +// SetProgramID sets field value +func (o *LoyaltyCard) SetProgramID(v int32) { + o.ProgramID = v +} + +// GetStatus returns the Status field value +func (o *LoyaltyCard) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// SetStatus sets field value +func (o *LoyaltyCard) SetStatus(v string) { + o.Status = v +} + +// GetIdentifier returns the Identifier field value +func (o *LoyaltyCard) GetIdentifier() string { + if o == nil { + var ret string + return ret + } + + return o.Identifier +} + +// SetIdentifier sets field value +func (o *LoyaltyCard) SetIdentifier(v string) { + o.Identifier = v +} + +// GetUsersPerCardLimit returns the UsersPerCardLimit field value +func (o *LoyaltyCard) GetUsersPerCardLimit() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsersPerCardLimit +} + +// SetUsersPerCardLimit sets field value +func (o *LoyaltyCard) SetUsersPerCardLimit(v int32) { + o.UsersPerCardLimit = v +} + +// GetProfiles returns the Profiles field value if set, zero value otherwise. +func (o *LoyaltyCard) GetProfiles() []LoyaltyCardProfileRegistration { + if o == nil || o.Profiles == nil { + var ret []LoyaltyCardProfileRegistration + return ret + } + return *o.Profiles +} + +// GetProfilesOk returns a tuple with the Profiles field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetProfilesOk() ([]LoyaltyCardProfileRegistration, bool) { + if o == nil || o.Profiles == nil { + var ret []LoyaltyCardProfileRegistration + return ret, false + } + return *o.Profiles, true +} + +// HasProfiles returns a boolean if a field has been set. +func (o *LoyaltyCard) HasProfiles() bool { + if o != nil && o.Profiles != nil { + return true + } + + return false +} + +// SetProfiles gets a reference to the given []LoyaltyCardProfileRegistration and assigns it to the Profiles field. +func (o *LoyaltyCard) SetProfiles(v []LoyaltyCardProfileRegistration) { + o.Profiles = &v +} + +// GetLedger returns the Ledger field value if set, zero value otherwise. +func (o *LoyaltyCard) GetLedger() LedgerInfo { + if o == nil || o.Ledger == nil { + var ret LedgerInfo + return ret + } + return *o.Ledger +} + +// GetLedgerOk returns a tuple with the Ledger field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetLedgerOk() (LedgerInfo, bool) { + if o == nil || o.Ledger == nil { + var ret LedgerInfo + return ret, false + } + return *o.Ledger, true +} + +// HasLedger returns a boolean if a field has been set. +func (o *LoyaltyCard) HasLedger() bool { + if o != nil && o.Ledger != nil { + return true + } + + return false +} + +// SetLedger gets a reference to the given LedgerInfo and assigns it to the Ledger field. +func (o *LoyaltyCard) SetLedger(v LedgerInfo) { + o.Ledger = &v +} + +// GetSubledgers returns the Subledgers field value if set, zero value otherwise. +func (o *LoyaltyCard) GetSubledgers() map[string]LedgerInfo { + if o == nil || o.Subledgers == nil { + var ret map[string]LedgerInfo + return ret + } + return *o.Subledgers +} + +// GetSubledgersOk returns a tuple with the Subledgers field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetSubledgersOk() (map[string]LedgerInfo, bool) { + if o == nil || o.Subledgers == nil { + var ret map[string]LedgerInfo + return ret, false + } + return *o.Subledgers, true +} + +// HasSubledgers returns a boolean if a field has been set. +func (o *LoyaltyCard) HasSubledgers() bool { + if o != nil && o.Subledgers != nil { + return true + } + + return false +} + +// SetSubledgers gets a reference to the given map[string]LedgerInfo and assigns it to the Subledgers field. +func (o *LoyaltyCard) SetSubledgers(v map[string]LedgerInfo) { + o.Subledgers = &v +} + +// GetModified returns the Modified field value if set, zero value otherwise. +func (o *LoyaltyCard) GetModified() time.Time { + if o == nil || o.Modified == nil { + var ret time.Time + return ret + } + return *o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetModifiedOk() (time.Time, bool) { + if o == nil || o.Modified == nil { + var ret time.Time + return ret, false + } + return *o.Modified, true +} + +// HasModified returns a boolean if a field has been set. +func (o *LoyaltyCard) HasModified() bool { + if o != nil && o.Modified != nil { + return true + } + + return false +} + +// SetModified gets a reference to the given time.Time and assigns it to the Modified field. +func (o *LoyaltyCard) SetModified(v time.Time) { + o.Modified = &v +} + +type NullableLoyaltyCard struct { + Value LoyaltyCard + ExplicitNull bool +} + +func (v NullableLoyaltyCard) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyCard) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_card_profile_registration.go b/model_loyalty_card_profile_registration.go new file mode 100644 index 00000000..a463a2c7 --- /dev/null +++ b/model_loyalty_card_profile_registration.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// LoyaltyCardProfileRegistration struct for LoyaltyCardProfileRegistration +type LoyaltyCardProfileRegistration struct { + // Integration ID of the customer associated with the card. + IntegrationId string `json:"integrationId"` + // Timestamp of the registration to the card. + Timestamp time.Time `json:"timestamp"` +} + +// GetIntegrationId returns the IntegrationId field value +func (o *LoyaltyCardProfileRegistration) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *LoyaltyCardProfileRegistration) SetIntegrationId(v string) { + o.IntegrationId = v +} + +// GetTimestamp returns the Timestamp field value +func (o *LoyaltyCardProfileRegistration) GetTimestamp() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Timestamp +} + +// SetTimestamp sets field value +func (o *LoyaltyCardProfileRegistration) SetTimestamp(v time.Time) { + o.Timestamp = v +} + +type NullableLoyaltyCardProfileRegistration struct { + Value LoyaltyCardProfileRegistration + ExplicitNull bool +} + +func (v NullableLoyaltyCardProfileRegistration) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyCardProfileRegistration) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_card_registration.go b/model_loyalty_card_registration.go new file mode 100644 index 00000000..b6a650d4 --- /dev/null +++ b/model_loyalty_card_registration.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyCardRegistration struct for LoyaltyCardRegistration +type LoyaltyCardRegistration struct { + // The integrationId of the customer profile. + IntegrationId string `json:"integrationId"` +} + +// GetIntegrationId returns the IntegrationId field value +func (o *LoyaltyCardRegistration) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *LoyaltyCardRegistration) SetIntegrationId(v string) { + o.IntegrationId = v +} + +type NullableLoyaltyCardRegistration struct { + Value LoyaltyCardRegistration + ExplicitNull bool +} + +func (v NullableLoyaltyCardRegistration) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyCardRegistration) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_dashboard_data.go b/model_loyalty_dashboard_data.go index fd1477e4..640109f7 100644 --- a/model_loyalty_dashboard_data.go +++ b/model_loyalty_dashboard_data.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty_dashboard_points_breakdown.go b/model_loyalty_dashboard_points_breakdown.go index 7fb20863..b0ea2aab 100644 --- a/model_loyalty_dashboard_points_breakdown.go +++ b/model_loyalty_dashboard_points_breakdown.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty_ledger.go b/model_loyalty_ledger.go index 9d8418ed..f5daa0dd 100644 --- a/model_loyalty_ledger.go +++ b/model_loyalty_ledger.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty_ledger_entry.go b/model_loyalty_ledger_entry.go index a404162d..32a06b24 100644 --- a/model_loyalty_ledger_entry.go +++ b/model_loyalty_ledger_entry.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -19,7 +19,8 @@ import ( type LoyaltyLedgerEntry struct { Created time.Time `json:"created"` ProgramID int32 `json:"programID"` - CustomerProfileID string `json:"customerProfileID"` + CustomerProfileID *string `json:"customerProfileID,omitempty"` + CardID *int32 `json:"cardID,omitempty"` CustomerSessionID *string `json:"customerSessionID,omitempty"` EventID *int32 `json:"eventID,omitempty"` // The type of the ledger transaction. Possible values are addition, subtraction, expire or expiring (for expiring points ledgers) @@ -29,7 +30,7 @@ type LoyaltyLedgerEntry struct { ExpiryDate *time.Time `json:"expiryDate,omitempty"` // A name referencing the condition or effect that added this entry, or the specific name provided in an API call. Name string `json:"name"` - // This specifies if we are adding loyalty points to the main ledger or a subledger + // This specifies if we are adding loyalty points to the main ledger or a subledger. SubLedgerID string `json:"subLedgerID"` // This is the ID of the user who created this entry, if the addition or subtraction was done manually. UserID *int32 `json:"userID,omitempty"` @@ -65,19 +66,70 @@ func (o *LoyaltyLedgerEntry) SetProgramID(v int32) { o.ProgramID = v } -// GetCustomerProfileID returns the CustomerProfileID field value +// GetCustomerProfileID returns the CustomerProfileID field value if set, zero value otherwise. func (o *LoyaltyLedgerEntry) GetCustomerProfileID() string { - if o == nil { + if o == nil || o.CustomerProfileID == nil { var ret string return ret } + return *o.CustomerProfileID +} + +// GetCustomerProfileIDOk returns a tuple with the CustomerProfileID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyLedgerEntry) GetCustomerProfileIDOk() (string, bool) { + if o == nil || o.CustomerProfileID == nil { + var ret string + return ret, false + } + return *o.CustomerProfileID, true +} + +// HasCustomerProfileID returns a boolean if a field has been set. +func (o *LoyaltyLedgerEntry) HasCustomerProfileID() bool { + if o != nil && o.CustomerProfileID != nil { + return true + } - return o.CustomerProfileID + return false } -// SetCustomerProfileID sets field value +// SetCustomerProfileID gets a reference to the given string and assigns it to the CustomerProfileID field. func (o *LoyaltyLedgerEntry) SetCustomerProfileID(v string) { - o.CustomerProfileID = v + o.CustomerProfileID = &v +} + +// GetCardID returns the CardID field value if set, zero value otherwise. +func (o *LoyaltyLedgerEntry) GetCardID() int32 { + if o == nil || o.CardID == nil { + var ret int32 + return ret + } + return *o.CardID +} + +// GetCardIDOk returns a tuple with the CardID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyLedgerEntry) GetCardIDOk() (int32, bool) { + if o == nil || o.CardID == nil { + var ret int32 + return ret, false + } + return *o.CardID, true +} + +// HasCardID returns a boolean if a field has been set. +func (o *LoyaltyLedgerEntry) HasCardID() bool { + if o != nil && o.CardID != nil { + return true + } + + return false +} + +// SetCardID gets a reference to the given int32 and assigns it to the CardID field. +func (o *LoyaltyLedgerEntry) SetCardID(v int32) { + o.CardID = &v } // GetCustomerSessionID returns the CustomerSessionID field value if set, zero value otherwise. diff --git a/model_loyalty_ledger_transactions.go b/model_loyalty_ledger_transactions.go new file mode 100644 index 00000000..be92621a --- /dev/null +++ b/model_loyalty_ledger_transactions.go @@ -0,0 +1,112 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyLedgerTransactions List of loyalty ledger transactions. +type LoyaltyLedgerTransactions struct { + // true means there is more data in the source collection to request. + HasMore *bool `json:"hasMore,omitempty"` + // List of transaction entries from a loyalty ledger. + Data *[]LoyaltyLedgerEntry `json:"data,omitempty"` +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *LoyaltyLedgerTransactions) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + return ret + } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyLedgerTransactions) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *LoyaltyLedgerTransactions) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } + + return false +} + +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *LoyaltyLedgerTransactions) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetData returns the Data field value if set, zero value otherwise. +func (o *LoyaltyLedgerTransactions) GetData() []LoyaltyLedgerEntry { + if o == nil || o.Data == nil { + var ret []LoyaltyLedgerEntry + return ret + } + return *o.Data +} + +// GetDataOk returns a tuple with the Data field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyLedgerTransactions) GetDataOk() ([]LoyaltyLedgerEntry, bool) { + if o == nil || o.Data == nil { + var ret []LoyaltyLedgerEntry + return ret, false + } + return *o.Data, true +} + +// HasData returns a boolean if a field has been set. +func (o *LoyaltyLedgerTransactions) HasData() bool { + if o != nil && o.Data != nil { + return true + } + + return false +} + +// SetData gets a reference to the given []LoyaltyLedgerEntry and assigns it to the Data field. +func (o *LoyaltyLedgerTransactions) SetData(v []LoyaltyLedgerEntry) { + o.Data = &v +} + +type NullableLoyaltyLedgerTransactions struct { + Value LoyaltyLedgerTransactions + ExplicitNull bool +} + +func (v NullableLoyaltyLedgerTransactions) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyLedgerTransactions) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_membership.go b/model_loyalty_membership.go index 551a1c73..1c431a91 100644 --- a/model_loyalty_membership.go +++ b/model_loyalty_membership.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty_points.go b/model_loyalty_points.go index 70beccbf..77dad0b5 100644 --- a/model_loyalty_points.go +++ b/model_loyalty_points.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,17 +14,17 @@ import ( "encoding/json" ) -// LoyaltyPoints Points to add or deduct +// LoyaltyPoints Points to add or deduct. type LoyaltyPoints struct { - // Amount of loyalty points + // Amount of loyalty points. Points float32 `json:"points"` - // Allows to specify a name for the addition or deduction + // Allows to specify a name/reason for the point addition or deduction. Name *string `json:"name,omitempty"` // Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). ValidityDuration *string `json:"validityDuration,omitempty"` // Indicates the amount of time before the points are considered valid. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). PendingDuration *string `json:"pendingDuration,omitempty"` - // This specifies if we are adding loyalty points to the main ledger or a subledger + // This specifies if we are adding loyalty points to the main ledger or a subledger. SubLedgerID *string `json:"subLedgerID,omitempty"` } diff --git a/model_loyalty_program.go b/model_loyalty_program.go index 600db785..a6b0b789 100644 --- a/model_loyalty_program.go +++ b/model_loyalty_program.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // LoyaltyProgram type LoyaltyProgram struct { - // The ID of loyalty program. Unique ID for this entity. + // The ID of loyalty program. Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -31,16 +31,20 @@ type LoyaltyProgram struct { DefaultValidity string `json:"defaultValidity"` // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. DefaultPending string `json:"defaultPending"` - // Indicates if this program supports subledgers inside the program + // Indicates if this program supports subledgers inside the program. AllowSubledger bool `json:"allowSubledger"` - // A string containing an IANA timezone descriptor. - Timezone *string `json:"timezone,omitempty"` + // The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. + UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` // The ID of the Talon.One account that owns this program. AccountID int32 `json:"accountID"` // The internal name for the Loyalty Program. This is an immutable value. Name string `json:"name"` - // The tiers in this loyalty program + // The tiers in this loyalty program. Tiers *[]LoyaltyTier `json:"tiers,omitempty"` + // A string containing an IANA timezone descriptor. + Timezone string `json:"timezone"` + // Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. + CardBased bool `json:"cardBased"` } // GetId returns the Id field value @@ -163,37 +167,37 @@ func (o *LoyaltyProgram) SetAllowSubledger(v bool) { o.AllowSubledger = v } -// GetTimezone returns the Timezone field value if set, zero value otherwise. -func (o *LoyaltyProgram) GetTimezone() string { - if o == nil || o.Timezone == nil { - var ret string +// GetUsersPerCardLimit returns the UsersPerCardLimit field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetUsersPerCardLimit() int32 { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret } - return *o.Timezone + return *o.UsersPerCardLimit } -// GetTimezoneOk returns a tuple with the Timezone field value if set, zero value otherwise +// GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *LoyaltyProgram) GetTimezoneOk() (string, bool) { - if o == nil || o.Timezone == nil { - var ret string +func (o *LoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool) { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret, false } - return *o.Timezone, true + return *o.UsersPerCardLimit, true } -// HasTimezone returns a boolean if a field has been set. -func (o *LoyaltyProgram) HasTimezone() bool { - if o != nil && o.Timezone != nil { +// HasUsersPerCardLimit returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasUsersPerCardLimit() bool { + if o != nil && o.UsersPerCardLimit != nil { return true } return false } -// SetTimezone gets a reference to the given string and assigns it to the Timezone field. -func (o *LoyaltyProgram) SetTimezone(v string) { - o.Timezone = &v +// SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +func (o *LoyaltyProgram) SetUsersPerCardLimit(v int32) { + o.UsersPerCardLimit = &v } // GetAccountID returns the AccountID field value @@ -259,6 +263,36 @@ func (o *LoyaltyProgram) SetTiers(v []LoyaltyTier) { o.Tiers = &v } +// GetTimezone returns the Timezone field value +func (o *LoyaltyProgram) GetTimezone() string { + if o == nil { + var ret string + return ret + } + + return o.Timezone +} + +// SetTimezone sets field value +func (o *LoyaltyProgram) SetTimezone(v string) { + o.Timezone = v +} + +// GetCardBased returns the CardBased field value +func (o *LoyaltyProgram) GetCardBased() bool { + if o == nil { + var ret bool + return ret + } + + return o.CardBased +} + +// SetCardBased sets field value +func (o *LoyaltyProgram) SetCardBased(v bool) { + o.CardBased = v +} + type NullableLoyaltyProgram struct { Value LoyaltyProgram ExplicitNull bool diff --git a/model_loyalty_program_balance.go b/model_loyalty_program_balance.go index b901cc6c..f153c262 100644 --- a/model_loyalty_program_balance.go +++ b/model_loyalty_program_balance.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,15 +16,15 @@ import ( // LoyaltyProgramBalance The balance in a Loyalty Program for some Customer. type LoyaltyProgramBalance struct { - // Sum of current active points amounts + // Sum of currently active points. CurrentBalance float32 `json:"currentBalance"` - // Sum of pending points amounts + // Sum of pending points. PendingBalance float32 `json:"pendingBalance"` - // Sum of expired points amounts + // Sum of expired points. ExpiredBalance float32 `json:"expiredBalance"` - // Sum of spent points amounts + // Sum of spent points. SpentBalance float32 `json:"spentBalance"` - // Sum of current active points amounts, including additions and deductions on open sessions + // Sum of currently active points, including points added and deducted in open sessions. TentativeCurrentBalance float32 `json:"tentativeCurrentBalance"` } diff --git a/model_loyalty_program_entity.go b/model_loyalty_program_entity.go index 5009c16b..899279dd 100644 --- a/model_loyalty_program_entity.go +++ b/model_loyalty_program_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty_program_ledgers.go b/model_loyalty_program_ledgers.go index 0f7f2f76..1ff2ea16 100644 --- a/model_loyalty_program_ledgers.go +++ b/model_loyalty_program_ledgers.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,14 +16,14 @@ import ( // LoyaltyProgramLedgers Customer specific information about loyalty points. type LoyaltyProgramLedgers struct { - // The internal ID of loyalty program + // The internal ID of loyalty program. Id int32 `json:"id"` - // Visible name of loyalty program + // Visible name of loyalty program. Title string `json:"title"` - // Internal name of loyalty program + // Internal name of loyalty program. Name string `json:"name"` Ledger LedgerInfo `json:"ledger"` - // A map containing information about each loyalty subledger + // A map containing information about each loyalty subledger. SubLedgers *map[string]LedgerInfo `json:"subLedgers,omitempty"` } diff --git a/model_loyalty_projection.go b/model_loyalty_projection.go new file mode 100644 index 00000000..82717c47 --- /dev/null +++ b/model_loyalty_projection.go @@ -0,0 +1,110 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyProjection Group of all loyalty points expected in the future. +type LoyaltyProjection struct { + Projections *[]LoyaltyProjectionData `json:"projections,omitempty"` + // Sum of points to be expired by the projection date set in the query parameter. + TotalExpiringPoints float32 `json:"totalExpiringPoints"` + // Sum of points to be active by the projection date set in the query parameter. + TotalActivatingPoints float32 `json:"totalActivatingPoints"` +} + +// GetProjections returns the Projections field value if set, zero value otherwise. +func (o *LoyaltyProjection) GetProjections() []LoyaltyProjectionData { + if o == nil || o.Projections == nil { + var ret []LoyaltyProjectionData + return ret + } + return *o.Projections +} + +// GetProjectionsOk returns a tuple with the Projections field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProjection) GetProjectionsOk() ([]LoyaltyProjectionData, bool) { + if o == nil || o.Projections == nil { + var ret []LoyaltyProjectionData + return ret, false + } + return *o.Projections, true +} + +// HasProjections returns a boolean if a field has been set. +func (o *LoyaltyProjection) HasProjections() bool { + if o != nil && o.Projections != nil { + return true + } + + return false +} + +// SetProjections gets a reference to the given []LoyaltyProjectionData and assigns it to the Projections field. +func (o *LoyaltyProjection) SetProjections(v []LoyaltyProjectionData) { + o.Projections = &v +} + +// GetTotalExpiringPoints returns the TotalExpiringPoints field value +func (o *LoyaltyProjection) GetTotalExpiringPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalExpiringPoints +} + +// SetTotalExpiringPoints sets field value +func (o *LoyaltyProjection) SetTotalExpiringPoints(v float32) { + o.TotalExpiringPoints = v +} + +// GetTotalActivatingPoints returns the TotalActivatingPoints field value +func (o *LoyaltyProjection) GetTotalActivatingPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalActivatingPoints +} + +// SetTotalActivatingPoints sets field value +func (o *LoyaltyProjection) SetTotalActivatingPoints(v float32) { + o.TotalActivatingPoints = v +} + +type NullableLoyaltyProjection struct { + Value LoyaltyProjection + ExplicitNull bool +} + +func (v NullableLoyaltyProjection) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyProjection) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_projection_data.go b/model_loyalty_projection_data.go new file mode 100644 index 00000000..a47b3737 --- /dev/null +++ b/model_loyalty_projection_data.go @@ -0,0 +1,111 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// LoyaltyProjectionData struct for LoyaltyProjectionData +type LoyaltyProjectionData struct { + // Specific date of projection. + Date time.Time `json:"date"` + // Points that will be expired by the specified date. + ExpiringPoints float32 `json:"expiringPoints"` + // Points that will be active by the specified date. + ActivatingPoints float32 `json:"activatingPoints"` + // Current balance plus projected active points, minus expiring points. + ProjectedBalance float32 `json:"projectedBalance"` +} + +// GetDate returns the Date field value +func (o *LoyaltyProjectionData) GetDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Date +} + +// SetDate sets field value +func (o *LoyaltyProjectionData) SetDate(v time.Time) { + o.Date = v +} + +// GetExpiringPoints returns the ExpiringPoints field value +func (o *LoyaltyProjectionData) GetExpiringPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.ExpiringPoints +} + +// SetExpiringPoints sets field value +func (o *LoyaltyProjectionData) SetExpiringPoints(v float32) { + o.ExpiringPoints = v +} + +// GetActivatingPoints returns the ActivatingPoints field value +func (o *LoyaltyProjectionData) GetActivatingPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.ActivatingPoints +} + +// SetActivatingPoints sets field value +func (o *LoyaltyProjectionData) SetActivatingPoints(v float32) { + o.ActivatingPoints = v +} + +// GetProjectedBalance returns the ProjectedBalance field value +func (o *LoyaltyProjectionData) GetProjectedBalance() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.ProjectedBalance +} + +// SetProjectedBalance sets field value +func (o *LoyaltyProjectionData) SetProjectedBalance(v float32) { + o.ProjectedBalance = v +} + +type NullableLoyaltyProjectionData struct { + Value LoyaltyProjectionData + ExplicitNull bool +} + +func (v NullableLoyaltyProjectionData) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyProjectionData) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_statistics.go b/model_loyalty_statistics.go index 9093db43..f953edf7 100644 --- a/model_loyalty_statistics.go +++ b/model_loyalty_statistics.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_loyalty_sub_ledger.go b/model_loyalty_sub_ledger.go index 026a27f3..b99bec20 100644 --- a/model_loyalty_sub_ledger.go +++ b/model_loyalty_sub_ledger.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // LoyaltySubLedger Ledger of Balance in Loyalty Program for a Customer. type LoyaltySubLedger struct { - // ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance. + // **DEPRECATED** Use `totalActivePoints` property instead. Total amount of currently active and available points in the customer's balance. Total float32 `json:"total"` // Total amount of currently active and available points in the customer's balance. TotalActivePoints float32 `json:"totalActivePoints"` diff --git a/model_loyalty_tier.go b/model_loyalty_tier.go index e2a96f37..41e07f35 100644 --- a/model_loyalty_tier.go +++ b/model_loyalty_tier.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // LoyaltyTier type LoyaltyTier struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -25,7 +25,7 @@ type LoyaltyTier struct { ProgramID int32 `json:"programID"` // The name of the tier Name string `json:"name"` - // The minimum amount of points required to be eligible for the tier + // The minimum amount of points required to be eligible for the tier. MinPoints float32 `json:"minPoints"` } diff --git a/model_management_key.go b/model_management_key.go new file mode 100644 index 00000000..67893b15 --- /dev/null +++ b/model_management_key.go @@ -0,0 +1,162 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// ManagementKey +type ManagementKey struct { + // Name for management key. + Name string `json:"name"` + // The date the management key expires. + ExpiryDate time.Time `json:"expiryDate"` + // The list of endpoints that can be accessed with the key + Endpoints []Endpoint `json:"endpoints"` + // ID of the management key. + Id int32 `json:"id"` + // ID of the user who created it. + CreatedBy int32 `json:"createdBy"` + // ID of account the key is used for. + AccountID int32 `json:"accountID"` + // The date the management key was created. + Created time.Time `json:"created"` +} + +// GetName returns the Name field value +func (o *ManagementKey) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *ManagementKey) SetName(v string) { + o.Name = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *ManagementKey) GetExpiryDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *ManagementKey) SetExpiryDate(v time.Time) { + o.ExpiryDate = v +} + +// GetEndpoints returns the Endpoints field value +func (o *ManagementKey) GetEndpoints() []Endpoint { + if o == nil { + var ret []Endpoint + return ret + } + + return o.Endpoints +} + +// SetEndpoints sets field value +func (o *ManagementKey) SetEndpoints(v []Endpoint) { + o.Endpoints = v +} + +// GetId returns the Id field value +func (o *ManagementKey) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *ManagementKey) SetId(v int32) { + o.Id = v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *ManagementKey) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *ManagementKey) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetAccountID returns the AccountID field value +func (o *ManagementKey) GetAccountID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountID +} + +// SetAccountID sets field value +func (o *ManagementKey) SetAccountID(v int32) { + o.AccountID = v +} + +// GetCreated returns the Created field value +func (o *ManagementKey) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *ManagementKey) SetCreated(v time.Time) { + o.Created = v +} + +type NullableManagementKey struct { + Value ManagementKey + ExplicitNull bool +} + +func (v NullableManagementKey) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableManagementKey) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_manager_config.go b/model_manager_config.go index d6a14052..4db2f9d6 100644 --- a/model_manager_config.go +++ b/model_manager_config.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_meta.go b/model_meta.go index 662154be..f5c70de2 100644 --- a/model_meta.go +++ b/model_meta.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_multi_application_entity.go b/model_multi_application_entity.go index 846ae075..4cf791c4 100644 --- a/model_multi_application_entity.go +++ b/model_multi_application_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_multiple_attribute.go b/model_multiple_attribute.go new file mode 100644 index 00000000..475ce9be --- /dev/null +++ b/model_multiple_attribute.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleAttribute struct for MultipleAttribute +type MultipleAttribute struct { + Attributes *[]Attribute `json:"attributes,omitempty"` +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *MultipleAttribute) GetAttributes() []Attribute { + if o == nil || o.Attributes == nil { + var ret []Attribute + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MultipleAttribute) GetAttributesOk() ([]Attribute, bool) { + if o == nil || o.Attributes == nil { + var ret []Attribute + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *MultipleAttribute) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given []Attribute and assigns it to the Attributes field. +func (o *MultipleAttribute) SetAttributes(v []Attribute) { + o.Attributes = &v +} + +type NullableMultipleAttribute struct { + Value MultipleAttribute + ExplicitNull bool +} + +func (v NullableMultipleAttribute) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleAttribute) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_multiple_audiences.go b/model_multiple_audiences.go new file mode 100644 index 00000000..3a7fd2d4 --- /dev/null +++ b/model_multiple_audiences.go @@ -0,0 +1,75 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleAudiences struct for MultipleAudiences +type MultipleAudiences struct { + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + Audiences []MultipleAudiencesItem `json:"audiences"` +} + +// GetAccountId returns the AccountId field value +func (o *MultipleAudiences) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *MultipleAudiences) SetAccountId(v int32) { + o.AccountId = v +} + +// GetAudiences returns the Audiences field value +func (o *MultipleAudiences) GetAudiences() []MultipleAudiencesItem { + if o == nil { + var ret []MultipleAudiencesItem + return ret + } + + return o.Audiences +} + +// SetAudiences sets field value +func (o *MultipleAudiences) SetAudiences(v []MultipleAudiencesItem) { + o.Audiences = v +} + +type NullableMultipleAudiences struct { + Value MultipleAudiences + ExplicitNull bool +} + +func (v NullableMultipleAudiences) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleAudiences) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_multiple_audiences_item.go b/model_multiple_audiences_item.go new file mode 100644 index 00000000..fc762a6b --- /dev/null +++ b/model_multiple_audiences_item.go @@ -0,0 +1,128 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// MultipleAudiencesItem +type MultipleAudiencesItem struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The human-friendly display name for this audience. + Name string `json:"name"` + // The ID of this audience in the third-party integration. + IntegrationId string `json:"integrationId"` + // Indicates whether the audience is new, updated or unmodified by the request. + Status string `json:"status"` +} + +// GetId returns the Id field value +func (o *MultipleAudiencesItem) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *MultipleAudiencesItem) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *MultipleAudiencesItem) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *MultipleAudiencesItem) SetCreated(v time.Time) { + o.Created = v +} + +// GetName returns the Name field value +func (o *MultipleAudiencesItem) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *MultipleAudiencesItem) SetName(v string) { + o.Name = v +} + +// GetIntegrationId returns the IntegrationId field value +func (o *MultipleAudiencesItem) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *MultipleAudiencesItem) SetIntegrationId(v string) { + o.IntegrationId = v +} + +// GetStatus returns the Status field value +func (o *MultipleAudiencesItem) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// SetStatus sets field value +func (o *MultipleAudiencesItem) SetStatus(v string) { + o.Status = v +} + +type NullableMultipleAudiencesItem struct { + Value MultipleAudiencesItem + ExplicitNull bool +} + +func (v NullableMultipleAudiencesItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleAudiencesItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_multiple_customer_profile_integration_request.go b/model_multiple_customer_profile_integration_request.go index 40102bbb..f6a45eb3 100644 --- a/model_multiple_customer_profile_integration_request.go +++ b/model_multiple_customer_profile_integration_request.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_multiple_customer_profile_integration_request_item.go b/model_multiple_customer_profile_integration_request_item.go index bad84c64..32c969e9 100644 --- a/model_multiple_customer_profile_integration_request_item.go +++ b/model_multiple_customer_profile_integration_request_item.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // MultipleCustomerProfileIntegrationRequestItem type MultipleCustomerProfileIntegrationRequestItem struct { - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // The custom identifier for this profile, must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). + // The identifier of this profile, set by your integration layer. It must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). IntegrationId string `json:"integrationId"` } diff --git a/model_multiple_customer_profile_integration_response_v2.go b/model_multiple_customer_profile_integration_response_v2.go index 97faa992..14d079f5 100644 --- a/model_multiple_customer_profile_integration_response_v2.go +++ b/model_multiple_customer_profile_integration_response_v2.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_multiple_new_attribute.go b/model_multiple_new_attribute.go new file mode 100644 index 00000000..d166d611 --- /dev/null +++ b/model_multiple_new_attribute.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleNewAttribute struct for MultipleNewAttribute +type MultipleNewAttribute struct { + Attributes *[]NewAttribute `json:"attributes,omitempty"` +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *MultipleNewAttribute) GetAttributes() []NewAttribute { + if o == nil || o.Attributes == nil { + var ret []NewAttribute + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MultipleNewAttribute) GetAttributesOk() ([]NewAttribute, bool) { + if o == nil || o.Attributes == nil { + var ret []NewAttribute + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *MultipleNewAttribute) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given []NewAttribute and assigns it to the Attributes field. +func (o *MultipleNewAttribute) SetAttributes(v []NewAttribute) { + o.Attributes = &v +} + +type NullableMultipleNewAttribute struct { + Value MultipleNewAttribute + ExplicitNull bool +} + +func (v NullableMultipleNewAttribute) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleNewAttribute) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_multiple_new_audiences.go b/model_multiple_new_audiences.go new file mode 100644 index 00000000..ce076589 --- /dev/null +++ b/model_multiple_new_audiences.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleNewAudiences struct for MultipleNewAudiences +type MultipleNewAudiences struct { + Audiences []NewMultipleAudiencesItem `json:"audiences"` +} + +// GetAudiences returns the Audiences field value +func (o *MultipleNewAudiences) GetAudiences() []NewMultipleAudiencesItem { + if o == nil { + var ret []NewMultipleAudiencesItem + return ret + } + + return o.Audiences +} + +// SetAudiences sets field value +func (o *MultipleNewAudiences) SetAudiences(v []NewMultipleAudiencesItem) { + o.Audiences = v +} + +type NullableMultipleNewAudiences struct { + Value MultipleNewAudiences + ExplicitNull bool +} + +func (v NullableMultipleNewAudiences) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleNewAudiences) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_mutable_entity.go b/model_mutable_entity.go index 5f9b3fc2..6da02666 100644 --- a/model_mutable_entity.go +++ b/model_mutable_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_account.go b/model_new_account.go index 4c05b794..d4f11b2b 100644 --- a/model_new_account.go +++ b/model_new_account.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_account_sign_up.go b/model_new_account_sign_up.go index 483559f0..b388f9ce 100644 --- a/model_new_account_sign_up.go +++ b/model_new_account_sign_up.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_additional_cost.go b/model_new_additional_cost.go index 9b8a9f4e..969d8e4a 100644 --- a/model_new_additional_cost.go +++ b/model_new_additional_cost.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -22,8 +22,10 @@ type NewAdditionalCost struct { Title string `json:"title"` // A description of this additional cost. Description string `json:"description"` - // A list of the IDs of the applications that are subscribed to this additional cost + // A list of the IDs of the applications that are subscribed to this additional cost. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session. + Type *string `json:"type,omitempty"` } // GetName returns the Name field value @@ -104,6 +106,39 @@ func (o *NewAdditionalCost) SetSubscribedApplicationsIds(v []int32) { o.SubscribedApplicationsIds = &v } +// GetType returns the Type field value if set, zero value otherwise. +func (o *NewAdditionalCost) GetType() string { + if o == nil || o.Type == nil { + var ret string + return ret + } + return *o.Type +} + +// GetTypeOk returns a tuple with the Type field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAdditionalCost) GetTypeOk() (string, bool) { + if o == nil || o.Type == nil { + var ret string + return ret, false + } + return *o.Type, true +} + +// HasType returns a boolean if a field has been set. +func (o *NewAdditionalCost) HasType() bool { + if o != nil && o.Type != nil { + return true + } + + return false +} + +// SetType gets a reference to the given string and assigns it to the Type field. +func (o *NewAdditionalCost) SetType(v string) { + o.Type = &v +} + type NullableNewAdditionalCost struct { Value NewAdditionalCost ExplicitNull bool diff --git a/model_new_application.go b/model_new_application.go index f9926080..92262be4 100644 --- a/model_new_application.go +++ b/model_new_application.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -22,28 +22,32 @@ type NewApplication struct { Description *string `json:"description,omitempty"` // A string containing an IANA timezone descriptor. Timezone string `json:"timezone"` - // A string describing a default currency for new customer sessions. + // The default currency for new customer sessions. Currency string `json:"currency"` - // A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. + // The case sensitivity behavior to check coupon codes in the campaigns of this Application. CaseSensitivity *string `json:"caseSensitivity,omitempty"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // Default limits for campaigns created in this application + // Default limits for campaigns created in this application. Limits *[]LimitConfig `json:"limits,omitempty"` - // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" + // Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. CampaignPriority *string `json:"campaignPriority,omitempty"` - // The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" + // The strategy used when choosing exclusive campaigns for evaluation. ExclusiveCampaignsStrategy *string `json:"exclusiveCampaignsStrategy,omitempty"` - // The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. + // The default scope to apply `setDiscount` effects on if no scope was provided with the effect. DefaultDiscountScope *string `json:"defaultDiscountScope,omitempty"` - // Indicates if discounts should cascade for this application + // Indicates if discounts should cascade for this Application. EnableCascadingDiscounts *bool `json:"enableCascadingDiscounts,omitempty"` - // Indicates if cart items of quantity larger than one should be separated into different items of quantity one + // Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` - // Indicates if this is a live or sandbox application + // Indicates if this is a live or sandbox Application. Sandbox *bool `json:"sandbox,omitempty"` - // Hex key for HMAC-signing API calls as coming from this application (16 hex digits) + // Indicates if this Application supports partial discounts. + EnablePartialDiscounts *bool `json:"enablePartialDiscounts,omitempty"` + // The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. + DefaultDiscountAdditionalCostPerItemScope *string `json:"defaultDiscountAdditionalCostPerItemScope,omitempty"` + // Hex key for HMAC-signing API calls as coming from this application (16 hex digits). Key *string `json:"key,omitempty"` } @@ -455,6 +459,72 @@ func (o *NewApplication) SetSandbox(v bool) { o.Sandbox = &v } +// GetEnablePartialDiscounts returns the EnablePartialDiscounts field value if set, zero value otherwise. +func (o *NewApplication) GetEnablePartialDiscounts() bool { + if o == nil || o.EnablePartialDiscounts == nil { + var ret bool + return ret + } + return *o.EnablePartialDiscounts +} + +// GetEnablePartialDiscountsOk returns a tuple with the EnablePartialDiscounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetEnablePartialDiscountsOk() (bool, bool) { + if o == nil || o.EnablePartialDiscounts == nil { + var ret bool + return ret, false + } + return *o.EnablePartialDiscounts, true +} + +// HasEnablePartialDiscounts returns a boolean if a field has been set. +func (o *NewApplication) HasEnablePartialDiscounts() bool { + if o != nil && o.EnablePartialDiscounts != nil { + return true + } + + return false +} + +// SetEnablePartialDiscounts gets a reference to the given bool and assigns it to the EnablePartialDiscounts field. +func (o *NewApplication) SetEnablePartialDiscounts(v bool) { + o.EnablePartialDiscounts = &v +} + +// GetDefaultDiscountAdditionalCostPerItemScope returns the DefaultDiscountAdditionalCostPerItemScope field value if set, zero value otherwise. +func (o *NewApplication) GetDefaultDiscountAdditionalCostPerItemScope() string { + if o == nil || o.DefaultDiscountAdditionalCostPerItemScope == nil { + var ret string + return ret + } + return *o.DefaultDiscountAdditionalCostPerItemScope +} + +// GetDefaultDiscountAdditionalCostPerItemScopeOk returns a tuple with the DefaultDiscountAdditionalCostPerItemScope field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetDefaultDiscountAdditionalCostPerItemScopeOk() (string, bool) { + if o == nil || o.DefaultDiscountAdditionalCostPerItemScope == nil { + var ret string + return ret, false + } + return *o.DefaultDiscountAdditionalCostPerItemScope, true +} + +// HasDefaultDiscountAdditionalCostPerItemScope returns a boolean if a field has been set. +func (o *NewApplication) HasDefaultDiscountAdditionalCostPerItemScope() bool { + if o != nil && o.DefaultDiscountAdditionalCostPerItemScope != nil { + return true + } + + return false +} + +// SetDefaultDiscountAdditionalCostPerItemScope gets a reference to the given string and assigns it to the DefaultDiscountAdditionalCostPerItemScope field. +func (o *NewApplication) SetDefaultDiscountAdditionalCostPerItemScope(v string) { + o.DefaultDiscountAdditionalCostPerItemScope = &v +} + // GetKey returns the Key field value if set, zero value otherwise. func (o *NewApplication) GetKey() string { if o == nil || o.Key == nil { diff --git a/model_new_application_api_key.go b/model_new_application_api_key.go index c829699c..aa88d798 100644 --- a/model_new_application_api_key.go +++ b/model_new_application_api_key.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,23 +17,23 @@ import ( // NewApplicationApiKey type NewApplicationApiKey struct { - // Title for API Key + // Title for API Key. Title string `json:"title"` - // The date the API key expired + // The date the API key expired. Expires time.Time `json:"expires"` - // Platform the API key is valid for. + // The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. Platform *string `json:"platform,omitempty"` - // ID of the API Key + // ID of the API Key. Id int32 `json:"id"` - // ID of user who created + // ID of user who created. CreatedBy int32 `json:"createdBy"` - // ID of account the key is used for + // ID of account the key is used for. AccountID int32 `json:"accountID"` - // ID of application the key is used for + // ID of application the key is used for. ApplicationID int32 `json:"applicationID"` - // The date the API key was created + // The date the API key was created. Created time.Time `json:"created"` - // Raw API Key + // The API key. Key string `json:"key"` } diff --git a/model_new_attribute.go b/model_new_attribute.go index b5708754..5e37d84f 100644 --- a/model_new_attribute.go +++ b/model_new_attribute.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -29,10 +29,18 @@ type NewAttribute struct { Description string `json:"description"` // A list of suggestions for the attribute. Suggestions []string `json:"suggestions"` + // Whether or not this attribute has an allowed list of values associated with it. + HasAllowedList *bool `json:"hasAllowedList,omitempty"` + // Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). + RestrictedBySuggestions *bool `json:"restrictedBySuggestions,omitempty"` // Whether or not this attribute can be edited. Editable bool `json:"editable"` - // A list of the IDs of the applications that are subscribed to this attribute + // A list of the IDs of the applications where this attribute is available. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // A list of the IDs of the catalogs where this attribute is available. + SubscribedCatalogsIds *[]int32 `json:"subscribedCatalogsIds,omitempty"` + // A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. + AllowedSubscriptions *[]string `json:"allowedSubscriptions,omitempty"` } // GetEntity returns the Entity field value @@ -158,6 +166,72 @@ func (o *NewAttribute) SetSuggestions(v []string) { o.Suggestions = v } +// GetHasAllowedList returns the HasAllowedList field value if set, zero value otherwise. +func (o *NewAttribute) GetHasAllowedList() bool { + if o == nil || o.HasAllowedList == nil { + var ret bool + return ret + } + return *o.HasAllowedList +} + +// GetHasAllowedListOk returns a tuple with the HasAllowedList field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAttribute) GetHasAllowedListOk() (bool, bool) { + if o == nil || o.HasAllowedList == nil { + var ret bool + return ret, false + } + return *o.HasAllowedList, true +} + +// HasHasAllowedList returns a boolean if a field has been set. +func (o *NewAttribute) HasHasAllowedList() bool { + if o != nil && o.HasAllowedList != nil { + return true + } + + return false +} + +// SetHasAllowedList gets a reference to the given bool and assigns it to the HasAllowedList field. +func (o *NewAttribute) SetHasAllowedList(v bool) { + o.HasAllowedList = &v +} + +// GetRestrictedBySuggestions returns the RestrictedBySuggestions field value if set, zero value otherwise. +func (o *NewAttribute) GetRestrictedBySuggestions() bool { + if o == nil || o.RestrictedBySuggestions == nil { + var ret bool + return ret + } + return *o.RestrictedBySuggestions +} + +// GetRestrictedBySuggestionsOk returns a tuple with the RestrictedBySuggestions field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAttribute) GetRestrictedBySuggestionsOk() (bool, bool) { + if o == nil || o.RestrictedBySuggestions == nil { + var ret bool + return ret, false + } + return *o.RestrictedBySuggestions, true +} + +// HasRestrictedBySuggestions returns a boolean if a field has been set. +func (o *NewAttribute) HasRestrictedBySuggestions() bool { + if o != nil && o.RestrictedBySuggestions != nil { + return true + } + + return false +} + +// SetRestrictedBySuggestions gets a reference to the given bool and assigns it to the RestrictedBySuggestions field. +func (o *NewAttribute) SetRestrictedBySuggestions(v bool) { + o.RestrictedBySuggestions = &v +} + // GetEditable returns the Editable field value func (o *NewAttribute) GetEditable() bool { if o == nil { @@ -206,6 +280,72 @@ func (o *NewAttribute) SetSubscribedApplicationsIds(v []int32) { o.SubscribedApplicationsIds = &v } +// GetSubscribedCatalogsIds returns the SubscribedCatalogsIds field value if set, zero value otherwise. +func (o *NewAttribute) GetSubscribedCatalogsIds() []int32 { + if o == nil || o.SubscribedCatalogsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedCatalogsIds +} + +// GetSubscribedCatalogsIdsOk returns a tuple with the SubscribedCatalogsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAttribute) GetSubscribedCatalogsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedCatalogsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedCatalogsIds, true +} + +// HasSubscribedCatalogsIds returns a boolean if a field has been set. +func (o *NewAttribute) HasSubscribedCatalogsIds() bool { + if o != nil && o.SubscribedCatalogsIds != nil { + return true + } + + return false +} + +// SetSubscribedCatalogsIds gets a reference to the given []int32 and assigns it to the SubscribedCatalogsIds field. +func (o *NewAttribute) SetSubscribedCatalogsIds(v []int32) { + o.SubscribedCatalogsIds = &v +} + +// GetAllowedSubscriptions returns the AllowedSubscriptions field value if set, zero value otherwise. +func (o *NewAttribute) GetAllowedSubscriptions() []string { + if o == nil || o.AllowedSubscriptions == nil { + var ret []string + return ret + } + return *o.AllowedSubscriptions +} + +// GetAllowedSubscriptionsOk returns a tuple with the AllowedSubscriptions field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAttribute) GetAllowedSubscriptionsOk() ([]string, bool) { + if o == nil || o.AllowedSubscriptions == nil { + var ret []string + return ret, false + } + return *o.AllowedSubscriptions, true +} + +// HasAllowedSubscriptions returns a boolean if a field has been set. +func (o *NewAttribute) HasAllowedSubscriptions() bool { + if o != nil && o.AllowedSubscriptions != nil { + return true + } + + return false +} + +// SetAllowedSubscriptions gets a reference to the given []string and assigns it to the AllowedSubscriptions field. +func (o *NewAttribute) SetAllowedSubscriptions(v []string) { + o.AllowedSubscriptions = &v +} + type NullableNewAttribute struct { Value NewAttribute ExplicitNull bool diff --git a/model_new_audience.go b/model_new_audience.go index 74199ee4..347c387f 100644 --- a/model_new_audience.go +++ b/model_new_audience.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,14 +14,20 @@ import ( "encoding/json" ) -// NewAudience struct for NewAudience +// NewAudience type NewAudience struct { - // The human-friendly display name for this Audience. + // The human-friendly display name for this audience. Name string `json:"name"` - // Integration that this audience was created in. - Integration string `json:"integration"` - // The ID of this Audience in the third-party integration - IntegrationId string `json:"integrationId"` + // Indicates if this is a live or sandbox Application. + Sandbox *bool `json:"sandbox,omitempty"` + // A description of the audience. + Description *string `json:"description,omitempty"` + // The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. + Integration *string `json:"integration,omitempty"` + // The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. + IntegrationId *string `json:"integrationId,omitempty"` + // Determines if this audience is a 3rd party audience or not. + CreatedIn3rdParty *bool `json:"createdIn3rdParty,omitempty"` } // GetName returns the Name field value @@ -39,34 +45,169 @@ func (o *NewAudience) SetName(v string) { o.Name = v } -// GetIntegration returns the Integration field value +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *NewAudience) GetSandbox() bool { + if o == nil || o.Sandbox == nil { + var ret bool + return ret + } + return *o.Sandbox +} + +// GetSandboxOk returns a tuple with the Sandbox field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAudience) GetSandboxOk() (bool, bool) { + if o == nil || o.Sandbox == nil { + var ret bool + return ret, false + } + return *o.Sandbox, true +} + +// HasSandbox returns a boolean if a field has been set. +func (o *NewAudience) HasSandbox() bool { + if o != nil && o.Sandbox != nil { + return true + } + + return false +} + +// SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +func (o *NewAudience) SetSandbox(v bool) { + o.Sandbox = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewAudience) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAudience) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewAudience) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewAudience) SetDescription(v string) { + o.Description = &v +} + +// GetIntegration returns the Integration field value if set, zero value otherwise. func (o *NewAudience) GetIntegration() string { - if o == nil { + if o == nil || o.Integration == nil { var ret string return ret } + return *o.Integration +} + +// GetIntegrationOk returns a tuple with the Integration field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAudience) GetIntegrationOk() (string, bool) { + if o == nil || o.Integration == nil { + var ret string + return ret, false + } + return *o.Integration, true +} + +// HasIntegration returns a boolean if a field has been set. +func (o *NewAudience) HasIntegration() bool { + if o != nil && o.Integration != nil { + return true + } - return o.Integration + return false } -// SetIntegration sets field value +// SetIntegration gets a reference to the given string and assigns it to the Integration field. func (o *NewAudience) SetIntegration(v string) { - o.Integration = v + o.Integration = &v } -// GetIntegrationId returns the IntegrationId field value +// GetIntegrationId returns the IntegrationId field value if set, zero value otherwise. func (o *NewAudience) GetIntegrationId() string { - if o == nil { + if o == nil || o.IntegrationId == nil { var ret string return ret } + return *o.IntegrationId +} + +// GetIntegrationIdOk returns a tuple with the IntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAudience) GetIntegrationIdOk() (string, bool) { + if o == nil || o.IntegrationId == nil { + var ret string + return ret, false + } + return *o.IntegrationId, true +} + +// HasIntegrationId returns a boolean if a field has been set. +func (o *NewAudience) HasIntegrationId() bool { + if o != nil && o.IntegrationId != nil { + return true + } - return o.IntegrationId + return false } -// SetIntegrationId sets field value +// SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. func (o *NewAudience) SetIntegrationId(v string) { - o.IntegrationId = v + o.IntegrationId = &v +} + +// GetCreatedIn3rdParty returns the CreatedIn3rdParty field value if set, zero value otherwise. +func (o *NewAudience) GetCreatedIn3rdParty() bool { + if o == nil || o.CreatedIn3rdParty == nil { + var ret bool + return ret + } + return *o.CreatedIn3rdParty +} + +// GetCreatedIn3rdPartyOk returns a tuple with the CreatedIn3rdParty field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAudience) GetCreatedIn3rdPartyOk() (bool, bool) { + if o == nil || o.CreatedIn3rdParty == nil { + var ret bool + return ret, false + } + return *o.CreatedIn3rdParty, true +} + +// HasCreatedIn3rdParty returns a boolean if a field has been set. +func (o *NewAudience) HasCreatedIn3rdParty() bool { + if o != nil && o.CreatedIn3rdParty != nil { + return true + } + + return false +} + +// SetCreatedIn3rdParty gets a reference to the given bool and assigns it to the CreatedIn3rdParty field. +func (o *NewAudience) SetCreatedIn3rdParty(v bool) { + o.CreatedIn3rdParty = &v } type NullableNewAudience struct { diff --git a/model_new_campaign.go b/model_new_campaign.go index 97dd3b1e..9c4ad0f7 100644 --- a/model_new_campaign.go +++ b/model_new_campaign.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -25,21 +25,21 @@ type NewCampaign struct { StartTime *time.Time `json:"startTime,omitempty"` // Timestamp the campaign will become inactive. EndTime *time.Time `json:"endTime,omitempty"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` // A disabled or archived campaign is not evaluated for rules or coupons. State string `json:"state"` - // ID of Ruleset this campaign applies on customer session evaluation. + // [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this campaign applies on customer session evaluation. ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` // A list of tags for the campaign. Tags []string `json:"tags"` - // A list of features for the campaign. + // The features enabled in this campaign. Features []string `json:"features"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of limits that will operate for this campaign + // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. Limits []LimitConfig `json:"limits"` - // The IDs of the campaign groups that own this entity. + // The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` } diff --git a/model_new_campaign_collection.go b/model_new_campaign_collection.go new file mode 100644 index 00000000..5a9e0ea8 --- /dev/null +++ b/model_new_campaign_collection.go @@ -0,0 +1,94 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewCampaignCollection +type NewCampaignCollection struct { + // A short description of the purpose of this collection. + Description *string `json:"description,omitempty"` + // The name of this collection. + Name string `json:"name"` +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewCampaignCollection) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaignCollection) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewCampaignCollection) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewCampaignCollection) SetDescription(v string) { + o.Description = &v +} + +// GetName returns the Name field value +func (o *NewCampaignCollection) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewCampaignCollection) SetName(v string) { + o.Name = v +} + +type NullableNewCampaignCollection struct { + Value NewCampaignCollection + ExplicitNull bool +} + +func (v NullableNewCampaignCollection) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewCampaignCollection) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_campaign_group.go b/model_new_campaign_group.go index 42507fa7..faae127e 100644 --- a/model_new_campaign_group.go +++ b/model_new_campaign_group.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -20,9 +20,9 @@ type NewCampaignGroup struct { Name string `json:"name"` // A longer description of the campaign group. Description *string `json:"description,omitempty"` - // A list of the IDs of the applications that this campaign group is enabled for + // A list of the IDs of the applications that this campaign group is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` - // A list of the IDs of the campaigns that this campaign group owns + // A list of the IDs of the campaigns that this campaign group owns. CampaignIds *[]int32 `json:"campaignIds,omitempty"` } diff --git a/model_new_campaign_set.go b/model_new_campaign_set.go index 5b8f5bfe..66995bec 100644 --- a/model_new_campaign_set.go +++ b/model_new_campaign_set.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -18,7 +18,7 @@ import ( type NewCampaignSet struct { // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` - // Version of the campaign set + // Version of the campaign set. Version int32 `json:"version"` Set CampaignSetBranchNode `json:"set"` } diff --git a/model_new_campaign_set_v2.go b/model_new_campaign_set_v2.go new file mode 100644 index 00000000..8c8d7f80 --- /dev/null +++ b/model_new_campaign_set_v2.go @@ -0,0 +1,92 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewCampaignSetV2 +type NewCampaignSetV2 struct { + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` + // Version of the campaign set. + Version int32 `json:"version"` + Set CampaignPrioritiesV2 `json:"set"` +} + +// GetApplicationId returns the ApplicationId field value +func (o *NewCampaignSetV2) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *NewCampaignSetV2) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetVersion returns the Version field value +func (o *NewCampaignSetV2) GetVersion() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Version +} + +// SetVersion sets field value +func (o *NewCampaignSetV2) SetVersion(v int32) { + o.Version = v +} + +// GetSet returns the Set field value +func (o *NewCampaignSetV2) GetSet() CampaignPrioritiesV2 { + if o == nil { + var ret CampaignPrioritiesV2 + return ret + } + + return o.Set +} + +// SetSet sets field value +func (o *NewCampaignSetV2) SetSet(v CampaignPrioritiesV2) { + o.Set = v +} + +type NullableNewCampaignSetV2 struct { + Value NewCampaignSetV2 + ExplicitNull bool +} + +func (v NullableNewCampaignSetV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewCampaignSetV2) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_campaign_template.go b/model_new_campaign_template.go index 8d907960..2f271eb8 100644 --- a/model_new_campaign_template.go +++ b/model_new_campaign_template.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -34,10 +34,14 @@ type NewCampaignTemplate struct { Features *[]string `json:"features,omitempty"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of limits that will operate for this campaign template + // The set of limits that will operate for this campaign template. Limits *[]TemplateLimitConfig `json:"limits,omitempty"` // Template parameters are fields which can be used to replace values in a rule. TemplateParams *[]CampaignTemplateParams `json:"templateParams,omitempty"` + // The campaign collections from the blueprint campaign for the template. + CampaignCollections *[]CampaignTemplateCollection `json:"campaignCollections,omitempty"` + // The default campaignGroupId. + DefaultCampaignGroupId *int32 `json:"defaultCampaignGroupId,omitempty"` } // GetName returns the Name field value @@ -364,6 +368,72 @@ func (o *NewCampaignTemplate) SetTemplateParams(v []CampaignTemplateParams) { o.TemplateParams = &v } +// GetCampaignCollections returns the CampaignCollections field value if set, zero value otherwise. +func (o *NewCampaignTemplate) GetCampaignCollections() []CampaignTemplateCollection { + if o == nil || o.CampaignCollections == nil { + var ret []CampaignTemplateCollection + return ret + } + return *o.CampaignCollections +} + +// GetCampaignCollectionsOk returns a tuple with the CampaignCollections field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaignTemplate) GetCampaignCollectionsOk() ([]CampaignTemplateCollection, bool) { + if o == nil || o.CampaignCollections == nil { + var ret []CampaignTemplateCollection + return ret, false + } + return *o.CampaignCollections, true +} + +// HasCampaignCollections returns a boolean if a field has been set. +func (o *NewCampaignTemplate) HasCampaignCollections() bool { + if o != nil && o.CampaignCollections != nil { + return true + } + + return false +} + +// SetCampaignCollections gets a reference to the given []CampaignTemplateCollection and assigns it to the CampaignCollections field. +func (o *NewCampaignTemplate) SetCampaignCollections(v []CampaignTemplateCollection) { + o.CampaignCollections = &v +} + +// GetDefaultCampaignGroupId returns the DefaultCampaignGroupId field value if set, zero value otherwise. +func (o *NewCampaignTemplate) GetDefaultCampaignGroupId() int32 { + if o == nil || o.DefaultCampaignGroupId == nil { + var ret int32 + return ret + } + return *o.DefaultCampaignGroupId +} + +// GetDefaultCampaignGroupIdOk returns a tuple with the DefaultCampaignGroupId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaignTemplate) GetDefaultCampaignGroupIdOk() (int32, bool) { + if o == nil || o.DefaultCampaignGroupId == nil { + var ret int32 + return ret, false + } + return *o.DefaultCampaignGroupId, true +} + +// HasDefaultCampaignGroupId returns a boolean if a field has been set. +func (o *NewCampaignTemplate) HasDefaultCampaignGroupId() bool { + if o != nil && o.DefaultCampaignGroupId != nil { + return true + } + + return false +} + +// SetDefaultCampaignGroupId gets a reference to the given int32 and assigns it to the DefaultCampaignGroupId field. +func (o *NewCampaignTemplate) SetDefaultCampaignGroupId(v int32) { + o.DefaultCampaignGroupId = &v +} + type NullableNewCampaignTemplate struct { Value NewCampaignTemplate ExplicitNull bool diff --git a/model_new_catalog.go b/model_new_catalog.go new file mode 100644 index 00000000..8abc57ea --- /dev/null +++ b/model_new_catalog.go @@ -0,0 +1,111 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewCatalog +type NewCatalog struct { + // The cart item catalog name. + Name string `json:"name"` + // A description of this cart item catalog. + Description string `json:"description"` + // A list of the IDs of the applications that are subscribed to this catalog. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` +} + +// GetName returns the Name field value +func (o *NewCatalog) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewCatalog) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value +func (o *NewCatalog) GetDescription() string { + if o == nil { + var ret string + return ret + } + + return o.Description +} + +// SetDescription sets field value +func (o *NewCatalog) SetDescription(v string) { + o.Description = v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *NewCatalog) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCatalog) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *NewCatalog) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *NewCatalog) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +type NullableNewCatalog struct { + Value NewCatalog + ExplicitNull bool +} + +func (v NullableNewCatalog) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewCatalog) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_collection.go b/model_new_collection.go index c68762af..65be4cf0 100644 --- a/model_new_collection.go +++ b/model_new_collection.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,27 +14,14 @@ import ( "encoding/json" ) -// NewCollection struct for NewCollection +// NewCollection type NewCollection struct { - // The name of this collection. - Name string `json:"name"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` -} - -// GetName returns the Name field value -func (o *NewCollection) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *NewCollection) SetName(v string) { - o.Name = v + // A list of the IDs of the Applications where this collection is enabled. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // The name of this collection. + Name string `json:"name"` } // GetDescription returns the Description field value if set, zero value otherwise. @@ -70,6 +57,54 @@ func (o *NewCollection) SetDescription(v string) { o.Description = &v } +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *NewCollection) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCollection) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *NewCollection) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *NewCollection) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetName returns the Name field value +func (o *NewCollection) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewCollection) SetName(v string) { + o.Name = v +} + type NullableNewCollection struct { Value NewCollection ExplicitNull bool diff --git a/model_new_coupon_creation_job.go b/model_new_coupon_creation_job.go index 12a7bd8a..dfc24ffb 100644 --- a/model_new_coupon_creation_job.go +++ b/model_new_coupon_creation_job.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // NewCouponCreationJob type NewCouponCreationJob struct { - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -28,7 +28,7 @@ type NewCouponCreationJob struct { // The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. NumberOfCoupons int32 `json:"numberOfCoupons"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` - // Arbitrary properties associated with coupons + // Arbitrary properties associated with coupons. Attributes map[string]interface{} `json:"attributes"` } diff --git a/model_new_coupons.go b/model_new_coupons.go index 36d587e1..b603fcd0 100644 --- a/model_new_coupons.go +++ b/model_new_coupons.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // NewCoupons type NewCoupons struct { - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -25,17 +25,19 @@ type NewCoupons struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. + Limits *[]LimitConfig `json:"limits,omitempty"` // The number of new coupon codes to generate for the campaign. Must be at least 1. NumberOfCoupons int32 `json:"numberOfCoupons"` - // A unique prefix to prepend to all generated coupons. + // **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously endpoint](https://docs.talon.one/management-api/#operation/createCouponsAsync). UniquePrefix *string `json:"uniquePrefix,omitempty"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // The integration ID for this coupon's beneficiary's profile + // The integration ID for this coupon's beneficiary's profile. RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` - // Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + // List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. ValidCharacters *[]string `json:"validCharacters,omitempty"` - // The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + // The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. CouponPattern *string `json:"couponPattern,omitempty"` } @@ -153,6 +155,39 @@ func (o *NewCoupons) SetExpiryDate(v time.Time) { o.ExpiryDate = &v } +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *NewCoupons) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCoupons) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *NewCoupons) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *NewCoupons) SetLimits(v []LimitConfig) { + o.Limits = &v +} + // GetNumberOfCoupons returns the NumberOfCoupons field value func (o *NewCoupons) GetNumberOfCoupons() int32 { if o == nil { diff --git a/model_new_coupons_for_multiple_recipients.go b/model_new_coupons_for_multiple_recipients.go index 791e016e..64c3aa4a 100644 --- a/model_new_coupons_for_multiple_recipients.go +++ b/model_new_coupons_for_multiple_recipients.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // NewCouponsForMultipleRecipients type NewCouponsForMultipleRecipients struct { - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -25,13 +25,13 @@ type NewCouponsForMultipleRecipients struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // The integration IDs for recipients + // The integration IDs for recipients. RecipientsIntegrationIds []string `json:"recipientsIntegrationIds"` - // Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + // List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. ValidCharacters *[]string `json:"validCharacters,omitempty"` - // The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + // The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. CouponPattern *string `json:"couponPattern,omitempty"` } diff --git a/model_new_custom_effect.go b/model_new_custom_effect.go index 44457795..71a07562 100644 --- a/model_new_custom_effect.go +++ b/model_new_custom_effect.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -28,7 +28,7 @@ type NewCustomEffect struct { Description *string `json:"description,omitempty"` // Determines if this effect is active. Enabled bool `json:"enabled"` - // Array of template argument definitions + // Array of template argument definitions. Params *[]TemplateArgDef `json:"params,omitempty"` } diff --git a/model_new_customer_profile.go b/model_new_customer_profile.go index ef642c55..c2557f56 100644 --- a/model_new_customer_profile.go +++ b/model_new_customer_profile.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // NewCustomerProfile struct for NewCustomerProfile type NewCustomerProfile struct { - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` } diff --git a/model_new_customer_session.go b/model_new_customer_session.go index 4404c9ec..704cb68e 100644 --- a/model_new_customer_session.go +++ b/model_new_customer_session.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,17 +16,17 @@ import ( // NewCustomerSession type NewCustomerSession struct { - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId *string `json:"profileId,omitempty"` // Any coupon code entered. Coupon *string `json:"coupon,omitempty"` // Any referral code entered. Referral *string `json:"referral,omitempty"` - // Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entities](/docs/dev/concepts/entities#customer-session). + // Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). State *string `json:"state,omitempty"` // Serialized JSON representation. CartItems *[]CartItem `json:"cartItems,omitempty"` - // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. + // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). Identifiers *[]string `json:"identifiers,omitempty"` // The total sum of the cart in one session. Total *float32 `json:"total,omitempty"` diff --git a/model_new_customer_session_v2.go b/model_new_customer_session_v2.go index bcfb3794..96eb99ba 100644 --- a/model_new_customer_session_v2.go +++ b/model_new_customer_session_v2.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,21 +16,23 @@ import ( // NewCustomerSessionV2 type NewCustomerSessionV2 struct { - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId *string `json:"profileId,omitempty"` - // Any coupon codes entered. + // Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. CouponCodes *[]string `json:"couponCodes,omitempty"` - // Any referral code entered. + // Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. ReferralCode *string `json:"referralCode,omitempty"` - // Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entites](/docs/dev/concepts/entities#customer-session). + // Any loyalty cards used. + LoyaltyCards *[]string `json:"loyaltyCards,omitempty"` + // Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). State *string `json:"state,omitempty"` - // All items the customer will be purchasing in this session + // The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. CartItems *[]CartItem `json:"cartItems,omitempty"` - // Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees. + // Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/). AdditionalCosts *map[string]AdditionalCost `json:"additionalCosts,omitempty"` - // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. + // Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains an identifier by the time you close it. Identifiers *[]string `json:"identifiers,omitempty"` - // A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. + // Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. Attributes *map[string]interface{} `json:"attributes,omitempty"` } @@ -133,6 +135,39 @@ func (o *NewCustomerSessionV2) SetReferralCode(v string) { o.ReferralCode = &v } +// GetLoyaltyCards returns the LoyaltyCards field value if set, zero value otherwise. +func (o *NewCustomerSessionV2) GetLoyaltyCards() []string { + if o == nil || o.LoyaltyCards == nil { + var ret []string + return ret + } + return *o.LoyaltyCards +} + +// GetLoyaltyCardsOk returns a tuple with the LoyaltyCards field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCustomerSessionV2) GetLoyaltyCardsOk() ([]string, bool) { + if o == nil || o.LoyaltyCards == nil { + var ret []string + return ret, false + } + return *o.LoyaltyCards, true +} + +// HasLoyaltyCards returns a boolean if a field has been set. +func (o *NewCustomerSessionV2) HasLoyaltyCards() bool { + if o != nil && o.LoyaltyCards != nil { + return true + } + + return false +} + +// SetLoyaltyCards gets a reference to the given []string and assigns it to the LoyaltyCards field. +func (o *NewCustomerSessionV2) SetLoyaltyCards(v []string) { + o.LoyaltyCards = &v +} + // GetState returns the State field value if set, zero value otherwise. func (o *NewCustomerSessionV2) GetState() string { if o == nil || o.State == nil { diff --git a/model_new_event.go b/model_new_event.go index 4c689a32..a282200e 100644 --- a/model_new_event.go +++ b/model_new_event.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // NewEvent type NewEvent struct { - // ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. + // ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. ProfileId *string `json:"profileId,omitempty"` // A string representing the event. Must not be a reserved event name. Type string `json:"type"` diff --git a/model_new_event_type.go b/model_new_event_type.go index 40a2b248..ba2853c5 100644 --- a/model_new_event_type.go +++ b/model_new_event_type.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,41 +16,12 @@ import ( // NewEventType type NewEventType struct { - // The IDs of the applications that are related to this entity. - ApplicationIds []int32 `json:"applicationIds"` // The human-friendly display name for this event type. Use a short, past-tense, description of the event. Title string `json:"title"` // The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created. Name string `json:"name"` // An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. - Description string `json:"description"` - // This defines how the request payload will be parsed before your handler code is run. - MimeType string `json:"mimeType"` - // It is often helpful to include an example payload with the event type definition for documentation purposes. - ExamplePayload *string `json:"examplePayload,omitempty"` - // It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. - Schema *map[string]interface{} `json:"schema,omitempty"` - // The language of the handler code. Currently only `\"talang\"` is supported. - HandlerLanguage *string `json:"handlerLanguage,omitempty"` - // Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules. - Handler string `json:"handler"` - // The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. - Version int32 `json:"version"` -} - -// GetApplicationIds returns the ApplicationIds field value -func (o *NewEventType) GetApplicationIds() []int32 { - if o == nil { - var ret []int32 - return ret - } - - return o.ApplicationIds -} - -// SetApplicationIds sets field value -func (o *NewEventType) SetApplicationIds(v []int32) { - o.ApplicationIds = v + Description *string `json:"description,omitempty"` } // GetTitle returns the Title field value @@ -83,163 +54,37 @@ func (o *NewEventType) SetName(v string) { o.Name = v } -// GetDescription returns the Description field value +// GetDescription returns the Description field value if set, zero value otherwise. func (o *NewEventType) GetDescription() string { - if o == nil { + if o == nil || o.Description == nil { var ret string return ret } - - return o.Description + return *o.Description } -// SetDescription sets field value -func (o *NewEventType) SetDescription(v string) { - o.Description = v -} - -// GetMimeType returns the MimeType field value -func (o *NewEventType) GetMimeType() string { - if o == nil { - var ret string - return ret - } - - return o.MimeType -} - -// SetMimeType sets field value -func (o *NewEventType) SetMimeType(v string) { - o.MimeType = v -} - -// GetExamplePayload returns the ExamplePayload field value if set, zero value otherwise. -func (o *NewEventType) GetExamplePayload() string { - if o == nil || o.ExamplePayload == nil { - var ret string - return ret - } - return *o.ExamplePayload -} - -// GetExamplePayloadOk returns a tuple with the ExamplePayload field value if set, zero value otherwise +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *NewEventType) GetExamplePayloadOk() (string, bool) { - if o == nil || o.ExamplePayload == nil { +func (o *NewEventType) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { var ret string return ret, false } - return *o.ExamplePayload, true + return *o.Description, true } -// HasExamplePayload returns a boolean if a field has been set. -func (o *NewEventType) HasExamplePayload() bool { - if o != nil && o.ExamplePayload != nil { +// HasDescription returns a boolean if a field has been set. +func (o *NewEventType) HasDescription() bool { + if o != nil && o.Description != nil { return true } return false } -// SetExamplePayload gets a reference to the given string and assigns it to the ExamplePayload field. -func (o *NewEventType) SetExamplePayload(v string) { - o.ExamplePayload = &v -} - -// GetSchema returns the Schema field value if set, zero value otherwise. -func (o *NewEventType) GetSchema() map[string]interface{} { - if o == nil || o.Schema == nil { - var ret map[string]interface{} - return ret - } - return *o.Schema -} - -// GetSchemaOk returns a tuple with the Schema field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *NewEventType) GetSchemaOk() (map[string]interface{}, bool) { - if o == nil || o.Schema == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Schema, true -} - -// HasSchema returns a boolean if a field has been set. -func (o *NewEventType) HasSchema() bool { - if o != nil && o.Schema != nil { - return true - } - - return false -} - -// SetSchema gets a reference to the given map[string]interface{} and assigns it to the Schema field. -func (o *NewEventType) SetSchema(v map[string]interface{}) { - o.Schema = &v -} - -// GetHandlerLanguage returns the HandlerLanguage field value if set, zero value otherwise. -func (o *NewEventType) GetHandlerLanguage() string { - if o == nil || o.HandlerLanguage == nil { - var ret string - return ret - } - return *o.HandlerLanguage -} - -// GetHandlerLanguageOk returns a tuple with the HandlerLanguage field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *NewEventType) GetHandlerLanguageOk() (string, bool) { - if o == nil || o.HandlerLanguage == nil { - var ret string - return ret, false - } - return *o.HandlerLanguage, true -} - -// HasHandlerLanguage returns a boolean if a field has been set. -func (o *NewEventType) HasHandlerLanguage() bool { - if o != nil && o.HandlerLanguage != nil { - return true - } - - return false -} - -// SetHandlerLanguage gets a reference to the given string and assigns it to the HandlerLanguage field. -func (o *NewEventType) SetHandlerLanguage(v string) { - o.HandlerLanguage = &v -} - -// GetHandler returns the Handler field value -func (o *NewEventType) GetHandler() string { - if o == nil { - var ret string - return ret - } - - return o.Handler -} - -// SetHandler sets field value -func (o *NewEventType) SetHandler(v string) { - o.Handler = v -} - -// GetVersion returns the Version field value -func (o *NewEventType) GetVersion() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Version -} - -// SetVersion sets field value -func (o *NewEventType) SetVersion(v int32) { - o.Version = v +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewEventType) SetDescription(v string) { + o.Description = &v } type NullableNewEventType struct { diff --git a/model_new_feature_flags.go b/model_new_feature_flags.go deleted file mode 100644 index 7b629592..00000000 --- a/model_new_feature_flags.go +++ /dev/null @@ -1,147 +0,0 @@ -/* - * Talon.One API - * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put - * - * API version: 1.0.0 - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// NewFeatureFlags struct for NewFeatureFlags -type NewFeatureFlags struct { - // Whether the account has access to the loyalty features or not - Loyalty *bool `json:"loyalty,omitempty"` - // Whether the account queries coupons with or without total result size - CouponsWithoutCount *bool `json:"coupons_without_count,omitempty"` - // Whether the account can test beta effects or not - BetaEffects *bool `json:"betaEffects,omitempty"` -} - -// GetLoyalty returns the Loyalty field value if set, zero value otherwise. -func (o *NewFeatureFlags) GetLoyalty() bool { - if o == nil || o.Loyalty == nil { - var ret bool - return ret - } - return *o.Loyalty -} - -// GetLoyaltyOk returns a tuple with the Loyalty field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *NewFeatureFlags) GetLoyaltyOk() (bool, bool) { - if o == nil || o.Loyalty == nil { - var ret bool - return ret, false - } - return *o.Loyalty, true -} - -// HasLoyalty returns a boolean if a field has been set. -func (o *NewFeatureFlags) HasLoyalty() bool { - if o != nil && o.Loyalty != nil { - return true - } - - return false -} - -// SetLoyalty gets a reference to the given bool and assigns it to the Loyalty field. -func (o *NewFeatureFlags) SetLoyalty(v bool) { - o.Loyalty = &v -} - -// GetCouponsWithoutCount returns the CouponsWithoutCount field value if set, zero value otherwise. -func (o *NewFeatureFlags) GetCouponsWithoutCount() bool { - if o == nil || o.CouponsWithoutCount == nil { - var ret bool - return ret - } - return *o.CouponsWithoutCount -} - -// GetCouponsWithoutCountOk returns a tuple with the CouponsWithoutCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *NewFeatureFlags) GetCouponsWithoutCountOk() (bool, bool) { - if o == nil || o.CouponsWithoutCount == nil { - var ret bool - return ret, false - } - return *o.CouponsWithoutCount, true -} - -// HasCouponsWithoutCount returns a boolean if a field has been set. -func (o *NewFeatureFlags) HasCouponsWithoutCount() bool { - if o != nil && o.CouponsWithoutCount != nil { - return true - } - - return false -} - -// SetCouponsWithoutCount gets a reference to the given bool and assigns it to the CouponsWithoutCount field. -func (o *NewFeatureFlags) SetCouponsWithoutCount(v bool) { - o.CouponsWithoutCount = &v -} - -// GetBetaEffects returns the BetaEffects field value if set, zero value otherwise. -func (o *NewFeatureFlags) GetBetaEffects() bool { - if o == nil || o.BetaEffects == nil { - var ret bool - return ret - } - return *o.BetaEffects -} - -// GetBetaEffectsOk returns a tuple with the BetaEffects field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *NewFeatureFlags) GetBetaEffectsOk() (bool, bool) { - if o == nil || o.BetaEffects == nil { - var ret bool - return ret, false - } - return *o.BetaEffects, true -} - -// HasBetaEffects returns a boolean if a field has been set. -func (o *NewFeatureFlags) HasBetaEffects() bool { - if o != nil && o.BetaEffects != nil { - return true - } - - return false -} - -// SetBetaEffects gets a reference to the given bool and assigns it to the BetaEffects field. -func (o *NewFeatureFlags) SetBetaEffects(v bool) { - o.BetaEffects = &v -} - -type NullableNewFeatureFlags struct { - Value NewFeatureFlags - ExplicitNull bool -} - -func (v NullableNewFeatureFlags) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableNewFeatureFlags) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_new_giveaways_pool.go b/model_new_giveaways_pool.go index b4b34503..4887ac96 100644 --- a/model_new_giveaways_pool.go +++ b/model_new_giveaways_pool.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -20,7 +20,7 @@ type NewGiveawaysPool struct { Name string `json:"name"` // The description of this giveaways pool. Description *string `json:"description,omitempty"` - // A list of the IDs of the applications that this giveaways pool is enabled for + // A list of the IDs of the applications that this giveaways pool is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` } diff --git a/model_new_internal_audience.go b/model_new_internal_audience.go new file mode 100644 index 00000000..4743f86a --- /dev/null +++ b/model_new_internal_audience.go @@ -0,0 +1,129 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewInternalAudience struct for NewInternalAudience +type NewInternalAudience struct { + // The human-friendly display name for this audience. + Name string `json:"name"` + // Indicates if this is a live or sandbox Application. + Sandbox *bool `json:"sandbox,omitempty"` + // A description of the audience. + Description *string `json:"description,omitempty"` +} + +// GetName returns the Name field value +func (o *NewInternalAudience) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewInternalAudience) SetName(v string) { + o.Name = v +} + +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *NewInternalAudience) GetSandbox() bool { + if o == nil || o.Sandbox == nil { + var ret bool + return ret + } + return *o.Sandbox +} + +// GetSandboxOk returns a tuple with the Sandbox field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewInternalAudience) GetSandboxOk() (bool, bool) { + if o == nil || o.Sandbox == nil { + var ret bool + return ret, false + } + return *o.Sandbox, true +} + +// HasSandbox returns a boolean if a field has been set. +func (o *NewInternalAudience) HasSandbox() bool { + if o != nil && o.Sandbox != nil { + return true + } + + return false +} + +// SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +func (o *NewInternalAudience) SetSandbox(v bool) { + o.Sandbox = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewInternalAudience) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewInternalAudience) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewInternalAudience) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewInternalAudience) SetDescription(v string) { + o.Description = &v +} + +type NullableNewInternalAudience struct { + Value NewInternalAudience + ExplicitNull bool +} + +func (v NullableNewInternalAudience) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewInternalAudience) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_invitation.go b/model_new_invitation.go index 7bb62ae8..c3e5a7da 100644 --- a/model_new_invitation.go +++ b/model_new_invitation.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,14 +14,14 @@ import ( "encoding/json" ) -// NewInvitation Parameters for inviting a new user +// NewInvitation Parameters for inviting a new user. type NewInvitation struct { // Name of the user being invited. Name *string `json:"name,omitempty"` Email string `json:"email"` - // a blob of acl json + // The `Access Control List` json defining the role of the user. This represents the actual access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` Acl string `json:"acl"` - // An array of roleIDs to assign the new user to + // An array of roleIDs to assign the new user to. Roles *[]int32 `json:"roles,omitempty"` } diff --git a/model_new_invite_email.go b/model_new_invite_email.go index 240ef4a6..96e63964 100644 --- a/model_new_invite_email.go +++ b/model_new_invite_email.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_loyalty_program.go b/model_new_loyalty_program.go index f7ce804a..a85f44b9 100644 --- a/model_new_loyalty_program.go +++ b/model_new_loyalty_program.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -26,14 +26,18 @@ type NewLoyaltyProgram struct { DefaultValidity string `json:"defaultValidity"` // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. DefaultPending string `json:"defaultPending"` - // Indicates if this program supports subledgers inside the program + // Indicates if this program supports subledgers inside the program. AllowSubledger bool `json:"allowSubledger"` - // A string containing an IANA timezone descriptor. - Timezone *string `json:"timezone,omitempty"` + // The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. + UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` // The internal name for the Loyalty Program. This is an immutable value. Name string `json:"name"` - // The tiers in this loyalty program + // The tiers in this loyalty program. Tiers *[]NewLoyaltyTier `json:"tiers,omitempty"` + // A string containing an IANA timezone descriptor. + Timezone string `json:"timezone"` + // Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. + CardBased bool `json:"cardBased"` } // GetTitle returns the Title field value @@ -162,37 +166,37 @@ func (o *NewLoyaltyProgram) SetAllowSubledger(v bool) { o.AllowSubledger = v } -// GetTimezone returns the Timezone field value if set, zero value otherwise. -func (o *NewLoyaltyProgram) GetTimezone() string { - if o == nil || o.Timezone == nil { - var ret string +// GetUsersPerCardLimit returns the UsersPerCardLimit field value if set, zero value otherwise. +func (o *NewLoyaltyProgram) GetUsersPerCardLimit() int32 { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret } - return *o.Timezone + return *o.UsersPerCardLimit } -// GetTimezoneOk returns a tuple with the Timezone field value if set, zero value otherwise +// GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *NewLoyaltyProgram) GetTimezoneOk() (string, bool) { - if o == nil || o.Timezone == nil { - var ret string +func (o *NewLoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool) { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret, false } - return *o.Timezone, true + return *o.UsersPerCardLimit, true } -// HasTimezone returns a boolean if a field has been set. -func (o *NewLoyaltyProgram) HasTimezone() bool { - if o != nil && o.Timezone != nil { +// HasUsersPerCardLimit returns a boolean if a field has been set. +func (o *NewLoyaltyProgram) HasUsersPerCardLimit() bool { + if o != nil && o.UsersPerCardLimit != nil { return true } return false } -// SetTimezone gets a reference to the given string and assigns it to the Timezone field. -func (o *NewLoyaltyProgram) SetTimezone(v string) { - o.Timezone = &v +// SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +func (o *NewLoyaltyProgram) SetUsersPerCardLimit(v int32) { + o.UsersPerCardLimit = &v } // GetName returns the Name field value @@ -243,6 +247,36 @@ func (o *NewLoyaltyProgram) SetTiers(v []NewLoyaltyTier) { o.Tiers = &v } +// GetTimezone returns the Timezone field value +func (o *NewLoyaltyProgram) GetTimezone() string { + if o == nil { + var ret string + return ret + } + + return o.Timezone +} + +// SetTimezone sets field value +func (o *NewLoyaltyProgram) SetTimezone(v string) { + o.Timezone = v +} + +// GetCardBased returns the CardBased field value +func (o *NewLoyaltyProgram) GetCardBased() bool { + if o == nil { + var ret bool + return ret + } + + return o.CardBased +} + +// SetCardBased sets field value +func (o *NewLoyaltyProgram) SetCardBased(v bool) { + o.CardBased = v +} + type NullableNewLoyaltyProgram struct { Value NewLoyaltyProgram ExplicitNull bool diff --git a/model_new_loyalty_tier.go b/model_new_loyalty_tier.go index 742c84d9..837c9a30 100644 --- a/model_new_loyalty_tier.go +++ b/model_new_loyalty_tier.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,11 +14,11 @@ import ( "encoding/json" ) -// NewLoyaltyTier A tier in a loyalty program +// NewLoyaltyTier A tier in a loyalty program. type NewLoyaltyTier struct { // The name of the tier Name string `json:"name"` - // The minimum amount of points required to be eligible for the tier + // The minimum amount of points required to be eligible for the tier. MinPoints float32 `json:"minPoints"` } diff --git a/model_new_management_key.go b/model_new_management_key.go new file mode 100644 index 00000000..93a951d7 --- /dev/null +++ b/model_new_management_key.go @@ -0,0 +1,179 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// NewManagementKey +type NewManagementKey struct { + // Name for management key. + Name string `json:"name"` + // The date the management key expires. + ExpiryDate time.Time `json:"expiryDate"` + // The list of endpoints that can be accessed with the key + Endpoints []Endpoint `json:"endpoints"` + // ID of the management key. + Id int32 `json:"id"` + // ID of the user who created it. + CreatedBy int32 `json:"createdBy"` + // ID of account the key is used for. + AccountID int32 `json:"accountID"` + // The date the management key was created. + Created time.Time `json:"created"` + // The management key. + Key string `json:"key"` +} + +// GetName returns the Name field value +func (o *NewManagementKey) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewManagementKey) SetName(v string) { + o.Name = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *NewManagementKey) GetExpiryDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *NewManagementKey) SetExpiryDate(v time.Time) { + o.ExpiryDate = v +} + +// GetEndpoints returns the Endpoints field value +func (o *NewManagementKey) GetEndpoints() []Endpoint { + if o == nil { + var ret []Endpoint + return ret + } + + return o.Endpoints +} + +// SetEndpoints sets field value +func (o *NewManagementKey) SetEndpoints(v []Endpoint) { + o.Endpoints = v +} + +// GetId returns the Id field value +func (o *NewManagementKey) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *NewManagementKey) SetId(v int32) { + o.Id = v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *NewManagementKey) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *NewManagementKey) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetAccountID returns the AccountID field value +func (o *NewManagementKey) GetAccountID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountID +} + +// SetAccountID sets field value +func (o *NewManagementKey) SetAccountID(v int32) { + o.AccountID = v +} + +// GetCreated returns the Created field value +func (o *NewManagementKey) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *NewManagementKey) SetCreated(v time.Time) { + o.Created = v +} + +// GetKey returns the Key field value +func (o *NewManagementKey) GetKey() string { + if o == nil { + var ret string + return ret + } + + return o.Key +} + +// SetKey sets field value +func (o *NewManagementKey) SetKey(v string) { + o.Key = v +} + +type NullableNewManagementKey struct { + Value NewManagementKey + ExplicitNull bool +} + +func (v NullableNewManagementKey) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewManagementKey) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_multiple_audiences_item.go b/model_new_multiple_audiences_item.go new file mode 100644 index 00000000..3c14f740 --- /dev/null +++ b/model_new_multiple_audiences_item.go @@ -0,0 +1,94 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewMultipleAudiencesItem +type NewMultipleAudiencesItem struct { + // The human-friendly display name for this audience. + Name string `json:"name"` + // The ID of this audience in the third-party integration. + IntegrationId *string `json:"integrationId,omitempty"` +} + +// GetName returns the Name field value +func (o *NewMultipleAudiencesItem) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewMultipleAudiencesItem) SetName(v string) { + o.Name = v +} + +// GetIntegrationId returns the IntegrationId field value if set, zero value otherwise. +func (o *NewMultipleAudiencesItem) GetIntegrationId() string { + if o == nil || o.IntegrationId == nil { + var ret string + return ret + } + return *o.IntegrationId +} + +// GetIntegrationIdOk returns a tuple with the IntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewMultipleAudiencesItem) GetIntegrationIdOk() (string, bool) { + if o == nil || o.IntegrationId == nil { + var ret string + return ret, false + } + return *o.IntegrationId, true +} + +// HasIntegrationId returns a boolean if a field has been set. +func (o *NewMultipleAudiencesItem) HasIntegrationId() bool { + if o != nil && o.IntegrationId != nil { + return true + } + + return false +} + +// SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. +func (o *NewMultipleAudiencesItem) SetIntegrationId(v string) { + o.IntegrationId = &v +} + +type NullableNewMultipleAudiencesItem struct { + Value NewMultipleAudiencesItem + ExplicitNull bool +} + +func (v NullableNewMultipleAudiencesItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewMultipleAudiencesItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_notification_webhook.go b/model_new_notification_webhook.go new file mode 100644 index 00000000..cdfcab8e --- /dev/null +++ b/model_new_notification_webhook.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewNotificationWebhook struct for NewNotificationWebhook +type NewNotificationWebhook struct { + // API url for this notification webhook. + Url string `json:"url"` + // List of API HTTP headers for this notification webhook. + Headers []string `json:"headers"` +} + +// GetUrl returns the Url field value +func (o *NewNotificationWebhook) GetUrl() string { + if o == nil { + var ret string + return ret + } + + return o.Url +} + +// SetUrl sets field value +func (o *NewNotificationWebhook) SetUrl(v string) { + o.Url = v +} + +// GetHeaders returns the Headers field value +func (o *NewNotificationWebhook) GetHeaders() []string { + if o == nil { + var ret []string + return ret + } + + return o.Headers +} + +// SetHeaders sets field value +func (o *NewNotificationWebhook) SetHeaders(v []string) { + o.Headers = v +} + +type NullableNewNotificationWebhook struct { + Value NewNotificationWebhook + ExplicitNull bool +} + +func (v NullableNewNotificationWebhook) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewNotificationWebhook) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_password.go b/model_new_password.go index 33b90d5a..5e0d9ee2 100644 --- a/model_new_password.go +++ b/model_new_password.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_password_email.go b/model_new_password_email.go index 6e1e8cab..16f119cb 100644 --- a/model_new_password_email.go +++ b/model_new_password_email.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_referral.go b/model_new_referral.go index 72b1b6a7..b9e37949 100644 --- a/model_new_referral.go +++ b/model_new_referral.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -21,13 +21,13 @@ type NewReferral struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` // ID of the campaign from which the referral received the referral code. CampaignId int32 `json:"campaignId"` // The Integration ID of the Advocate's Profile. AdvocateProfileIntegrationId string `json:"advocateProfileIntegrationId"` - // An optional Integration ID of the Friend's Profile + // An optional Integration ID of the Friend's Profile. FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` diff --git a/model_new_referrals_for_multiple_advocates.go b/model_new_referrals_for_multiple_advocates.go index 85f0e5a1..357c9cb4 100644 --- a/model_new_referrals_for_multiple_advocates.go +++ b/model_new_referrals_for_multiple_advocates.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -21,7 +21,7 @@ type NewReferralsForMultipleAdvocates struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // The ID of the campaign from which the referral received the referral code. CampaignId int32 `json:"campaignId"` @@ -29,9 +29,9 @@ type NewReferralsForMultipleAdvocates struct { AdvocateProfileIntegrationIds []string `json:"advocateProfileIntegrationIds"` // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + // List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. ValidCharacters *[]string `json:"validCharacters,omitempty"` - // The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + // The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. ReferralPattern *string `json:"referralPattern,omitempty"` } diff --git a/model_new_return.go b/model_new_return.go new file mode 100644 index 00000000..ed6608a9 --- /dev/null +++ b/model_new_return.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewReturn struct for NewReturn +type NewReturn struct { + // List of cart items to be returned. + ReturnedCartItems []ReturnedCartItem `json:"returnedCartItems"` +} + +// GetReturnedCartItems returns the ReturnedCartItems field value +func (o *NewReturn) GetReturnedCartItems() []ReturnedCartItem { + if o == nil { + var ret []ReturnedCartItem + return ret + } + + return o.ReturnedCartItems +} + +// SetReturnedCartItems sets field value +func (o *NewReturn) SetReturnedCartItems(v []ReturnedCartItem) { + o.ReturnedCartItems = v +} + +type NullableNewReturn struct { + Value NewReturn + ExplicitNull bool +} + +func (v NullableNewReturn) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewReturn) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_role.go b/model_new_role.go index 9d40590e..90a07e11 100644 --- a/model_new_role.go +++ b/model_new_role.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,13 +16,13 @@ import ( // NewRole type NewRole struct { - // Name of the role + // Name of the role. Name string `json:"name"` - // Description of the role + // Description of the role. Description *string `json:"description,omitempty"` - // Role Policy this should be a stringified blob of json + // Role Policy this should be a stringified blob of json. Acl string `json:"acl"` - // An array of user identifiers + // An array of user identifiers. Members []int32 `json:"members"` } diff --git a/model_new_ruleset.go b/model_new_ruleset.go index d58dfd3b..395f1b2d 100644 --- a/model_new_ruleset.go +++ b/model_new_ruleset.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -20,9 +20,9 @@ type NewRuleset struct { Rules []Rule `json:"rules"` // An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. Bindings []Binding `json:"bindings"` - // A string indicating which version of the rulebuilder was used to create this ruleset. + // The version of the rulebuilder used to create this ruleset. RbVersion *string `json:"rbVersion,omitempty"` - // A boolean indicating whether this newly created ruleset should also be activated for the campaign that owns it + // Indicates whether this created ruleset should be activated for the campaign that owns it. Activate *bool `json:"activate,omitempty"` } diff --git a/model_new_saml_connection.go b/model_new_saml_connection.go index 16a54445..7c076a47 100644 --- a/model_new_saml_connection.go +++ b/model_new_saml_connection.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_template_def.go b/model_new_template_def.go index d8365bf1..9faaf0c5 100644 --- a/model_new_template_def.go +++ b/model_new_template_def.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_user.go b/model_new_user.go index 3868696f..4a9f8792 100644 --- a/model_new_user.go +++ b/model_new_user.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_new_webhook.go b/model_new_webhook.go index f2346338..c791a538 100644 --- a/model_new_webhook.go +++ b/model_new_webhook.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -18,19 +18,19 @@ import ( type NewWebhook struct { // The IDs of the applications that are related to this entity. ApplicationIds []int32 `json:"applicationIds"` - // Friendly title for this webhook + // Friendly title for this webhook. Title string `json:"title"` - // API method for this webhook + // API method for this webhook. Verb string `json:"verb"` - // API url (supports templating using parameters) for this webhook + // API url (supports templating using parameters) for this webhook. Url string `json:"url"` - // List of API HTTP headers for this webhook + // List of API HTTP headers for this webhook. Headers []string `json:"headers"` - // API payload (supports templating using parameters) for this webhook + // API payload (supports templating using parameters) for this webhook. Payload *string `json:"payload,omitempty"` - // Array of template argument definitions + // Array of template argument definitions. Params []TemplateArgDef `json:"params"` - // Enables or disables webhook from showing in rule builder + // Enables or disables webhook from showing in rule builder. Enabled bool `json:"enabled"` } diff --git a/model_notification.go b/model_notification.go index ac0a605a..517475db 100644 --- a/model_notification.go +++ b/model_notification.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,11 +16,11 @@ import ( // Notification struct for Notification type Notification struct { - // id of the notification + // id of the notification. Id int32 `json:"id"` - // name of the notification + // name of the notification. Name string `json:"name"` - // description of the notification + // description of the notification. Description string `json:"description"` } diff --git a/model_notification_webhook.go b/model_notification_webhook.go new file mode 100644 index 00000000..1af0de9a --- /dev/null +++ b/model_notification_webhook.go @@ -0,0 +1,145 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// NotificationWebhook +type NotificationWebhook struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` + // API url for this notification webhook. + Url string `json:"url"` + // List of API HTTP headers for this notification webhook. + Headers []string `json:"headers"` +} + +// GetId returns the Id field value +func (o *NotificationWebhook) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *NotificationWebhook) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *NotificationWebhook) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *NotificationWebhook) SetCreated(v time.Time) { + o.Created = v +} + +// GetModified returns the Modified field value +func (o *NotificationWebhook) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *NotificationWebhook) SetModified(v time.Time) { + o.Modified = v +} + +// GetApplicationId returns the ApplicationId field value +func (o *NotificationWebhook) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *NotificationWebhook) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetUrl returns the Url field value +func (o *NotificationWebhook) GetUrl() string { + if o == nil { + var ret string + return ret + } + + return o.Url +} + +// SetUrl sets field value +func (o *NotificationWebhook) SetUrl(v string) { + o.Url = v +} + +// GetHeaders returns the Headers field value +func (o *NotificationWebhook) GetHeaders() []string { + if o == nil { + var ret []string + return ret + } + + return o.Headers +} + +// SetHeaders sets field value +func (o *NotificationWebhook) SetHeaders(v []string) { + o.Headers = v +} + +type NullableNotificationWebhook struct { + Value NotificationWebhook + ExplicitNull bool +} + +func (v NullableNotificationWebhook) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNotificationWebhook) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_patch_item_catalog_action.go b/model_patch_item_catalog_action.go new file mode 100644 index 00000000..c0a934b8 --- /dev/null +++ b/model_patch_item_catalog_action.go @@ -0,0 +1,164 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// PatchItemCatalogAction The specific properties of the \"PATCH\" catalog sync action. +type PatchItemCatalogAction struct { + // The unique SKU of the item to patch. + Sku string `json:"sku"` + // Price of the item. + Price *float32 `json:"price,omitempty"` + // The attributes of the item to patch. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Indicates whether to create an item if the SKU does not exist. + CreateIfNotExists *bool `json:"createIfNotExists,omitempty"` +} + +// GetSku returns the Sku field value +func (o *PatchItemCatalogAction) GetSku() string { + if o == nil { + var ret string + return ret + } + + return o.Sku +} + +// SetSku sets field value +func (o *PatchItemCatalogAction) SetSku(v string) { + o.Sku = v +} + +// GetPrice returns the Price field value if set, zero value otherwise. +func (o *PatchItemCatalogAction) GetPrice() float32 { + if o == nil || o.Price == nil { + var ret float32 + return ret + } + return *o.Price +} + +// GetPriceOk returns a tuple with the Price field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *PatchItemCatalogAction) GetPriceOk() (float32, bool) { + if o == nil || o.Price == nil { + var ret float32 + return ret, false + } + return *o.Price, true +} + +// HasPrice returns a boolean if a field has been set. +func (o *PatchItemCatalogAction) HasPrice() bool { + if o != nil && o.Price != nil { + return true + } + + return false +} + +// SetPrice gets a reference to the given float32 and assigns it to the Price field. +func (o *PatchItemCatalogAction) SetPrice(v float32) { + o.Price = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *PatchItemCatalogAction) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *PatchItemCatalogAction) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *PatchItemCatalogAction) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *PatchItemCatalogAction) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetCreateIfNotExists returns the CreateIfNotExists field value if set, zero value otherwise. +func (o *PatchItemCatalogAction) GetCreateIfNotExists() bool { + if o == nil || o.CreateIfNotExists == nil { + var ret bool + return ret + } + return *o.CreateIfNotExists +} + +// GetCreateIfNotExistsOk returns a tuple with the CreateIfNotExists field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *PatchItemCatalogAction) GetCreateIfNotExistsOk() (bool, bool) { + if o == nil || o.CreateIfNotExists == nil { + var ret bool + return ret, false + } + return *o.CreateIfNotExists, true +} + +// HasCreateIfNotExists returns a boolean if a field has been set. +func (o *PatchItemCatalogAction) HasCreateIfNotExists() bool { + if o != nil && o.CreateIfNotExists != nil { + return true + } + + return false +} + +// SetCreateIfNotExists gets a reference to the given bool and assigns it to the CreateIfNotExists field. +func (o *PatchItemCatalogAction) SetCreateIfNotExists(v bool) { + o.CreateIfNotExists = &v +} + +type NullablePatchItemCatalogAction struct { + Value PatchItemCatalogAction + ExplicitNull bool +} + +func (v NullablePatchItemCatalogAction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullablePatchItemCatalogAction) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_patch_many_items_catalog_action.go b/model_patch_many_items_catalog_action.go new file mode 100644 index 00000000..6b02d00a --- /dev/null +++ b/model_patch_many_items_catalog_action.go @@ -0,0 +1,147 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// PatchManyItemsCatalogAction The specific properties of the \"PATCH_MANY\" catalog sync action. +type PatchManyItemsCatalogAction struct { + // Price of the item. + Price *float32 `json:"price,omitempty"` + // The list of filters used to select the items to patch, joined by `AND`. **Note:** Every item in the catalog will be modified if there are no filters. + Filters *[]CatalogActionFilter `json:"filters,omitempty"` + // The attributes of the items to patch. + Attributes *map[string]interface{} `json:"attributes,omitempty"` +} + +// GetPrice returns the Price field value if set, zero value otherwise. +func (o *PatchManyItemsCatalogAction) GetPrice() float32 { + if o == nil || o.Price == nil { + var ret float32 + return ret + } + return *o.Price +} + +// GetPriceOk returns a tuple with the Price field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *PatchManyItemsCatalogAction) GetPriceOk() (float32, bool) { + if o == nil || o.Price == nil { + var ret float32 + return ret, false + } + return *o.Price, true +} + +// HasPrice returns a boolean if a field has been set. +func (o *PatchManyItemsCatalogAction) HasPrice() bool { + if o != nil && o.Price != nil { + return true + } + + return false +} + +// SetPrice gets a reference to the given float32 and assigns it to the Price field. +func (o *PatchManyItemsCatalogAction) SetPrice(v float32) { + o.Price = &v +} + +// GetFilters returns the Filters field value if set, zero value otherwise. +func (o *PatchManyItemsCatalogAction) GetFilters() []CatalogActionFilter { + if o == nil || o.Filters == nil { + var ret []CatalogActionFilter + return ret + } + return *o.Filters +} + +// GetFiltersOk returns a tuple with the Filters field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *PatchManyItemsCatalogAction) GetFiltersOk() ([]CatalogActionFilter, bool) { + if o == nil || o.Filters == nil { + var ret []CatalogActionFilter + return ret, false + } + return *o.Filters, true +} + +// HasFilters returns a boolean if a field has been set. +func (o *PatchManyItemsCatalogAction) HasFilters() bool { + if o != nil && o.Filters != nil { + return true + } + + return false +} + +// SetFilters gets a reference to the given []CatalogActionFilter and assigns it to the Filters field. +func (o *PatchManyItemsCatalogAction) SetFilters(v []CatalogActionFilter) { + o.Filters = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *PatchManyItemsCatalogAction) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *PatchManyItemsCatalogAction) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *PatchManyItemsCatalogAction) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *PatchManyItemsCatalogAction) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +type NullablePatchManyItemsCatalogAction struct { + Value PatchManyItemsCatalogAction + ExplicitNull bool +} + +func (v NullablePatchManyItemsCatalogAction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullablePatchManyItemsCatalogAction) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_profile_audiences_changes.go b/model_profile_audiences_changes.go index fb1b6e8c..7bd2c379 100644 --- a/model_profile_audiences_changes.go +++ b/model_profile_audiences_changes.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_redeem_referral_effect_props.go b/model_redeem_referral_effect_props.go index 7370811b..38be5889 100644 --- a/model_redeem_referral_effect_props.go +++ b/model_redeem_referral_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,11 +14,11 @@ import ( "encoding/json" ) -// RedeemReferralEffectProps The properties specific to the \"redeemReferral\" effect. This gets triggered whenever the referral code is valid, and a rule was triggered that contains a \"redeem referral\" effect. +// RedeemReferralEffectProps This effect is **deprecated**. The properties specific to the \"redeemReferral\" effect. This gets triggered whenever the referral code is valid, and a rule was triggered that contains a \"redeem referral\" effect. type RedeemReferralEffectProps struct { - // The id of the referral code that was redeemed + // The id of the referral code that was redeemed. Id int32 `json:"id"` - // The referral code that was redeemed + // The referral code that was redeemed. Value string `json:"value"` } diff --git a/model_referral.go b/model_referral.go index 526c3e59..e466bcf0 100644 --- a/model_referral.go +++ b/model_referral.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Referral type Referral struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -25,19 +25,19 @@ type Referral struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` // ID of the campaign from which the referral received the referral code. CampaignId int32 `json:"campaignId"` // The Integration ID of the Advocate's Profile. AdvocateProfileIntegrationId string `json:"advocateProfileIntegrationId"` - // An optional Integration ID of the Friend's Profile + // An optional Integration ID of the Friend's Profile. FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` // The ID of the Import which created this referral. ImportId *int32 `json:"importId,omitempty"` - // The actual referral code. + // The referral code. Code string `json:"code"` // The number of times this referral code has been successfully used. UsageCounter int32 `json:"usageCounter"` diff --git a/model_referral_constraints.go b/model_referral_constraints.go index 0da69966..3afac68a 100644 --- a/model_referral_constraints.go +++ b/model_referral_constraints.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -21,7 +21,7 @@ type ReferralConstraints struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` } diff --git a/model_referral_created_effect_props.go b/model_referral_created_effect_props.go index 97b1c0ae..0fa1fe51 100644 --- a/model_referral_created_effect_props.go +++ b/model_referral_created_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // ReferralCreatedEffectProps The properties specific to the \"referralCreated\" effect. This gets triggered whenever a validated rule contained a \"create referral\" effect, and a referral code was created for a customer. See \"createdReferrals\" on the response for all details of this referral code. type ReferralCreatedEffectProps struct { - // The referral code that was created + // The referral code that was created. Value string `json:"value"` } diff --git a/model_referral_rejection_reason.go b/model_referral_rejection_reason.go index c61630d7..72048547 100644 --- a/model_referral_rejection_reason.go +++ b/model_referral_rejection_reason.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_reject_coupon_effect_props.go b/model_reject_coupon_effect_props.go index b37d7cfc..08ce29bf 100644 --- a/model_reject_coupon_effect_props.go +++ b/model_reject_coupon_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,15 +16,15 @@ import ( // RejectCouponEffectProps The properties specific to the \"rejectCoupon\" effect. This gets triggered whenever the coupon was rejected. See rejectionReason for more info on why. type RejectCouponEffectProps struct { - // The coupon code that was rejected + // The coupon code that was rejected. Value string `json:"value"` - // The reason why this coupon was rejected + // The reason why this coupon was rejected. RejectionReason string `json:"rejectionReason"` - // The index of the condition that caused the rejection of the coupon + // The index of the condition that caused the rejection of the coupon. ConditionIndex *int32 `json:"conditionIndex,omitempty"` - // The index of the effect that caused the rejection of the coupon + // The index of the effect that caused the rejection of the coupon. EffectIndex *int32 `json:"effectIndex,omitempty"` - // More details about the failure + // More details about the failure. Details *string `json:"details,omitempty"` } diff --git a/model_reject_referral_effect_props.go b/model_reject_referral_effect_props.go index 3bfa91d5..fbfc71a3 100644 --- a/model_reject_referral_effect_props.go +++ b/model_reject_referral_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,15 +16,15 @@ import ( // RejectReferralEffectProps The properties specific to the \"rejectReferral\" effect. This gets triggered whenever the referral code was rejected. See rejectionReason for more info on why. type RejectReferralEffectProps struct { - // The referral code that was rejected + // The referral code that was rejected. Value string `json:"value"` - // The reason why this referral code was rejected + // The reason why this referral code was rejected. RejectionReason string `json:"rejectionReason"` - // The index of the condition that caused the rejection of the referral + // The index of the condition that caused the rejection of the referral. ConditionIndex *int32 `json:"conditionIndex,omitempty"` - // The index of the effect that caused the rejection of the referral + // The index of the effect that caused the rejection of the referral. EffectIndex *int32 `json:"effectIndex,omitempty"` - // More details about the failure + // More details about the failure. Details *string `json:"details,omitempty"` } diff --git a/model_remove_item_catalog_action.go b/model_remove_item_catalog_action.go new file mode 100644 index 00000000..03ca3def --- /dev/null +++ b/model_remove_item_catalog_action.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RemoveItemCatalogAction The specific properties of the \"REMOVE\" catalog sync action. +type RemoveItemCatalogAction struct { + // The unique SKU of the item to remove. + Sku string `json:"sku"` +} + +// GetSku returns the Sku field value +func (o *RemoveItemCatalogAction) GetSku() string { + if o == nil { + var ret string + return ret + } + + return o.Sku +} + +// SetSku sets field value +func (o *RemoveItemCatalogAction) SetSku(v string) { + o.Sku = v +} + +type NullableRemoveItemCatalogAction struct { + Value RemoveItemCatalogAction + ExplicitNull bool +} + +func (v NullableRemoveItemCatalogAction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRemoveItemCatalogAction) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_remove_many_items_catalog_action.go b/model_remove_many_items_catalog_action.go new file mode 100644 index 00000000..04df4a04 --- /dev/null +++ b/model_remove_many_items_catalog_action.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RemoveManyItemsCatalogAction The specific properties of the \"REMOVE_MANY\" catalog sync action. +type RemoveManyItemsCatalogAction struct { + // The list of filters used to select the items to patch, joined by `AND`. **Note:** Every item in the catalog will be removed if there are no filters. + Filters *[]CatalogActionFilter `json:"filters,omitempty"` +} + +// GetFilters returns the Filters field value if set, zero value otherwise. +func (o *RemoveManyItemsCatalogAction) GetFilters() []CatalogActionFilter { + if o == nil || o.Filters == nil { + var ret []CatalogActionFilter + return ret + } + return *o.Filters +} + +// GetFiltersOk returns a tuple with the Filters field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RemoveManyItemsCatalogAction) GetFiltersOk() ([]CatalogActionFilter, bool) { + if o == nil || o.Filters == nil { + var ret []CatalogActionFilter + return ret, false + } + return *o.Filters, true +} + +// HasFilters returns a boolean if a field has been set. +func (o *RemoveManyItemsCatalogAction) HasFilters() bool { + if o != nil && o.Filters != nil { + return true + } + + return false +} + +// SetFilters gets a reference to the given []CatalogActionFilter and assigns it to the Filters field. +func (o *RemoveManyItemsCatalogAction) SetFilters(v []CatalogActionFilter) { + o.Filters = &v +} + +type NullableRemoveManyItemsCatalogAction struct { + Value RemoveManyItemsCatalogAction + ExplicitNull bool +} + +func (v NullableRemoveManyItemsCatalogAction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRemoveManyItemsCatalogAction) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_return.go b/model_return.go new file mode 100644 index 00000000..bbec2cbe --- /dev/null +++ b/model_return.go @@ -0,0 +1,284 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// Return +type Return struct { + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // List of cart items to be returned. + ReturnedCartItems []ReturnedCartItem `json:"returnedCartItems"` + // The event ID of that was generated for this return. + EventId int32 `json:"eventId"` + // The internal ID of the session this return was requested on. + SessionId int32 `json:"sessionId"` + // The integration ID of the session this return was requested on. + SessionIntegrationId string `json:"sessionIntegrationId"` + // The internal ID of the profile this return was requested on. + ProfileId *int32 `json:"profileId,omitempty"` + // The integration ID of the profile this return was requested on. + ProfileIntegrationId *string `json:"profileIntegrationId,omitempty"` + // ID of the user who requested this return. + CreatedBy *int32 `json:"createdBy,omitempty"` +} + +// GetId returns the Id field value +func (o *Return) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *Return) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *Return) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Return) SetCreated(v time.Time) { + o.Created = v +} + +// GetApplicationId returns the ApplicationId field value +func (o *Return) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *Return) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetAccountId returns the AccountId field value +func (o *Return) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *Return) SetAccountId(v int32) { + o.AccountId = v +} + +// GetReturnedCartItems returns the ReturnedCartItems field value +func (o *Return) GetReturnedCartItems() []ReturnedCartItem { + if o == nil { + var ret []ReturnedCartItem + return ret + } + + return o.ReturnedCartItems +} + +// SetReturnedCartItems sets field value +func (o *Return) SetReturnedCartItems(v []ReturnedCartItem) { + o.ReturnedCartItems = v +} + +// GetEventId returns the EventId field value +func (o *Return) GetEventId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.EventId +} + +// SetEventId sets field value +func (o *Return) SetEventId(v int32) { + o.EventId = v +} + +// GetSessionId returns the SessionId field value +func (o *Return) GetSessionId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.SessionId +} + +// SetSessionId sets field value +func (o *Return) SetSessionId(v int32) { + o.SessionId = v +} + +// GetSessionIntegrationId returns the SessionIntegrationId field value +func (o *Return) GetSessionIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.SessionIntegrationId +} + +// SetSessionIntegrationId sets field value +func (o *Return) SetSessionIntegrationId(v string) { + o.SessionIntegrationId = v +} + +// GetProfileId returns the ProfileId field value if set, zero value otherwise. +func (o *Return) GetProfileId() int32 { + if o == nil || o.ProfileId == nil { + var ret int32 + return ret + } + return *o.ProfileId +} + +// GetProfileIdOk returns a tuple with the ProfileId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Return) GetProfileIdOk() (int32, bool) { + if o == nil || o.ProfileId == nil { + var ret int32 + return ret, false + } + return *o.ProfileId, true +} + +// HasProfileId returns a boolean if a field has been set. +func (o *Return) HasProfileId() bool { + if o != nil && o.ProfileId != nil { + return true + } + + return false +} + +// SetProfileId gets a reference to the given int32 and assigns it to the ProfileId field. +func (o *Return) SetProfileId(v int32) { + o.ProfileId = &v +} + +// GetProfileIntegrationId returns the ProfileIntegrationId field value if set, zero value otherwise. +func (o *Return) GetProfileIntegrationId() string { + if o == nil || o.ProfileIntegrationId == nil { + var ret string + return ret + } + return *o.ProfileIntegrationId +} + +// GetProfileIntegrationIdOk returns a tuple with the ProfileIntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Return) GetProfileIntegrationIdOk() (string, bool) { + if o == nil || o.ProfileIntegrationId == nil { + var ret string + return ret, false + } + return *o.ProfileIntegrationId, true +} + +// HasProfileIntegrationId returns a boolean if a field has been set. +func (o *Return) HasProfileIntegrationId() bool { + if o != nil && o.ProfileIntegrationId != nil { + return true + } + + return false +} + +// SetProfileIntegrationId gets a reference to the given string and assigns it to the ProfileIntegrationId field. +func (o *Return) SetProfileIntegrationId(v string) { + o.ProfileIntegrationId = &v +} + +// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. +func (o *Return) GetCreatedBy() int32 { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret + } + return *o.CreatedBy +} + +// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Return) GetCreatedByOk() (int32, bool) { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret, false + } + return *o.CreatedBy, true +} + +// HasCreatedBy returns a boolean if a field has been set. +func (o *Return) HasCreatedBy() bool { + if o != nil && o.CreatedBy != nil { + return true + } + + return false +} + +// SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. +func (o *Return) SetCreatedBy(v int32) { + o.CreatedBy = &v +} + +type NullableReturn struct { + Value Return + ExplicitNull bool +} + +func (v NullableReturn) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableReturn) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_return_integration_request.go b/model_return_integration_request.go new file mode 100644 index 00000000..ecc2bddb --- /dev/null +++ b/model_return_integration_request.go @@ -0,0 +1,93 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ReturnIntegrationRequest The body of a return integration API request. Next to the cart items details, this contains an optional listing of extra properties that should be returned in the response. +type ReturnIntegrationRequest struct { + Return NewReturn `json:"return"` + // Optional list of extra data that you want to get in the response. Use this property to get as much data as you need in one request instead of sending extra requests to other endpoints. **Note:** `ruleFailureReasons` is always part of the response when the [Application type](https://docs.talon.one/docs/product/applications/overview#application-types) is `sandbox`. + ResponseContent *[]string `json:"responseContent,omitempty"` +} + +// GetReturn returns the Return field value +func (o *ReturnIntegrationRequest) GetReturn() NewReturn { + if o == nil { + var ret NewReturn + return ret + } + + return o.Return +} + +// SetReturn sets field value +func (o *ReturnIntegrationRequest) SetReturn(v NewReturn) { + o.Return = v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *ReturnIntegrationRequest) GetResponseContent() []string { + if o == nil || o.ResponseContent == nil { + var ret []string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ReturnIntegrationRequest) GetResponseContentOk() ([]string, bool) { + if o == nil || o.ResponseContent == nil { + var ret []string + return ret, false + } + return *o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *ReturnIntegrationRequest) HasResponseContent() bool { + if o != nil && o.ResponseContent != nil { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given []string and assigns it to the ResponseContent field. +func (o *ReturnIntegrationRequest) SetResponseContent(v []string) { + o.ResponseContent = &v +} + +type NullableReturnIntegrationRequest struct { + Value ReturnIntegrationRequest + ExplicitNull bool +} + +func (v NullableReturnIntegrationRequest) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableReturnIntegrationRequest) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_returned_cart_item.go b/model_returned_cart_item.go new file mode 100644 index 00000000..4dc864b6 --- /dev/null +++ b/model_returned_cart_item.go @@ -0,0 +1,94 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ReturnedCartItem struct for ReturnedCartItem +type ReturnedCartItem struct { + // The index of the cart item in the provided customer session's `cartItems` property. + Position int32 `json:"position"` + // Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. + Quantity *int32 `json:"quantity,omitempty"` +} + +// GetPosition returns the Position field value +func (o *ReturnedCartItem) GetPosition() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Position +} + +// SetPosition sets field value +func (o *ReturnedCartItem) SetPosition(v int32) { + o.Position = v +} + +// GetQuantity returns the Quantity field value if set, zero value otherwise. +func (o *ReturnedCartItem) GetQuantity() int32 { + if o == nil || o.Quantity == nil { + var ret int32 + return ret + } + return *o.Quantity +} + +// GetQuantityOk returns a tuple with the Quantity field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ReturnedCartItem) GetQuantityOk() (int32, bool) { + if o == nil || o.Quantity == nil { + var ret int32 + return ret, false + } + return *o.Quantity, true +} + +// HasQuantity returns a boolean if a field has been set. +func (o *ReturnedCartItem) HasQuantity() bool { + if o != nil && o.Quantity != nil { + return true + } + + return false +} + +// SetQuantity gets a reference to the given int32 and assigns it to the Quantity field. +func (o *ReturnedCartItem) SetQuantity(v int32) { + o.Quantity = &v +} + +type NullableReturnedCartItem struct { + Value ReturnedCartItem + ExplicitNull bool +} + +func (v NullableReturnedCartItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableReturnedCartItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_role.go b/model_role.go index 99139db8..23e4d10e 100644 --- a/model_role.go +++ b/model_role.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Role type Role struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -25,15 +25,15 @@ type Role struct { Modified time.Time `json:"modified"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // The ID of the Campaign Group this role was created for. + // The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this role was created for. CampaignGroupID *int32 `json:"campaignGroupID,omitempty"` - // Name of the role + // Name of the role. Name string `json:"name"` - // Description of the role + // Description of the role. Description *string `json:"description,omitempty"` - // A list of user identifiers assigned to this role + // A list of user identifiers assigned to this role. Members *[]int32 `json:"members,omitempty"` - // Role ACL Policy + // Role ACL Policy. Acl map[string]interface{} `json:"acl"` } diff --git a/model_role_assign.go b/model_role_assign.go index 6c5c7f34..a4e4d6e2 100644 --- a/model_role_assign.go +++ b/model_role_assign.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // RoleAssign type RoleAssign struct { - // An array of userIDs + // An array of userIDs. Users []int32 `json:"users"` - // An array of roleIDs + // An array of roleIDs. Roles []int32 `json:"roles"` } diff --git a/model_role_membership.go b/model_role_membership.go index 20c00025..5e505bf9 100644 --- a/model_role_membership.go +++ b/model_role_membership.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // RoleMembership struct for RoleMembership type RoleMembership struct { - // ID of role + // ID of role. RoleID int32 `json:"RoleID"` - // ID of User + // ID of User. UserID int32 `json:"UserID"` } diff --git a/model_rollback_added_loyalty_points_effect_props.go b/model_rollback_added_loyalty_points_effect_props.go index 9c58dc6d..af580ee5 100644 --- a/model_rollback_added_loyalty_points_effect_props.go +++ b/model_rollback_added_loyalty_points_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,16 +16,22 @@ import ( // RollbackAddedLoyaltyPointsEffectProps The properties specific to the \"rollbackAddedLoyaltyPoints\" effect. This gets triggered whenever previously a closed session with an addLoyaltyPoints effect is cancelled. type RollbackAddedLoyaltyPointsEffectProps struct { - // The ID of the loyalty program where the points were originally added + // The ID of the loyalty program where the points were originally added. ProgramId int32 `json:"programId"` - // The ID of the subledger within the loyalty program where these points were originally added + // The ID of the subledger within the loyalty program where these points were originally added. SubLedgerId string `json:"subLedgerId"` - // The amount of points that were rolled back + // The amount of points that were rolled back. Value float32 `json:"value"` - // The user for whom these points were originally added + // The user for whom these points were originally added. RecipientIntegrationId string `json:"recipientIntegrationId"` // The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. TransactionUUID string `json:"transactionUUID"` + // The index of the item in the cart items for which the loyalty points were rolled back. + CartItemPosition *float32 `json:"cartItemPosition,omitempty"` + // The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. + CartItemSubPosition *float32 `json:"cartItemSubPosition,omitempty"` + // The card on which these points were originally added. + CardIdentifier *string `json:"cardIdentifier,omitempty"` } // GetProgramId returns the ProgramId field value @@ -103,6 +109,105 @@ func (o *RollbackAddedLoyaltyPointsEffectProps) SetTransactionUUID(v string) { o.TransactionUUID = v } +// GetCartItemPosition returns the CartItemPosition field value if set, zero value otherwise. +func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemPosition() float32 { + if o == nil || o.CartItemPosition == nil { + var ret float32 + return ret + } + return *o.CartItemPosition +} + +// GetCartItemPositionOk returns a tuple with the CartItemPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemPositionOk() (float32, bool) { + if o == nil || o.CartItemPosition == nil { + var ret float32 + return ret, false + } + return *o.CartItemPosition, true +} + +// HasCartItemPosition returns a boolean if a field has been set. +func (o *RollbackAddedLoyaltyPointsEffectProps) HasCartItemPosition() bool { + if o != nil && o.CartItemPosition != nil { + return true + } + + return false +} + +// SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. +func (o *RollbackAddedLoyaltyPointsEffectProps) SetCartItemPosition(v float32) { + o.CartItemPosition = &v +} + +// GetCartItemSubPosition returns the CartItemSubPosition field value if set, zero value otherwise. +func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemSubPosition() float32 { + if o == nil || o.CartItemSubPosition == nil { + var ret float32 + return ret + } + return *o.CartItemSubPosition +} + +// GetCartItemSubPositionOk returns a tuple with the CartItemSubPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackAddedLoyaltyPointsEffectProps) GetCartItemSubPositionOk() (float32, bool) { + if o == nil || o.CartItemSubPosition == nil { + var ret float32 + return ret, false + } + return *o.CartItemSubPosition, true +} + +// HasCartItemSubPosition returns a boolean if a field has been set. +func (o *RollbackAddedLoyaltyPointsEffectProps) HasCartItemSubPosition() bool { + if o != nil && o.CartItemSubPosition != nil { + return true + } + + return false +} + +// SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. +func (o *RollbackAddedLoyaltyPointsEffectProps) SetCartItemSubPosition(v float32) { + o.CartItemSubPosition = &v +} + +// GetCardIdentifier returns the CardIdentifier field value if set, zero value otherwise. +func (o *RollbackAddedLoyaltyPointsEffectProps) GetCardIdentifier() string { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret + } + return *o.CardIdentifier +} + +// GetCardIdentifierOk returns a tuple with the CardIdentifier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackAddedLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool) { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret, false + } + return *o.CardIdentifier, true +} + +// HasCardIdentifier returns a boolean if a field has been set. +func (o *RollbackAddedLoyaltyPointsEffectProps) HasCardIdentifier() bool { + if o != nil && o.CardIdentifier != nil { + return true + } + + return false +} + +// SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. +func (o *RollbackAddedLoyaltyPointsEffectProps) SetCardIdentifier(v string) { + o.CardIdentifier = &v +} + type NullableRollbackAddedLoyaltyPointsEffectProps struct { Value RollbackAddedLoyaltyPointsEffectProps ExplicitNull bool diff --git a/model_rollback_coupon_effect_props.go b/model_rollback_coupon_effect_props.go index 1dae6ab4..28b2f2b8 100644 --- a/model_rollback_coupon_effect_props.go +++ b/model_rollback_coupon_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // RollbackCouponEffectProps The properties specific to the \"rollbackCoupon\" effect. This gets triggered whenever previously closed session is now cancelled and a coupon redemption was cancelled on our internal usage limit counters. type RollbackCouponEffectProps struct { - // The coupon code whose usage has been rolled back + // The coupon code whose usage has been rolled back. Value string `json:"value"` } diff --git a/model_rollback_deducted_loyalty_points_effect_props.go b/model_rollback_deducted_loyalty_points_effect_props.go index fe610d9f..258101d5 100644 --- a/model_rollback_deducted_loyalty_points_effect_props.go +++ b/model_rollback_deducted_loyalty_points_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,20 +17,22 @@ import ( // RollbackDeductedLoyaltyPointsEffectProps The properties specific to the \"rollbackDeductedLoyaltyPoints\" effect. This effect is triggered whenever a previously closed session is cancelled and a deductLoyaltyPoints effect was revoked. type RollbackDeductedLoyaltyPointsEffectProps struct { - // The ID of the loyalty program where these points were reimbursed + // The ID of the loyalty program where these points were reimbursed. ProgramId int32 `json:"programId"` - // The ID of the subledger within the loyalty program where these points were reimbursed + // The ID of the subledger within the loyalty program where these points were reimbursed. SubLedgerId string `json:"subLedgerId"` - // The amount of reimbursed points that were added + // The amount of reimbursed points that were added. Value float32 `json:"value"` - // The user for whom these points were reimbursed + // The user for whom these points were reimbursed. RecipientIntegrationId string `json:"recipientIntegrationId"` - // Date after which the reimbursed points will be valid + // Date after which the reimbursed points will be valid. StartDate *time.Time `json:"startDate,omitempty"` - // Date after which the reimbursed points will expire + // Date after which the reimbursed points will expire. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back + // The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back. TransactionUUID string `json:"transactionUUID"` + // The card on which these points were added. + CardIdentifier *string `json:"cardIdentifier,omitempty"` } // GetProgramId returns the ProgramId field value @@ -174,6 +176,39 @@ func (o *RollbackDeductedLoyaltyPointsEffectProps) SetTransactionUUID(v string) o.TransactionUUID = v } +// GetCardIdentifier returns the CardIdentifier field value if set, zero value otherwise. +func (o *RollbackDeductedLoyaltyPointsEffectProps) GetCardIdentifier() string { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret + } + return *o.CardIdentifier +} + +// GetCardIdentifierOk returns a tuple with the CardIdentifier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackDeductedLoyaltyPointsEffectProps) GetCardIdentifierOk() (string, bool) { + if o == nil || o.CardIdentifier == nil { + var ret string + return ret, false + } + return *o.CardIdentifier, true +} + +// HasCardIdentifier returns a boolean if a field has been set. +func (o *RollbackDeductedLoyaltyPointsEffectProps) HasCardIdentifier() bool { + if o != nil && o.CardIdentifier != nil { + return true + } + + return false +} + +// SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. +func (o *RollbackDeductedLoyaltyPointsEffectProps) SetCardIdentifier(v string) { + o.CardIdentifier = &v +} + type NullableRollbackDeductedLoyaltyPointsEffectProps struct { Value RollbackDeductedLoyaltyPointsEffectProps ExplicitNull bool diff --git a/model_rollback_discount_effect_props.go b/model_rollback_discount_effect_props.go index b0665fe1..39eea23a 100644 --- a/model_rollback_discount_effect_props.go +++ b/model_rollback_discount_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,12 +14,22 @@ import ( "encoding/json" ) -// RollbackDiscountEffectProps The properties specific to the \"rollbackDiscount\" effect. This gets triggered whenever previously closed session is now cancelled and a setDiscount effect was cancelled on our internal discount limit counters. +// RollbackDiscountEffectProps The properties specific to the \"rollbackDiscount\" effect. This gets triggered whenever previously closed session is now cancelled or partially returned and a setDiscount effect was cancelled on our internal discount limit counters. type RollbackDiscountEffectProps struct { - // The name of the \"setDiscount\" effect that was rolled back + // The name of the \"setDiscount\" effect that was rolled back. Name string `json:"name"` - // The value of the discount that was rolled back + // The value of the discount that was rolled back. Value float32 `json:"value"` + // The index of the item in the cart items for which the discount was rolled back. + CartItemPosition *float32 `json:"cartItemPosition,omitempty"` + // The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is only returned when cart item flattening is enabled. + CartItemSubPosition *float32 `json:"cartItemSubPosition,omitempty"` + // The ID of the additional cost that was rolled back. + AdditionalCostId *int32 `json:"additionalCostId,omitempty"` + // The name of the additional cost that was rolled back. + AdditionalCost *string `json:"additionalCost,omitempty"` + // The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` + Scope *string `json:"scope,omitempty"` } // GetName returns the Name field value @@ -52,6 +62,171 @@ func (o *RollbackDiscountEffectProps) SetValue(v float32) { o.Value = v } +// GetCartItemPosition returns the CartItemPosition field value if set, zero value otherwise. +func (o *RollbackDiscountEffectProps) GetCartItemPosition() float32 { + if o == nil || o.CartItemPosition == nil { + var ret float32 + return ret + } + return *o.CartItemPosition +} + +// GetCartItemPositionOk returns a tuple with the CartItemPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackDiscountEffectProps) GetCartItemPositionOk() (float32, bool) { + if o == nil || o.CartItemPosition == nil { + var ret float32 + return ret, false + } + return *o.CartItemPosition, true +} + +// HasCartItemPosition returns a boolean if a field has been set. +func (o *RollbackDiscountEffectProps) HasCartItemPosition() bool { + if o != nil && o.CartItemPosition != nil { + return true + } + + return false +} + +// SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. +func (o *RollbackDiscountEffectProps) SetCartItemPosition(v float32) { + o.CartItemPosition = &v +} + +// GetCartItemSubPosition returns the CartItemSubPosition field value if set, zero value otherwise. +func (o *RollbackDiscountEffectProps) GetCartItemSubPosition() float32 { + if o == nil || o.CartItemSubPosition == nil { + var ret float32 + return ret + } + return *o.CartItemSubPosition +} + +// GetCartItemSubPositionOk returns a tuple with the CartItemSubPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackDiscountEffectProps) GetCartItemSubPositionOk() (float32, bool) { + if o == nil || o.CartItemSubPosition == nil { + var ret float32 + return ret, false + } + return *o.CartItemSubPosition, true +} + +// HasCartItemSubPosition returns a boolean if a field has been set. +func (o *RollbackDiscountEffectProps) HasCartItemSubPosition() bool { + if o != nil && o.CartItemSubPosition != nil { + return true + } + + return false +} + +// SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. +func (o *RollbackDiscountEffectProps) SetCartItemSubPosition(v float32) { + o.CartItemSubPosition = &v +} + +// GetAdditionalCostId returns the AdditionalCostId field value if set, zero value otherwise. +func (o *RollbackDiscountEffectProps) GetAdditionalCostId() int32 { + if o == nil || o.AdditionalCostId == nil { + var ret int32 + return ret + } + return *o.AdditionalCostId +} + +// GetAdditionalCostIdOk returns a tuple with the AdditionalCostId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackDiscountEffectProps) GetAdditionalCostIdOk() (int32, bool) { + if o == nil || o.AdditionalCostId == nil { + var ret int32 + return ret, false + } + return *o.AdditionalCostId, true +} + +// HasAdditionalCostId returns a boolean if a field has been set. +func (o *RollbackDiscountEffectProps) HasAdditionalCostId() bool { + if o != nil && o.AdditionalCostId != nil { + return true + } + + return false +} + +// SetAdditionalCostId gets a reference to the given int32 and assigns it to the AdditionalCostId field. +func (o *RollbackDiscountEffectProps) SetAdditionalCostId(v int32) { + o.AdditionalCostId = &v +} + +// GetAdditionalCost returns the AdditionalCost field value if set, zero value otherwise. +func (o *RollbackDiscountEffectProps) GetAdditionalCost() string { + if o == nil || o.AdditionalCost == nil { + var ret string + return ret + } + return *o.AdditionalCost +} + +// GetAdditionalCostOk returns a tuple with the AdditionalCost field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackDiscountEffectProps) GetAdditionalCostOk() (string, bool) { + if o == nil || o.AdditionalCost == nil { + var ret string + return ret, false + } + return *o.AdditionalCost, true +} + +// HasAdditionalCost returns a boolean if a field has been set. +func (o *RollbackDiscountEffectProps) HasAdditionalCost() bool { + if o != nil && o.AdditionalCost != nil { + return true + } + + return false +} + +// SetAdditionalCost gets a reference to the given string and assigns it to the AdditionalCost field. +func (o *RollbackDiscountEffectProps) SetAdditionalCost(v string) { + o.AdditionalCost = &v +} + +// GetScope returns the Scope field value if set, zero value otherwise. +func (o *RollbackDiscountEffectProps) GetScope() string { + if o == nil || o.Scope == nil { + var ret string + return ret + } + return *o.Scope +} + +// GetScopeOk returns a tuple with the Scope field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RollbackDiscountEffectProps) GetScopeOk() (string, bool) { + if o == nil || o.Scope == nil { + var ret string + return ret, false + } + return *o.Scope, true +} + +// HasScope returns a boolean if a field has been set. +func (o *RollbackDiscountEffectProps) HasScope() bool { + if o != nil && o.Scope != nil { + return true + } + + return false +} + +// SetScope gets a reference to the given string and assigns it to the Scope field. +func (o *RollbackDiscountEffectProps) SetScope(v string) { + o.Scope = &v +} + type NullableRollbackDiscountEffectProps struct { Value RollbackDiscountEffectProps ExplicitNull bool diff --git a/model_rollback_referral_effect_props.go b/model_rollback_referral_effect_props.go index addb15af..a9a4eb31 100644 --- a/model_rollback_referral_effect_props.go +++ b/model_rollback_referral_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // RollbackReferralEffectProps The properties specific to the \"rollbackReferral\" effect. This gets triggered whenever previously closed session is now cancelled and a referral redemption was cancelled on our internal usage limit counters. type RollbackReferralEffectProps struct { - // The referral code whose usage has been rolled back + // The referral code whose usage has been rolled back. Value string `json:"value"` } diff --git a/model_rule.go b/model_rule.go index 8da3f4b3..544dbc31 100644 --- a/model_rule.go +++ b/model_rule.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_rule_failure_reason.go b/model_rule_failure_reason.go index d5b3cb90..6cd17231 100644 --- a/model_rule_failure_reason.go +++ b/model_rule_failure_reason.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,29 +16,29 @@ import ( // RuleFailureReason Details about why a rule failed. type RuleFailureReason struct { - // The ID of the campaign that contains the rule that failed + // The ID of the campaign that contains the rule that failed. CampaignID int32 `json:"campaignID"` - // The name of the campaign that contains the rule that failed + // The name of the campaign that contains the rule that failed. CampaignName string `json:"campaignName"` - // The ID of the ruleset that contains the rule that failed + // The ID of the ruleset that contains the rule that failed. RulesetID int32 `json:"rulesetID"` - // The ID of the coupon that was being evaluated at the time of the rule failure + // The ID of the coupon that was being evaluated at the time of the rule failure. CouponID *int32 `json:"couponID,omitempty"` - // The value of the coupon that was being evaluated at the time of the rule failure + // The code of the coupon that was being evaluated at the time of the rule failure. CouponValue *string `json:"couponValue,omitempty"` - // The ID of the referral that was being evaluated at the time of the rule failure + // The ID of the referral that was being evaluated at the time of the rule failure. ReferralID *int32 `json:"referralID,omitempty"` - // The value of the referral that was being evaluated at the time of the rule failure + // The code of the referral that was being evaluated at the time of the rule failure. ReferralValue *string `json:"referralValue,omitempty"` - // The index of the rule that failed within the ruleset + // The index of the rule that failed within the ruleset. RuleIndex int32 `json:"ruleIndex"` - // The name of the rule that failed within the ruleset + // The name of the rule that failed within the ruleset. RuleName string `json:"ruleName"` - // The index of the condition that failed + // The index of the condition that failed. ConditionIndex *int32 `json:"conditionIndex,omitempty"` - // The index of the effect that failed + // The index of the effect that failed. EffectIndex *int32 `json:"effectIndex,omitempty"` - // More details about the failure + // More details about the failure. Details *string `json:"details,omitempty"` } diff --git a/model_ruleset.go b/model_ruleset.go index d099ab8f..691bd775 100644 --- a/model_ruleset.go +++ b/model_ruleset.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Ruleset type Ruleset struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -27,9 +27,9 @@ type Ruleset struct { Rules []Rule `json:"rules"` // An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. Bindings []Binding `json:"bindings"` - // A string indicating which version of the rulebuilder was used to create this ruleset. + // The version of the rulebuilder used to create this ruleset. RbVersion *string `json:"rbVersion,omitempty"` - // A boolean indicating whether this newly created ruleset should also be activated for the campaign that owns it + // Indicates whether this created ruleset should be activated for the campaign that owns it. Activate *bool `json:"activate,omitempty"` // The ID of the campaign that owns this entity. CampaignId *int32 `json:"campaignId,omitempty"` diff --git a/model_saml_connection.go b/model_saml_connection.go index 93b33354..fcdcce19 100644 --- a/model_saml_connection.go +++ b/model_saml_connection.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -35,7 +35,7 @@ type SamlConnection struct { MetadataURL *string `json:"metadataURL,omitempty"` // The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. AudienceURI string `json:"audienceURI"` - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_saml_connection_metadata.go b/model_saml_connection_metadata.go index 2fe3cf15..409956c5 100644 --- a/model_saml_connection_metadata.go +++ b/model_saml_connection_metadata.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_saml_login_endpoint.go b/model_saml_login_endpoint.go index 492fd66f..148f1cbc 100644 --- a/model_saml_login_endpoint.go +++ b/model_saml_login_endpoint.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_session.go b/model_session.go index ad27b7f7..1c8110bf 100644 --- a/model_session.go +++ b/model_session.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Session struct for Session type Session struct { - // The ID of the user of this session + // The ID of the user of this session. UserId int32 `json:"userId"` // The token to use as a bearer token to query Management API endpoints. Token string `json:"token"` diff --git a/model_set_discount_effect_props.go b/model_set_discount_effect_props.go index fdb9a55a..e5442327 100644 --- a/model_set_discount_effect_props.go +++ b/model_set_discount_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,12 +16,14 @@ import ( // SetDiscountEffectProps The properties specific to the \"setDiscount\" effect. This gets triggered whenever a validated rule contained a \"set discount\" effect. This is a discount that should be applied on the scope of defined with it. type SetDiscountEffectProps struct { - // The name/description of this discount + // The name/description of this discount. Name string `json:"name"` - // The total monetary value of the discount + // The total monetary value of the discount. Value float32 `json:"value"` - // The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal) + // The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal). Scope *string `json:"scope,omitempty"` + // The original value of the discount. + DesiredValue *float32 `json:"desiredValue,omitempty"` } // GetName returns the Name field value @@ -87,6 +89,39 @@ func (o *SetDiscountEffectProps) SetScope(v string) { o.Scope = &v } +// GetDesiredValue returns the DesiredValue field value if set, zero value otherwise. +func (o *SetDiscountEffectProps) GetDesiredValue() float32 { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret + } + return *o.DesiredValue +} + +// GetDesiredValueOk returns a tuple with the DesiredValue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountEffectProps) GetDesiredValueOk() (float32, bool) { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret, false + } + return *o.DesiredValue, true +} + +// HasDesiredValue returns a boolean if a field has been set. +func (o *SetDiscountEffectProps) HasDesiredValue() bool { + if o != nil && o.DesiredValue != nil { + return true + } + + return false +} + +// SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. +func (o *SetDiscountEffectProps) SetDesiredValue(v float32) { + o.DesiredValue = &v +} + type NullableSetDiscountEffectProps struct { Value SetDiscountEffectProps ExplicitNull bool diff --git a/model_set_discount_per_additional_cost_effect_props.go b/model_set_discount_per_additional_cost_effect_props.go index 2aa84c0f..312384a8 100644 --- a/model_set_discount_per_additional_cost_effect_props.go +++ b/model_set_discount_per_additional_cost_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,14 +16,16 @@ import ( // SetDiscountPerAdditionalCostEffectProps The properties specific to the \"setDiscountPerAdditionalCost\" effect. This gets triggered whenever a validated rule contained a \"set per additional cost discount\" effect. This is a discount that should be applied on a specific additional cost. type SetDiscountPerAdditionalCostEffectProps struct { - // The name/description of this discount + // The name/description of this discount. Name string `json:"name"` - // The ID of the additional cost + // The ID of the additional cost. AdditionalCostId int32 `json:"additionalCostId"` - // The name of the additional cost + // The name of the additional cost. AdditionalCost string `json:"additionalCost"` - // The total monetary value of the discount + // The total monetary value of the discount. Value float32 `json:"value"` + // The original value of the discount. + DesiredValue *float32 `json:"desiredValue,omitempty"` } // GetName returns the Name field value @@ -86,6 +88,39 @@ func (o *SetDiscountPerAdditionalCostEffectProps) SetValue(v float32) { o.Value = v } +// GetDesiredValue returns the DesiredValue field value if set, zero value otherwise. +func (o *SetDiscountPerAdditionalCostEffectProps) GetDesiredValue() float32 { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret + } + return *o.DesiredValue +} + +// GetDesiredValueOk returns a tuple with the DesiredValue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerAdditionalCostEffectProps) GetDesiredValueOk() (float32, bool) { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret, false + } + return *o.DesiredValue, true +} + +// HasDesiredValue returns a boolean if a field has been set. +func (o *SetDiscountPerAdditionalCostEffectProps) HasDesiredValue() bool { + if o != nil && o.DesiredValue != nil { + return true + } + + return false +} + +// SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. +func (o *SetDiscountPerAdditionalCostEffectProps) SetDesiredValue(v float32) { + o.DesiredValue = &v +} + type NullableSetDiscountPerAdditionalCostEffectProps struct { Value SetDiscountPerAdditionalCostEffectProps ExplicitNull bool diff --git a/model_set_discount_per_additional_cost_per_item_effect_props.go b/model_set_discount_per_additional_cost_per_item_effect_props.go new file mode 100644 index 00000000..e45cd870 --- /dev/null +++ b/model_set_discount_per_additional_cost_per_item_effect_props.go @@ -0,0 +1,197 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// SetDiscountPerAdditionalCostPerItemEffectProps The properties specific to the \"setDiscountPerAdditionalCostPerItem\" effect. This gets triggered whenever a validated rule contained a \"set discount per additional cost per item\" effect. This is a discount that should be applied on a specific additional cost in a specific item. +type SetDiscountPerAdditionalCostPerItemEffectProps struct { + // The name/description of this discount. + Name string `json:"name"` + // The ID of the additional cost. + AdditionalCostId int32 `json:"additionalCostId"` + // The total monetary value of the discount. + Value float32 `json:"value"` + // The index of the item in the cart item list containing the additional cost to be discounted. + Position float32 `json:"position"` + // Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. + SubPosition *float32 `json:"subPosition,omitempty"` + // The name of the additional cost. + AdditionalCost string `json:"additionalCost"` + // Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. + DesiredValue *float32 `json:"desiredValue,omitempty"` +} + +// GetName returns the Name field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetName(v string) { + o.Name = v +} + +// GetAdditionalCostId returns the AdditionalCostId field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetAdditionalCostId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AdditionalCostId +} + +// SetAdditionalCostId sets field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetAdditionalCostId(v int32) { + o.AdditionalCostId = v +} + +// GetValue returns the Value field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetValue() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetValue(v float32) { + o.Value = v +} + +// GetPosition returns the Position field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetPosition() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Position +} + +// SetPosition sets field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetPosition(v float32) { + o.Position = v +} + +// GetSubPosition returns the SubPosition field value if set, zero value otherwise. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetSubPosition() float32 { + if o == nil || o.SubPosition == nil { + var ret float32 + return ret + } + return *o.SubPosition +} + +// GetSubPositionOk returns a tuple with the SubPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetSubPositionOk() (float32, bool) { + if o == nil || o.SubPosition == nil { + var ret float32 + return ret, false + } + return *o.SubPosition, true +} + +// HasSubPosition returns a boolean if a field has been set. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasSubPosition() bool { + if o != nil && o.SubPosition != nil { + return true + } + + return false +} + +// SetSubPosition gets a reference to the given float32 and assigns it to the SubPosition field. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetSubPosition(v float32) { + o.SubPosition = &v +} + +// GetAdditionalCost returns the AdditionalCost field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetAdditionalCost() string { + if o == nil { + var ret string + return ret + } + + return o.AdditionalCost +} + +// SetAdditionalCost sets field value +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetAdditionalCost(v string) { + o.AdditionalCost = v +} + +// GetDesiredValue returns the DesiredValue field value if set, zero value otherwise. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetDesiredValue() float32 { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret + } + return *o.DesiredValue +} + +// GetDesiredValueOk returns a tuple with the DesiredValue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) GetDesiredValueOk() (float32, bool) { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret, false + } + return *o.DesiredValue, true +} + +// HasDesiredValue returns a boolean if a field has been set. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) HasDesiredValue() bool { + if o != nil && o.DesiredValue != nil { + return true + } + + return false +} + +// SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. +func (o *SetDiscountPerAdditionalCostPerItemEffectProps) SetDesiredValue(v float32) { + o.DesiredValue = &v +} + +type NullableSetDiscountPerAdditionalCostPerItemEffectProps struct { + Value SetDiscountPerAdditionalCostPerItemEffectProps + ExplicitNull bool +} + +func (v NullableSetDiscountPerAdditionalCostPerItemEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableSetDiscountPerAdditionalCostPerItemEffectProps) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_set_discount_per_item_effect_props.go b/model_set_discount_per_item_effect_props.go index e0278b9f..68c091cf 100644 --- a/model_set_discount_per_item_effect_props.go +++ b/model_set_discount_per_item_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,16 +14,28 @@ import ( "encoding/json" ) -// SetDiscountPerItemEffectProps The properties specific to the \"setDiscountPerItem\" effect. This gets triggered whenever a validated rule contained a \"set per item discount\" effect. This is a discount that should be applied on a specific item. +// SetDiscountPerItemEffectProps The properties specific to the `setDiscountPerItem` effect, triggered whenever a validated rule contained a \"set per item discount\" effect. This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. This depends on the chosen scope. type SetDiscountPerItemEffectProps struct { - // The name/description of this discount + // The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. Name string `json:"name"` - // The total monetary value of the discount + // The total monetary value of the discount. Value float32 `json:"value"` - // The index of the item in the cart items list on which this discount should be applied + // The index of the item in the cart items list on which this discount should be applied. Position float32 `json:"position"` - // The sub-index of the item in an item stack on which this discount should be applied + // Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. SubPosition *float32 `json:"subPosition,omitempty"` + // The original value of the discount. + DesiredValue *float32 `json:"desiredValue,omitempty"` + // The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. + Scope *string `json:"scope,omitempty"` + // The total discount given if this effect is a result of a prorated discount. + TotalDiscount *float32 `json:"totalDiscount,omitempty"` + // The original total discount to give if this effect is a result of a prorated discount. + DesiredTotalDiscount *float32 `json:"desiredTotalDiscount,omitempty"` + // The position of the bundle in a list of item bundles created from the same bundle definition. + BundleIndex *int32 `json:"bundleIndex,omitempty"` + // The name of the bundle binding. + BundleName *string `json:"bundleName,omitempty"` } // GetName returns the Name field value @@ -104,6 +116,204 @@ func (o *SetDiscountPerItemEffectProps) SetSubPosition(v float32) { o.SubPosition = &v } +// GetDesiredValue returns the DesiredValue field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetDesiredValue() float32 { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret + } + return *o.DesiredValue +} + +// GetDesiredValueOk returns a tuple with the DesiredValue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetDesiredValueOk() (float32, bool) { + if o == nil || o.DesiredValue == nil { + var ret float32 + return ret, false + } + return *o.DesiredValue, true +} + +// HasDesiredValue returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasDesiredValue() bool { + if o != nil && o.DesiredValue != nil { + return true + } + + return false +} + +// SetDesiredValue gets a reference to the given float32 and assigns it to the DesiredValue field. +func (o *SetDiscountPerItemEffectProps) SetDesiredValue(v float32) { + o.DesiredValue = &v +} + +// GetScope returns the Scope field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetScope() string { + if o == nil || o.Scope == nil { + var ret string + return ret + } + return *o.Scope +} + +// GetScopeOk returns a tuple with the Scope field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetScopeOk() (string, bool) { + if o == nil || o.Scope == nil { + var ret string + return ret, false + } + return *o.Scope, true +} + +// HasScope returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasScope() bool { + if o != nil && o.Scope != nil { + return true + } + + return false +} + +// SetScope gets a reference to the given string and assigns it to the Scope field. +func (o *SetDiscountPerItemEffectProps) SetScope(v string) { + o.Scope = &v +} + +// GetTotalDiscount returns the TotalDiscount field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetTotalDiscount() float32 { + if o == nil || o.TotalDiscount == nil { + var ret float32 + return ret + } + return *o.TotalDiscount +} + +// GetTotalDiscountOk returns a tuple with the TotalDiscount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetTotalDiscountOk() (float32, bool) { + if o == nil || o.TotalDiscount == nil { + var ret float32 + return ret, false + } + return *o.TotalDiscount, true +} + +// HasTotalDiscount returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasTotalDiscount() bool { + if o != nil && o.TotalDiscount != nil { + return true + } + + return false +} + +// SetTotalDiscount gets a reference to the given float32 and assigns it to the TotalDiscount field. +func (o *SetDiscountPerItemEffectProps) SetTotalDiscount(v float32) { + o.TotalDiscount = &v +} + +// GetDesiredTotalDiscount returns the DesiredTotalDiscount field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetDesiredTotalDiscount() float32 { + if o == nil || o.DesiredTotalDiscount == nil { + var ret float32 + return ret + } + return *o.DesiredTotalDiscount +} + +// GetDesiredTotalDiscountOk returns a tuple with the DesiredTotalDiscount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetDesiredTotalDiscountOk() (float32, bool) { + if o == nil || o.DesiredTotalDiscount == nil { + var ret float32 + return ret, false + } + return *o.DesiredTotalDiscount, true +} + +// HasDesiredTotalDiscount returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasDesiredTotalDiscount() bool { + if o != nil && o.DesiredTotalDiscount != nil { + return true + } + + return false +} + +// SetDesiredTotalDiscount gets a reference to the given float32 and assigns it to the DesiredTotalDiscount field. +func (o *SetDiscountPerItemEffectProps) SetDesiredTotalDiscount(v float32) { + o.DesiredTotalDiscount = &v +} + +// GetBundleIndex returns the BundleIndex field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetBundleIndex() int32 { + if o == nil || o.BundleIndex == nil { + var ret int32 + return ret + } + return *o.BundleIndex +} + +// GetBundleIndexOk returns a tuple with the BundleIndex field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetBundleIndexOk() (int32, bool) { + if o == nil || o.BundleIndex == nil { + var ret int32 + return ret, false + } + return *o.BundleIndex, true +} + +// HasBundleIndex returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasBundleIndex() bool { + if o != nil && o.BundleIndex != nil { + return true + } + + return false +} + +// SetBundleIndex gets a reference to the given int32 and assigns it to the BundleIndex field. +func (o *SetDiscountPerItemEffectProps) SetBundleIndex(v int32) { + o.BundleIndex = &v +} + +// GetBundleName returns the BundleName field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetBundleName() string { + if o == nil || o.BundleName == nil { + var ret string + return ret + } + return *o.BundleName +} + +// GetBundleNameOk returns a tuple with the BundleName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetBundleNameOk() (string, bool) { + if o == nil || o.BundleName == nil { + var ret string + return ret, false + } + return *o.BundleName, true +} + +// HasBundleName returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasBundleName() bool { + if o != nil && o.BundleName != nil { + return true + } + + return false +} + +// SetBundleName gets a reference to the given string and assigns it to the BundleName field. +func (o *SetDiscountPerItemEffectProps) SetBundleName(v string) { + o.BundleName = &v +} + type NullableSetDiscountPerItemEffectProps struct { Value SetDiscountPerItemEffectProps ExplicitNull bool diff --git a/model_show_bundle_metadata_effect_props.go b/model_show_bundle_metadata_effect_props.go index dabac551..27c703b8 100644 --- a/model_show_bundle_metadata_effect_props.go +++ b/model_show_bundle_metadata_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,13 +14,13 @@ import ( "encoding/json" ) -// ShowBundleMetadataEffectProps The properties specific to the \"ShowBundleMetadata\" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. +// ShowBundleMetadataEffectProps This effect is **deprecated**. The properties specific to the \"ShowBundleMetadata\" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. type ShowBundleMetadataEffectProps struct { - // Description of the product bundle + // Description of the product bundle. Description string `json:"description"` - // The cart item attributes that determined which items are being bundled together + // The cart item attributes that determined which items are being bundled together. BundleAttributes []string `json:"bundleAttributes"` - // The indices in the cart items array of the bundled items + // The indices in the cart items array of the bundled items. ItemsIndices []float32 `json:"itemsIndices"` } diff --git a/model_show_notification_effect_props.go b/model_show_notification_effect_props.go index cd91adac..d52360cc 100644 --- a/model_show_notification_effect_props.go +++ b/model_show_notification_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,11 +16,11 @@ import ( // ShowNotificationEffectProps The properties specific to the \"showNotification\" effect. This gets triggered whenever a validated rule contained a \"show notification\" effect. type ShowNotificationEffectProps struct { - // The type of notification that should be shown (e.g. error/warning/info) + // The type of notification that should be shown (e.g. error/warning/info). NotificationType string `json:"notificationType"` - // Title of the notification + // Title of the notification. Title string `json:"title"` - // Body of the notification + // Body of the notification. Body string `json:"body"` } diff --git a/model_slot_def.go b/model_slot_def.go index 6bf21aca..67c72542 100644 --- a/model_slot_def.go +++ b/model_slot_def.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_template_arg_def.go b/model_template_arg_def.go index 4a83d987..339fb948 100644 --- a/model_template_arg_def.go +++ b/model_template_arg_def.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_template_def.go b/model_template_def.go index fc518a7a..991c08ca 100644 --- a/model_template_def.go +++ b/model_template_def.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // TemplateDef type TemplateDef struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_template_limit_config.go b/model_template_limit_config.go index cf8999a1..0cb28024 100644 --- a/model_template_limit_config.go +++ b/model_template_limit_config.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,16 +16,14 @@ import ( // TemplateLimitConfig type TemplateLimitConfig struct { - // The limitable action to which this limit will be applied + // The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` Action string `json:"action"` - // The value to set for the limit + // The value to set for the limit. Limit float32 `json:"limit"` - // The period on which the budget limit recurs + // The period on which the budget limit recurs. Period *string `json:"period,omitempty"` - // The entities that make the address of this limit + // The entity that this limit applies to. Entities []string `json:"entities"` - // The description of this budget configuration - Description string `json:"description"` } // GetAction returns the Action field value @@ -106,21 +104,6 @@ func (o *TemplateLimitConfig) SetEntities(v []string) { o.Entities = v } -// GetDescription returns the Description field value -func (o *TemplateLimitConfig) GetDescription() string { - if o == nil { - var ret string - return ret - } - - return o.Description -} - -// SetDescription sets field value -func (o *TemplateLimitConfig) SetDescription(v string) { - o.Description = v -} - type NullableTemplateLimitConfig struct { Value TemplateLimitConfig ExplicitNull bool diff --git a/model_tier.go b/model_tier.go index f9d7f122..8d535252 100644 --- a/model_tier.go +++ b/model_tier.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // Tier struct for Tier type Tier struct { - // The internal ID of the tier + // The internal ID of the tier. Id int32 `json:"id"` - // The name of the tier + // The name of the tier. Name string `json:"name"` } diff --git a/model_trigger_webhook_effect_props.go b/model_trigger_webhook_effect_props.go index cde8a713..ebab3b3e 100644 --- a/model_trigger_webhook_effect_props.go +++ b/model_trigger_webhook_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // TriggerWebhookEffectProps The properties specific to the \"triggerWebhook\" effect. This gets triggered whenever a validated rule contained a \"trigger webhook\" effect. This is communicated as an FYI and should usually not require action on your side. type TriggerWebhookEffectProps struct { - // The ID of the webhook that was triggered + // The ID of the webhook that was triggered. WebhookId float32 `json:"webhookId"` - // The name of the webhook that was triggered + // The name of the webhook that was triggered. WebhookName string `json:"webhookName"` } diff --git a/model_update_account.go b/model_update_account.go index f0621eff..3418b6a5 100644 --- a/model_update_account.go +++ b/model_update_account.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,13 +17,13 @@ import ( // UpdateAccount struct for UpdateAccount type UpdateAccount struct { - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` // Name of your company. CompanyName string `json:"companyName"` // The billing email address associated with your company account. BillingEmail string `json:"billingEmail"` - // State of the account (active, deactivated) + // State of the account (active, deactivated). State *string `json:"state,omitempty"` // The point in time at which your current plan expires. PlanExpires *time.Time `json:"planExpires,omitempty"` diff --git a/model_update_application.go b/model_update_application.go index 5c67ca99..3943ee96 100644 --- a/model_update_application.go +++ b/model_update_application.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -22,27 +22,31 @@ type UpdateApplication struct { Description *string `json:"description,omitempty"` // A string containing an IANA timezone descriptor. Timezone string `json:"timezone"` - // A string describing a default currency for new customer sessions. + // The default currency for new customer sessions. Currency string `json:"currency"` - // A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. + // The case sensitivity behavior to check coupon codes in the campaigns of this Application. CaseSensitivity *string `json:"caseSensitivity,omitempty"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // Default limits for campaigns created in this application + // Default limits for campaigns created in this application. Limits *[]LimitConfig `json:"limits,omitempty"` - // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" + // Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. CampaignPriority *string `json:"campaignPriority,omitempty"` - // The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" + // The strategy used when choosing exclusive campaigns for evaluation. ExclusiveCampaignsStrategy *string `json:"exclusiveCampaignsStrategy,omitempty"` - // The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. + // The default scope to apply `setDiscount` effects on if no scope was provided with the effect. DefaultDiscountScope *string `json:"defaultDiscountScope,omitempty"` - // Indicates if discounts should cascade for this application + // Indicates if discounts should cascade for this Application. EnableCascadingDiscounts *bool `json:"enableCascadingDiscounts,omitempty"` - // Indicates if cart items of quantity larger than one should be separated into different items of quantity one + // Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` - // Indicates if this is a live or sandbox application + // Indicates if this is a live or sandbox Application. Sandbox *bool `json:"sandbox,omitempty"` + // Indicates if this Application supports partial discounts. + EnablePartialDiscounts *bool `json:"enablePartialDiscounts,omitempty"` + // The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. + DefaultDiscountAdditionalCostPerItemScope *string `json:"defaultDiscountAdditionalCostPerItemScope,omitempty"` } // GetName returns the Name field value @@ -453,6 +457,72 @@ func (o *UpdateApplication) SetSandbox(v bool) { o.Sandbox = &v } +// GetEnablePartialDiscounts returns the EnablePartialDiscounts field value if set, zero value otherwise. +func (o *UpdateApplication) GetEnablePartialDiscounts() bool { + if o == nil || o.EnablePartialDiscounts == nil { + var ret bool + return ret + } + return *o.EnablePartialDiscounts +} + +// GetEnablePartialDiscountsOk returns a tuple with the EnablePartialDiscounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetEnablePartialDiscountsOk() (bool, bool) { + if o == nil || o.EnablePartialDiscounts == nil { + var ret bool + return ret, false + } + return *o.EnablePartialDiscounts, true +} + +// HasEnablePartialDiscounts returns a boolean if a field has been set. +func (o *UpdateApplication) HasEnablePartialDiscounts() bool { + if o != nil && o.EnablePartialDiscounts != nil { + return true + } + + return false +} + +// SetEnablePartialDiscounts gets a reference to the given bool and assigns it to the EnablePartialDiscounts field. +func (o *UpdateApplication) SetEnablePartialDiscounts(v bool) { + o.EnablePartialDiscounts = &v +} + +// GetDefaultDiscountAdditionalCostPerItemScope returns the DefaultDiscountAdditionalCostPerItemScope field value if set, zero value otherwise. +func (o *UpdateApplication) GetDefaultDiscountAdditionalCostPerItemScope() string { + if o == nil || o.DefaultDiscountAdditionalCostPerItemScope == nil { + var ret string + return ret + } + return *o.DefaultDiscountAdditionalCostPerItemScope +} + +// GetDefaultDiscountAdditionalCostPerItemScopeOk returns a tuple with the DefaultDiscountAdditionalCostPerItemScope field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetDefaultDiscountAdditionalCostPerItemScopeOk() (string, bool) { + if o == nil || o.DefaultDiscountAdditionalCostPerItemScope == nil { + var ret string + return ret, false + } + return *o.DefaultDiscountAdditionalCostPerItemScope, true +} + +// HasDefaultDiscountAdditionalCostPerItemScope returns a boolean if a field has been set. +func (o *UpdateApplication) HasDefaultDiscountAdditionalCostPerItemScope() bool { + if o != nil && o.DefaultDiscountAdditionalCostPerItemScope != nil { + return true + } + + return false +} + +// SetDefaultDiscountAdditionalCostPerItemScope gets a reference to the given string and assigns it to the DefaultDiscountAdditionalCostPerItemScope field. +func (o *UpdateApplication) SetDefaultDiscountAdditionalCostPerItemScope(v string) { + o.DefaultDiscountAdditionalCostPerItemScope = &v +} + type NullableUpdateApplication struct { Value UpdateApplication ExplicitNull bool diff --git a/model_update_attribute_effect_props.go b/model_update_attribute_effect_props.go index 069b70e0..58555174 100644 --- a/model_update_attribute_effect_props.go +++ b/model_update_attribute_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,9 +16,9 @@ import ( // UpdateAttributeEffectProps The properties specific to the \"updateAttribute\" effect. This gets triggered whenever a validated rule contained an \"update an attribute\" effect. type UpdateAttributeEffectProps struct { - // The exact path of the attribute that was updated + // The exact path of the attribute that was updated. Path string `json:"path"` - // The new value of this attribute. Value can be any of the following types (time, string, number, location, boolean) or a list of any of those types + // The new value of this attribute. The value can be of the following types: - boolean - location - number - string - time - list of any of those types Value map[string]interface{} `json:"value"` } diff --git a/model_update_audience.go b/model_update_audience.go index 552942ed..34236678 100644 --- a/model_update_audience.go +++ b/model_update_audience.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,7 +16,7 @@ import ( // UpdateAudience struct for UpdateAudience type UpdateAudience struct { - // The human-friendly display name for this Audience. + // The human-friendly display name for this audience. Name string `json:"name"` } diff --git a/model_update_campaign.go b/model_update_campaign.go index 3100e9a3..a4aee733 100644 --- a/model_update_campaign.go +++ b/model_update_campaign.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -25,7 +25,7 @@ type UpdateCampaign struct { StartTime *time.Time `json:"startTime,omitempty"` // Timestamp when the campaign will become inactive. EndTime *time.Time `json:"endTime,omitempty"` - // Arbitrary properties associated with this campaign + // Arbitrary properties associated with this campaign. Attributes *map[string]interface{} `json:"attributes,omitempty"` // A disabled or archived campaign is not evaluated for rules or coupons. State *string `json:"state,omitempty"` @@ -37,7 +37,7 @@ type UpdateCampaign struct { Features []string `json:"features"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of limits that will operate for this campaign + // The set of limits that will operate for this campaign. Limits []LimitConfig `json:"limits"` // The IDs of the campaign groups that own this entity. CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` diff --git a/model_update_campaign_collection.go b/model_update_campaign_collection.go new file mode 100644 index 00000000..a7def640 --- /dev/null +++ b/model_update_campaign_collection.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// UpdateCampaignCollection struct for UpdateCampaignCollection +type UpdateCampaignCollection struct { + // A short description of the purpose of this collection. + Description *string `json:"description,omitempty"` +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateCampaignCollection) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaignCollection) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *UpdateCampaignCollection) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *UpdateCampaignCollection) SetDescription(v string) { + o.Description = &v +} + +type NullableUpdateCampaignCollection struct { + Value UpdateCampaignCollection + ExplicitNull bool +} + +func (v NullableUpdateCampaignCollection) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateCampaignCollection) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_campaign_group.go b/model_update_campaign_group.go index 980c2941..3b0737d3 100644 --- a/model_update_campaign_group.go +++ b/model_update_campaign_group.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -20,9 +20,9 @@ type UpdateCampaignGroup struct { Name string `json:"name"` // A longer description of the campaign group. Description *string `json:"description,omitempty"` - // A list of the IDs of the applications that this campaign group is enabled for + // A list of the IDs of the applications that this campaign group is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` - // A list of the IDs of the campaigns that this campaign group owns + // A list of the IDs of the campaigns that this campaign group owns. CampaignIds *[]int32 `json:"campaignIds,omitempty"` } diff --git a/model_update_campaign_template.go b/model_update_campaign_template.go index fe3d0e07..35be8793 100644 --- a/model_update_campaign_template.go +++ b/model_update_campaign_template.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -36,12 +36,16 @@ type UpdateCampaignTemplate struct { Features *[]string `json:"features,omitempty"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of limits that will operate for this campaign template + // The set of limits that will operate for this campaign template. Limits *[]TemplateLimitConfig `json:"limits,omitempty"` // Template parameters are fields which can be used to replace values in a rule. TemplateParams *[]CampaignTemplateParams `json:"templateParams,omitempty"` - // A list of the IDs of the applications that are subscribed to this campaign template + // A list of the IDs of the applications that are subscribed to this campaign template. ApplicationsIds []int32 `json:"applicationsIds"` + // The campaign collections from the blueprint campaign for the template. + CampaignCollections *[]CampaignTemplateCollection `json:"campaignCollections,omitempty"` + // The default campaignGroupId. + DefaultCampaignGroupId *int32 `json:"defaultCampaignGroupId,omitempty"` } // GetName returns the Name field value @@ -416,6 +420,72 @@ func (o *UpdateCampaignTemplate) SetApplicationsIds(v []int32) { o.ApplicationsIds = v } +// GetCampaignCollections returns the CampaignCollections field value if set, zero value otherwise. +func (o *UpdateCampaignTemplate) GetCampaignCollections() []CampaignTemplateCollection { + if o == nil || o.CampaignCollections == nil { + var ret []CampaignTemplateCollection + return ret + } + return *o.CampaignCollections +} + +// GetCampaignCollectionsOk returns a tuple with the CampaignCollections field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaignTemplate) GetCampaignCollectionsOk() ([]CampaignTemplateCollection, bool) { + if o == nil || o.CampaignCollections == nil { + var ret []CampaignTemplateCollection + return ret, false + } + return *o.CampaignCollections, true +} + +// HasCampaignCollections returns a boolean if a field has been set. +func (o *UpdateCampaignTemplate) HasCampaignCollections() bool { + if o != nil && o.CampaignCollections != nil { + return true + } + + return false +} + +// SetCampaignCollections gets a reference to the given []CampaignTemplateCollection and assigns it to the CampaignCollections field. +func (o *UpdateCampaignTemplate) SetCampaignCollections(v []CampaignTemplateCollection) { + o.CampaignCollections = &v +} + +// GetDefaultCampaignGroupId returns the DefaultCampaignGroupId field value if set, zero value otherwise. +func (o *UpdateCampaignTemplate) GetDefaultCampaignGroupId() int32 { + if o == nil || o.DefaultCampaignGroupId == nil { + var ret int32 + return ret + } + return *o.DefaultCampaignGroupId +} + +// GetDefaultCampaignGroupIdOk returns a tuple with the DefaultCampaignGroupId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaignTemplate) GetDefaultCampaignGroupIdOk() (int32, bool) { + if o == nil || o.DefaultCampaignGroupId == nil { + var ret int32 + return ret, false + } + return *o.DefaultCampaignGroupId, true +} + +// HasDefaultCampaignGroupId returns a boolean if a field has been set. +func (o *UpdateCampaignTemplate) HasDefaultCampaignGroupId() bool { + if o != nil && o.DefaultCampaignGroupId != nil { + return true + } + + return false +} + +// SetDefaultCampaignGroupId gets a reference to the given int32 and assigns it to the DefaultCampaignGroupId field. +func (o *UpdateCampaignTemplate) SetDefaultCampaignGroupId(v int32) { + o.DefaultCampaignGroupId = &v +} + type NullableUpdateCampaignTemplate struct { Value UpdateCampaignTemplate ExplicitNull bool diff --git a/model_update_catalog.go b/model_update_catalog.go new file mode 100644 index 00000000..6e4a4d39 --- /dev/null +++ b/model_update_catalog.go @@ -0,0 +1,147 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// UpdateCatalog struct for UpdateCatalog +type UpdateCatalog struct { + // A description of this cart item catalog. + Description *string `json:"description,omitempty"` + // Name of this cart item catalog. + Name *string `json:"name,omitempty"` + // A list of the IDs of the applications that are subscribed to this catalog. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateCatalog) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCatalog) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *UpdateCatalog) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *UpdateCatalog) SetDescription(v string) { + o.Description = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *UpdateCatalog) GetName() string { + if o == nil || o.Name == nil { + var ret string + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCatalog) GetNameOk() (string, bool) { + if o == nil || o.Name == nil { + var ret string + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *UpdateCatalog) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given string and assigns it to the Name field. +func (o *UpdateCatalog) SetName(v string) { + o.Name = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *UpdateCatalog) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCatalog) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *UpdateCatalog) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *UpdateCatalog) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +type NullableUpdateCatalog struct { + Value UpdateCatalog + ExplicitNull bool +} + +func (v NullableUpdateCatalog) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateCatalog) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_collection.go b/model_update_collection.go index 6773666e..38ca8110 100644 --- a/model_update_collection.go +++ b/model_update_collection.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -14,27 +14,12 @@ import ( "encoding/json" ) -// UpdateCollection +// UpdateCollection struct for UpdateCollection type UpdateCollection struct { - // The name of this collection. - Name string `json:"name"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` -} - -// GetName returns the Name field value -func (o *UpdateCollection) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *UpdateCollection) SetName(v string) { - o.Name = v + // A list of the IDs of the Applications where this collection is enabled. + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` } // GetDescription returns the Description field value if set, zero value otherwise. @@ -70,6 +55,39 @@ func (o *UpdateCollection) SetDescription(v string) { o.Description = &v } +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *UpdateCollection) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCollection) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *UpdateCollection) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *UpdateCollection) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + type NullableUpdateCollection struct { Value UpdateCollection ExplicitNull bool diff --git a/model_update_coupon.go b/model_update_coupon.go index d2a98019..99d45950 100644 --- a/model_update_coupon.go +++ b/model_update_coupon.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // UpdateCoupon type UpdateCoupon struct { - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -25,9 +25,11 @@ type UpdateCoupon struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The integration ID for this coupon's beneficiary's profile + // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. + Limits *[]LimitConfig `json:"limits,omitempty"` + // The integration ID for this coupon's beneficiary's profile. RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` } @@ -163,6 +165,39 @@ func (o *UpdateCoupon) SetExpiryDate(v time.Time) { o.ExpiryDate = &v } +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *UpdateCoupon) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCoupon) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *UpdateCoupon) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *UpdateCoupon) SetLimits(v []LimitConfig) { + o.Limits = &v +} + // GetRecipientIntegrationId returns the RecipientIntegrationId field value if set, zero value otherwise. func (o *UpdateCoupon) GetRecipientIntegrationId() string { if o == nil || o.RecipientIntegrationId == nil { diff --git a/model_update_coupon_batch.go b/model_update_coupon_batch.go index ce296a55..632ced3f 100644 --- a/model_update_coupon_batch.go +++ b/model_update_coupon_batch.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // UpdateCouponBatch type UpdateCouponBatch struct { - // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + // The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` // The amount of discounts that can be given with this coupon code. DiscountLimit *float32 `json:"discountLimit,omitempty"` @@ -25,10 +25,10 @@ type UpdateCouponBatch struct { StartDate *time.Time `json:"startDate,omitempty"` // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` // The id of the batch the coupon belongs to. - BatchID string `json:"batchID"` + BatchID *string `json:"batchID,omitempty"` } // GetUsageLimit returns the UsageLimit field value if set, zero value otherwise. @@ -196,19 +196,37 @@ func (o *UpdateCouponBatch) SetAttributes(v map[string]interface{}) { o.Attributes = &v } -// GetBatchID returns the BatchID field value +// GetBatchID returns the BatchID field value if set, zero value otherwise. func (o *UpdateCouponBatch) GetBatchID() string { - if o == nil { + if o == nil || o.BatchID == nil { var ret string return ret } + return *o.BatchID +} - return o.BatchID +// GetBatchIDOk returns a tuple with the BatchID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCouponBatch) GetBatchIDOk() (string, bool) { + if o == nil || o.BatchID == nil { + var ret string + return ret, false + } + return *o.BatchID, true +} + +// HasBatchID returns a boolean if a field has been set. +func (o *UpdateCouponBatch) HasBatchID() bool { + if o != nil && o.BatchID != nil { + return true + } + + return false } -// SetBatchID sets field value +// SetBatchID gets a reference to the given string and assigns it to the BatchID field. func (o *UpdateCouponBatch) SetBatchID(v string) { - o.BatchID = v + o.BatchID = &v } type NullableUpdateCouponBatch struct { diff --git a/model_update_custom_effect.go b/model_update_custom_effect.go index 4e0f7a53..ea6ed342 100644 --- a/model_update_custom_effect.go +++ b/model_update_custom_effect.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -28,7 +28,7 @@ type UpdateCustomEffect struct { Description *string `json:"description,omitempty"` // Determines if this effect is active. Enabled bool `json:"enabled"` - // Array of template argument definitions + // Array of template argument definitions. Params *[]TemplateArgDef `json:"params,omitempty"` } diff --git a/model_update_loyalty_card.go b/model_update_loyalty_card.go new file mode 100644 index 00000000..600ae3ec --- /dev/null +++ b/model_update_loyalty_card.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// UpdateLoyaltyCard struct for UpdateLoyaltyCard +type UpdateLoyaltyCard struct { + // Status of the loyalty card. Can be one of: ['active', 'disabled'] + Status string `json:"status"` +} + +// GetStatus returns the Status field value +func (o *UpdateLoyaltyCard) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// SetStatus sets field value +func (o *UpdateLoyaltyCard) SetStatus(v string) { + o.Status = v +} + +type NullableUpdateLoyaltyCard struct { + Value UpdateLoyaltyCard + ExplicitNull bool +} + +func (v NullableUpdateLoyaltyCard) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateLoyaltyCard) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_loyalty_program.go b/model_update_loyalty_program.go index de66e45b..7b82fc47 100644 --- a/model_update_loyalty_program.go +++ b/model_update_loyalty_program.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -26,11 +26,11 @@ type UpdateLoyaltyProgram struct { DefaultValidity *string `json:"defaultValidity,omitempty"` // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. DefaultPending *string `json:"defaultPending,omitempty"` - // Indicates if this program supports subledgers inside the program + // Indicates if this program supports subledgers inside the program. AllowSubledger *bool `json:"allowSubledger,omitempty"` - // A string containing an IANA timezone descriptor. - Timezone *string `json:"timezone,omitempty"` - // The tiers in this loyalty program + // The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. + UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` + // The tiers in this loyalty program. Tiers *[]NewLoyaltyTier `json:"tiers,omitempty"` } @@ -232,37 +232,37 @@ func (o *UpdateLoyaltyProgram) SetAllowSubledger(v bool) { o.AllowSubledger = &v } -// GetTimezone returns the Timezone field value if set, zero value otherwise. -func (o *UpdateLoyaltyProgram) GetTimezone() string { - if o == nil || o.Timezone == nil { - var ret string +// GetUsersPerCardLimit returns the UsersPerCardLimit field value if set, zero value otherwise. +func (o *UpdateLoyaltyProgram) GetUsersPerCardLimit() int32 { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret } - return *o.Timezone + return *o.UsersPerCardLimit } -// GetTimezoneOk returns a tuple with the Timezone field value if set, zero value otherwise +// GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *UpdateLoyaltyProgram) GetTimezoneOk() (string, bool) { - if o == nil || o.Timezone == nil { - var ret string +func (o *UpdateLoyaltyProgram) GetUsersPerCardLimitOk() (int32, bool) { + if o == nil || o.UsersPerCardLimit == nil { + var ret int32 return ret, false } - return *o.Timezone, true + return *o.UsersPerCardLimit, true } -// HasTimezone returns a boolean if a field has been set. -func (o *UpdateLoyaltyProgram) HasTimezone() bool { - if o != nil && o.Timezone != nil { +// HasUsersPerCardLimit returns a boolean if a field has been set. +func (o *UpdateLoyaltyProgram) HasUsersPerCardLimit() bool { + if o != nil && o.UsersPerCardLimit != nil { return true } return false } -// SetTimezone gets a reference to the given string and assigns it to the Timezone field. -func (o *UpdateLoyaltyProgram) SetTimezone(v string) { - o.Timezone = &v +// SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +func (o *UpdateLoyaltyProgram) SetUsersPerCardLimit(v int32) { + o.UsersPerCardLimit = &v } // GetTiers returns the Tiers field value if set, zero value otherwise. diff --git a/model_update_loyalty_tier.go b/model_update_loyalty_tier.go deleted file mode 100644 index 96664f7e..00000000 --- a/model_update_loyalty_tier.go +++ /dev/null @@ -1,76 +0,0 @@ -/* - * Talon.One API - * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put - * - * API version: 1.0.0 - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// UpdateLoyaltyTier -type UpdateLoyaltyTier struct { - // The name of the tier - Name string `json:"name"` - // The minimum amount of points required to be eligible for the tier - MinPoints float32 `json:"minPoints"` -} - -// GetName returns the Name field value -func (o *UpdateLoyaltyTier) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *UpdateLoyaltyTier) SetName(v string) { - o.Name = v -} - -// GetMinPoints returns the MinPoints field value -func (o *UpdateLoyaltyTier) GetMinPoints() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.MinPoints -} - -// SetMinPoints sets field value -func (o *UpdateLoyaltyTier) SetMinPoints(v float32) { - o.MinPoints = v -} - -type NullableUpdateLoyaltyTier struct { - Value UpdateLoyaltyTier - ExplicitNull bool -} - -func (v NullableUpdateLoyaltyTier) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableUpdateLoyaltyTier) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_update_referral.go b/model_update_referral.go index ff09366d..c814e435 100644 --- a/model_update_referral.go +++ b/model_update_referral.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // UpdateReferral struct for UpdateReferral type UpdateReferral struct { - // An optional Integration ID of the Friend's Profile + // An optional Integration ID of the Friend's Profile. FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` @@ -25,7 +25,7 @@ type UpdateReferral struct { ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` } diff --git a/model_update_referral_batch.go b/model_update_referral_batch.go index c592ef1b..f703c707 100644 --- a/model_update_referral_batch.go +++ b/model_update_referral_batch.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // UpdateReferralBatch struct for UpdateReferralBatch type UpdateReferralBatch struct { - // Arbitrary properties associated with this item + // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` // The id of the batch the referral belongs to. BatchID string `json:"batchID"` diff --git a/model_update_role.go b/model_update_role.go index 2c17355a..2f79f2a4 100644 --- a/model_update_role.go +++ b/model_update_role.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,13 +16,13 @@ import ( // UpdateRole struct for UpdateRole type UpdateRole struct { - // Name of the role + // Name of the role. Name *string `json:"name,omitempty"` - // Description of the role + // Description of the role. Description *string `json:"description,omitempty"` - // Role Policy this should be a stringified blob of json + // Role Policy this should be a stringified blob of json. Acl *string `json:"acl,omitempty"` - // An array of user identifiers + // An array of user identifiers. Members *[]int32 `json:"members,omitempty"` } diff --git a/model_update_user.go b/model_update_user.go index c1fb21d2..bffdc0d8 100644 --- a/model_update_user.go +++ b/model_update_user.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -16,13 +16,13 @@ import ( // UpdateUser struct for UpdateUser type UpdateUser struct { - // Your name. + // The user name. Name *string `json:"name,omitempty"` - // a blob of acl json + // ACL Json. Policy *string `json:"policy,omitempty"` // New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. State *string `json:"state,omitempty"` - // Update + // List of roles to assign to the user. Roles *[]int32 `json:"roles,omitempty"` ApplicationNotificationSubscriptions *map[string]interface{} `json:"applicationNotificationSubscriptions,omitempty"` } diff --git a/model_update_user_latest_feed_timestamp.go b/model_update_user_latest_feed_timestamp.go index 6b458df5..1e32acde 100644 --- a/model_update_user_latest_feed_timestamp.go +++ b/model_update_user_latest_feed_timestamp.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,9 +15,9 @@ import ( "time" ) -// UpdateUserLatestFeedTimestamp Updates current user's latest seen notifications timestamp +// UpdateUserLatestFeedTimestamp Updates current user's latest seen notifications timestamp. type UpdateUserLatestFeedTimestamp struct { - // New timestamp to update for the current user + // New timestamp to update for the current user. NewLatestFeedTimestamp time.Time `json:"newLatestFeedTimestamp"` } diff --git a/model_user.go b/model_user.go index ff3c8553..5199e541 100644 --- a/model_user.go +++ b/model_user.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // User type User struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -37,10 +37,10 @@ type User struct { Policy map[string]interface{} `json:"policy"` // Latest timestamp the user has been notified for feed. LatestFeedTimestamp *time.Time `json:"latestFeedTimestamp,omitempty"` - // Contains a list of all roles the user is a member of + // Contains a list of all roles the user is a member of. Roles *[]int32 `json:"roles,omitempty"` ApplicationNotificationSubscriptions *map[string]interface{} `json:"applicationNotificationSubscriptions,omitempty"` - // The Authentication method for this user + // The Authentication method for this user. AuthMethod *string `json:"authMethod,omitempty"` } diff --git a/model_user_entity.go b/model_user_entity.go index 6afd0313..52e21454 100644 --- a/model_user_entity.go +++ b/model_user_entity.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/model_user_feed_notifications.go b/model_user_feed_notifications.go index 8722a01f..52ff359f 100644 --- a/model_user_feed_notifications.go +++ b/model_user_feed_notifications.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,11 +15,11 @@ import ( "time" ) -// UserFeedNotifications notifications to notify CAMA user about +// UserFeedNotifications Notifications to notify CAMA user about. type UserFeedNotifications struct { - // Timestamp of the last request for this list + // Timestamp of the last request for this list. LastUpdate time.Time `json:"lastUpdate"` - // List of all notifications to notify the user about + // List of all notifications to notify the user about. Notifications []FeedNotification `json:"notifications"` } diff --git a/model_webhook.go b/model_webhook.go index 40bb9bb1..70bd4c63 100644 --- a/model_webhook.go +++ b/model_webhook.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import ( // Webhook type Webhook struct { - // Unique ID for this entity. + // Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -25,19 +25,19 @@ type Webhook struct { Modified time.Time `json:"modified"` // The IDs of the applications that are related to this entity. The IDs of the applications that are related to this entity. ApplicationIds []int32 `json:"applicationIds"` - // Friendly title for this webhook + // Friendly title for this webhook. Title string `json:"title"` - // API method for this webhook + // API method for this webhook. Verb string `json:"verb"` - // API url (supports templating using parameters) for this webhook + // API url (supports templating using parameters) for this webhook. Url string `json:"url"` - // List of API HTTP headers for this webhook + // List of API HTTP headers for this webhook. Headers []string `json:"headers"` - // API payload (supports templating using parameters) for this webhook + // API payload (supports templating using parameters) for this webhook. Payload *string `json:"payload,omitempty"` - // Array of template argument definitions + // Array of template argument definitions. Params []TemplateArgDef `json:"params"` - // Enables or disables webhook from showing in rule builder + // Enables or disables webhook from showing in rule builder. Enabled bool `json:"enabled"` } diff --git a/model_webhook_activation_log_entry.go b/model_webhook_activation_log_entry.go index 2bae5dbc..1ca86a19 100644 --- a/model_webhook_activation_log_entry.go +++ b/model_webhook_activation_log_entry.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,15 +15,15 @@ import ( "time" ) -// WebhookActivationLogEntry Log of activated webhooks +// WebhookActivationLogEntry Log of activated webhooks. type WebhookActivationLogEntry struct { - // UUID reference of the integration request that triggered the effect with the webhook + // UUID reference of the integration request that triggered the effect with the webhook. IntegrationRequestUuid string `json:"integrationRequestUuid"` - // ID of the webhook that triggered the request + // ID of the webhook that triggered the request. WebhookId int32 `json:"webhookId"` - // ID of the application that triggered the webhook + // ID of the application that triggered the webhook. ApplicationId int32 `json:"applicationId"` - // ID of the campaign that triggered the webhook + // ID of the campaign that triggered the webhook. CampaignId int32 `json:"campaignId"` // Timestamp of request Created time.Time `json:"created"` diff --git a/model_webhook_log_entry.go b/model_webhook_log_entry.go index 95a96ae0..f20efb66 100644 --- a/model_webhook_log_entry.go +++ b/model_webhook_log_entry.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) @@ -15,15 +15,15 @@ import ( "time" ) -// WebhookLogEntry Log of webhook api calls +// WebhookLogEntry Log of webhook api calls. type WebhookLogEntry struct { - // UUID reference of the webhook request + // UUID reference of the webhook request. Id string `json:"id"` - // UUID reference of the integration request linked to this webhook request + // UUID reference of the integration request linked to this webhook request. IntegrationRequestUuid string `json:"integrationRequestUuid"` - // ID of the webhook that triggered the request + // ID of the webhook that triggered the request. WebhookId int32 `json:"webhookId"` - // ID of the application that triggered the webhook + // ID of the application that triggered the webhook. ApplicationId *int32 `json:"applicationId,omitempty"` // Target url of request Url string `json:"url"` @@ -31,7 +31,7 @@ type WebhookLogEntry struct { Request string `json:"request"` // Response message Response *string `json:"response,omitempty"` - // HTTP status code of response + // HTTP status code of response. Status *int32 `json:"status,omitempty"` // Timestamp of request RequestTime time.Time `json:"requestTime"` diff --git a/model_will_award_giveaway_effect_props.go b/model_will_award_giveaway_effect_props.go index 30fd6015..221207e0 100644 --- a/model_will_award_giveaway_effect_props.go +++ b/model_will_award_giveaway_effect_props.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/response.go b/response.go index be8a38cd..0e207605 100644 --- a/response.go +++ b/response.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech) diff --git a/utils.go b/utils.go index 6b24d3c3..a5f652b3 100644 --- a/utils.go +++ b/utils.go @@ -1,7 +1,7 @@ /* * Talon.One API * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` * * API version: 1.0.0 * Generated by: OpenAPI Generator (https://openapi-generator.tech)