From bfaee0c35eead912791755927b629c87267bb2cc Mon Sep 17 00:00:00 2001 From: "Jakob (Koby) Shimony" Date: Fri, 28 Apr 2023 16:35:22 +0200 Subject: [PATCH] v3.0.0: Reopen session endpoint, loyalty data integration endpoints and loyalty card management endpoints (#22) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Summary ### Integration API - [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) - [Get customer's loyalty points](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyBalances) - [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) - [Get card's point balances](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/getLoyaltyCardBalances) - [List card's transactions](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/getLoyaltyCardTransactions) - [Link customer profile to card](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/linkLoyaltyCardToProfile) ### Management API - [Add points to card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/addLoyaltyCardPoints) - [Deduct points from card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/deductLoyaltyCardPoints) - [Delete loyalty card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/deleteLoyaltyCard) - [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) - [Get loyalty card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCard) - [Import loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/importLoyaltyCards) - [Transfer card data](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/transferLoyaltyCard) - [Update loyalty card status](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/updateLoyaltyCard) - [List card's transactions](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCardTransactionLogs) - [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) - [Export customer loyalty balances](https://docs.talon.one/management-api#tag/Loyalty/operation/exportLoyaltyBalances) -- please note deprecation notice blow - [Export all card transaction logs](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/exportLoyaltyCardBalances) - [Export card's ledger log](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/exportLoyaltyCardLedger) ### ⚠️⚠️ Migration to v3.0.0 from prior versions As part of introducing and incorporating [Cart Item Catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs) in the SDKs, we had to introduce some breaking changes to our `CartItem` model. Please refer to [this migration guide](https://github.com/talon-one/talon_go/blob/master/migrations/Migration-v3.md) for a detailed explanation about the required changes. ## ⚠️ Deprecation Notice: Export customer loyalty balance to CSV endpoint Please note that the [Export customer loyalty balance to CSV](https://docs.talon.one/management-api#tag/Loyalty/operation/exportLoyaltyBalance) endpoint is getting deprecated, please update your code to point at the new [Export customer loyalty balances](https://docs.talon.one/management-api#tag/Loyalty/operation/exportLoyaltyBalances) ## Commit summary * Initial Commit * Fix talang expression field definitions * Use management-key authorization in README's mgmt API example * v3 migration guide, module version README examples --- README.md | 164 +- api/openapi.yaml | 13470 ++++++++++------ api_integration.go | 1388 +- api_management.go | 11203 +++++++++---- client.go | 6 +- configuration.go | 6 +- docs/Account.md | 6 +- docs/AccountAdditionalCost.md | 8 +- docs/AccountDashboardStatistic.md | 169 + docs/AccountDashboardStatisticApiCalls.md | 65 + docs/AccountDashboardStatisticCampaigns.md | 65 + docs/AccountDashboardStatisticDiscount.md | 91 + .../AccountDashboardStatisticLoyaltyPoints.md | 65 + docs/AccountDashboardStatisticReferrals.md | 65 + docs/AccountDashboardStatisticRevenue.md | 91 + docs/AddFreeItemEffectProps.md | 2 +- docs/AddLoyaltyPoints.md | 221 + docs/AddLoyaltyPointsEffectProps.md | 56 +- docs/AddedDeductedPointsNotificationPolicy.md | 65 + docs/Application.md | 8 +- docs/ApplicationApiHealth.md | 2 +- docs/ApplicationCustomer.md | 36 +- docs/ApplicationEvent.md | 14 +- docs/ApplicationSession.md | 6 +- docs/Attribute.md | 4 +- docs/Audience.md | 30 +- docs/AudienceCustomer.md | 351 + docs/BaseLoyaltyProgram.md | 30 +- docs/BaseNotification.md | 91 + docs/BaseNotificationEntity.md | 39 + docs/BaseNotificationWebhook.md | 143 + docs/BaseNotifications.md | 39 + docs/Binding.md | 2 +- docs/Campaign.md | 34 +- docs/CampaignCollection.md | 6 +- docs/CampaignCollectionWithoutPayload.md | 6 +- docs/CampaignCreatedNotification.md | 52 + docs/CampaignDeletedNotification.md | 26 + docs/CampaignEditedNotification.md | 26 + docs/CampaignGroup.md | 6 +- docs/CampaignPrioritiesChangedNotification.md | 46 +- docs/CampaignRulesetChangedNotification.md | 2 +- docs/CampaignSet.md | 30 +- docs/CampaignSetV2.md | 4 +- docs/CampaignStateChangedNotification.md | 26 + docs/CampaignTemplate.md | 26 +- docs/CardLedgerTransactionLogEntry.md | 8 +- ...LedgerTransactionLogEntryIntegrationApi.md | 8 +- docs/CartItem.md | 8 +- docs/Catalog.md | 6 +- docs/CatalogItem.md | 4 +- ...CatalogsStrikethroughNotificationPolicy.md | 39 + docs/Change.md | 32 +- docs/CodeGeneratorSettings.md | 2 +- docs/Collection.md | 6 +- docs/CollectionWithoutPayload.md | 6 +- docs/Coupon.md | 90 +- docs/CouponConstraints.md | 30 +- docs/CouponCreationJob.md | 36 +- docs/CouponsNotificationPolicy.md | 65 + docs/CreateManagementKey.md | 26 + docs/CreateTemplateCampaign.md | 2 +- docs/CustomEffect.md | 34 +- docs/CustomEffectProps.md | 104 + docs/CustomerActivityReport.md | 2 +- docs/CustomerProfile.md | 36 +- docs/CustomerProfileIntegrationRequestV2.md | 28 +- docs/CustomerProfileUpdateV2Response.md | 39 + docs/CustomerSession.md | 6 +- docs/CustomerSessionV2.md | 36 +- docs/DeductLoyaltyPoints.md | 117 + docs/DeductLoyaltyPointsEffectProps.md | 2 +- docs/Effect.md | 4 +- docs/EffectEntity.md | 2 +- docs/Entity.md | 4 +- docs/Environment.md | 4 +- docs/EvaluableCampaignIds.md | 39 + docs/Event.md | 6 +- docs/EventType.md | 10 +- docs/EventV2.md | 30 +- docs/ExpiringPointsNotificationPolicy.md | 65 + docs/ExpiringPointsNotificationTrigger.md | 65 + docs/Export.md | 6 +- docs/FeatureFlag.md | 8 +- docs/FrontendState.md | 11 + docs/Giveaway.md | 56 +- docs/GiveawaysPool.md | 30 +- docs/Import.md | 6 +- docs/InlineResponse2001.md | 10 +- docs/InlineResponse20010.md | 38 +- docs/InlineResponse20011.md | 36 +- docs/InlineResponse20012.md | 38 +- docs/InlineResponse20013.md | 10 +- docs/InlineResponse20014.md | 36 +- docs/InlineResponse20015.md | 38 +- docs/InlineResponse20016.md | 38 +- docs/InlineResponse20017.md | 38 +- docs/InlineResponse20018.md | 10 +- docs/InlineResponse20019.md | 36 +- docs/InlineResponse2002.md | 36 +- docs/InlineResponse20020.md | 36 +- docs/InlineResponse20021.md | 38 +- docs/InlineResponse20022.md | 38 +- docs/InlineResponse20023.md | 10 +- docs/InlineResponse20024.md | 36 +- docs/InlineResponse20025.md | 36 +- docs/InlineResponse20026.md | 36 +- docs/InlineResponse20027.md | 36 +- docs/InlineResponse20028.md | 10 +- docs/InlineResponse20029.md | 38 +- docs/InlineResponse2003.md | 10 +- docs/InlineResponse20030.md | 38 +- docs/InlineResponse20031.md | 10 +- docs/InlineResponse20032.md | 38 +- docs/InlineResponse20033.md | 10 +- docs/InlineResponse20034.md | 10 +- docs/InlineResponse20035.md | 65 + docs/InlineResponse20036.md | 65 + docs/InlineResponse20037.md | 65 + docs/InlineResponse20038.md | 91 + docs/InlineResponse20039.md | 65 + docs/InlineResponse2004.md | 10 +- docs/InlineResponse20040.md | 65 + docs/InlineResponse2005.md | 10 +- docs/InlineResponse2006.md | 10 +- docs/InlineResponse2007.md | 26 +- docs/InlineResponse2008.md | 10 +- docs/InlineResponse2009.md | 36 +- docs/IntegrationApi.md | 322 +- docs/IntegrationCoupon.md | 585 + docs/IntegrationEntity.md | 2 +- docs/IntegrationEventV2Request.md | 30 +- docs/IntegrationRequest.md | 2 +- docs/IntegrationStateV2.md | 12 +- docs/InventoryCoupon.md | 90 +- docs/InventoryReferral.md | 6 +- docs/LedgerEntry.md | 6 +- docs/LedgerInfo.md | 58 +- ...LedgerTransactionLogEntryIntegrationApi.md | 8 +- docs/LimitCounter.md | 12 +- docs/LoyaltyCard.md | 64 +- docs/LoyaltyCardProfileRegistration.md | 2 +- docs/LoyaltyLedgerEntry.md | 28 +- docs/LoyaltyPoints.md | 143 - docs/LoyaltyProgram.md | 34 +- docs/LoyaltyProgramBalance.md | 32 +- docs/LoyaltyProgramTransaction.md | 455 + docs/LoyaltyProjection.md | 91 - docs/LoyaltyProjectionData.md | 117 - docs/LoyaltyTier.md | 4 +- docs/ManagementApi.md | 1502 +- docs/ManagementKey.md | 26 + docs/MultiApplicationEntity.md | 2 +- docs/MultipleAudiencesItem.md | 4 +- ...leCustomerProfileIntegrationRequestItem.md | 2 +- ...pleCustomerProfileIntegrationResponseV2.md | 10 +- docs/MutableEntity.md | 2 +- docs/NewAdditionalCost.md | 4 +- docs/NewApplication.md | 2 +- docs/NewAudience.md | 26 + docs/NewBaseNotification.md | 65 + docs/NewCampaign.md | 6 +- docs/NewCampaignTemplate.md | 8 +- docs/NewCouponCreationJob.md | 32 +- docs/NewCoupons.md | 58 +- docs/NewCouponsForMultipleRecipients.md | 30 +- docs/NewCustomEffect.md | 28 +- docs/NewCustomerSession.md | 4 +- docs/NewCustomerSessionV2.md | 32 +- docs/NewEventType.md | 6 +- docs/NewGiveawaysPool.md | 26 + docs/NewInvitation.md | 2 +- docs/NewLoyaltyProgram.md | 30 +- docs/NewManagementKey.md | 26 + docs/NewNotificationWebhook.md | 4 +- docs/NewOutgoingIntegrationWebhook.md | 65 + docs/NewPicklist.md | 65 + docs/NewReferral.md | 2 +- docs/NewReferralsForMultipleAdvocates.md | 4 +- docs/NewRole.md | 2 +- docs/NewRuleset.md | 26 + docs/NewTemplateDef.md | 10 +- docs/NewWebhook.md | 8 +- docs/NotificationWebhook.md | 10 +- docs/OutgoingIntegrationBrazePolicy.md | 65 + docs/OutgoingIntegrationConfiguration.md | 117 + docs/OutgoingIntegrationType.md | 143 + docs/OutgoingIntegrationTypes.md | 39 + docs/OutgoingIntegrationWebhookTemplate.md | 169 + docs/OutgoingIntegrationWebhookTemplates.md | 39 + docs/Picklist.md | 221 + docs/PriorityPosition.md | 65 + docs/Referral.md | 6 +- docs/ReferralConstraints.md | 2 +- docs/ReopenSessionResponse.md | 39 + docs/ReserveCouponEffectProps.md | 91 + docs/Return.md | 4 +- docs/ReturnIntegrationRequest.md | 2 +- docs/ReturnedCartItem.md | 2 +- docs/Role.md | 10 +- docs/RoleV2.md | 143 + docs/RoleV2ApplicationDetails.md | 91 + docs/RoleV2PermissionSet.md | 65 + docs/RoleV2Permissions.md | 65 + docs/RoleV2PermissionsRoles.md | 91 + docs/RollbackAddedLoyaltyPointsEffectProps.md | 4 +- ...ollbackDeductedLoyaltyPointsEffectProps.md | 2 +- docs/Rule.md | 53 + docs/Ruleset.md | 32 +- docs/SamlConnection.md | 4 +- docs/SetDiscountEffectProps.md | 2 +- ...SetDiscountPerAdditionalCostEffectProps.md | 2 +- ...ountPerAdditionalCostPerItemEffectProps.md | 4 +- docs/SetDiscountPerItemEffectProps.md | 4 +- docs/StrikethroughChangedItem.md | 195 + docs/StrikethroughCustomEffectPerItemProps.md | 91 + docs/StrikethroughEffect.md | 169 + docs/StrikethroughLabelingNotification.md | 143 + ...ikethroughSetDiscountPerItemEffectProps.md | 65 + docs/StrikethroughTrigger.md | 143 + docs/TalangAttribute.md | 247 + docs/TalangAttributeVisibility.md | 65 + docs/TemplateArgDef.md | 52 + docs/TemplateDef.md | 4 +- docs/TransferLoyaltyCard.md | 39 + docs/UpdateApplication.md | 2 +- docs/UpdateCampaignTemplate.md | 16 +- docs/UpdateCoupon.md | 56 +- docs/UpdateCouponBatch.md | 30 +- docs/UpdateCustomEffect.md | 28 +- docs/UpdateLoyaltyCard.md | 2 +- docs/UpdateLoyaltyProgram.md | 30 +- docs/UpdatePicklist.md | 65 + docs/UpdateReferral.md | 2 +- docs/UpdateReferralBatch.md | 2 +- docs/UpdateRole.md | 2 +- docs/UpdateUser.md | 2 +- docs/User.md | 6 +- docs/UserEntity.md | 2 +- docs/Webhook.md | 14 +- go.mod | 2 +- Migration-v2.md => migrations/Migration-v2.md | 0 migrations/Migration-v3.md | 159 + model_accept_coupon_effect_props.go | 4 +- model_accept_referral_effect_props.go | 4 +- model_access_log_entry.go | 4 +- model_account.go | 10 +- model_account_additional_cost.go | 12 +- model_account_analytics.go | 4 +- model_account_dashboard_statistic.go | 233 + ...l_account_dashboard_statistic_api_calls.go | 77 + ...l_account_dashboard_statistic_campaigns.go | 76 + model_account_dashboard_statistic_discount.go | 94 + ...ount_dashboard_statistic_loyalty_points.go | 77 + ...l_account_dashboard_statistic_referrals.go | 77 + model_account_dashboard_statistic_revenue.go | 94 + model_account_entity.go | 4 +- model_account_limits.go | 4 +- model_add_free_item_effect_props.go | 6 +- model_add_item_catalog_action.go | 4 +- model_add_loyalty_points.go | 305 + model_add_loyalty_points_effect_props.go | 78 +- ...ded_deducted_points_notification_policy.go | 75 + model_additional_cost.go | 4 +- model_api_error.go | 4 +- model_application.go | 12 +- model_application_api_health.go | 6 +- model_application_api_key.go | 4 +- model_application_campaign_stats.go | 4 +- model_application_customer.go | 49 +- model_application_customer_entity.go | 4 +- model_application_entity.go | 4 +- model_application_event.go | 16 +- model_application_notification.go | 4 +- model_application_referee.go | 4 +- model_application_session.go | 10 +- model_application_session_entity.go | 4 +- model_async_coupon_creation_response.go | 4 +- model_attribute.go | 8 +- model_attributes_mandatory.go | 4 +- model_attributes_settings.go | 4 +- model_audience.go | 43 +- model_audience_analytics.go | 4 +- model_audience_customer.go | 354 + model_audience_integration_id.go | 4 +- model_audience_membership.go | 4 +- model_award_giveaway_effect_props.go | 4 +- model_base_loyalty_program.go | 43 +- model_base_notification.go | 91 + model_base_notification_entity.go | 58 + model_base_notification_webhook.go | 128 + model_base_notifications.go | 77 + model_base_saml_connection.go | 4 +- model_binding.go | 4 +- model_bulk_application_notification.go | 4 +- model_bulk_campaign_notification.go | 4 +- model_campaign.go | 47 +- model_campaign_activation_request.go | 4 +- model_campaign_analytics.go | 4 +- model_campaign_collection.go | 10 +- model_campaign_collection_without_payload.go | 10 +- model_campaign_copy.go | 4 +- model_campaign_created_notification.go | 56 +- model_campaign_deleted_notification.go | 22 +- model_campaign_edited_notification.go | 38 +- model_campaign_entity.go | 4 +- model_campaign_group.go | 10 +- model_campaign_group_entity.go | 4 +- model_campaign_notification.go | 4 +- ...ampaign_priorities_changed_notification.go | 45 +- model_campaign_priorities_v2.go | 4 +- ...l_campaign_ruleset_changed_notification.go | 34 +- model_campaign_search.go | 4 +- model_campaign_set.go | 43 +- model_campaign_set_branch_node.go | 4 +- model_campaign_set_i_ds.go | 4 +- model_campaign_set_leaf_node.go | 4 +- model_campaign_set_node.go | 4 +- model_campaign_set_v2.go | 8 +- model_campaign_state_changed_notification.go | 40 +- model_campaign_template.go | 30 +- model_campaign_template_collection.go | 4 +- model_campaign_template_params.go | 4 +- model_card_ledger_transaction_log_entry.go | 40 +- ...r_transaction_log_entry_integration_api.go | 40 +- model_cart_item.go | 70 +- model_catalog.go | 10 +- model_catalog_action.go | 4 +- model_catalog_action_filter.go | 4 +- model_catalog_item.go | 8 +- model_catalog_sync_request.go | 4 +- ...alogs_strikethrough_notification_policy.go | 59 + model_change.go | 45 +- model_change_profile_password.go | 4 +- model_code_generator_settings.go | 6 +- model_collection.go | 10 +- model_collection_item.go | 4 +- model_collection_without_payload.go | 10 +- model_coupon.go | 121 +- model_coupon_constraints.go | 43 +- model_coupon_created_effect_props.go | 4 +- model_coupon_creation_job.go | 49 +- model_coupon_limit_configs.go | 4 +- model_coupon_rejection_reason.go | 4 +- model_coupon_reservations.go | 4 +- model_coupon_search.go | 4 +- model_coupon_value.go | 4 +- model_coupons_notification_policy.go | 75 + model_create_application_api_key.go | 4 +- model_create_management_key.go | 39 +- model_create_template_campaign.go | 6 +- model_create_template_campaign_response.go | 4 +- model_custom_effect.go | 47 +- model_custom_effect_props.go | 144 +- model_customer_activity_report.go | 6 +- model_customer_analytics.go | 4 +- model_customer_inventory.go | 4 +- model_customer_profile.go | 49 +- model_customer_profile_audience_request.go | 4 +- ..._customer_profile_audience_request_item.go | 4 +- ...customer_profile_integration_request_v2.go | 45 +- model_customer_profile_search_query.go | 4 +- model_customer_profile_update_v2_response.go | 58 + model_customer_session.go | 10 +- model_customer_session_v2.go | 49 +- model_deduct_loyalty_points.go | 164 + model_deduct_loyalty_points_effect_props.go | 6 +- model_effect.go | 11 +- model_effect_entity.go | 6 +- model_email_entity.go | 4 +- model_endpoint.go | 4 +- model_entity.go | 8 +- model_entity_with_talang_visible_id.go | 4 +- model_environment.go | 8 +- model_error_effect_props.go | 4 +- model_error_response.go | 4 +- model_error_response_with_status.go | 4 +- model_error_source.go | 4 +- model_evaluable_campaign_ids.go | 77 + model_event.go | 10 +- model_event_type.go | 14 +- model_event_v2.go | 43 +- model_expiring_points_notification_policy.go | 75 + model_expiring_points_notification_trigger.go | 76 + model_export.go | 10 +- model_feature_flag.go | 12 +- model_features_feed.go | 4 +- model_feed_notification.go | 4 +- model_frontend_state.go | 50 + model_func_arg_def.go | 4 +- model_function_def.go | 4 +- model_giveaway.go | 78 +- model_giveaways_pool.go | 25 +- model_import.go | 10 +- model_import_entity.go | 4 +- model_inline_response_200.go | 4 +- model_inline_response_200_1.go | 14 +- model_inline_response_200_10.go | 76 +- model_inline_response_200_11.go | 28 +- model_inline_response_200_12.go | 76 +- model_inline_response_200_13.go | 14 +- model_inline_response_200_14.go | 30 +- model_inline_response_200_15.go | 76 +- model_inline_response_200_16.go | 76 +- model_inline_response_200_17.go | 76 +- model_inline_response_200_18.go | 14 +- model_inline_response_200_19.go | 28 +- model_inline_response_200_2.go | 28 +- model_inline_response_200_20.go | 48 +- model_inline_response_200_21.go | 76 +- model_inline_response_200_22.go | 76 +- model_inline_response_200_23.go | 16 +- model_inline_response_200_24.go | 30 +- model_inline_response_200_25.go | 28 +- model_inline_response_200_26.go | 48 +- model_inline_response_200_27.go | 28 +- model_inline_response_200_28.go | 14 +- model_inline_response_200_29.go | 76 +- model_inline_response_200_3.go | 14 +- model_inline_response_200_30.go | 76 +- model_inline_response_200_31.go | 14 +- model_inline_response_200_32.go | 76 +- model_inline_response_200_33.go | 14 +- model_inline_response_200_34.go | 14 +- model_inline_response_200_35.go | 74 + model_inline_response_200_36.go | 74 + model_inline_response_200_37.go | 74 + model_inline_response_200_38.go | 126 + model_inline_response_200_39.go | 74 + model_inline_response_200_4.go | 14 +- model_inline_response_200_40.go | 74 + model_inline_response_200_5.go | 14 +- model_inline_response_200_6.go | 14 +- model_inline_response_200_7.go | 22 +- model_inline_response_200_8.go | 14 +- model_inline_response_200_9.go | 28 +- model_inline_response_201.go | 4 +- model_integration_coupon.go | 687 + ...l_integration_customer_session_response.go | 4 +- model_integration_entity.go | 6 +- model_integration_event.go | 4 +- model_integration_event_v2_request.go | 43 +- model_integration_profile_entity.go | 4 +- model_integration_request.go | 6 +- model_integration_state.go | 4 +- model_integration_state_v2.go | 21 +- model_inventory_coupon.go | 121 +- model_inventory_referral.go | 10 +- model_item_attribute.go | 4 +- model_ledger_entry.go | 10 +- model_ledger_info.go | 83 +- ...r_transaction_log_entry_integration_api.go | 40 +- model_library_attribute.go | 4 +- model_limit_config.go | 4 +- model_limit_counter.go | 20 +- model_login_params.go | 4 +- model_loyalty.go | 4 +- model_loyalty_balance.go | 4 +- model_loyalty_balances.go | 4 +- model_loyalty_card.go | 84 +- model_loyalty_card_profile_registration.go | 6 +- model_loyalty_card_registration.go | 4 +- model_loyalty_dashboard_data.go | 4 +- model_loyalty_dashboard_points_breakdown.go | 4 +- model_loyalty_ledger.go | 4 +- model_loyalty_ledger_entry.go | 41 +- model_loyalty_ledger_transactions.go | 4 +- model_loyalty_membership.go | 4 +- model_loyalty_points.go | 199 - model_loyalty_program.go | 29 +- model_loyalty_program_balance.go | 45 +- model_loyalty_program_entity.go | 4 +- model_loyalty_program_ledgers.go | 4 +- model_loyalty_program_transaction.go | 476 + model_loyalty_projection.go | 110 - model_loyalty_projection_data.go | 111 - model_loyalty_statistics.go | 4 +- model_loyalty_sub_ledger.go | 4 +- model_loyalty_tier.go | 8 +- model_management_key.go | 39 +- model_manager_config.go | 4 +- model_meta.go | 4 +- model_multi_application_entity.go | 6 +- model_multiple_attribute.go | 4 +- model_multiple_audiences.go | 4 +- model_multiple_audiences_item.go | 8 +- ...le_customer_profile_integration_request.go | 4 +- ...stomer_profile_integration_request_item.go | 6 +- ...ustomer_profile_integration_response_v2.go | 18 +- model_multiple_new_attribute.go | 4 +- model_multiple_new_audiences.go | 4 +- model_mutable_entity.go | 6 +- model_new_account.go | 4 +- model_new_account_sign_up.go | 4 +- model_new_additional_cost.go | 8 +- model_new_application.go | 6 +- model_new_application_api_key.go | 4 +- model_new_attribute.go | 4 +- model_new_audience.go | 40 +- model_new_base_notification.go | 74 + model_new_campaign.go | 10 +- model_new_campaign_collection.go | 4 +- model_new_campaign_group.go | 4 +- model_new_campaign_set.go | 4 +- model_new_campaign_set_v2.go | 4 +- model_new_campaign_template.go | 12 +- model_new_catalog.go | 4 +- model_new_collection.go | 4 +- model_new_coupon_creation_job.go | 45 +- model_new_coupons.go | 80 +- model_new_coupons_for_multiple_recipients.go | 43 +- model_new_custom_effect.go | 41 +- model_new_customer_profile.go | 4 +- model_new_customer_session.go | 8 +- model_new_customer_session_v2.go | 47 +- model_new_event.go | 4 +- model_new_event_type.go | 10 +- model_new_giveaways_pool.go | 21 +- model_new_internal_audience.go | 4 +- model_new_invitation.go | 6 +- model_new_invite_email.go | 4 +- model_new_loyalty_program.go | 25 +- model_new_loyalty_tier.go | 4 +- model_new_management_key.go | 39 +- model_new_multiple_audiences_item.go | 4 +- model_new_notification_webhook.go | 8 +- model_new_outgoing_integration_webhook.go | 76 + model_new_password.go | 4 +- model_new_password_email.go | 4 +- model_new_picklist.go | 76 + model_new_referral.go | 6 +- model_new_referrals_for_multiple_advocates.go | 8 +- model_new_return.go | 4 +- model_new_role.go | 6 +- model_new_ruleset.go | 39 +- model_new_saml_connection.go | 4 +- model_new_template_def.go | 12 +- model_new_user.go | 4 +- model_new_webhook.go | 12 +- model_notification.go | 4 +- model_notification_webhook.go | 14 +- model_outgoing_integration_braze_policy.go | 76 + model_outgoing_integration_configuration.go | 109 + model_outgoing_integration_type.go | 181 + model_outgoing_integration_types.go | 77 + ...l_outgoing_integration_webhook_template.go | 144 + ..._outgoing_integration_webhook_templates.go | 77 + model_patch_item_catalog_action.go | 4 +- model_patch_many_items_catalog_action.go | 4 +- model_picklist.go | 233 + model_priority_position.go | 76 + model_profile_audiences_changes.go | 4 +- model_redeem_referral_effect_props.go | 4 +- model_referral.go | 10 +- model_referral_constraints.go | 6 +- model_referral_created_effect_props.go | 4 +- model_referral_rejection_reason.go | 4 +- model_reject_coupon_effect_props.go | 4 +- model_reject_referral_effect_props.go | 4 +- model_remove_item_catalog_action.go | 4 +- model_remove_many_items_catalog_action.go | 4 +- model_reopen_session_response.go | 59 + model_reserve_coupon_effect_props.go | 93 + model_return.go | 8 +- model_return_integration_request.go | 6 +- model_returned_cart_item.go | 6 +- model_role.go | 14 +- model_role_assign.go | 4 +- model_role_membership.go | 4 +- model_role_v2.go | 216 + model_role_v2_application_details.go | 147 + model_role_v2_permission_set.go | 75 + model_role_v2_permissions.go | 111 + model_role_v2_permissions_roles.go | 144 + ...lback_added_loyalty_points_effect_props.go | 8 +- model_rollback_coupon_effect_props.go | 4 +- ...ck_deducted_loyalty_points_effect_props.go | 6 +- model_rollback_discount_effect_props.go | 4 +- model_rollback_referral_effect_props.go | 4 +- model_rule.go | 74 +- model_rule_failure_reason.go | 4 +- model_ruleset.go | 45 +- model_saml_connection.go | 8 +- model_saml_connection_metadata.go | 4 +- model_saml_login_endpoint.go | 4 +- model_session.go | 4 +- model_set_discount_effect_props.go | 6 +- ...scount_per_additional_cost_effect_props.go | 6 +- ...r_additional_cost_per_item_effect_props.go | 8 +- model_set_discount_per_item_effect_props.go | 8 +- model_show_bundle_metadata_effect_props.go | 4 +- model_show_notification_effect_props.go | 4 +- model_slot_def.go | 4 +- model_strikethrough_changed_item.go | 179 + ...ikethrough_custom_effect_per_item_props.go | 93 + model_strikethrough_effect.go | 143 + model_strikethrough_labeling_notification.go | 125 + ...ough_set_discount_per_item_effect_props.go | 76 + model_strikethrough_trigger.go | 128 + model_talang_attribute.go | 267 + model_talang_attribute_visibility.go | 112 + model_template_arg_def.go | 74 +- model_template_def.go | 8 +- model_template_limit_config.go | 4 +- model_tier.go | 4 +- model_transfer_loyalty_card.go | 59 + model_trigger_webhook_effect_props.go | 4 +- model_update_account.go | 4 +- model_update_application.go | 6 +- model_update_attribute_effect_props.go | 4 +- model_update_audience.go | 4 +- model_update_campaign.go | 4 +- model_update_campaign_collection.go | 4 +- model_update_campaign_group.go | 4 +- model_update_campaign_template.go | 20 +- model_update_catalog.go | 4 +- model_update_collection.go | 4 +- model_update_coupon.go | 78 +- model_update_coupon_batch.go | 43 +- model_update_custom_effect.go | 41 +- model_update_loyalty_card.go | 6 +- model_update_loyalty_program.go | 43 +- model_update_picklist.go | 76 + model_update_referral.go | 6 +- model_update_referral_batch.go | 6 +- model_update_role.go | 6 +- model_update_user.go | 6 +- model_update_user_latest_feed_timestamp.go | 4 +- model_user.go | 10 +- model_user_entity.go | 6 +- model_user_feed_notifications.go | 4 +- model_webhook.go | 18 +- model_webhook_activation_log_entry.go | 4 +- model_webhook_log_entry.go | 6 +- model_will_award_giveaway_effect_props.go | 4 +- response.go | 4 +- utils.go | 4 +- 637 files changed, 39448 insertions(+), 12061 deletions(-) create mode 100644 docs/AccountDashboardStatistic.md create mode 100644 docs/AccountDashboardStatisticApiCalls.md create mode 100644 docs/AccountDashboardStatisticCampaigns.md create mode 100644 docs/AccountDashboardStatisticDiscount.md create mode 100644 docs/AccountDashboardStatisticLoyaltyPoints.md create mode 100644 docs/AccountDashboardStatisticReferrals.md create mode 100644 docs/AccountDashboardStatisticRevenue.md create mode 100644 docs/AddLoyaltyPoints.md create mode 100644 docs/AddedDeductedPointsNotificationPolicy.md create mode 100644 docs/AudienceCustomer.md create mode 100644 docs/BaseNotification.md create mode 100644 docs/BaseNotificationEntity.md create mode 100644 docs/BaseNotificationWebhook.md create mode 100644 docs/BaseNotifications.md create mode 100644 docs/CatalogsStrikethroughNotificationPolicy.md create mode 100644 docs/CouponsNotificationPolicy.md create mode 100644 docs/CustomerProfileUpdateV2Response.md create mode 100644 docs/DeductLoyaltyPoints.md create mode 100644 docs/EvaluableCampaignIds.md create mode 100644 docs/ExpiringPointsNotificationPolicy.md create mode 100644 docs/ExpiringPointsNotificationTrigger.md create mode 100644 docs/FrontendState.md create mode 100644 docs/InlineResponse20035.md create mode 100644 docs/InlineResponse20036.md create mode 100644 docs/InlineResponse20037.md create mode 100644 docs/InlineResponse20038.md create mode 100644 docs/InlineResponse20039.md create mode 100644 docs/InlineResponse20040.md create mode 100644 docs/IntegrationCoupon.md delete mode 100644 docs/LoyaltyPoints.md create mode 100644 docs/LoyaltyProgramTransaction.md delete mode 100644 docs/LoyaltyProjection.md delete mode 100644 docs/LoyaltyProjectionData.md create mode 100644 docs/NewBaseNotification.md create mode 100644 docs/NewOutgoingIntegrationWebhook.md create mode 100644 docs/NewPicklist.md create mode 100644 docs/OutgoingIntegrationBrazePolicy.md create mode 100644 docs/OutgoingIntegrationConfiguration.md create mode 100644 docs/OutgoingIntegrationType.md create mode 100644 docs/OutgoingIntegrationTypes.md create mode 100644 docs/OutgoingIntegrationWebhookTemplate.md create mode 100644 docs/OutgoingIntegrationWebhookTemplates.md create mode 100644 docs/Picklist.md create mode 100644 docs/PriorityPosition.md create mode 100644 docs/ReopenSessionResponse.md create mode 100644 docs/ReserveCouponEffectProps.md create mode 100644 docs/RoleV2.md create mode 100644 docs/RoleV2ApplicationDetails.md create mode 100644 docs/RoleV2PermissionSet.md create mode 100644 docs/RoleV2Permissions.md create mode 100644 docs/RoleV2PermissionsRoles.md create mode 100644 docs/StrikethroughChangedItem.md create mode 100644 docs/StrikethroughCustomEffectPerItemProps.md create mode 100644 docs/StrikethroughEffect.md create mode 100644 docs/StrikethroughLabelingNotification.md create mode 100644 docs/StrikethroughSetDiscountPerItemEffectProps.md create mode 100644 docs/StrikethroughTrigger.md create mode 100644 docs/TalangAttribute.md create mode 100644 docs/TalangAttributeVisibility.md create mode 100644 docs/TransferLoyaltyCard.md create mode 100644 docs/UpdatePicklist.md rename Migration-v2.md => migrations/Migration-v2.md (100%) create mode 100644 migrations/Migration-v3.md create mode 100644 model_account_dashboard_statistic.go create mode 100644 model_account_dashboard_statistic_api_calls.go create mode 100644 model_account_dashboard_statistic_campaigns.go create mode 100644 model_account_dashboard_statistic_discount.go create mode 100644 model_account_dashboard_statistic_loyalty_points.go create mode 100644 model_account_dashboard_statistic_referrals.go create mode 100644 model_account_dashboard_statistic_revenue.go create mode 100644 model_add_loyalty_points.go create mode 100644 model_added_deducted_points_notification_policy.go create mode 100644 model_audience_customer.go create mode 100644 model_base_notification.go create mode 100644 model_base_notification_entity.go create mode 100644 model_base_notification_webhook.go create mode 100644 model_base_notifications.go create mode 100644 model_catalogs_strikethrough_notification_policy.go create mode 100644 model_coupons_notification_policy.go create mode 100644 model_customer_profile_update_v2_response.go create mode 100644 model_deduct_loyalty_points.go create mode 100644 model_evaluable_campaign_ids.go create mode 100644 model_expiring_points_notification_policy.go create mode 100644 model_expiring_points_notification_trigger.go create mode 100644 model_frontend_state.go create mode 100644 model_inline_response_200_35.go create mode 100644 model_inline_response_200_36.go create mode 100644 model_inline_response_200_37.go create mode 100644 model_inline_response_200_38.go create mode 100644 model_inline_response_200_39.go create mode 100644 model_inline_response_200_40.go create mode 100644 model_integration_coupon.go delete mode 100644 model_loyalty_points.go create mode 100644 model_loyalty_program_transaction.go delete mode 100644 model_loyalty_projection.go delete mode 100644 model_loyalty_projection_data.go create mode 100644 model_new_base_notification.go create mode 100644 model_new_outgoing_integration_webhook.go create mode 100644 model_new_picklist.go create mode 100644 model_outgoing_integration_braze_policy.go create mode 100644 model_outgoing_integration_configuration.go create mode 100644 model_outgoing_integration_type.go create mode 100644 model_outgoing_integration_types.go create mode 100644 model_outgoing_integration_webhook_template.go create mode 100644 model_outgoing_integration_webhook_templates.go create mode 100644 model_picklist.go create mode 100644 model_priority_position.go create mode 100644 model_reopen_session_response.go create mode 100644 model_reserve_coupon_effect_props.go create mode 100644 model_role_v2.go create mode 100644 model_role_v2_application_details.go create mode 100644 model_role_v2_permission_set.go create mode 100644 model_role_v2_permissions.go create mode 100644 model_role_v2_permissions_roles.go create mode 100644 model_strikethrough_changed_item.go create mode 100644 model_strikethrough_custom_effect_per_item_props.go create mode 100644 model_strikethrough_effect.go create mode 100644 model_strikethrough_labeling_notification.go create mode 100644 model_strikethrough_set_discount_per_item_effect_props.go create mode 100644 model_strikethrough_trigger.go create mode 100644 model_talang_attribute.go create mode 100644 model_talang_attribute_visibility.go create mode 100644 model_transfer_loyalty_card.go create mode 100644 model_update_picklist.go diff --git a/README.md b/README.md index c47382c7..37a8621f 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. -For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, -the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint -is `https://mycompany.talon.one/v2/customer_sessions/{Id}` +For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, +the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint +is `https://yourbaseurl.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.6.1 +- API version: +- Package version: 3.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen ## Installation @@ -103,7 +103,7 @@ func main() { configuration.Servers = talon.ServerConfigurations{ { // Notice that there is no trailing '/' - URL: "https://mycompany.talon.one", + URL: "https://yourbaseurl.talon.one", Description: "Talon.One's API base URL", }, } @@ -114,7 +114,7 @@ func main() { // Create integration authentication context using api key integrationAuthContext := context.WithValue(context.Background(), talon.ContextAPIKeys, map[string]talon.APIKey{ - "Authorization": talon.APIKey{ + "Authorization": { Prefix: "ApiKey-v1", Key: "fd1fd219b1e953a6b2700e8034de5bfc877462ae106127311ddd710978654312", }, @@ -130,17 +130,17 @@ func main() { // Or alternatively, using the relevant setter in a later stage in the code newCustomerSession.SetCartItems([]talon.CartItem{ { - Name: "Pad Thai - Veggie", + Name: talon.PtrString("Pad Thai - Veggie"), Sku: "pad-332", Quantity: 1, - Price: 5.5, + Price: talon.PtrFloat32(5.5), Category: talon.PtrString("Noodles"), }, { - Name: "Chang", + Name: talon.PtrString("Chang"), Sku: "chang-br-42", Quantity: 1, - Price: 2.3, + Price: talon.PtrFloat32(2.3), Category: talon.PtrString("Beverages"), }, }) @@ -229,7 +229,7 @@ func main() { configuration.Servers = talon.ServerConfigurations{ { // Notice that there is no trailing '/' - URL: "https://mycompany.talon.one", + URL: "https://yourbaseurl.talon.one", Description: "Talon.One's API base URL", }, } @@ -238,24 +238,11 @@ func main() { managementClient := talon.NewAPIClient(configuration) - session, _, err := managementClient.ManagementApi. - CreateSession(context.Background()). - Body(talon.LoginParams{ - Email: "admin@talon.one", - Password: "50meSecureVeryPa$$w0rd!", - }). - Execute() - - if err != nil { - fmt.Printf("ERROR while creating a new session using CreateSession: %s\n", err) - return - } - // Create integration authentication context using the logged-in session managerAuthContext := context.WithValue(context.Background(), talon.ContextAPIKeys, map[string]talon.APIKey{ "Authorization": talon.APIKey{ - Prefix: "Bearer", - Key: session.GetToken(), + Prefix: "ManagementKey-v1", + Key: "2f0dce055da01ae595005d7d79154bae7448d319d5fc7c5b2951fadd6ba1ea07", }, }) @@ -290,8 +277,13 @@ Class | Method | HTTP request | Description *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* | [**GetLoyaltyBalances**](docs/IntegrationApi.md#getloyaltybalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points +*IntegrationApi* | [**GetLoyaltyCardBalances**](docs/IntegrationApi.md#getloyaltycardbalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances +*IntegrationApi* | [**GetLoyaltyCardTransactions**](docs/IntegrationApi.md#getloyaltycardtransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions +*IntegrationApi* | [**GetLoyaltyProgramProfileTransactions**](docs/IntegrationApi.md#getloyaltyprogramprofiletransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions *IntegrationApi* | [**GetReservedCustomers**](docs/IntegrationApi.md#getreservedcustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved +*IntegrationApi* | [**LinkLoyaltyCardToProfile**](docs/IntegrationApi.md#linkloyaltycardtoprofile) | **Post** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card +*IntegrationApi* | [**ReopenCustomerSession**](docs/IntegrationApi.md#reopencustomersession) | **Put** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session *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 @@ -302,8 +294,9 @@ Class | Method | HTTP request | Description *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/{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* | [**AddLoyaltyCardPoints**](docs/ManagementApi.md#addloyaltycardpoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card +*ManagementApi* | [**AddLoyaltyPoints**](docs/ManagementApi.md#addloyaltypoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile +*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 @@ -312,15 +305,17 @@ Class | Method | HTTP request | Description *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* | [**CreateNotificationWebhook**](docs/ManagementApi.md#createnotificationwebhook) | **Post** /v1/applications/{applicationId}/notification_webhooks | Create notification about campaign-related changes *ManagementApi* | [**CreatePasswordRecoveryEmail**](docs/ManagementApi.md#createpasswordrecoveryemail) | **Post** /v1/password_recovery_emails | Request a password reset *ManagementApi* | [**CreateSession**](docs/ManagementApi.md#createsession) | **Post** /v1/sessions | Create session +*ManagementApi* | [**DeductLoyaltyCardPoints**](docs/ManagementApi.md#deductloyaltycardpoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card *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* | [**DeleteLoyaltyCard**](docs/ManagementApi.md#deleteloyaltycard) | **Delete** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card +*ManagementApi* | [**DeleteNotificationWebhook**](docs/ManagementApi.md#deletenotificationwebhook) | **Delete** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification about campaign-related changes *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* | [**ExportAccountCollectionItems**](docs/ManagementApi.md#exportaccountcollectionitems) | **Get** /v1/collections/{collectionId}/export | Export account-level collection's items @@ -328,8 +323,11 @@ Class | Method | HTTP request | Description *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* | [**ExportLoyaltyBalance**](docs/ManagementApi.md#exportloyaltybalance) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV +*ManagementApi* | [**ExportLoyaltyBalances**](docs/ManagementApi.md#exportloyaltybalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances +*ManagementApi* | [**ExportLoyaltyCardBalances**](docs/ManagementApi.md#exportloyaltycardbalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs +*ManagementApi* | [**ExportLoyaltyCardLedger**](docs/ManagementApi.md#exportloyaltycardledger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log +*ManagementApi* | [**ExportLoyaltyLedger**](docs/ManagementApi.md#exportloyaltyledger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs *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 @@ -339,8 +337,8 @@ Class | Method | HTTP request | Description *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* | [**GetApplicationApiHealth**](docs/ManagementApi.md#getapplicationapihealth) | **Get** /v1/applications/{applicationId}/health_report | Get report of health of application API +*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 Application health *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 *ManagementApi* | [**GetApplicationCustomers**](docs/ManagementApi.md#getapplicationcustomers) | **Get** /v1/applications/{applicationId}/customers | List application's customers @@ -349,13 +347,14 @@ 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* | [**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* | [**GetCampaignTemplates**](docs/ManagementApi.md#getcampaigntemplates) | **Get** /v1/campaign_templates | List campaign templates *ManagementApi* | [**GetCampaigns**](docs/ManagementApi.md#getcampaigns) | **Get** /v1/applications/{applicationId}/campaigns | List campaigns *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 @@ -369,12 +368,16 @@ Class | Method | HTTP request | Description *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/{loyaltyProgramId}/profile/{integrationId} | Get the Loyalty Ledger for this integrationID +*ManagementApi* | [**GetLoyaltyCard**](docs/ManagementApi.md#getloyaltycard) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card +*ManagementApi* | [**GetLoyaltyCardTransactionLogs**](docs/ManagementApi.md#getloyaltycardtransactionlogs) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions +*ManagementApi* | [**GetLoyaltyCards**](docs/ManagementApi.md#getloyaltycards) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards +*ManagementApi* | [**GetLoyaltyPoints**](docs/ManagementApi.md#getloyaltypoints) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger *ManagementApi* | [**GetLoyaltyProgram**](docs/ManagementApi.md#getloyaltyprogram) | **Get** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program +*ManagementApi* | [**GetLoyaltyProgramTransactions**](docs/ManagementApi.md#getloyaltyprogramtransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions *ManagementApi* | [**GetLoyaltyPrograms**](docs/ManagementApi.md#getloyaltyprograms) | **Get** /v1/loyalty_programs | List loyalty programs -*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* | [**GetLoyaltyStatistics**](docs/ManagementApi.md#getloyaltystatistics) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics +*ManagementApi* | [**GetNotificationWebhook**](docs/ManagementApi.md#getnotificationwebhook) | **Get** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Get notification about campaign-related changes +*ManagementApi* | [**GetNotificationWebhooks**](docs/ManagementApi.md#getnotificationwebhooks) | **Get** /v1/applications/{applicationId}/notification_webhooks | List notifications about campaign-related changes *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 @@ -389,16 +392,20 @@ Class | Method | HTTP request | Description *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* | [**ImportLoyaltyCards**](docs/ManagementApi.md#importloyaltycards) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards *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 *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* | [**PostAddedDeductedPointsNotification**](docs/ManagementApi.md#postaddeddeductedpointsnotification) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points +*ManagementApi* | [**PostCatalogsStrikethroughNotification**](docs/ManagementApi.md#postcatalogsstrikethroughnotification) | **Post** /v1/catalogs/{applicationId}/notifications/strikethrough | Create strikethrough notification +*ManagementApi* | [**RemoveLoyaltyPoints**](docs/ManagementApi.md#removeloyaltypoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile *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 (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* | [**TransferLoyaltyCard**](docs/ManagementApi.md#transferloyaltycard) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data *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 @@ -406,7 +413,8 @@ Class | Method | HTTP request | Description *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 coupons -*ManagementApi* | [**UpdateNotificationWebhook**](docs/ManagementApi.md#updatenotificationwebhook) | **Put** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification webhook +*ManagementApi* | [**UpdateLoyaltyCard**](docs/ManagementApi.md#updateloyaltycard) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status +*ManagementApi* | [**UpdateNotificationWebhook**](docs/ManagementApi.md#updatenotificationwebhook) | **Put** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification about campaign-related changes *ManagementApi* | [**UpdateReferral**](docs/ManagementApi.md#updatereferral) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral @@ -418,11 +426,20 @@ Class | Method | HTTP request | Description - [Account](docs/Account.md) - [AccountAdditionalCost](docs/AccountAdditionalCost.md) - [AccountAnalytics](docs/AccountAnalytics.md) + - [AccountDashboardStatistic](docs/AccountDashboardStatistic.md) + - [AccountDashboardStatisticApiCalls](docs/AccountDashboardStatisticApiCalls.md) + - [AccountDashboardStatisticCampaigns](docs/AccountDashboardStatisticCampaigns.md) + - [AccountDashboardStatisticDiscount](docs/AccountDashboardStatisticDiscount.md) + - [AccountDashboardStatisticLoyaltyPoints](docs/AccountDashboardStatisticLoyaltyPoints.md) + - [AccountDashboardStatisticReferrals](docs/AccountDashboardStatisticReferrals.md) + - [AccountDashboardStatisticRevenue](docs/AccountDashboardStatisticRevenue.md) - [AccountEntity](docs/AccountEntity.md) - [AccountLimits](docs/AccountLimits.md) - [AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md) - [AddItemCatalogAction](docs/AddItemCatalogAction.md) + - [AddLoyaltyPoints](docs/AddLoyaltyPoints.md) - [AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md) + - [AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md) - [AdditionalCost](docs/AdditionalCost.md) - [ApiError](docs/ApiError.md) - [Application](docs/Application.md) @@ -443,10 +460,15 @@ Class | Method | HTTP request | Description - [AttributesSettings](docs/AttributesSettings.md) - [Audience](docs/Audience.md) - [AudienceAnalytics](docs/AudienceAnalytics.md) + - [AudienceCustomer](docs/AudienceCustomer.md) - [AudienceIntegrationId](docs/AudienceIntegrationId.md) - [AudienceMembership](docs/AudienceMembership.md) - [AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md) - [BaseLoyaltyProgram](docs/BaseLoyaltyProgram.md) + - [BaseNotification](docs/BaseNotification.md) + - [BaseNotificationEntity](docs/BaseNotificationEntity.md) + - [BaseNotificationWebhook](docs/BaseNotificationWebhook.md) + - [BaseNotifications](docs/BaseNotifications.md) - [BaseSamlConnection](docs/BaseSamlConnection.md) - [Binding](docs/Binding.md) - [BulkApplicationNotification](docs/BulkApplicationNotification.md) @@ -486,6 +508,7 @@ Class | Method | HTTP request | Description - [CatalogActionFilter](docs/CatalogActionFilter.md) - [CatalogItem](docs/CatalogItem.md) - [CatalogSyncRequest](docs/CatalogSyncRequest.md) + - [CatalogsStrikethroughNotificationPolicy](docs/CatalogsStrikethroughNotificationPolicy.md) - [Change](docs/Change.md) - [ChangeProfilePassword](docs/ChangeProfilePassword.md) - [CodeGeneratorSettings](docs/CodeGeneratorSettings.md) @@ -501,6 +524,7 @@ Class | Method | HTTP request | Description - [CouponReservations](docs/CouponReservations.md) - [CouponSearch](docs/CouponSearch.md) - [CouponValue](docs/CouponValue.md) + - [CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md) - [CreateApplicationApiKey](docs/CreateApplicationApiKey.md) - [CreateManagementKey](docs/CreateManagementKey.md) - [CreateTemplateCampaign](docs/CreateTemplateCampaign.md) @@ -515,8 +539,10 @@ Class | Method | HTTP request | Description - [CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md) - [CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md) - [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md) + - [CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md) - [CustomerSession](docs/CustomerSession.md) - [CustomerSessionV2](docs/CustomerSessionV2.md) + - [DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md) - [DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md) - [Effect](docs/Effect.md) - [EffectEntity](docs/EffectEntity.md) @@ -529,13 +555,17 @@ Class | Method | HTTP request | Description - [ErrorResponse](docs/ErrorResponse.md) - [ErrorResponseWithStatus](docs/ErrorResponseWithStatus.md) - [ErrorSource](docs/ErrorSource.md) + - [EvaluableCampaignIds](docs/EvaluableCampaignIds.md) - [Event](docs/Event.md) - [EventType](docs/EventType.md) - [EventV2](docs/EventV2.md) + - [ExpiringPointsNotificationPolicy](docs/ExpiringPointsNotificationPolicy.md) + - [ExpiringPointsNotificationTrigger](docs/ExpiringPointsNotificationTrigger.md) - [Export](docs/Export.md) - [FeatureFlag](docs/FeatureFlag.md) - [FeaturesFeed](docs/FeaturesFeed.md) - [FeedNotification](docs/FeedNotification.md) + - [FrontendState](docs/FrontendState.md) - [FuncArgDef](docs/FuncArgDef.md) - [FunctionDef](docs/FunctionDef.md) - [Giveaway](docs/Giveaway.md) @@ -571,13 +601,20 @@ Class | Method | HTTP request | Description - [InlineResponse20032](docs/InlineResponse20032.md) - [InlineResponse20033](docs/InlineResponse20033.md) - [InlineResponse20034](docs/InlineResponse20034.md) + - [InlineResponse20035](docs/InlineResponse20035.md) + - [InlineResponse20036](docs/InlineResponse20036.md) + - [InlineResponse20037](docs/InlineResponse20037.md) + - [InlineResponse20038](docs/InlineResponse20038.md) + - [InlineResponse20039](docs/InlineResponse20039.md) - [InlineResponse2004](docs/InlineResponse2004.md) + - [InlineResponse20040](docs/InlineResponse20040.md) - [InlineResponse2005](docs/InlineResponse2005.md) - [InlineResponse2006](docs/InlineResponse2006.md) - [InlineResponse2007](docs/InlineResponse2007.md) - [InlineResponse2008](docs/InlineResponse2008.md) - [InlineResponse2009](docs/InlineResponse2009.md) - [InlineResponse201](docs/InlineResponse201.md) + - [IntegrationCoupon](docs/IntegrationCoupon.md) - [IntegrationCustomerSessionResponse](docs/IntegrationCustomerSessionResponse.md) - [IntegrationEntity](docs/IntegrationEntity.md) - [IntegrationEvent](docs/IntegrationEvent.md) @@ -608,13 +645,11 @@ Class | Method | HTTP request | Description - [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) + - [LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md) - [LoyaltyStatistics](docs/LoyaltyStatistics.md) - [LoyaltySubLedger](docs/LoyaltySubLedger.md) - [LoyaltyTier](docs/LoyaltyTier.md) @@ -638,6 +673,7 @@ Class | Method | HTTP request | Description - [NewApplicationApiKey](docs/NewApplicationApiKey.md) - [NewAttribute](docs/NewAttribute.md) - [NewAudience](docs/NewAudience.md) + - [NewBaseNotification](docs/NewBaseNotification.md) - [NewCampaign](docs/NewCampaign.md) - [NewCampaignCollection](docs/NewCampaignCollection.md) - [NewCampaignGroup](docs/NewCampaignGroup.md) @@ -664,8 +700,10 @@ Class | Method | HTTP request | Description - [NewManagementKey](docs/NewManagementKey.md) - [NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md) - [NewNotificationWebhook](docs/NewNotificationWebhook.md) + - [NewOutgoingIntegrationWebhook](docs/NewOutgoingIntegrationWebhook.md) - [NewPassword](docs/NewPassword.md) - [NewPasswordEmail](docs/NewPasswordEmail.md) + - [NewPicklist](docs/NewPicklist.md) - [NewReferral](docs/NewReferral.md) - [NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md) - [NewReturn](docs/NewReturn.md) @@ -677,8 +715,16 @@ Class | Method | HTTP request | Description - [NewWebhook](docs/NewWebhook.md) - [Notification](docs/Notification.md) - [NotificationWebhook](docs/NotificationWebhook.md) + - [OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md) + - [OutgoingIntegrationConfiguration](docs/OutgoingIntegrationConfiguration.md) + - [OutgoingIntegrationType](docs/OutgoingIntegrationType.md) + - [OutgoingIntegrationTypes](docs/OutgoingIntegrationTypes.md) + - [OutgoingIntegrationWebhookTemplate](docs/OutgoingIntegrationWebhookTemplate.md) + - [OutgoingIntegrationWebhookTemplates](docs/OutgoingIntegrationWebhookTemplates.md) - [PatchItemCatalogAction](docs/PatchItemCatalogAction.md) - [PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md) + - [Picklist](docs/Picklist.md) + - [PriorityPosition](docs/PriorityPosition.md) - [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) - [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) - [Referral](docs/Referral.md) @@ -689,12 +735,19 @@ Class | Method | HTTP request | Description - [RejectReferralEffectProps](docs/RejectReferralEffectProps.md) - [RemoveItemCatalogAction](docs/RemoveItemCatalogAction.md) - [RemoveManyItemsCatalogAction](docs/RemoveManyItemsCatalogAction.md) + - [ReopenSessionResponse](docs/ReopenSessionResponse.md) + - [ReserveCouponEffectProps](docs/ReserveCouponEffectProps.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) + - [RoleV2](docs/RoleV2.md) + - [RoleV2ApplicationDetails](docs/RoleV2ApplicationDetails.md) + - [RoleV2PermissionSet](docs/RoleV2PermissionSet.md) + - [RoleV2Permissions](docs/RoleV2Permissions.md) + - [RoleV2PermissionsRoles](docs/RoleV2PermissionsRoles.md) - [RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md) - [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md) - [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md) @@ -714,10 +767,19 @@ Class | Method | HTTP request | Description - [ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md) - [ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md) - [SlotDef](docs/SlotDef.md) + - [StrikethroughChangedItem](docs/StrikethroughChangedItem.md) + - [StrikethroughCustomEffectPerItemProps](docs/StrikethroughCustomEffectPerItemProps.md) + - [StrikethroughEffect](docs/StrikethroughEffect.md) + - [StrikethroughLabelingNotification](docs/StrikethroughLabelingNotification.md) + - [StrikethroughSetDiscountPerItemEffectProps](docs/StrikethroughSetDiscountPerItemEffectProps.md) + - [StrikethroughTrigger](docs/StrikethroughTrigger.md) + - [TalangAttribute](docs/TalangAttribute.md) + - [TalangAttributeVisibility](docs/TalangAttributeVisibility.md) - [TemplateArgDef](docs/TemplateArgDef.md) - [TemplateDef](docs/TemplateDef.md) - [TemplateLimitConfig](docs/TemplateLimitConfig.md) - [Tier](docs/Tier.md) + - [TransferLoyaltyCard](docs/TransferLoyaltyCard.md) - [TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md) - [UpdateAccount](docs/UpdateAccount.md) - [UpdateApplication](docs/UpdateApplication.md) @@ -734,6 +796,7 @@ Class | Method | HTTP request | Description - [UpdateCustomEffect](docs/UpdateCustomEffect.md) - [UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md) - [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) + - [UpdatePicklist](docs/UpdatePicklist.md) - [UpdateReferral](docs/UpdateReferral.md) - [UpdateReferralBatch](docs/UpdateReferralBatch.md) - [UpdateRole](docs/UpdateRole.md) @@ -761,6 +824,15 @@ Class | Method | HTTP request | Description Note, each API key must be added to a map of `map[string]APIKey` where the key is: Authorization and passed in as the auth context for each request. +### management_key + +- **Type**: API key +- **API key parameter name**: Authorization +- **Location**: HTTP header + +Note, each API key must be added to a map of `map[string]APIKey` where the key is: Authorization and passed in as the auth context for each request. + + ### manager_auth - **Type**: API key diff --git a/api/openapi.yaml b/api/openapi.yaml index 39cb6ce9..10034c04 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -12,43 +12,56 @@ info: ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. - For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, - the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint - is `https://mycompany.talon.one/v2/customer_sessions/{Id}` + For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, + the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint + is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` title: Talon.One API - version: 1.0.0 + version: "" servers: - url: https://yourbaseurl.talon.one/ security: - manager_auth: [] +- management_key: [] 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 regarding account statistics. + name: Account statistics - 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). + 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. + Analytics are used to retrieve statistical data about the performance of campaigns within an Application. name: Analytics - description: | - 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. + Represents an Application in the Campaign Manager. + An Application is the target of every Integration API request to Talon.One. One Application can hold various API keys used for Integration API requests. You may have multiple Applications within one account, for example staging and production, or different international markets. + + See the [docs](https://docs.talon.one/docs/product/applications/overview). name: Applications - description: | 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). + 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. + Represents lists of customer profiles that allow you to target specific groups of customers in your campaigns. + Audiences can be synced from customer data platforms or created directly in Talon.One. + + See the [docs](https://docs.talon.one/docs/product/audiences/overview). name: Audiences - description: | Represents the campaign groups users can create in their applications. @@ -57,24 +70,34 @@ tags: 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. + Represents the primary resource used to control the behavior of the Talon.One Rule Engine. + They combine rulesets, coupons, and limits into a single unit. + + See the [docs](https://docs.talon.one/docs/product/campaigns/overview). 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). + + See the [docs](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/). + + See the [docs](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. + 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. + + See the [docs](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). name: Coupons - description: | Represents the custom effects that users can create. + + See the [docs](https://docs.talon.one/docs/product/account/dev-tools/managing-custom-effects). name: Custom effects - description: | Represents the data of a customer, including sessions and events used for reporting and debugging in the Campaign Manager. @@ -88,8 +111,11 @@ tags: 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). + Sessions are a key concept of Talon.One. We strongly recommend you read the [documentation about customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session). name: Customer sessions +- description: | + Represents internal database-related operations. + name: Database - description: | 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. @@ -100,10 +126,12 @@ tags: name: Feature flags - description: | Represents a program that rewards customers with giveaways, such as free gift cards. + + See the [docs](https://docs.talon.one/docs/product/giveaways/overview). name: Giveaways - description: | 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 more background information about this API, see [Integration API overview](https://docs.talon.one/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. @@ -124,19 +152,34 @@ tags: name: Integration API +- description: | + Represents internal notification operations. Not to be confused with the [notifications relying on webhooks](#tag/Notification). + name: Internal notification operations +- description: | + Represents internal routing operations. + name: Internal routing - description: | Operations to query the Talon.One logs. They contain all incoming and outgoing requests. name: Logs - description: | - 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). + Represents loyalty programs or concepts related to them. + + Loyalty programs can be _profile-based_ or _card-based_, depending on whether loyalty points are linked + to [customer profiles](https://docs.talon.one/docs/product/applications/displaying-customer-profiles) or [loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview). + + See [the Product docs](https://docs.talon.one/docs/product/loyalty-programs/overview) for more information. 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) + Represents loyalty cards. - Use the Management API to programmatically do what the Campaign Manager does. + [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards) allow your customers to collect and spend loyalty points within a card-based loyalty program. + name: Loyalty cards +- description: | + The Management API allows you to programmatically do what the Campaign Manager does. For example, use it for management purposes and backoffice systems. + For more background information about this API, see [Management API overview](https://docs.talon.one/docs/dev/management-api/overview) + Ensure you [authenticate](#section/Authentication) to make requests to the API. **Warnings:** @@ -161,11 +204,16 @@ tags: 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. + Represents the notifications that customers can create about various events. See [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). name: Notifications +- description: | + Represents the outgoing integrations that we currently support. + + An outgoing integration may be, for example, a customer data platform or customer engagement platform. + name: Outgoing integrations +- description: | + Represents the picklist that users can create for a custom effect. + name: Picklists - description: | A referral is a code shared between a customer and a prospect. @@ -173,9 +221,13 @@ tags: - 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. + + See the [docs](https://docs.talon.one/docs/product/campaigns/referrals/referral-overview). name: Referrals - description: | Represents a set of permissions assigned to a user. + + See the [docs](https://docs.talon.one/docs/product/account/managing-roles). name: Roles - description: | Represents the endpoints related to the SAML config used for SSO. @@ -188,7 +240,9 @@ tags: 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). + 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}: @@ -206,7 +260,7 @@ paths: 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). + [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. in: path name: customerSessionId required: true @@ -238,45 +292,45 @@ paths: - integration put: description: | - Update or create a [customer session](/docs/dev/concepts/entities#customer-session). - For example, use this endpoint to share the content of a customer's cart with Talon.One and to check which - promotion rules apply. + Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. + For example, use this endpoint to share the contents of a customer's cart with Talon.One. - **Note:** The currency for the session and the cart items in the session is the same as the + **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### 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: - - - Track multiple independent sessions or, - - Use the same session across all of them. - - You should share sessions when application access points share other state, such as the user's cart. - 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 the [documentation](/docs/dev/concepts/entities#customer-session). + To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session) + and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - 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. + - A profile can be linked to simultaneous sessions in different Applications. Either: + - Use unique session integration IDs or, + - Use the same session integration ID across all of the Applications. - **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. + **Note:** If the specified profile does not exist, an empty profile is **created automatically**. + You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).

Performance tips

- 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). + Updating a customer session returns a response with the new 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 introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). + - 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 - when `dry=true`. + - description: | + Indicates whether to persist the changes. Changes are ignored when `dry=true`. + + When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. in: query name: dry schema: @@ -285,7 +339,7 @@ paths: 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). + [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. in: path name: customerSessionId required: true @@ -296,6 +350,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IntegrationRequest' + description: body required: true responses: "200": @@ -321,7 +376,7 @@ paths: application/json: schema: type: object - description: Too many requests - Avoid parallel requests, see the [docs](/docs/dev/tutorials/integrating-talon-one/#managing-parallel-requests). + description: Too many requests - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). security: - api_key_v1: [] summary: Update customer session @@ -335,7 +390,7 @@ paths: 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) + Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled for the Application. **Note:** This will roll back any effects associated with these cart items. For more information, see @@ -343,8 +398,8 @@ paths: and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). operationId: returnCartItems parameters: - - description: Indicates whether to persist the changes. Changes are ignored - when `dry=true`. + - description: | + Indicates whether to persist the changes. Changes are ignored when `dry=true`. in: query name: dry schema: @@ -353,7 +408,7 @@ paths: 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). + [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. in: path name: customerSessionId required: true @@ -364,6 +419,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReturnIntegrationRequest' + description: body required: true responses: "200": @@ -390,10 +446,79 @@ paths: tags: - integration x-codegen-request-body-name: body + /v2/customer_sessions/{customerSessionId}/reopen: + put: + description: | + Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). + For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. + A reopen session is treated like a standard open session. + + When reopening a session: + - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. + - The session state is updated to `open`. + - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. + +
+ Effects and budgets unimpacted by a session reopening +
+

The following effects and budgets are left the way they were once the session was originally closed:

+
    +
  • Add free item effect
    • +
  • Any not pending pending loyalty points.
    • +
  • Award giveaway
    • +
  • Coupon and referral creation
    • +
  • Coupon reservation
    • +
  • Custom effect
    • +
  • Update attribute value
    • +
  • Update cart item attribute value
    • +
+
+

To see an example of roll back, see the Cancelling a session with campaign budgets tutorial.

+
+ + **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the + [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel + a closed session and create a new one. + operationId: reopenCustomerSession + 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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. + in: path + name: customerSessionId + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ReopenSessionResponse' + 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: Reopen customer session + tags: + - integration /v2/customer_profiles/{integrationId}: put: description: | - Update or create a [Customer Profile](/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. + Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. @@ -437,9 +562,9 @@ paths: default: false type: boolean - description: | - Indicates whether to persist the changes. Changes are ignored when `dry=true`. + (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. - This property only works when `runRuleEngine=true`. + When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. in: query name: dry schema: @@ -449,6 +574,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CustomerProfileIntegrationRequestV2' + description: body required: true responses: "200": @@ -474,7 +600,7 @@ paths: application/json: schema: type: object - description: Too many requests - Avoid parallel requests, see the [docs](/docs/dev/tutorials/integrating-talon-one/#managing-parallel-requests). + description: Too many requests - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). security: - api_key_v1: [] summary: Update customer profile @@ -484,19 +610,19 @@ paths: /v2/customer_profiles: put: description: | - Update (or create) up to 1000 [customer profiles](/docs/dev/concepts/entities#customer-profile) in 1 request. + Update (or create) up to 1000 [customer profiles](https://docs.talon.one/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). + A customer profile [can be linked to one or more sessions](https://docs.talon.one/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. + - `no`: Returns a 200 response that contains the updated customer profiles. in: query name: silent schema: @@ -507,6 +633,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequest' + description: body required: true responses: "200": @@ -538,6 +665,8 @@ paths: description: | Create an audience. The audience can be created directly from scratch or can come from third party platforms. + **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). + 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. @@ -556,6 +685,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewAudience' + description: body required: true responses: "201": @@ -595,6 +725,8 @@ 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. + + **Note:** Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience). operationId: deleteAudienceV2 parameters: - description: The ID of the audience. You get it via the `id` property when @@ -626,6 +758,8 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Not found + security: + - api_key_v1: [] summary: Delete audience tags: - integration @@ -633,7 +767,7 @@ paths: description: | 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. - To update the audience's members, use the [Update customer profile endpoint](#tag/Customer-profiles/operation/updateCustomerProfileV2). + To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. operationId: updateAudienceV2 parameters: - description: The ID of the audience. You get it via the `id` property when @@ -648,6 +782,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateAudience' + description: body required: true responses: "200": @@ -703,6 +838,8 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Not found + security: + - api_key_v1: [] summary: Delete audience memberships tags: - integration @@ -719,6 +856,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CustomerProfileAudienceRequest' + description: body required: true responses: "204": @@ -766,6 +904,7 @@ paths: application/json: schema: $ref: '#/components/schemas/AttributeQuery' + description: body required: true responses: "204": @@ -789,24 +928,95 @@ paths: tags: - integration x-codegen-request-body-name: body + /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile: + post: + description: | + [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect + and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). + They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. + + Link a customer profile to a given loyalty card for the card to be set as **Registered**. + This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). + + **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows. + operationId: linkLoyaltyCardToProfile + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCardRegistration' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCard' + 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: Link customer profile to card + tags: + - integration + x-codegen-request-body-name: body /v1/events: post: + deprecated: true description: | - **Important:** This endpoint is **DEPRECATED**. Use [Track Event V2](https://docs.talon.one/integration-api/#tag/Events/operation/trackEventV2) instead. +
+

Deprecation warning

+

This endpoint is DEPRECATED and will be sunset on March 31st 2023. + Use Track Event V2 instead.

+

See Migrating to V2.

+
-
- 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. + Triggers a custom event in a customer session. You can then check this event in your rules. - 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). + Before using this endpoint, create your event as a custom attribute of type `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. -
+ 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 - when `dry=true`. + - description: | + Indicates whether to persist the changes. Changes are ignored when `dry=true`. in: query name: dry schema: @@ -816,6 +1026,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewEvent' + description: body required: true responses: "201": @@ -841,7 +1052,7 @@ paths: application/json: schema: type: object - description: Too many requests - Avoid parallel requests, see the [docs](/docs/dev/tutorials/integrating-talon-one/#managing-parallel-requests). + description: Too many requests - Avoid parallel requests. See the [docs](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one#managing-parallel-requests). security: - api_key_v1: [] summary: Track event @@ -851,9 +1062,9 @@ paths: /v2/events: post: description: | - Triggers a custom event. You can then check this event in your rules. + Triggers a custom event. You can build a condition around this event in your rules. - Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create + Talon.One offers a set of [built-in events](https://docs.talon.one/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. @@ -862,20 +1073,23 @@ paths: **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). + See the [Developer docs](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event). + + When you successfully sent an event to Talon.One, you can list received events in the + **Events** view in the Campaign Manager. 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. + - `no`: Returns a 200 response that contains the updated customer profiles. in: query name: silent schema: default: "yes" type: string - - description: Indicates whether to persist the changes. Changes are ignored - when `dry=true`. + - description: | + Indicates whether to persist the changes. Changes are ignored when `dry=true`. in: query name: dry schema: @@ -885,6 +1099,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IntegrationEventV2Request' + description: body required: true responses: "200": @@ -921,6 +1136,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewReferral' + description: body required: true responses: "201": @@ -956,7 +1172,7 @@ paths: - 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. + - `no`: Returns a 200 response that contains the updated customer profiles. in: query name: silent schema: @@ -967,6 +1183,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewReferralsForMultipleAdvocates' + description: body required: true responses: "201": @@ -1006,8 +1223,8 @@ paths: parameters: - 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). + - A customer session integration Id with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. + - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. in: path name: integrationId required: true @@ -1052,6 +1269,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CouponReservations' + description: body required: true responses: "204": @@ -1084,27 +1302,36 @@ paths: post: description: | Create a coupon reservation for specified customer profiles on the specified coupon. + You can also create a reservation via the Campaign Manager using the + [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer - with the [List customer data endpoint](/integration-api/#operation/getCustomerInventory). + with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - If a coupon gets created for a specific user, it will automatically show up in their coupons. + If a coupon gets created for a specific user, it will automatically appear in their coupons. 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 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. + the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. 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. + +
+

Important

+ + This endpoint creates a **soft** reservation. _Any_ customer + can use a reserved coupon code and proceed to checkout. + + To create a hard reservation, you can: + - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, + - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) + endpoint setting the `recipientsIntegrationId` property or, + - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). +
+ + To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. operationId: createCouponReservation parameters: - description: The code of the coupon. @@ -1118,6 +1345,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CouponReservations' + description: body required: true responses: "201": @@ -1157,7 +1385,7 @@ paths: 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. + - 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](https://docs.talon.one/management-api#operation/createCoupons) or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoints. operationId: getReservedCustomers parameters: - description: The code of the coupon. @@ -1201,17 +1429,14 @@ paths: description: | 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. + Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards 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 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). + - A customer session integration Id with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. + - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. in: path name: integrationId required: true @@ -1243,13 +1468,6 @@ 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: @@ -1274,66 +1492,45 @@ paths: summary: List customer data tags: - integration - /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions: + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances: 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 + Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. + If no filtering options are applied, all loyalty balances for the given loyalty card are returned. + operationId: getLoyaltyCardBalances 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). + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. 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. + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. in: path - name: integrationId + name: loyaltyCardId required: true schema: + maxLength: 108 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. + - description: | + Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. + + **Note:** 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/inline_response_200_1' + $ref: '#/components/schemas/LoyaltyBalances' description: OK "400": content: @@ -1355,65 +1552,323 @@ paths: description: Not found security: - api_key_v1: [] - summary: Get loyalty ledger transaction logs + summary: Get card's point balances tags: - integration - /v1/applications: + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances: get: - description: List all applications in the current account. - operationId: getApplications + description: | + Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. + You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. + + Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. + + **Note:** For more information, see [our documentation on managing loyalty data](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-data#obtaining-the-loyalty-balances-of-a-customer). + operationId: getLoyaltyBalances 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: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true schema: - maximum: 1000 - minimum: 1 type: integer - - description: Skips the given number of items when paging through large result - sets. - in: query - name: skip + - 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: 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. + type: string + - description: | + Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. + + **Note:** It must be an RFC3339 timestamp string. in: query - name: sort + name: endDate schema: + format: date-time type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_2' + $ref: '#/components/schemas/LoyaltyBalances' description: OK - summary: List applications + "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: Get customer's loyalty points tags: - - management - /v1/applications/{applicationId}: + - integration + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions: get: - description: Get the application specified by the ID. - operationId: getApplication + description: | + Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. + If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned. + operationId: getLoyaltyCardTransactions parameters: - - description: The ID of the Application. It is displayed in your Talon.One - deployment URL. + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. in: path - name: applicationId + name: loyaltyProgramId required: true schema: type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Application' + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + - description: The ID of the subledger by which we filter the data. + in: query + name: subledgerId + schema: + type: string + - description: | + Date and time from which results are returned. Results are filtered by transaction creation date. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: startDate + schema: + format: date-time + type: string + - description: | + Date and time by which results are returned. Results are filtered by transaction creation date. + + **Note:** 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. + in: query + name: pageSize + schema: + default: 1000 + 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/inline_response_200_1' + 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 card's transactions + tags: + - integration + /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions: + get: + description: | + Retrieve paginated results of 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 50 loyalty transactions for the given integration ID are returned. + + **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, + use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint. + operationId: getLoyaltyProgramProfileTransactions + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + 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: The ID of the subledger by which we filter the data. + in: query + name: subledgerId + schema: + type: string + - description: | + Date and time from which results are returned. Results are filtered by transaction creation date. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: startDate + schema: + format: date-time + type: string + - description: | + Date and time by which results are returned. Results are filtered by transaction creation date. + + **Note:** 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. + in: query + name: pageSize + schema: + default: 50 + maximum: 50 + 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/inline_response_200_2' + 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 customer's loyalty transactions + tags: + - integration + /v1/applications: + get: + description: List all applications in the current account. + operationId: getApplications + parameters: + - description: The number of items in this response. + in: query + name: pageSize + schema: + default: 1000 + 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. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. + in: query + name: sort + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_3' + description: OK + summary: List Applications + tags: + - management + /v1/applications/{applicationId}: + get: + description: Get the application specified by the ID. + operationId: getApplication + 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/Application' description: OK - summary: Get application + summary: Get Application tags: - management /v1/applications/{applicationId}/campaigns: @@ -1422,11 +1877,11 @@ paths: List the campaigns of the specified application that match your filter criteria. operationId: getCampaigns parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -1436,9 +1891,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -1515,7 +1971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_3' + $ref: '#/components/schemas/inline_response_200_4' description: OK "400": content: @@ -1528,7 +1984,10 @@ paths: - management /v1/applications/{applicationId}/notification_webhooks: get: - description: List all outbound notification webhooks for this application. + description: | + List all + [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) + for the given Application. operationId: getNotificationWebhooks parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -1543,15 +2002,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_4' + $ref: '#/components/schemas/inline_response_200_5' description: OK - summary: List notification webhooks + summary: List notifications about campaign-related changes tags: - management post: description: | - 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). + Create a + [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + + A notification about campaign-related changes is different from regular webhooks + in that it is Application-scoped and has a predefined payload. + [Regular webhooks](https://docs.talon.one/docs/dev/getting-started/webhooks) have user-definable payloads. + + **Tip:** + + - You can create these notifications using the Campaign Manager. + See [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). + - You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_created/post). operationId: createNotificationWebhook parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -1566,6 +2035,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewNotificationWebhook' + description: body required: true responses: "201": @@ -1574,13 +2044,15 @@ paths: schema: $ref: '#/components/schemas/NotificationWebhook' description: Created - summary: Create notification webhook + summary: Create notification about campaign-related changes tags: - management x-codegen-request-body-name: body /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}: delete: - description: Remove the given existing outbound notification webhook. + description: | + Remove the given existing + [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). operationId: deleteNotificationWebhook parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -1590,7 +2062,9 @@ paths: required: true schema: type: integer - - in: path + - description: The ID of the webhook. Get it with the appropriate _List notifications_ + endpoint. + in: path name: notificationWebhookId required: true schema: @@ -1599,11 +2073,13 @@ paths: "204": content: {} description: No Content - summary: Delete notification webhook + summary: Delete notification about campaign-related changes tags: - management get: - description: Return the given outbound notification webhook. + description: | + Return the given + [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). operationId: getNotificationWebhook parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -1613,7 +2089,9 @@ paths: required: true schema: type: integer - - in: path + - description: The ID of the webhook. Get it with the appropriate _List notifications_ + endpoint. + in: path name: notificationWebhookId required: true schema: @@ -1625,11 +2103,15 @@ paths: schema: $ref: '#/components/schemas/NotificationWebhook' description: OK - summary: Get notification webhook + summary: Get notification about campaign-related changes tags: - management put: - description: Update the given outbound notification webhook. + description: | + Update the given + [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + + **Tip:** You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_edited/post). operationId: updateNotificationWebhook parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -1639,7 +2121,9 @@ paths: required: true schema: type: integer - - in: path + - description: The ID of the webhook. Get it with the appropriate _List notifications_ + endpoint. + in: path name: notificationWebhookId required: true schema: @@ -1649,6 +2133,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewNotificationWebhook' + description: body required: true responses: "200": @@ -1657,7 +2142,7 @@ paths: schema: $ref: '#/components/schemas/NotificationWebhook' description: OK - summary: Update notification webhook + summary: Update notification about campaign-related changes tags: - management x-codegen-request-body-name: body @@ -1738,6 +2223,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCampaign' + description: body required: true responses: "200": @@ -1752,7 +2238,7 @@ paths: x-codegen-request-body-name: body /v1/applications/{applicationId}/campaigns/{campaignId}/copy: post: - description: Copy the campaign into all specified application. + description: Copy the campaign into all specified Applications. operationId: copyCampaignToApplications parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -1774,103 +2260,136 @@ paths: application/json: schema: $ref: '#/components/schemas/CampaignCopy' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_3' + $ref: '#/components/schemas/inline_response_200_4' description: OK - summary: Copy the campaign into the specified application + summary: Copy the campaign into the specified Application tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns_search: + /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points: post: description: | - Get a list of all the campaigns that match a set of attributes. - operationId: getCampaignByAttributes + Create a notification about added or deducted loyalty points in a given profile-based loyalty program. + A notification for added or deducted loyalty points is different from regular webhooks + in that it is loyalty program-scoped and has a predefined payload. + + For more information, see [Managing notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications). + operationId: postAddedDeductedPointsNotification 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: The ID of the Application. It is displayed in your Talon.One - deployment URL. + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. in: path - name: applicationId + name: loyaltyProgramId required: true schema: type: integer - - 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/CampaignSearch' + $ref: '#/components/schemas/NewBaseNotification' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_3' + $ref: '#/components/schemas/BaseNotification' description: OK - summary: List campaigns that match the given attributes + "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: Create notification about added or deducted loyalty points tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets: - get: + /v1/catalogs/{applicationId}/notifications/strikethrough: + post: description: | - 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. - operationId: getRulesets + Create a notification for the in the given Application. + For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). + + See the [payload](https://docs.talon.one/outbound-notifications) you will receive. + operationId: postCatalogsStrikethroughNotification + 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/NewBaseNotification' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BaseNotification' + 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 + summary: Create strikethrough notification + tags: + - management + x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns_search: + post: + description: | + Get a list of all the campaigns that match a set of attributes. + operationId: getCampaignByAttributes parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -1880,9 +2399,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -1894,70 +2414,74 @@ paths: 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 + - 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: - type: integer + enum: + - enabled + - disabled + - archived + - draft + - scheduled + - running + - expired + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignSearch' + description: body + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_5' + $ref: '#/components/schemas/inline_response_200_4' description: OK - summary: List campaign rulesets + summary: List campaigns that match the given attributes tags: - management - /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}: + x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets: get: - description: Retrieve the specified ruleset. - operationId: getRuleset + description: | + 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. + operationId: getRulesets 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 + - description: The number of items in this response. + in: query + name: pageSize schema: + default: 1000 + maximum: 1000 + minimum: 1 type: integer - - in: path - name: rulesetId - required: true + - 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/Ruleset' - description: OK - summary: Get ruleset - tags: - - management - /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients: - post: - description: Create coupons according to some pattern for up to 1000 recipients. - operationId: createCouponsForMultipleRecipients - 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. + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query - name: silent + name: sort schema: - default: "yes" type: string - description: The ID of the Application. It is displayed in your Talon.One deployment URL. @@ -1973,12 +2497,6 @@ paths: required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewCouponsForMultipleRecipients' - required: true responses: "200": content: @@ -1986,17 +2504,13 @@ paths: schema: $ref: '#/components/schemas/inline_response_200_6' description: OK - "204": - content: {} - description: No Content - summary: Create coupons for multiple recipients + summary: List campaign rulesets tags: - management - x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async: - post: - description: Create any number of coupons from 20,001 to 5,000,000. - operationId: createCouponsAsync + /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}: + get: + description: Retrieve the specified ruleset. + operationId: getRuleset parameters: - description: The ID of the Application. It is displayed in your Talon.One deployment URL. @@ -2012,23 +2526,22 @@ paths: required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewCouponCreationJob' + - description: The ID of the ruleset. + in: path + name: rulesetId required: true + schema: + type: integer responses: "200": content: application/json: schema: - $ref: '#/components/schemas/AsyncCouponCreationResponse' + $ref: '#/components/schemas/Ruleset' description: OK - summary: Create coupons asynchronously + summary: Get ruleset tags: - management - x-codegen-request-body-name: body /v1/applications/{applicationId}/campaigns/{campaignId}/coupons: delete: description: Deletes all the coupons matching the specified criteria. @@ -2104,8 +2617,8 @@ paths: format: date-time type: string - description: | - - `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. + - `expired`: Matches coupons in which the expiration date is set and in the past. + - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. in: query name: valid @@ -2130,9 +2643,8 @@ paths: - "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. + - description: Filter the results by matching them with the ID of a referral. + This filter shows the coupons created by redeeming a referral code. in: query name: referralId schema: @@ -2166,7 +2678,7 @@ paths: - 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. + - `no`: Returns a 200 response that contains the updated customer profiles. in: query name: silent schema: @@ -2191,13 +2703,14 @@ paths: application/json: schema: $ref: '#/components/schemas/NewCoupons' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_6' + $ref: '#/components/schemas/inline_response_200_7' description: OK "204": content: {} @@ -2208,13 +2721,19 @@ paths: x-codegen-request-body-name: body put: description: | - Update all coupons of an campaign, or a specific batch of coupons. + Update all coupons, or a specific batch of coupons, in a campaign. You can find the `batchId` in the **Coupons** view of your Application - in the Campaign Manager or by using [List coupons](#operation/getCouponsWithoutTotalCount). + in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). + +
+

Important

- **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. +
    +
  • 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 @@ -2238,6 +2757,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCouponBatch' + description: body required: true responses: "204": @@ -2247,32 +2767,19 @@ paths: tags: - management x-codegen-request-body-name: body - /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total: - get: - description: | - List all the coupons matching the specified criteria. - operationId: getCouponsWithoutTotalCount + /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients: + post: + description: Create coupons according to some pattern for up to 1000 recipients. + operationId: createCouponsForMultipleRecipients 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. + - 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 the updated customer profiles. in: query - name: sort + name: silent schema: + default: "yes" type: string - description: The ID of the Application. It is displayed in your Talon.One deployment URL. @@ -2288,31 +2795,134 @@ paths: 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCouponsForMultipleRecipients' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_7' + description: OK + "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_async: + post: + description: | + Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. + + If you want to create less than 20,001 coupons, you can use the [Create coupons](https://docs.talon.one/management-api#tag/Coupons/operation/createCoupons) endpoint. + operationId: createCouponsAsync + 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/NewCouponCreationJob' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncCouponCreationResponse' + description: OK + summary: Create coupons asynchronously + tags: + - management + x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total: + get: + description: | + List all the coupons matching the specified criteria. + operationId: getCouponsWithoutTotalCount + parameters: + - description: The number of items in this response. + in: query + name: pageSize + schema: + default: 1000 + 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. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. + in: query + 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 ID of the campaign. It is displayed in your Talon.One deployment + URL. + 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. + 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. + Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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: @@ -2330,9 +2940,8 @@ paths: - "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. + - description: Filter the results by matching them with the ID of a referral. + This filter shows the coupons created by redeeming a referral code. in: query name: referralId schema: @@ -2360,7 +2969,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/inline_response_200_8' description: OK summary: List coupons tags: @@ -2384,7 +2993,9 @@ paths: required: true schema: type: integer - - description: The ID of the coupon code to update + - description: | + The internal ID of the coupon code. You can find this value in the `id` property from the + [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. in: path name: couponId required: true @@ -2398,7 +3009,16 @@ paths: tags: - management put: - description: Update the specified coupon. + description: | + Update the specified coupon. + +
+

Important

+ +

With this PUT endpoint only, any property you do not explicitly set in your request + will be set to null.

+ +
operationId: updateCoupon parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -2415,7 +3035,9 @@ paths: required: true schema: type: integer - - description: The ID of the coupon code to update + - description: | + The internal ID of the coupon code. You can find this value in the `id` property from the + [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. in: path name: couponId required: true @@ -2426,6 +3048,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCoupon' + description: body required: true responses: "200": @@ -2450,11 +3073,11 @@ paths: **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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -2464,9 +3087,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -2509,7 +3133,7 @@ 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. + Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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: @@ -2527,9 +3151,8 @@ paths: - "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. + - description: Filter the results by matching them with the ID of a referral. + This filter shows the coupons created by redeeming a referral code. in: query name: referralId schema: @@ -2557,13 +3180,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AttributeQuery' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/inline_response_200_8' description: OK summary: List coupons that match the given attributes in campaign (without total count) @@ -2581,11 +3205,11 @@ paths: **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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -2595,9 +3219,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -2633,7 +3258,7 @@ 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. + Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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: @@ -2651,9 +3276,8 @@ paths: - "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. + - description: Filter the results by matching them with the ID of a referral. + This filter shows the coupons created by redeeming a referral code. in: query name: referralId schema: @@ -2702,13 +3326,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AttributeQuery' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/inline_response_200_8' description: OK summary: List coupons that match the given attributes (without total count) tags: @@ -2733,7 +3358,7 @@ paths: required: true schema: type: integer - - description: The ID of the referral code to delete + - description: The ID of the referral code. in: path name: referralId required: true @@ -2764,7 +3389,7 @@ paths: required: true schema: type: integer - - description: The ID of the referral code to delete + - description: The ID of the referral code. in: path name: referralId required: true @@ -2775,6 +3400,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateReferral' + description: body required: true responses: "200": @@ -2792,11 +3418,11 @@ paths: description: List all referrals of the specified campaign. operationId: getReferralsWithoutTotalCount parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -2806,9 +3432,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -2851,7 +3478,7 @@ paths: 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. + Either "expired", "validNow", or "validFuture". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future. in: query name: valid schema: @@ -2880,11 +3507,74 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_8' + $ref: '#/components/schemas/inline_response_200_9' description: OK summary: List referrals tags: - management + /v1/campaign_templates: + get: + description: Retrieve a list of campaign templates. + operationId: getCampaignTemplates + parameters: + - description: The number of items in this response. + in: query + name: pageSize + schema: + default: 1000 + 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. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. + in: query + name: sort + schema: + type: string + - description: Filter results by the state of the campaign template. + in: query + name: state + schema: + enum: + - enabled + - disabled + - draft + type: string + - description: Filter results performing case-insensitive matching against the + name of the campaign template. + in: query + name: name + schema: + type: string + - description: | + Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values. + in: query + name: tags + schema: + type: string + - description: Filter results by user ID. + in: query + name: userId + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + description: OK + summary: List campaign templates + tags: + - management /v1/applications/{applicationId}/create_campaign_from_template: post: description: | @@ -2907,6 +3597,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateTemplateCampaign' + description: body required: true responses: "201": @@ -2928,7 +3619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/inline_response_200_11' description: OK summary: List loyalty programs tags: @@ -2944,8 +3635,8 @@ paths: operationId: getLoyaltyProgram 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). + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. in: path name: loyaltyProgramId required: true @@ -2964,36 +3655,47 @@ paths: /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. + Upload a CSV file containing the loyalty points you want to import into a given loyalty program. + Send the file as multipart data. - **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). + Depending on the loyalty program type, you can import the points into a given customer profile or into a given _active_ loyalty card. - The CSV file can contain the following columns: + The CSV file contains the following columns: - - `customerprofileid`: The integration ID of the customer profile that should receive the loyalty points. + - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. + - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - - `startdate`: The earliest date when the points can be redeemed. On this date and until the expiry date, the points are `active`. + - `startdate`: The earliest date when the points can be redeemed. On this date and until the expiration 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. + - `reason` (optional): The reason why these points are awarded. - **Important:** Do not leave empty columns in the file. + You can use the time zone of your choice. It is converted to UTC internally by Talon.One. - You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the + value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until + the date provided for `startdate` is reached. - **Example:** + **Note:** We recommend limiting your file size to 500MB. + + **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` + + **Example for card-based programs:** + + ```text + identifier,amount,startdate,expirydate,subledgerid,reason + summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement + ``` operationId: importLoyaltyPoints 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). + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. in: path name: loyaltyProgramId required: true @@ -3025,7 +3727,10 @@ paths: 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). + [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. + + **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, + we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions). operationId: getLoyaltyPoints parameters: - description: The identifier for the loyalty program. @@ -3047,7 +3752,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltyLedger' description: OK - summary: Get the Loyalty Ledger for this integrationID + summary: Get customer's full loyalty ledger tags: - management /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points: @@ -3056,7 +3761,7 @@ paths: Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the - [Update customer session](/integration-api/#operation/updateCustomerSessionV2). + [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. operationId: addLoyaltyPoints parameters: - description: The identifier for the loyalty program. @@ -3075,7 +3780,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LoyaltyPoints' + $ref: '#/components/schemas/AddLoyaltyPoints' + description: body required: true responses: "204": @@ -3099,17 +3805,17 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Not found - summary: Add points in loyalty program for given customer + summary: Add points to customer profile tags: - management x-codegen-request-body-name: body /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points: put: description: | - Remove points from the specified loyalty program and specified customer profile. + Deduct points from the specified loyalty program and specified customer profile. To get the `integrationId` of the profile from a `sessionId`, use the - [Update customer session](/integration-api/#operation/updateCustomerSessionV2). + [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. operationId: removeLoyaltyPoints parameters: - description: The identifier for the loyalty program. @@ -3128,7 +3834,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LoyaltyPoints' + $ref: '#/components/schemas/DeductLoyaltyPoints' + description: body required: true responses: "204": @@ -3152,26 +3859,45 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Not found - summary: Deduct points in loyalty program for given customer + summary: Deduct points from customer profile tags: - management x-codegen-request-body-name: body /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log: get: - description: Download a CSV file containing a customer's ledger log in the loyalty - program + description: | + Download a CSV file containing a customer's transaction logs in the loyalty program. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The generated file can contain the following columns: + + - `customerprofileid`: The ID of the profile. + - `customersessionid`: The ID of the customer session. + - `rulesetid`: The ID of the rule set. + - `rulename`: The name of the rule. + - `programid`: The ID of the loyalty program. + - `type`: The type of the loyalty program. + - `name`: The name of the loyalty program. + - `subledgerid`: The ID of the subledger, when applicable. + - `startdate`: The start date of the program. + - `expirydate`: The expiration date of the program. + - `id`: The ID of the transaction. + - `created`: The timestamp of the creation of the loyalty program. + - `amount`: The number of points in that transaction. + - `archived`: Whether the session related to the transaction is archived. operationId: exportLoyaltyLedger parameters: - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string. + - description: Only return results from after this timestamp. This 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. + - description: Only return results from before this timestamp. This must be + an RFC3339 timestamp string. in: query name: rangeEnd required: true @@ -3202,23 +3928,30 @@ paths: "200": content: application/csv: + example: | + customerprofileid,customersessionid,rulesetid,rulename,programid,type,name,subledgerid,startdate,expirydate,id,created,amount,archived + 8NHOS78H,06b0fafb-ccbf-42c7-b44b-d858e8b525022,1691,test,37,subtraction,10% of current total,,immediate,unlimited,60803,2022-11-29 16:16:10,100.00,false + EB780RDN,06b0fafb-ccbf-42c7-b44b-d858e8b525022,1691,test,37,addition,Reimbursed loyalty points,,immediate,unlimited,60804,2022-11-29 16:16:23,100.00,false schema: format: csv type: string description: OK - summary: Export a customer's loyalty ledger log + summary: Export customer's transaction logs tags: - management /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. + total active points, pending points, spent points, and expired points. + + **Important:** The returned data does not include the current day. All statistics + are updated daily at 11:59 PM in the loyalty program time zone. operationId: getLoyaltyStatistics 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). + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. in: path name: loyaltyProgramId required: true @@ -3231,14 +3964,27 @@ paths: schema: $ref: '#/components/schemas/LoyaltyStatistics' description: OK - summary: Get loyalty program statistics by loyalty program ID + summary: Get loyalty program statistics tags: - management - /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance: + /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances: get: - description: Download a CSV file containing the balance of each customer in - the loyalty program. - operationId: exportLoyaltyBalance + description: | + Download a CSV file containing the balance of each customer in the loyalty program. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The generated file can contain the following columns: + + - `loyaltyProgramID`: The ID of the loyalty program. + - `loyaltySubledger`: The name of the subdleger, when applicatble. + - `profileIntegrationID`: The integration ID of the customer profile. + - `currentBalance`: The current point balance. + - `pendingBalance`: The number of pending points. + - `expiredBalance`: The number of expired points. + - `spentBalance`: The number of spent points. + - `currentTier`: The tier that the customer is in at the time of the export. + operationId: exportLoyaltyBalances parameters: - description: The identifier for the loyalty program. in: path @@ -3246,10 +3992,23 @@ paths: required: true schema: type: string + - description: | + Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: endDate + schema: + format: date-time + type: string responses: "200": content: application/csv: + example: | + loyaltyProgramID,loyaltySubledger,profileIntegrationID,currentBalance,pendingBalance,expiredBalance,spentBalance,currentTier + 40,,8786NTHSAO8,10.00,0.00,0.00,0.00,First + 40,,2735HATHOH8,20.00,0.00,0.00,0.00,First schema: format: csv type: string @@ -3266,46 +4025,865 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Unauthorized - summary: Export customer loyalty balance to a CSV file + summary: Export customer loyalty balances tags: - management - /v1/giveaways/pools/{poolId}/import: - post: + /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance: + get: + deprecated: true description: | - 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. + ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. + To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. - 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:** + Download a CSV file containing the balance of each customer in the loyalty program. - ```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 + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + operationId: exportLoyaltyBalance parameters: - - in: path - name: poolId + - description: The identifier for the loyalty program. + in: path + name: loyaltyProgramId required: true schema: - type: integer - requestBody: - content: - multipart/form-data: - schema: + type: string + - description: | + Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: endDate + schema: + format: date-time + type: string + responses: + "200": + content: + application/csv: + schema: + 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 CSV + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/transactions: + get: + description: | + Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. + If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. + + **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, + we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions). + operationId: getLoyaltyProgramTransactions + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Filter results by loyalty transaction type: + - `manual`: Loyalty transaction that was done manually. + - `session`: Loyalty transaction that resulted from a customer session. + - `import`: Loyalty transaction that was imported from a CSV file. + in: query + name: loyaltyTransactionType + schema: + enum: + - manual + - session + - import + maxLength: 255 + type: string + - description: The ID of the subledger by which we filter the data. + in: query + name: subledgerId + schema: + type: string + - description: | + Date and time from which results are returned. Results are filtered by transaction creation date. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: startDate + schema: + format: date-time + type: string + - description: | + Date and time by which results are returned. Results are filtered by transaction creation date. + + **Note:** 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. + in: query + name: pageSize + schema: + default: 50 + maximum: 50 + 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/inline_response_200_12' + 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 + summary: List loyalty program transactions + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/import_cards: + post: + description: | + Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. + Send the file as multipart data. + + It contains the following columns for each card: + + - `identifier` (required): The alphanumeric identifier of the loyalty card. + - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. + - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. + + **Note:** We recommend limiting your file size to 500MB. + + **Example:** + + ```csv + identifier,state,customerprofileids + 123-456-789AT,active,Alexa001;UserA + ``` + operationId: importLoyaltyCards + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + 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 + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Import loyalty cards + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances: + get: + description: | + Download a CSV file containing the balances of all cards in the loyalty program. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The CSV file contains the following columns: + - `loyaltyProgramID`: The ID of the loyalty program. + - `loyaltySubledger`: The name of the subdleger, when applicatble. + - `cardIdentifier`: The alphanumeric identifier of the loyalty card. + - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. + - `currentBalance`: The current point balance. + - `pendingBalance`: The number of pending points. + - `expiredBalance`: The number of expired points. + - `spentBalance`: The number of spent points. + operationId: exportLoyaltyCardBalances + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: endDate + schema: + format: date-time + type: string + responses: + "200": + content: + application/csv: + example: | + loyaltyProgramID,loyaltySubledger,cardIdentifier,cardState,currentBalance,pendingBalance,expiredBalance,spentBalance + 40,,111,active,10,0,0,0,5 + schema: + 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 all card transaction logs + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/cards: + get: + description: | + For the given card-based loyalty program, list the loyalty cards that match your filter criteria. + operationId: getLoyaltyCards + parameters: + - description: The number of items in this response. + in: query + name: pageSize + schema: + default: 1000 + 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. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. + in: query + name: sort + schema: + type: string + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: Optional query parameter to search cards by identifier. + in: query + name: identifier + schema: + minLength: 4 + type: string + - description: Filter by the profile ID. + in: query + name: profileId + schema: + minimum: 1 + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_13' + 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: List loyalty cards + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}: + delete: + description: Delete the given loyalty card. + operationId: deleteLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + responses: + "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 loyalty card + tags: + - management + get: + description: Get the given loyalty card. + operationId: getLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCard' + 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 + summary: Get loyalty card + tags: + - management + put: + description: Update the status of the given loyalty card. A card can be _active_ + or _inactive_. + operationId: updateLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLoyaltyCard' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCard' + 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 + summary: Update loyalty card status + tags: + - management + x-codegen-request-body-name: body + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points: + put: + description: | + Add points to the given loyalty card in the specified card-based loyalty program. + operationId: addLoyaltyCardPoints + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddLoyaltyPoints' + description: body + required: true + responses: + "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 to card + tags: + - management + x-codegen-request-body-name: body + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points: + put: + description: | + Deduct points from the given loyalty card in the specified card-based loyalty program. + operationId: deductLoyaltyCardPoints + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeductLoyaltyPoints' + description: body + required: true + responses: + "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 from card + tags: + - management + x-codegen-request-body-name: body + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log: + get: + description: | + Download a CSV file containing a loyalty card ledger log of the loyalty program. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + operationId: exportLoyaltyCardLedger + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + - description: Only return results from after this timestamp. This 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. This must be + an RFC3339 timestamp string. + in: query + name: rangeEnd + required: true + schema: + format: date-time + 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/csv: + 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 card's ledger log + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs: + get: + description: | + Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) + within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. + If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned. + operationId: getLoyaltyCardTransactionLogs + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + - description: | + Date and time from which results are returned. Results are filtered by transaction creation date. + + **Note:** It must be an RFC3339 timestamp string. + in: query + name: startDate + schema: + format: date-time + type: string + - description: | + Date and time by which results are returned. Results are filtered by transaction creation date. + + **Note:** 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. + in: query + name: pageSize + schema: + default: 1000 + 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 ID of the subledger by which we filter the data. + in: query + name: subledgerId + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_14' + 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 + summary: List card's transactions + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer: + put: + description: | + Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. + + **Important:** + + - The original card is automatically blocked once the new card is created, and it cannot be activated again. + - The default status of the new card is _active_. + operationId: transferLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferLoyaltyCard' + description: body + required: true + responses: + "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: Transfer card data + tags: + - management + x-codegen-request-body-name: body + /v1/giveaways/pools/{poolId}/import: + post: + description: | + Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. + + The CSV file contains 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""}"`. + + 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 time zone of your choice. It is converted to UTC internally by Talon.One. + + **Note:** We recommend limiting your file size to 500MB. + + **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: + - description: The ID of the pool. You can find it in the Campaign Manager, + in the **Giveaways** section. + in: path + name: poolId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: properties: upFile: description: The file with the information about the data that should @@ -3327,11 +4905,11 @@ paths: description: List collections in account. operationId: listAccountCollections parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -3341,9 +4919,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -3367,7 +4946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_10' + $ref: '#/components/schemas/inline_response_200_15' description: OK "400": content: @@ -3398,6 +4977,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewCollection' + description: body required: true responses: "201": @@ -3434,7 +5014,7 @@ paths: operationId: deleteAccountCollection parameters: - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3458,7 +5038,7 @@ paths: operationId: getAccountCollection parameters: - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3486,7 +5066,7 @@ paths: operationId: updateAccountCollection parameters: - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3497,6 +5077,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCollection' + description: body required: true responses: "200": @@ -3532,11 +5113,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -3547,7 +5128,7 @@ paths: schema: type: integer - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3558,7 +5139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_11' + $ref: '#/components/schemas/inline_response_200_16' description: OK "404": content: @@ -3581,11 +5162,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -3595,9 +5176,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -3621,7 +5203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' + $ref: '#/components/schemas/inline_response_200_17' description: OK "404": content: @@ -3651,11 +5233,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -3665,9 +5247,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -3691,7 +5274,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' + $ref: '#/components/schemas/inline_response_200_17' description: OK "404": content: @@ -3725,6 +5308,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewCampaignCollection' + description: body required: true responses: "201": @@ -3757,7 +5341,7 @@ paths: schema: type: integer - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3795,7 +5379,7 @@ paths: schema: type: integer - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3836,7 +5420,7 @@ paths: schema: type: integer - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3847,6 +5431,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCampaignCollection' + description: body required: true responses: "200": @@ -3906,7 +5491,7 @@ paths: schema: type: integer - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -3965,7 +5550,7 @@ paths: operationId: importAccountCollection parameters: - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -4005,11 +5590,14 @@ paths: - management /v1/collections/{collectionId}/export: get: - description: Download a CSV file containing items from an account-level collection. + description: | + Download a CSV file containing items from an account-level collection. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). operationId: exportAccountCollectionItems parameters: - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -4045,7 +5633,10 @@ paths: - management /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export: get: - description: Download a CSV file containing a collection's items. + description: | + Download a CSV file containing a collection's items. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). operationId: exportCollectionItems parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -4063,7 +5654,7 @@ paths: schema: type: integer - description: The ID of the collection. You can get it with the [List collection - in account endpoint](#operation/listCollectionsInApplication). + in account](#operation/listCollectionsInApplication) endpoint. in: path name: collectionId required: true @@ -4100,8 +5691,11 @@ paths: /v1/applications/{applicationId}/health_report: get: description: | - Display the health of the application and show the last time the Application + Display the health of the Application and show the last time the Application was used. + + You can also display this information from the **Settings** of an Application, in the **Developer Settings** menu. + See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status). operationId: getApplicationApiHealth parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -4118,13 +5712,13 @@ paths: schema: $ref: '#/components/schemas/ApplicationApiHealth' description: OK - summary: Get report of health of application API + summary: Get Application health tags: - management /v1/applications/{applicationId}/access_logs/no_total: get: description: | - Retrieve the list of API calls to this Application matching the specified criteria. + Retrieve the list of API calls sent to the specified Application. operationId: getAccessLogsWithoutTotalCount parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -4160,27 +5754,27 @@ paths: - success - error type: string - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string. + - description: Only return results from after this timestamp. This 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. + - description: Only return results from before this timestamp. This must be + an RFC3339 timestamp string. in: query name: rangeEnd required: true schema: format: date-time type: string - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4190,9 +5784,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -4202,7 +5797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/inline_response_200_18' description: OK summary: Get access logs for Application tags: @@ -4213,16 +5808,16 @@ paths: Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. operationId: getAllAccessLogs parameters: - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string. + - description: Only return results from after this timestamp. This 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. + - description: Only return results from before this timestamp. This must be + an RFC3339 timestamp string. in: query name: rangeEnd required: true @@ -4255,11 +5850,11 @@ paths: - success - error type: string - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4269,9 +5864,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -4281,7 +5877,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_14' + $ref: '#/components/schemas/inline_response_200_19' description: OK summary: List access logs tags: @@ -4305,16 +5901,16 @@ paths: required: true schema: type: integer - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string. + - description: Only return results from after this timestamp. This 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. + - description: Only return results from before this timestamp. This must be + an RFC3339 timestamp string. in: query name: rangeEnd required: true @@ -4337,7 +5933,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/inline_response_200_20' description: OK summary: Get analytics of campaigns tags: @@ -4360,11 +5956,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4388,7 +5984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_16' + $ref: '#/components/schemas/inline_response_200_21' description: OK summary: List application's customers tags: @@ -4408,11 +6004,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4436,13 +6032,14 @@ paths: application/json: schema: $ref: '#/components/schemas/CustomerProfileSearchQuery' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_17' + $ref: '#/components/schemas/inline_response_200_22' description: OK summary: List application customers matching the given attributes tags: @@ -4456,11 +6053,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4470,18 +6067,25 @@ paths: name: skip schema: type: integer + - description: Indicates whether you are pointing to a sandbox or Live customer. + in: query + name: sandbox + schema: + default: false + type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerProfileSearchQuery' + description: body required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_18' + $ref: '#/components/schemas/inline_response_200_23' description: OK summary: List customer profiles matching the given attributes tags: @@ -4505,7 +6109,7 @@ paths: parameters: - 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. + [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. in: path name: customerId required: true @@ -4526,11 +6130,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4540,12 +6144,18 @@ paths: name: skip schema: type: integer + - description: Indicates whether you are pointing to a sandbox or Live customer. + in: query + name: sandbox + schema: + default: false + type: boolean responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_18' + $ref: '#/components/schemas/inline_response_200_24' description: OK summary: List customer profiles tags: @@ -4565,7 +6175,7 @@ paths: 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. + [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. in: path name: customerId required: true @@ -4588,11 +6198,11 @@ paths: in the response, this endpoint only mentions whether there are more results. operationId: getCustomerActivityReportsWithoutTotalCount parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4602,23 +6212,24 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: type: string - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string. + - description: Only return results from after this timestamp. This 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. + - description: Only return results from before this timestamp. This must be + an RFC3339 timestamp string. in: query name: rangeEnd required: true @@ -4658,7 +6269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_19' + $ref: '#/components/schemas/inline_response_200_25' description: OK summary: Get Activity Reports for Application Customers tags: @@ -4669,11 +6280,11 @@ paths: in a time range. operationId: getCustomerActivityReport parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4683,16 +6294,16 @@ paths: name: skip schema: type: integer - - description: Only return results from after this timestamp, must be an RFC3339 - timestamp string. + - description: Only return results from after this timestamp. This 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. + - description: Only return results from before this timestamp. This must be + an RFC3339 timestamp string. in: query name: rangeEnd required: true @@ -4708,7 +6319,7 @@ paths: 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. + [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. in: path name: customerId required: true @@ -4729,11 +6340,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4743,9 +6354,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -4759,7 +6371,7 @@ paths: 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. + [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. in: path name: customerId required: true @@ -4781,11 +6393,11 @@ paths: List all the sessions of the specified Application. operationId: getApplicationSessions parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4795,9 +6407,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -4858,7 +6471,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_20' + $ref: '#/components/schemas/inline_response_200_26' description: OK summary: List Application sessions tags: @@ -4867,7 +6480,7 @@ paths: get: description: | Get the details of the given session. - You can list the sessions with the [List Application sessions](/#tag/Customer-data/operation/getApplicationSession) endpoint. + You can list the sessions with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. operationId: getApplicationSession parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -4878,7 +6491,7 @@ paths: 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). + The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. in: path name: sessionId required: true @@ -4900,11 +6513,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -4914,9 +6527,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -4996,7 +6610,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_21' + $ref: '#/components/schemas/inline_response_200_27' description: OK summary: List Applications events tags: @@ -5006,14 +6620,14 @@ paths: 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) + See also: [Track an event](https://docs.talon.one/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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5023,9 +6637,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5042,7 +6657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_22' + $ref: '#/components/schemas/inline_response_200_28' description: OK summary: List Applications event types tags: @@ -5053,11 +6668,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5067,9 +6682,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5088,7 +6704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_23' + $ref: '#/components/schemas/inline_response_200_29' description: OK summary: List audiences tags: @@ -5099,11 +6715,11 @@ paths: List the friends referred by the specified customer profile in this Application. operationId: getApplicationCustomerFriends parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5113,9 +6729,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5147,7 +6764,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_24' + $ref: '#/components/schemas/inline_response_200_30' description: OK summary: List friends referred by customer profile tags: @@ -5155,14 +6772,14 @@ paths: /v1/attributes: get: description: | - Returns all the defined custom attributes for the account. + Return all the 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5172,9 +6789,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5189,28 +6807,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_25' + $ref: '#/components/schemas/inline_response_200_31' description: OK summary: List custom attributes tags: - management post: description: | - Create a _custom attribute_ in this account. Custom attributes allow you - to attach new fields to Talon.One domain objects like campaigns, coupons, + Create a _custom attribute_ in this account. + [Custom attributes](https://docs.talon.one/docs/dev/concepts/attributes) allow you + to add data to Talon.One domain entities 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, + These attributes can then be given values when creating/updating these entities, 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. + 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' + description: body required: true responses: "201": @@ -5226,10 +6848,13 @@ paths: /v1/attributes/{attributeId}: get: description: | - Returns custom attribute for the account by its id. + Retrieve the specified custom attribute. operationId: getAttribute parameters: - - in: path + - description: The ID of the attribute. You can find the ID in the Campaign + Manager's URL when you display the details of an attribute in **Account** + > **Tools** > **Attributes**. + in: path name: attributeId required: true schema: @@ -5246,12 +6871,17 @@ paths: - 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. + Update an existing custom attribute. Once created, the only property of a custom attribute that can be + changed is the description. - 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. + 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. operationId: updateAttribute parameters: - - in: path + - description: The ID of the attribute. You can find the ID in the Campaign + Manager's URL when you display the details of an attribute in **Account** + > **Tools** > **Attributes**. + in: path name: attributeId required: true schema: @@ -5261,6 +6891,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewAttribute' + description: body required: true responses: "200": @@ -5276,8 +6907,7 @@ paths: /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). + Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. @@ -5298,7 +6928,10 @@ paths: ``` operationId: importAllowedList parameters: - - in: path + - description: The ID of the attribute. You can find the ID in the Campaign + Manager's URL when you display the details of an attribute in **Account** + > **Tools** > **Attributes**. + in: path name: attributeId required: true schema: @@ -5352,7 +6985,7 @@ paths: - 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). + **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 @@ -5360,7 +6993,7 @@ paths: 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: + The `filters` array contains an object with 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. @@ -5399,7 +7032,8 @@ paths: "type": "shoe" }, "replaceIfExists": true, - "sku": "SKU1241028" + "sku": "SKU1241028", + "price": 100 }, "type": "ADD" } @@ -5537,7 +7171,9 @@ paths: operationId: syncCatalog parameters: - - in: path + - description: The ID of the catalog. You can find the ID in the Campaign Manager + in **Account** > **Tools** > **Cart item catalogs**. + in: path name: catalogId required: true schema: @@ -5547,6 +7183,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CatalogSyncRequest' + description: body required: true responses: "200": @@ -5573,6 +7210,8 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Not found + security: + - api_key_v1: [] summary: Sync cart item catalog tags: - integration @@ -5583,11 +7222,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5597,9 +7236,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5609,14 +7249,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_26' + $ref: '#/components/schemas/inline_response_200_32' description: OK summary: List additional costs tags: - management post: description: | - Create an [additional cost](/docs/product/account/dev-tools/managing-additional-costs/). + Create an [additional cost](https://docs.talon.one/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 @@ -5625,6 +7265,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewAdditionalCost' + description: body required: true responses: "201": @@ -5643,7 +7284,9 @@ paths: Returns the additional cost. operationId: getAdditionalCost parameters: - - in: path + - description: | + The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. + in: path name: additionalCostId required: true schema: @@ -5663,7 +7306,9 @@ paths: 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 + - description: | + The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. + in: path name: additionalCostId required: true schema: @@ -5673,6 +7318,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewAdditionalCost' + description: body required: true responses: "200": @@ -5690,23 +7336,24 @@ paths: description: List all webhooks. operationId: getWebhooks parameters: - - description: Filter by one or more application ids separated by comma. + - description: Filter by one or more application IDs separated by a comma. in: query name: applicationIds schema: type: string - - 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query 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: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5721,7 +7368,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_27' + $ref: '#/components/schemas/inline_response_200_33' description: OK summary: List webhooks tags: @@ -5731,7 +7378,9 @@ paths: description: Returns a webhook by its id. operationId: getWebhook parameters: - - in: path + - description: | + The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**. + in: path name: webhookId required: true schema: @@ -5748,15 +7397,16 @@ paths: - 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. + description: | + Webhook activation log entries are created as soon as an integration request + triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks). operationId: getWebhookActivationLogs parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5766,9 +7416,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5812,7 +7463,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_28' + $ref: '#/components/schemas/inline_response_200_34' description: OK summary: List webhook activation log entries tags: @@ -5822,11 +7473,11 @@ paths: description: Retrieve all webhook log entries. operationId: getWebhookLogs parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5836,9 +7487,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5892,7 +7544,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_29' + $ref: '#/components/schemas/inline_response_200_35' description: OK summary: List webhook log entries tags: @@ -5915,11 +7567,11 @@ paths: schema: default: false type: boolean - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -5929,9 +7581,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -5941,7 +7594,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_30' + $ref: '#/components/schemas/inline_response_200_36' description: OK summary: List event types tags: @@ -5951,20 +7604,23 @@ paths: 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: + The CSV file contains 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. For unlimited redemptions, use `0`. Defaults to `1` when not provided. + - `recipientintegrationid`: The integration ID of the customer who receives the coupon. + Only the customer with this integration ID can redeem the corresponding coupon code. + Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). + - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. + - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `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""}"`. - **Important:** Do not leave empty columns in the file. + You can use the time zone of your choice. It is converted to UTC internally by Talon.One. - You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + **Note:** We recommend limiting your file size to 500MB. **Example:** @@ -6013,8 +7669,39 @@ paths: - management /v1/applications/{applicationId}/export_coupons: get: - description: Download a CSV file containing the coupons that match the given - properties. + description: | + Download a CSV file containing the coupons that match the given properties. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The CSV file contains the following columns: + + - `accountid`: The ID of your deployment. + - `applicationid`: The ID of the Application this coupon is related to. + - `attributes`: A json object describing _custom_ referral attribute names and their values. + - `batchid`: The ID of the batch this coupon is part of. + - `campaignid`: The ID of the campaign this coupon is related to. + - `counter`: The number of times this coupon has been redeemed. + - `created`: The creation date of the coupon code. + - `deleted`: Whether the coupon code is deleted. + - `deleted_changelogid`: The ID of the delete event in the logs. + - `discount_counter`: The amount of discount given by this coupon. + - `discount_limitval`: The maximum discount amount that can be given be this coupon. + - `expirydate`: The end date in RFC3339 of the code redemption period. + - `id`: The internal ID of the coupon code. + - `importid`: The ID of the import job that created this coupon. + - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. + - `limits`: The limits set on this coupon. + - `limitval`: The maximum number of redemptions of this code. + - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. + Only the customer with this integration ID can redeem the corresponding coupon code. + Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). + - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). + - `reservation`: Whether the coupon is reserved. + - `reservation_counter`: How many times this coupon has been reserved. + - `reservation_limitval`: The maximum of number of reservations this coupon can have. + - `startdate`: The start date in RFC3339 of the code redemption period. + - `value`: The coupon code. operationId: exportCoupons parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -6029,9 +7716,10 @@ paths: 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. + - description: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -6060,7 +7748,7 @@ 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. + Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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: @@ -6078,9 +7766,8 @@ paths: - "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. + - description: Filter the results by matching them with the ID of a referral. + This filter shows the coupons created by redeeming a referral code. in: query name: referralId schema: @@ -6148,8 +7835,19 @@ paths: - management /v1/applications/{applicationId}/export_referrals: get: - description: Download a CSV file containing the referrals that match the given - parameters. + description: | + Download a CSV file containing the referrals that match the given parameters. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The CSV file contains the following columns: + + - `code`: The referral code. + - `advocateprofileintegrationid`: 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 number of redemptions of this code. Defaults to `1` when left blank. + - `attributes`: A json object describing _custom_ referral attribute names and their values. operationId: exportReferrals parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -6181,8 +7879,8 @@ paths: 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. + - `expired`: Matches referrals in which the expiration date is set and in the past. + - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. in: query name: valid @@ -6233,6 +7931,26 @@ paths: get: description: | Download a CSV file containing the triggered effects that match the given attributes. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The generated file can contain the following columns: + + - `applicationid`: The ID of the Application. + - `campaignid`: The ID of the campaign. + - `couponid`: The ID of the coupon, when applicable to the effect. + - `created`: The timestamp of the effect. + - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/events). + - `eventid`: The internal ID of the effect. + - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). + - `profileintegrationid`: The ID of the customer profile, when applicable. + - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. + - `ruleindex`: The index of the rule. + - `rulesetid`: The ID of the rule set. + - `sessionid`: The internal ID of the session that triggered the effect. + - `profileid`: The internal ID of the customer profile. + - `sessionintegrationid`: The integration ID of the session. + - `total_revenue`: The total revenue. operationId: exportEffects parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -6292,6 +8010,28 @@ paths: 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). + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + - `id`: The internal ID of the session. + - `firstsession`: Whether this is a first session. + - `integrationid`: The integration ID of the session. + - `applicationid`: The ID of the Application. + - `profileid`: The internal ID of the customer profile. + - `profileintegrationid`: The integration ID of the customer profile. + - `created`: The timestamp when the session was created. + - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) of the session. + - `cartitems`: The cart items in the session. + - `discounts`: The discounts in the session. + - `total`: The total value of the session. + - `attributes`: The attributes set in the session. + - `closedat`: Timestamp when the session was closed. + - `cancelledat`: Timestamp when the session was cancelled. + - `referral`: The referral code in the session. + - `identifiers`: The identifiers in the session. + - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. + - `updated`: Timestamp of the last session update. + - `coupons`: Coupon codes in the session. operationId: exportCustomerSessions parameters: - description: The ID of the Application. It is displayed in your Talon.One @@ -6359,19 +8099,21 @@ paths: 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: + The CSV file contains 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. + - `limitval`: The maximum number 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. + You can use the time zone of your choice. It is converted to UTC internally by Talon.One. + + **Note:** We recommend limiting your file size to 500MB. **Example:** @@ -6422,11 +8164,11 @@ paths: 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -6436,9 +8178,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -6448,7 +8191,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_31' + $ref: '#/components/schemas/inline_response_200_37' description: OK summary: List users in account tags: @@ -6478,14 +8221,14 @@ paths: /v1/changes: get: description: | - Export the audit logs displayed in **Accounts > Audit logs**. + Retrieve 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. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -6495,9 +8238,10 @@ 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: | + The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. + + **Note:** This parameter works only with numeric fields. in: query name: sort schema: @@ -6513,7 +8257,7 @@ paths: name: entityPath schema: type: string - - description: Filter results that match the given user ID. + - description: Filter results by user ID. in: query name: userId schema: @@ -6543,6 +8287,11 @@ paths: name: withTotalResultSize schema: type: boolean + - description: Filter results that match the given management key ID. + in: query + name: managementKeyId + schema: + type: integer - description: When this flag is set to false, the state without the change will not be returned. The default value is true. in: query @@ -6554,7 +8303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_32' + $ref: '#/components/schemas/inline_response_200_38' description: OK summary: Get audit logs for an account tags: @@ -6563,12 +8312,15 @@ paths: post: description: | Send an email with a password recovery link to the email address of an existing account. + + **Note:** The password recovery link expires 30 minutes after this endpoint is triggered. operationId: createPasswordRecoveryEmail requestBody: content: application/json: schema: $ref: '#/components/schemas/NewPasswordEmail' + description: body required: true responses: "204": @@ -6592,6 +8344,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NewPassword' + description: body required: true responses: "204": @@ -6612,7 +8365,7 @@ paths: parameters: - 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` + [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. in: path name: accountId @@ -6637,7 +8390,7 @@ paths: parameters: - 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` + [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. in: path name: accountId @@ -6675,14 +8428,18 @@ paths: 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. +
+

Granular API key

+ Instead of using a session, you can also use the Management API key feature + in the Campaign Manager to decide which endpoints can be used with a given key. +
operationId: createSession requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginParams' + description: body required: true responses: "201": @@ -6701,11 +8458,11 @@ paths: List all past exports operationId: getExports parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: The number of items in this response. in: query name: pageSize schema: + default: 1000 maximum: 1000 minimum: 1 type: integer @@ -6737,13 +8494,14 @@ paths: - LoyaltyLedger - LoyaltyLedgerLog - Collection + - AudienceMembership type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_33' + $ref: '#/components/schemas/inline_response_200_39' description: OK summary: Get exports tags: @@ -6757,7 +8515,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_34' + $ref: '#/components/schemas/inline_response_200_40' description: OK summary: List roles tags: @@ -6829,17 +8587,20 @@ components: FeatureFlag: properties: name: - description: The name for the featureflag. + description: The name of the feature flag. + example: canCreateCampaignFromTemplate type: string value: - description: The value for the featureflag. + description: The value of the feature flag. + example: "true" type: string created: - description: The exact moment this entity was last created. + description: The time this entity was last created. + example: 2021-09-22T12:24:14.956203Z format: date-time type: string modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. format: date-time type: string required: @@ -6867,12 +8628,11 @@ components: Entity: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -6884,9 +8644,11 @@ components: properties: id: description: Unique ID for this entity. + example: 4 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string required: @@ -6896,7 +8658,7 @@ components: MutableEntity: properties: modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -6915,7 +8677,8 @@ components: UserEntity: properties: userId: - description: The ID of the account that owns this entity. + description: The ID of the user associated with this entity. + example: 388 type: integer required: - userId @@ -6959,7 +8722,7 @@ components: MultiApplicationEntity: properties: applicationIds: - description: The IDs of the applications that are related to this entity. + description: The IDs of the Applications that are related to this entity. items: type: integer minItems: 1 @@ -6982,6 +8745,7 @@ components: sessionId: description: The globally unique Talon.One ID of the session where this entity was created. + example: 2 type: integer required: - sessionId @@ -7003,7 +8767,7 @@ components: maxLength: 1000 type: string created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-02-07T08:15:22Z format: date-time type: string @@ -7041,18 +8805,27 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string type: object @@ -7065,21 +8838,78 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" properties: validCharacters: 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. + List of characters used to generate the random parts of a code. example: - A - B - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" items: type: string type: array @@ -7096,7 +8926,7 @@ components: type: object Session: example: - created: 2000-01-23T04:56:07.000+00:00 + created: 2021-07-20T22:00:00Z userId: 109 token: dy_Fa_lQ4iDAnqldJFvVEmnsN8xDTxej19l0LZDBJhQ properties: @@ -7111,6 +8941,7 @@ components: type: string created: description: Unix timestamp indicating when the session was first created. + example: 2021-07-20T22:00:00Z format: date-time type: string required: @@ -7238,18 +9069,22 @@ components: - sessionTotal - cartItems - additionalCosts + example: sessionTotal type: string enableCascadingDiscounts: description: Indicates if discounts should cascade for this Application. + example: true type: boolean enableFlattenedCartItems: 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). + 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#flattening). + example: true type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' sandbox: description: Indicates if this is a live or sandbox Application. + example: true type: boolean enablePartialDiscounts: description: Indicates if this Application supports partial discounts. @@ -7262,6 +9097,7 @@ components: - price - itemTotal - additionalCosts + example: price type: string required: - currency @@ -7335,18 +9171,22 @@ components: - sessionTotal - cartItems - additionalCosts + example: sessionTotal type: string enableCascadingDiscounts: description: Indicates if discounts should cascade for this Application. + example: true type: boolean enableFlattenedCartItems: 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). + 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#flattening). + example: true type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' sandbox: description: Indicates if this is a live or sandbox Application. + example: true type: boolean enablePartialDiscounts: description: Indicates if this Application supports partial discounts. @@ -7359,6 +9199,7 @@ components: - price - itemTotal - additionalCosts + example: price type: string key: description: Hex key for HMAC-signing API calls as coming from this application @@ -7411,17 +9252,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 - cardBased: true tiers: - name: Gold @@ -7442,17 +9284,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 name: My Application exclusiveCampaignsStrategy: listOrder modified: 2021-09-12T10:12:42Z @@ -7475,17 +9318,16 @@ components: enablePartialDiscounts: false 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -7557,18 +9399,22 @@ components: - sessionTotal - cartItems - additionalCosts + example: sessionTotal type: string enableCascadingDiscounts: description: Indicates if discounts should cascade for this Application. + example: true type: boolean enableFlattenedCartItems: 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). + 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#flattening). + example: true type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' sandbox: description: Indicates if this is a live or sandbox Application. + example: true type: boolean enablePartialDiscounts: description: Indicates if this Application supports partial discounts. @@ -7581,6 +9427,7 @@ components: - price - itemTotal - additionalCosts + example: price type: string loyaltyPrograms: description: An array containing all the loyalty programs to which this @@ -7606,16 +9453,25 @@ components: type: string description: description: A longer description of the campaign group. + example: My campaign group. type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this campaign group is enabled for. + example: + - 1 + - 2 + - 3 items: type: integer type: array campaignIds: description: A list of the IDs of the campaigns that this campaign group owns. + example: + - 4 + - 6 + - 8 items: type: integer type: array @@ -7626,17 +9482,16 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -7650,16 +9505,25 @@ components: type: string description: description: A longer description of the campaign group. + example: My campaign group. type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this campaign group is enabled for. + example: + - 1 + - 2 + - 3 items: type: integer type: array campaignIds: description: A list of the IDs of the campaigns that this campaign group owns. + example: + - 4 + - 6 + - 8 items: type: integer type: array @@ -7679,16 +9543,25 @@ components: type: string description: description: A longer description of the campaign group. + example: My campaign group. type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this campaign group is enabled for. + example: + - 1 + - 2 + - 3 items: type: integer type: array campaignIds: description: A list of the IDs of the campaigns that this campaign group owns. + example: + - 4 + - 6 + - 8 items: type: integer type: array @@ -7730,11 +9603,13 @@ components: - enabled - disabled - archived + example: enabled type: string activeRulesetId: description: | - [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this + [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. + example: 6 type: integer tags: description: A list of tags for the campaign. @@ -7757,6 +9632,7 @@ components: - referrals - loyalty - giveaways + - strikethrough type: string type: array couponSettings: @@ -7765,13 +9641,13 @@ components: $ref: '#/components/schemas/CodeGeneratorSettings' limits: description: | - The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. + 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](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. example: - 1 - 3 @@ -7787,21 +9663,18 @@ components: type: object UpdateCampaign: example: - activeRulesetId: 0 - description: description + activeRulesetId: 2 + description: Campaign for all summer 2021 promotions campaignGroups: - - 6 - - 6 + - 4 + - 5 tags: - - tags - - tags - - tags - - tags - - tags + - Summer + - Shoes features: - coupons - - coupons - name: name + - loyalty + name: Summer promotions referralSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -7810,8 +9683,37 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -7820,12 +9722,42 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" - startTime: 2000-01-23T04:56:07.000+00:00 - attributes: '{}' - endTime: 2000-01-23T04:56:07.000+00:00 - state: enabled + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + startTime: 2021-07-20T22:00:00Z + attributes: + myattribute: 20 + endTime: 2021-10-01T02:00:00Z + state: disabled limits: - period: yearly entities: @@ -7840,23 +9772,29 @@ components: 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 when the campaign will become inactive. + example: 2021-10-01T02:00:00Z format: date-time type: string attributes: description: Arbitrary properties associated with this campaign. + example: + myattribute: 20 properties: {} type: object state: @@ -7867,12 +9805,17 @@ components: - enabled - disabled - archived + example: disabled type: string activeRulesetId: description: ID of Ruleset this campaign applies on customer session evaluation. + example: 2 type: integer tags: description: A list of tags for the campaign. + example: + - Summer + - Shoes items: maxLength: 50 minLength: 1 @@ -7881,12 +9824,16 @@ components: type: array features: description: A list of features for the campaign. + example: + - coupons + - loyalty items: enum: - coupons - referrals - loyalty - giveaways + - strikethrough type: string type: array couponSettings: @@ -7900,6 +9847,9 @@ components: type: array campaignGroups: description: The IDs of the campaign groups that own this entity. + example: + - 4 + - 5 items: type: integer type: array @@ -7930,10 +9880,39 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" startTime: 2021-07-20T22:00:00Z - id: 3 + id: 4 state: enabled limits: - period: yearly @@ -7946,12 +9925,13 @@ components: - Coupon limit: 1000.0 action: createCoupon - activeRulesetId: 4 + activeRulesetId: 6 + reservecouponEffectCount: 9 updatedBy: Jane Doe - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 couponRedemptionCount: 163 - userId: 2 + userId: 388 couponCreationCount: 16 campaignGroups: - 1 @@ -7973,8 +9953,37 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z @@ -7984,9 +9993,11 @@ components: properties: id: description: Unique ID for this entity. + example: 4 type: integer created: description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z format: date-time type: string applicationId: @@ -7994,7 +10005,8 @@ components: example: 322 type: integer userId: - description: The ID of the account that owns this entity. + description: The ID of the user associated with this entity. + example: 388 type: integer name: description: A user-facing name for this campaign. @@ -8029,11 +10041,13 @@ components: - enabled - disabled - archived + example: enabled type: string activeRulesetId: description: | - [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this + [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. + example: 6 type: integer tags: description: A list of tags for the campaign. @@ -8056,6 +10070,7 @@ components: - referrals - loyalty - giveaways + - strikethrough type: string type: array couponSettings: @@ -8064,13 +10079,13 @@ components: $ref: '#/components/schemas/CodeGeneratorSettings' limits: description: | - The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. + 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](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. example: - 1 - 3 @@ -8136,6 +10151,11 @@ components: description: Total number of webhook triggered by rules in this campaign. example: 0 type: integer + reservecouponEffectCount: + description: Total number of reserve coupon effects triggered by rules in + this campaign. + example: 9 + type: integer lastActivity: description: Timestamp of the most recent event received by this campaign. example: 2022-11-10T23:00:00Z @@ -8178,6 +10198,11 @@ components: items: $ref: '#/components/schemas/Rule' type: array + strikethroughRules: + description: Set of rules to apply for strikethrough. + items: + $ref: '#/components/schemas/Rule' + type: array bindings: description: An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during @@ -8194,6 +10219,7 @@ components: activate: description: Indicates whether this created ruleset should be activated for the campaign that owns it. + example: true type: boolean required: - bindings @@ -8238,7 +10264,9 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - condition: - and - - couponValid @@ -8268,29 +10296,101 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 id: 6 + strikethroughRules: + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 templateId: 3 - userId: 6 + userId: 388 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The ID of the user associated with this entity. + example: 388 type: integer rules: description: Set of rules to apply. items: $ref: '#/components/schemas/Rule' type: array + strikethroughRules: + description: Set of rules to apply for strikethrough. + items: + $ref: '#/components/schemas/Rule' + type: array bindings: description: An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during @@ -8307,6 +10407,7 @@ components: activate: description: Indicates whether this created ruleset should be activated for the campaign that owns it. + example: true type: boolean campaignId: description: The ID of the campaign that owns this entity. @@ -8401,8 +10502,20 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 properties: + id: + description: A unique identifier for the rule. + example: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + format: uuid + type: string + parentId: + description: The ID of the rule that was copied to create this rule. + example: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + format: uuid + type: string title: description: A short description of the rule. example: Give discount via coupon @@ -8456,6 +10569,12 @@ components: type: object TemplateLimitConfig: description: "" + example: + period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon properties: action: description: | @@ -8549,12 +10668,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -8564,10 +10682,15 @@ components: type: integer version: description: Version of the campaign set. + example: 3 minimum: 1 type: integer set: $ref: '#/components/schemas/CampaignSetBranchNode' + updatedBy: + description: Name of the user who last updated this campaign set, if available. + example: Jane Doe + type: string required: - applicationId - created @@ -8579,12 +10702,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -8594,6 +10716,7 @@ components: type: integer version: description: Version of the campaign set. + example: 3 minimum: 1 type: integer set: @@ -8610,6 +10733,7 @@ components: properties: campaignId: description: ID of the campaign + example: 2 type: integer type: object CampaignPrioritiesV2: @@ -8630,6 +10754,7 @@ components: CampaignSetNode: properties: type: + example: type type: string required: - type @@ -8640,15 +10765,18 @@ components: description: Indicates the node type. enum: - SET + example: SET type: string name: description: Name of the set + example: name type: string operator: description: How does the set operates on its elements. enum: - ALL - FIRST + example: ALL type: string elements: description: Child elements of this set. @@ -8684,6 +10812,7 @@ components: type: integer version: description: Version of the campaign set. + example: 2 minimum: 1 type: integer set: @@ -8702,6 +10831,7 @@ components: type: integer version: description: Version of the campaign set. + example: 2 minimum: 1 type: integer set: @@ -8720,8 +10850,8 @@ components: 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. + description: Expiration 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 @@ -8753,8 +10883,8 @@ components: 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. + description: Expiration 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 @@ -8777,7 +10907,8 @@ components: friendProfileIntegrationId: BZGGC2454PA usageLimit: 1 campaignId: 78 - attributes: '{}' + attributes: + channel: web startDate: 2020-11-10T23:00:00Z advocateProfileIntegrationId: URNGV8294NV properties: @@ -8788,8 +10919,8 @@ components: 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. + description: Expiration 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 @@ -8821,6 +10952,8 @@ components: type: string attributes: description: Arbitrary properties associated with this item. + example: + channel: web properties: {} type: object required: @@ -8831,6 +10964,7 @@ components: properties: importId: description: The ID of the Import which created this referral. + example: 4 type: integer type: object Referral: @@ -8844,19 +10978,19 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -8867,8 +11001,8 @@ components: 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. + description: Expiration 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 @@ -8900,10 +11034,13 @@ components: type: string attributes: description: Arbitrary properties associated with this item. + example: + channel: web properties: {} type: object importId: description: The ID of the Import which created this referral. + example: 4 type: integer code: description: The referral code. @@ -8952,8 +11089,8 @@ components: 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. + description: Expiration 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 @@ -8979,17 +11116,37 @@ components: - URNGV8294NV - DRPVV9476AF validCharacters: + - A + - B + - C + - D - E - F + - G + - H - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" - Z - - "1" - - "2" - - "3" usageLimit: 1 campaignId: 45 referralPattern: REF-###-### - attributes: '{}' + attributes: + channel: web startDate: 2020-11-10T23:00:00Z properties: startDate: @@ -8999,8 +11156,8 @@ components: 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. + description: Expiration 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 @@ -9031,7 +11188,9 @@ components: title: Advocate Profile List type: array attributes: - description: Arbitrary properties associated with this item. + description: Arbitrary properties associated with this referral code. + example: + channel: web properties: {} type: object validCharacters: @@ -9039,13 +11198,32 @@ components: 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 + - C + - D - E - F + - G + - H - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" - Z - - "1" - - "2" - - "3" items: type: string type: array @@ -9072,9 +11250,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 5 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web referredCustomers: - referredCustomers - referredCustomers @@ -9082,12 +11261,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -9098,8 +11276,8 @@ components: 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. + description: Expiration 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 @@ -9131,10 +11309,13 @@ components: type: string attributes: description: Arbitrary properties associated with this item. + example: + channel: web properties: {} type: object importId: description: The ID of the Import which created this referral. + example: 4 type: integer code: description: The referral code. @@ -9200,44 +11381,53 @@ components: type: object CampaignCopy: example: - name: name - description: description - startTime: 2000-01-23T04:56:07.000+00:00 - endTime: 2000-01-23T04:56:07.000+00:00 + name: Copy of Summer promotions + description: Campaign for all summer 2021 promotions + startTime: 2021-06-01T09:00:27.993483Z + endTime: 2021-09-10T01:00:00.993483Z applicationIds: - - 0 - - 0 + - 1 + - 2 + - 3 tags: - - tags - - tags - - tags - - tags - - tags + - Summer + - Shoes properties: name: description: Name of the copied campaign (Defaults to "Copy of original campaign name"). + example: Copy of Summer promotions type: string applicationIds: description: Application IDs of the applications to which a campaign should be copied to. + example: + - 1 + - 2 + - 3 items: type: integer type: array 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-06-01T09:00:27.993483Z format: date-time type: string endTime: description: Timestamp when the campaign will become inactive. + example: 2021-09-10T01:00:00.993483Z format: date-time type: string tags: description: A list of tags for the campaign. + example: + - Summer + - Shoes items: maxLength: 50 minLength: 1 @@ -9250,20 +11440,22 @@ components: NewCoupons: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 recipientIntegrationId: URNGV8294NV - uniquePrefix: uniquePrefix + uniquePrefix: "" + usageLimit: 100 + numberOfCoupons: 1 + expiryDate: 2023-08-24T14:15:22Z couponPattern: SUMMER-##### validCharacters: - A - B - G - "Y" - usageLimit: 100 - numberOfCoupons: 1 - attributes: '{}' + reservationLimit: 45 + attributes: + venueId: 12 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -9275,6 +11467,7 @@ components: - Coupon limit: 1000.0 action: createCoupon + isReservationMandatory: false properties: usageLimit: description: | @@ -9285,18 +11478,27 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string limits: @@ -9316,11 +11518,14 @@ components: type: integer uniquePrefix: 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). + **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint. + example: "" title: Coupon code unique prefix type: string attributes: description: Arbitrary properties associated with this item. + example: + venueId: 12 properties: {} type: object recipientIntegrationId: @@ -9349,6 +11554,12 @@ components: maxLength: 100 minLength: 3 type: string + isReservationMandatory: + default: true + description: Whether the reservation effect actually created a new reservation. + example: false + title: Is reservation mandatory + type: boolean required: - numberOfCoupons - usageLimit @@ -9356,21 +11567,44 @@ components: NewCouponsForMultipleRecipients: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - couponPattern: couponPattern + expiryDate: 2023-08-24T14:15:22Z + couponPattern: SUMMER-##### validCharacters: - - validCharacters - - validCharacters + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z usageLimit: 100 + reservationLimit: 45 recipientsIntegrationIds: - - recipientsIntegrationIds - - recipientsIntegrationIds - - recipientsIntegrationIds - - recipientsIntegrationIds - - recipientsIntegrationIds - attributes: '{}' + - URNGV8294NV + - BZGGC2454PA + attributes: + venueId: 12 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z properties: usageLimit: description: | @@ -9381,26 +11615,40 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string attributes: description: Arbitrary properties associated with this item. + example: + venueId: 12 properties: {} type: object recipientsIntegrationIds: description: The integration IDs for recipients. + example: + - URNGV8294NV + - BZGGC2454PA items: type: string maxItems: 1000 @@ -9411,12 +11659,40 @@ components: 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 + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z items: type: string type: array couponPattern: description: | 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 @@ -9427,12 +11703,13 @@ components: UpdateCoupon: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - recipientIntegrationId: recipientIntegrationId + expiryDate: 2023-08-24T14:15:22Z + recipientIntegrationId: URNGV8294NV usageLimit: 100 + reservationLimit: 45 attributes: '{}' discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -9444,6 +11721,7 @@ components: - Coupon limit: 1000.0 action: createCoupon + isReservationMandatory: false properties: usageLimit: description: | @@ -9454,18 +11732,27 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string limits: @@ -9480,6 +11767,7 @@ components: type: array recipientIntegrationId: description: The integration ID for this coupon's beneficiary's profile. + example: URNGV8294NV maxLength: 1000 title: Receiving customer profile integration ID type: string @@ -9487,16 +11775,23 @@ components: description: Arbitrary properties associated with this item. properties: {} type: object + isReservationMandatory: + default: true + description: Whether the reservation effect actually created a new reservation. + example: false + title: Is reservation mandatory + type: boolean type: object UpdateCouponBatch: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 + expiryDate: 2023-08-24T14:15:22Z usageLimit: 100 + reservationLimit: 45 attributes: '{}' batchID: batchID discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z properties: usageLimit: description: | @@ -9507,18 +11802,27 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string attributes: @@ -9530,7 +11834,176 @@ components: title: Batch ID type: string type: object - Coupon: + Coupon: + description: "" + example: + recipientIntegrationId: URNGV8294NV + created: 2020-06-10T09:05:27.993483Z + campaignId: 211 + usageLimit: 100 + referralId: 326632952 + usageCounter: 10 + batchId: 32535-43255 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 + reservation: false + attributes: '{}' + id: 6 + value: XMAS-20-2021 + discountLimit: 30.0 + startDate: 2020-01-24T14:15:22Z + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + discountRemainder: 5.0 + isReservationMandatory: false + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time 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 + value: + description: The coupon code. + example: XMAS-20-2021 + minLength: 4 + title: Coupon Code + type: string + 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 total discount value that the code can give. Typically used to represent a gift card value. + example: 30.0 + maximum: 999999 + minimum: 0 + type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer + startDate: + description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z + format: date-time + type: string + expiryDate: + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z + 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 the coupon has been successfully redeemed. + example: 10 + title: Total coupon redemptions + type: integer + discountCounter: + description: The amount of discounts given on rules redeeming this coupon. + Only usable if a coupon discount budget was set for this coupon. + example: 10.0 + title: Discounts Given + type: number + discountRemainder: + description: The remaining discount this coupon can give. + example: 5.0 + title: Coupon Discount Remainder + type: number + reservationCounter: + description: The number of times this coupon has been reserved. + example: 1.0 + title: Number of reservations + type: number + attributes: + description: Custom attributes associated with this coupon. + properties: {} + title: Attributes of coupon + type: object + referralId: + description: The integration ID of the referring customer (if any) for whom + this coupon was created as an effect. + example: 326632952 + title: Advocate ID + type: integer + 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: + description: The ID of the Import which created this coupon. + example: 4 + title: Import ID + type: integer + reservation: + 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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. + - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. + example: false + title: Reservation Status + type: boolean + batchId: + description: The id of the batch the coupon belongs to. + example: 32535-43255 + title: Batch ID + type: string + isReservationMandatory: + default: true + description: Whether the reservation effect actually created a new reservation. + example: false + title: Is reservation mandatory + type: boolean + required: + - campaignId + - created + - id + - usageCounter + - usageLimit + - value + type: object + IntegrationCoupon: description: "" example: recipientIntegrationId: URNGV8294NV @@ -9538,17 +12011,20 @@ components: campaignId: 211 usageLimit: 100 referralId: 326632952 + profileRedemptionCount: 5 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -9560,15 +12036,15 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -9592,18 +12068,27 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string limits: @@ -9617,19 +12102,26 @@ components: $ref: '#/components/schemas/LimitConfig' type: array usageCounter: - description: The number of times this coupon has been successfully used. + description: The number of times the coupon has been successfully redeemed. example: 10 - title: Number of coupon usages + title: Total coupon redemptions type: integer discountCounter: description: The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. + example: 10.0 title: Discounts Given type: number discountRemainder: description: The remaining discount this coupon can give. + example: 5.0 title: Coupon Discount Remainder type: number + reservationCounter: + description: The number of times this coupon has been reserved. + example: 1.0 + title: Number of reservations + type: number attributes: description: Custom attributes associated with this coupon. properties: {} @@ -9650,14 +12142,15 @@ components: type: string importId: description: The ID of the Import which created this coupon. + example: 4 title: Import ID type: integer reservation: 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). + - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. + - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. example: false title: Reservation Status type: boolean @@ -9666,10 +12159,22 @@ components: example: 32535-43255 title: Batch ID type: string + isReservationMandatory: + default: true + description: Whether the reservation effect actually created a new reservation. + example: false + title: Is reservation mandatory + type: boolean + profileRedemptionCount: + description: The number of times the coupon was redeemed by the profile. + example: 5 + title: Coupon redemptions for the profile + type: integer required: - campaignId - created - id + - profileRedemptionCount - usageCounter - usageLimit - value @@ -9685,16 +12190,18 @@ components: profileRedemptionCount: 5 usageCounter: 10 batchId: 32535-43255 - discountCounter: 0.8008281904610115 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 state: active value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -9706,15 +12213,15 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 6.027456183070403 + discountRemainder: 5.0 + isReservationMandatory: false 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -9738,18 +12245,27 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z format: date-time type: string limits: @@ -9763,19 +12279,26 @@ components: $ref: '#/components/schemas/LimitConfig' type: array usageCounter: - description: The number of times this coupon has been successfully used. + description: The number of times the coupon has been successfully redeemed. example: 10 - title: Number of coupon usages + title: Total coupon redemptions type: integer discountCounter: description: The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. + example: 10.0 title: Discounts Given type: number discountRemainder: description: The remaining discount this coupon can give. + example: 5.0 title: Coupon Discount Remainder type: number + reservationCounter: + description: The number of times this coupon has been reserved. + example: 1.0 + title: Number of reservations + type: number attributes: description: Custom attributes associated with this coupon. properties: {} @@ -9796,14 +12319,15 @@ components: type: string importId: description: The ID of the Import which created this coupon. + example: 4 title: Import ID type: integer reservation: 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). + - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the [Create coupon reservation](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. + - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. example: false title: Reservation Status type: boolean @@ -9812,9 +12336,16 @@ components: example: 32535-43255 title: Batch ID type: string + isReservationMandatory: + default: true + description: Whether the reservation effect actually created a new reservation. + example: false + title: Is reservation mandatory + type: boolean profileRedemptionCount: description: The number of times the coupon was redeemed by the profile. - title: Number of coupon usages + example: 5 + title: Number of coupon usages per profile type: integer state: description: | @@ -9840,42 +12371,45 @@ components: CampaignAnalytics: description: "" example: - date: 2000-01-23T04:56:07.000+00:00 - couponRolledbackRedemptions: 1 - totalCouponRolledbackRedemptions: 1 - campaignRefundedDiscounts: 9.301444243932576 - totalDeductedLoyaltyPoints: 9.018348186070783 - couponRedemptions: 7 - totalCampaignDiscountCosts: 7.061401241503109 - referralRedemptions: 6 - totalCampaignRevenue: 1.4658129805029452 - campaignRevenue: 6.027456183070403 - campaignDiscountCosts: 2.3021358869347655 - totalReferralRedemptions: 7 + date: 2021-10-12T10:12:42Z + couponRolledbackRedemptions: 2 + totalCouponRolledbackRedemptions: 4 + campaignRefundedDiscounts: 5.637376656633329 + totalDeductedLoyaltyPoints: 220.0 + couponRedemptions: 9 + totalCampaignDiscountCosts: 5.962133916683182 + referralRedemptions: 7 + totalCampaignRevenue: 5784.63 + campaignRevenue: 3539.76 + campaignDiscountCosts: 1.4658129805029452 + totalReferralRedemptions: 1 couponsCreated: 1 - addedLoyaltyPoints: 9.369310271410669 - campaignRefund: 5.962133916683182 - campaignFreeItems: 2 - totalAddedLoyaltyPoints: 6.683562403749608 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 - totalCampaignRefund: 5.637376656633329 - totalCouponsCreated: 4 - deductedLoyaltyPoints: 8.762042012749001 - totalCouponRedemptions: 1 - referralsCreated: 5 - totalReferralsCreated: 9 + addedLoyaltyPoints: 250.0 + campaignRefund: 0.8008281904610115 + campaignFreeItems: 7 + totalAddedLoyaltyPoints: 340.0 + totalCampaignFreeItems: 86 + totalCampaignRefundedDiscounts: 2.3021358869347655 + totalCampaignRefund: 6.027456183070403 + totalCouponsCreated: 1 + deductedLoyaltyPoints: 120.0 + totalCouponRedemptions: 3 + referralsCreated: 6 + totalReferralsCreated: 7 properties: date: + example: 2021-10-12T10:12:42Z format: date-time type: string campaignRevenue: description: Amount of revenue in this campaign (for coupon or discount sessions). + example: 3539.76 type: number totalCampaignRevenue: description: Amount of revenue in this campaign since it began (for coupon or discount sessions). + example: 5784.63 type: number campaignRefund: description: Amount of refunds in this campaign (for coupon or discount @@ -9904,6 +12438,7 @@ components: type: integer totalCampaignFreeItems: description: Amount of free items given in the campaign since it began. + example: 86 type: integer couponRedemptions: description: Number of coupon redemptions in the campaign. @@ -9942,17 +12477,21 @@ components: addedLoyaltyPoints: description: Number of added loyalty points in the campaign in a specific interval. + example: 250.0 type: number totalAddedLoyaltyPoints: description: Number of added loyalty points in the campaign since it began. + example: 340.0 type: number deductedLoyaltyPoints: description: Number of deducted loyalty points in the campaign in a specific interval. + example: 120.0 type: number totalDeductedLoyaltyPoints: description: Number of deducted loyalty points in the campaign since it began. + example: 220.0 type: number required: - addedLoyaltyPoints @@ -9985,18 +12524,18 @@ components: description: "" example: date: 2000-01-23T04:56:07.000+00:00 - totalMembers: 5.637376656633329 - totalSpentPoints: 1.4658129805029452 + totalMembers: 2582.0 + totalSpentPoints: 25668.0 spentPoints: - createdManually: 7.061401241503109 - createdViaRuleEngine: 9.301444243932576 - totalActivePoints: 0.8008281904610115 - totalPendingPoints: 6.027456183070403 - totalExpiredPoints: 5.962133916683182 - newMembers: 2.3021358869347655 + createdManually: 125.0 + createdViaRuleEngine: 9631.0 + totalActivePoints: 9756.0 + totalPendingPoints: 548.0 + totalExpiredPoints: 1156.0 + newMembers: 3.0 earnedPoints: - createdManually: 7.061401241503109 - createdViaRuleEngine: 9.301444243932576 + createdManually: 125.0 + createdViaRuleEngine: 9631.0 properties: date: description: Date at which data point was collected. @@ -10004,21 +12543,27 @@ components: type: string totalActivePoints: description: Total of active points for this loyalty program. + example: 9756.0 type: number totalPendingPoints: description: Total of pending points for this loyalty program. + example: 548.0 type: number totalSpentPoints: description: Total of spent points for this loyalty program. + example: 25668.0 type: number totalExpiredPoints: description: Total of expired points for this loyalty program. + example: 1156.0 type: number totalMembers: description: Number of loyalty program members. + example: 2582.0 type: number newMembers: description: Number of members who joined on this day. + example: 3.0 type: number spentPoints: $ref: '#/components/schemas/LoyaltyDashboardPointsBreakdown' @@ -10044,21 +12589,27 @@ components: type: string totalActivePoints: description: Total of active points for this loyalty program. + example: 9756.0 type: number totalPendingPoints: description: Total of pending points for this loyalty program. + example: 548.0 type: number totalSpentPoints: description: Total of spent points for this loyalty program. + example: 25668.0 type: number totalExpiredPoints: description: Total of expired points for this loyalty program. + example: 1156.0 type: number totalMembers: description: Number of loyalty program members. + example: 2582.0 type: number newMembers: description: Number of members who joined on this day. + example: 3.0 type: number spentPoints: $ref: '#/components/schemas/LoyaltyDashboardPointsBreakdown' @@ -10077,12 +12628,14 @@ components: type: object LoyaltyDashboardPointsBreakdown: example: - createdManually: 7.061401241503109 - createdViaRuleEngine: 9.301444243932576 + createdManually: 125.0 + createdViaRuleEngine: 9631.0 properties: createdManually: + example: 125.0 type: number createdViaRuleEngine: + example: 9631.0 type: number required: - createdManually @@ -10095,8 +12648,13 @@ components: lastUsed: 2021-09-12T10:12:42Z properties: summary: - description: One-word summary of the health of the API connection of an - application. + description: | + One-word summary of the health of the API connection of an application. Possible values are: + - `OK`: The Application has received only successful API requests in the last 5 minutes. + - `WARNING`: The Application received at least one failed request in the last 50 minutes. + - `ERROR`: More than 50% of received requests failed. + - `CRITICAL`: All received requests failed. + - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests. enum: - OK - WARNING @@ -10116,35 +12674,54 @@ components: AccessLogEntry: description: Log of application accesses. example: - method: method - requestPayload: requestPayload - responsePayload: responsePayload - requestUri: requestUri - time: 2000-01-23T04:56:07.000+00:00 - uuid: uuid - status: 0 + method: PUT + requestPayload: |- + { + "customerSession": { + "profileId": "customer123", + "state": "closed", + ... + } + responsePayload: '{"coupons":[],"createdCoupons":[],...}' + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z + uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 properties: uuid: description: UUID reference of request. + example: 606e7d34-2d36-4d53-ac71-d4442c325985 type: string status: description: HTTP status code of response. + example: 200 type: integer method: description: HTTP method of request. + example: PUT type: string requestUri: description: target URI of request + example: /v2/customer_sessions/Session136667 type: string time: description: timestamp of request + example: 2023-01-16T16:00:00.700763Z format: date-time type: string requestPayload: description: payload of request + example: |- + { + "customerSession": { + "profileId": "customer123", + "state": "closed", + ... + } type: string responsePayload: description: payload of response + example: '{"coupons":[],"createdCoupons":[],...}' type: string required: - method @@ -10156,50 +12733,66 @@ 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 - webhookId: 6 - response: response - responseTime: 2000-01-23T04:56:07.000+00:00 - integrationRequestUuid: integrationRequestUuid - id: id - applicationId: 1 - url: url - status: 5 + requestTime: 2021-07-20T22:00:00Z + request: | + { + mydata: "somevalue" + } + webhookId: 5 + response: "" + responseTime: 2021-07-20T22:00:50Z + integrationRequestUuid: "472075793" + id: "2" + applicationId: 12 + url: www.my-company.com/my-endpoint-name + status: 204 properties: id: description: UUID reference of the webhook request. + example: "2" type: string integrationRequestUuid: description: UUID reference of the integration request linked to this webhook request. + example: "472075793" type: string webhookId: description: ID of the webhook that triggered the request. + example: 5 type: integer applicationId: description: ID of the application that triggered the webhook. + example: 12 type: integer url: description: Target url of request + example: www.my-company.com/my-endpoint-name type: string request: description: Request message + example: | + { + mydata: "somevalue" + } type: string response: description: Response message + example: "" type: string status: description: HTTP status code of response. + example: 204 type: integer requestTime: description: Timestamp of request + example: 2021-07-20T22:00:00Z format: date-time type: string responseTime: description: Timestamp of response + example: 2021-07-20T22:00:50Z format: date-time type: string required: @@ -10213,27 +12806,32 @@ components: WebhookActivationLogEntry: description: Log of activated webhooks. example: - webhookId: 6 - campaignId: 5 - created: 2000-01-23T04:56:07.000+00:00 - integrationRequestUuid: integrationRequestUuid - applicationId: 1 + webhookId: 1 + campaignId: 86 + created: 2023-03-21T13:55:08.571144Z + integrationRequestUuid: 6d3699cf-95bd-444a-b62f-80d6e8391dc9 + applicationId: 13 properties: integrationRequestUuid: description: UUID reference of the integration request that triggered the effect with the webhook. + example: 6d3699cf-95bd-444a-b62f-80d6e8391dc9 type: string webhookId: description: ID of the webhook that triggered the request. + example: 1 type: integer applicationId: description: ID of the application that triggered the webhook. + example: 13 type: integer campaignId: description: ID of the campaign that triggered the webhook. + example: 86 type: integer created: description: Timestamp of request + example: 2023-03-21T13:55:08.571144Z format: date-time type: string required: @@ -10263,17 +12861,16 @@ components: Role: 127 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -10351,7 +12948,7 @@ components: type: string acl: description: | - The `Access Control List` json defining the role of the user. This represents the actual access control on the user level. + The `Access Control List` json defining the role of the user. This represents the access control on the user level. Use one of the following: - normal user: `{"Role": 0}` - admin: `{"Role": 127}` @@ -10383,21 +12980,22 @@ components: old: '{}' id: 6 applicationId: 359 - userId: 6 + userId: 388 entity: /v1/applications/359/campaigns/6727 + managementKeyId: 3 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The ID of the user associated with this entity. + example: 388 type: integer applicationId: description: ID of application associated with change. @@ -10425,19 +13023,26 @@ components: id: 6727 properties: {} type: object + managementKeyId: + description: ID of management key used to perform changes. + example: 3 + type: integer required: - created - entity - id - userId type: object - LoyaltyPoints: - description: Points to add or deduct. + AddLoyaltyPoints: + description: Points to add. example: - name: name - validityDuration: validityDuration - pendingDuration: pendingDuration - subLedgerID: subLedgerID + subledgerId: sub-123 + name: Compensation + validityDuration: 5D + pendingDuration: 12h + validUntil: 2021-07-20T22:00:00Z + applicationId: 322 + pendingUntil: 2021-07-20T22:00:00Z points: 300.0 properties: points: @@ -10449,22 +13054,112 @@ components: minimum: 0 type: number name: - description: Allows to specify a name/reason for the point addition or deduction. + description: Name / reason for the point addition. + example: Compensation type: string validityDuration: - description: 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). + description: | + The time format is either: + - `immediate` or, + - an **integer** followed by one letter indicating the time unit. + + Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. + + Available units: + + - `s`: seconds + - `m`: minutes + - `h`: hours + - `D`: days + - `W`: weeks + - `M`: months + + You can round certain units up or down: + - `_D` for rounding down days only. Signifies the start of the day. + - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. + + If passed, `validUntil` should be omitted. + example: 5D + type: string + validUntil: + description: | + Date and time when points should expire. The value should be provided in RFC 3339 format. + If passed, `validityDuration` should be omitted. + example: 2021-07-20T22:00:00Z + format: date-time type: string pendingDuration: - description: 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). + description: | + The amount of time before the points are considered valid. + + The time format is either: + - `immediate` or, + - an **integer** followed by one letter indicating the time unit. + + Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. + + Available units: + + - `s`: seconds + - `m`: minutes + - `h`: hours + - `D`: days + - `W`: weeks + - `M`: months + + You can round certain units up or down: + - `_D` for rounding down days only. Signifies the start of the day. + - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. + example: 12h type: string - subLedgerID: - description: This specifies if we are adding loyalty points to the main - ledger or a subledger. + pendingUntil: + description: | + Date and time after the points are considered valid. The value should be provided in RFC 3339 format. + If passed, `pendingDuration` should be omitted. + example: 2021-07-20T22:00:00Z + format: date-time + type: string + subledgerId: + description: ID of the subledger the points are added to. If there is no + existing subledger with this ID, the subledger is created automatically. + example: sub-123 + type: string + applicationId: + description: ID of the Application that is connected to the loyalty program. + It is displayed in your Talon.One deployment URL. + example: 322 + type: integer + required: + - points + type: object + DeductLoyaltyPoints: + description: Points to deduct. + example: + subledgerId: sub-123 + name: Penalty + applicationId: 322 + points: 300.0 + properties: + points: + description: Amount of loyalty points. + example: 300.0 + exclusiveMaximum: false + exclusiveMinimum: true + maximum: 999999999999.99 + minimum: 0 + type: number + name: + description: Name / reason for the point deduction. + example: Penalty + type: string + subledgerId: + description: ID of the subledger the points are deducted from. + example: sub-123 type: string + applicationId: + description: ID of the Application that is connected to the loyalty program. + example: 322 + type: integer required: - points type: object @@ -10491,25 +13186,24 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 properties: id: - 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. + description: The ID of loyalty program. Internal ID of this entity. type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -10531,15 +13225,19 @@ components: type: integer type: array defaultValidity: - 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 + description: | + The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. + example: 2W_U 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'. + description: | + The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. example: immediate type: string allowSubledger: @@ -10553,6 +13251,12 @@ components: example: 111 minimum: 0 type: integer + sandbox: + description: Indicates if this program is a live or sandbox program. Programs + of a given type can only be connected to Applications of the same type. + example: true + title: Sandbox + type: boolean accountID: description: The ID of the Talon.One account that owns this program. example: 1 @@ -10606,6 +13310,7 @@ components: - description - id - name + - sandbox - subscribedApplications - timezone - title @@ -10614,12 +13319,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -10685,15 +13389,19 @@ components: type: integer type: array defaultValidity: - 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 + description: | + The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. + example: 2W_U 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'. + description: | + The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. example: immediate type: string allowSubledger: @@ -10707,6 +13415,12 @@ components: example: 111 minimum: 0 type: integer + sandbox: + description: Indicates if this program is a live or sandbox program. Programs + of a given type can only be connected to Applications of the same type. + example: true + title: Sandbox + type: boolean type: object NewLoyaltyProgram: description: "" @@ -10729,15 +13443,19 @@ components: type: integer type: array defaultValidity: - 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 + description: | + The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. + example: 2W_U 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'. + description: | + The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. example: immediate type: string allowSubledger: @@ -10751,6 +13469,12 @@ components: example: 111 minimum: 0 type: integer + sandbox: + description: Indicates if this program is a live or sandbox program. Programs + of a given type can only be connected to Applications of the same type. + example: true + title: Sandbox + type: boolean name: description: The internal name for the Loyalty Program. This is an immutable value. @@ -10779,6 +13503,7 @@ components: - defaultPending - defaultValidity - name + - sandbox - timezone - title type: object @@ -10803,15 +13528,19 @@ components: type: integer type: array defaultValidity: - 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 + description: | + The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. + example: 2W_U 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'. + description: | + The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. example: immediate type: string allowSubledger: @@ -10825,6 +13554,12 @@ components: example: 111 minimum: 0 type: integer + sandbox: + description: Indicates if this program is a live or sandbox program. Programs + of a given type can only be connected to Applications of the same type. + example: true + title: Sandbox + type: boolean tiers: description: The tiers in this loyalty program. items: @@ -10847,57 +13582,79 @@ components: LoyaltyLedgerEntry: description: A single row of the ledger, describing one addition or deduction. example: - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z properties: created: + example: 2021-07-20T22:00:00Z format: date-time type: string programID: + example: 5 type: integer customerProfileID: + example: URNGV8294NV type: string cardID: + example: 241 type: integer customerSessionID: + example: t2gy5s-47274 type: string eventID: + example: 5 type: integer type: description: | - The type of the ledger transaction. Possible values are addition, subtraction, expire or expiring (for expiring points ledgers) + The type of the ledger transaction. Possible values are: + - `addition` + - `subtraction` + - `expire` + - `expiring` (for expiring points ledgers) + example: addition type: string amount: + example: 100.0 type: number startDate: + example: 2021-07-20T22:00:00Z format: date-time type: string expiryDate: + example: 2022-07-20T22:00:00Z format: date-time type: string name: description: A name referencing the condition or effect that added this entry, or the specific name provided in an API call. + example: Add points on purchase type: string subLedgerID: description: This specifies if we are adding loyalty points to the main ledger or a subledger. + example: mysubledger type: string userID: description: This is the ID of the user who created this entry, if the addition or subtraction was done manually. + example: 499 type: integer + archived: + description: Indicates if the entry belongs to the archived session. + example: false + type: boolean required: - amount - created @@ -10908,6 +13665,18 @@ components: type: object LoyaltyBalances: description: List of loyalty balances for a ledger and its subledgers. + example: + balance: + activePoints: 286.0 + spentPoints: 150.0 + expiredPoints: 286.0 + pendingPoints: 50.0 + subledgerBalances: + mysubledger: + activePoints: 286 + pendingPoints: 50 + spentPoints: 150 + expiredPoints: 25 properties: balance: $ref: '#/components/schemas/LoyaltyBalance' @@ -10915,28 +13684,43 @@ components: additionalProperties: $ref: '#/components/schemas/LoyaltyBalance' description: Map of the loyalty balances of the subledgers of a ledger. + example: + mysubledger: + activePoints: 286 + pendingPoints: 50 + spentPoints: 150 + expiredPoints: 25 type: object type: object LoyaltyBalance: description: Point balance of a ledger in the Loyalty Program. + example: + activePoints: 286.0 + spentPoints: 150.0 + expiredPoints: 286.0 + pendingPoints: 50.0 properties: activePoints: description: Total amount of points awarded to this customer and available to spend. + example: 286.0 title: Current Balance type: number pendingPoints: description: Total amount of points awarded to this customer but not available until their start date. + example: 50.0 title: Total pending points type: number spentPoints: description: Total amount of points already spent by this customer. + example: 150.0 title: Total spent points type: number expiredPoints: description: Total amount of points awarded but never redeemed. They cannot be used anymore. + example: 286.0 title: Total expired points type: number type: object @@ -10947,291 +13731,162 @@ components: total: 0.8008281904610115 totalSpentPoints: 5.962133916683182 activePoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z expiringPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z totalActivePoints: 6.027456183070403 totalPendingPoints: 1.4658129805029452 totalExpiredPoints: 5.637376656633329 transactions: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z expiredPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z currentTier: name: bronze id: 11 pendingPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z subLedgers: - key: - total: 0.8008281904610115 - totalSpentPoints: 5.962133916683182 - activePoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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: bronze - id: 11 - pendingPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + mysubledger: + activePoints: 286 + pendingPoints: 50 + spentPoints: 150 + expiredPoints: 25 properties: ledger: $ref: '#/components/schemas/LoyaltySubLedger' @@ -11239,6 +13894,12 @@ components: additionalProperties: $ref: '#/components/schemas/LoyaltySubLedger' description: A map containing a list of all loyalty subledger balances. + example: + mysubledger: + activePoints: 286 + pendingPoints: 50 + spentPoints: 150 + expiredPoints: 25 type: object required: - ledger @@ -11249,146 +13910,156 @@ components: total: 0.8008281904610115 totalSpentPoints: 5.962133916683182 activePoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z expiringPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z totalActivePoints: 6.027456183070403 totalPendingPoints: 1.4658129805029452 totalExpiredPoints: 5.637376656633329 transactions: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z expiredPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z currentTier: name: bronze id: 11 pendingPoints: - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 - - eventID: 9 - amount: 3.616076749251911 - created: 2000-01-23T04:56:07.000+00:00 - subLedgerID: subLedgerID - customerSessionID: customerSessionID - type: type - 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 + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z + - eventID: 5 + amount: 100.0 + created: 2021-07-20T22:00:00Z + subLedgerID: mysubledger + customerSessionID: t2gy5s-47274 + type: addition + userID: 499 + expiryDate: 2022-07-20T22:00:00Z + archived: false + customerProfileID: URNGV8294NV + cardID: 241 + name: Add points on purchase + programID: 5 + startDate: 2021-07-20T22:00:00Z properties: total: description: | @@ -11454,234 +14125,100 @@ components: cards: - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active programs: key: ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 subLedgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 @@ -11710,70 +14247,24 @@ components: example: ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 subLedgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 @@ -11810,42 +14301,19 @@ components: description: "" example: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 properties: currentBalance: description: Sum of currently active points. - example: 46.0 + example: 100.0 title: Current balance type: number pendingBalance: @@ -11854,29 +14322,38 @@ components: title: Pending balance type: number expiredBalance: - description: Sum of expired points. - example: 30.0 + description: | + **DEPRECATED** Value is shown as 0. + example: 0.0 title: Expired balance type: number spentBalance: - description: Sum of spent points. - example: 84.0 + description: | + **DEPRECATED** Value is shown as 0. + example: 0.0 title: Spent balance type: number tentativeCurrentBalance: - description: Sum of currently active points, including points added and - deducted in open sessions. - example: 56.0 + description: Sum of the tentative active points (including additions and + deductions) inside the currently open session. The `currentBalance` is + updated to this value when you close the session, and the effects are + applied. + example: 100.0 title: Tentative current balance type: number + tentativePendingBalance: + description: Sum of pending points (including additions and deductions) + inside the currently open session. The `pendingBalance` is updated to + this value when you close the session, and the effects are applied. + example: 20.0 + title: Tentative pending 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 @@ -11906,93 +14383,48 @@ components: example: ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -12002,19 +14434,23 @@ components: type: integer status: description: | - Status of the loyalty card. Can be one of: ['active', 'disabled'] + Status of the loyalty card. Can be one of: ['active', 'inactive'] + example: active type: string identifier: - description: The alphanumeric identifier of the loyalty card. + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 type: string usersPerCardLimit: description: | - The max amount of user profiles a card can be shared with. 0 means unlimited. + The max amount of customer profiles that can be linked to the card. 0 means unlimited. example: 111 minimum: 0 type: integer profiles: - description: Integration IDs of the customers associated with the card. + description: Integration IDs of the customers profiles linked to the card. items: $ref: '#/components/schemas/LoyaltyCardProfileRegistration' type: array @@ -12031,6 +14467,18 @@ components: example: 2021-09-12T10:12:42Z format: date-time type: string + oldCardIdentifier: + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + type: string + newCardIdentifier: + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + type: string required: - created - id @@ -12039,8 +14487,28 @@ components: - status - usersPerCardLimit type: object + LoyaltyCardIdentifier: + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + type: string CardLedgerTransactionLogEntry: description: Log entry for a given loyalty card transaction. + example: + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + sessionId: 233 + type: addition + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + id: 123 + applicationId: 322 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 properties: created: description: Date and time the loyalty card transaction occurred. @@ -12051,9 +14519,10 @@ components: example: 324 type: integer cardIdentifier: - description: Identifier of the loyalty card. + description: | + The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 - maxLength: 255 + maxLength: 108 type: string applicationId: description: The ID of the Application that owns this entity. @@ -12071,9 +14540,9 @@ components: type: string type: description: | - Type of transaction. Possible values are: - - `addition`: Points were added. - - `subtraction`: Points were subtracted. + Type of transaction. Possible values: + - `addition`: Signifies added points. + - `subtraction`: Signifies deducted points. enum: - addition - subtraction @@ -12087,9 +14556,9 @@ components: 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. + When points become active. Possible values: + - `immediate`: Points are immediately active. + - a timestamp value: Points become active at a given date and time. example: 2022-01-02T15:04:05Z07:00 maxLength: 64 type: string @@ -12098,7 +14567,7 @@ components: 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 + example: 2022-08-02T15:04:05Z07:00 type: string subledgerId: description: ID of the subledger. @@ -12117,7 +14586,6 @@ components: - amount - cardIdentifier - created - - customerSessionId - expiryDate - id - name @@ -12128,6 +14596,20 @@ components: type: object CardLedgerTransactionLogEntryIntegrationAPI: description: Log entry for a given loyalty card transaction. + example: + rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + type: addition + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + ruleName: Add 2 points + id: 123 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 properties: created: description: Date and time the loyalty card transaction occurred. @@ -12138,9 +14620,10 @@ components: example: 324 type: integer cardIdentifier: - description: Identifier of the loyalty card. + description: | + The alphanumeric identifier of the loyalty card. example: summer-loyalty-card-0543 - maxLength: 255 + maxLength: 108 type: string customerSessionId: description: ID of the customer session where the transaction occurred. @@ -12149,9 +14632,9 @@ components: type: string type: description: | - Type of transaction. Possible values are: - - `addition`: Points were added. - - `subtraction`: Points were subtracted. + Type of transaction. Possible values: + - `addition`: Signifies added points. + - `subtraction`: Signifies deducted points. enum: - addition - subtraction @@ -12165,9 +14648,9 @@ components: type: string startDate: description: | - Date when points become active. Possible values are: + When points become active. Possible values: - `immediate`: Points are active immediately. - - `timestamp value`: Points become active from the given date. + - a timestamp value: Points become active at a given date and time. example: 2022-01-02T15:04:05Z07:00 maxLength: 64 type: string @@ -12176,7 +14659,7 @@ components: 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 + example: 2022-08-02T15:04:05Z07:00 type: string subledgerId: description: ID of the subledger. @@ -12204,7 +14687,6 @@ components: - amount - cardIdentifier - created - - customerSessionId - expiryDate - id - name @@ -12216,7 +14698,7 @@ components: LedgerTransactionLogEntryIntegrationAPI: description: Log entry for a given loyalty card transaction. example: - expiryDate: 2022-01-02T15:04:05Z07:00 + expiryDate: 2022-08-02T15:04:05Z07:00 rulesetId: 11 amount: 10.25 created: 2000-01-23T04:56:07.000+00:00 @@ -12230,7 +14712,7 @@ components: startDate: 2022-01-02T15:04:05Z07:00 properties: created: - description: Date and time the loyalty card transaction occurred. + description: Date and time the loyalty transaction occurred. format: date-time type: string programId: @@ -12244,9 +14726,9 @@ components: type: string type: description: | - Type of transaction. Possible values are: - - `addition`: Points were added. - - `subtraction`: Points were subtracted. + Type of transaction. Possible values: + - `addition`: Signifies added points. + - `subtraction`: Signifies deducted points. enum: - addition - subtraction @@ -12260,9 +14742,9 @@ components: 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. + When points become active. Possible values: + - `immediate`: Points are immediately active. + - a timestamp value: Points become active at a given date and time. example: 2022-01-02T15:04:05Z07:00 maxLength: 64 type: string @@ -12271,7 +14753,7 @@ components: 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 + example: 2022-08-02T15:04:05Z07:00 type: string subledgerId: description: ID of the subledger. @@ -12298,7 +14780,6 @@ components: required: - amount - created - - customerSessionId - expiryDate - id - name @@ -12307,22 +14788,162 @@ components: - subledgerId - type type: object + LoyaltyProgramTransaction: + example: + rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + type: addition + userId: 5 + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-01-02T15:04:05Z07:00 + importId: 4 + customerProfileId: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + subledgerId: sub-123 + name: Reward 50 points for each $500 purchase + ruleName: 10 points for every $100 spent + userEmail: john.doe@example.com + id: 123 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + properties: + id: + description: ID of the loyalty ledger transaction. + example: 123 + type: integer + programId: + description: ID of the loyalty program. + example: 324 + type: integer + created: + description: Date and time the loyalty transaction occurred. + format: date-time + type: string + type: + description: | + Type of transaction. Possible values: + - `addition`: Signifies added points. + - `subtraction`: Signifies deducted points. + enum: + - addition + - subtraction + example: addition + maxLength: 255 + type: string + amount: + description: Amount of loyalty points added or deducted in the transaction. + example: 10.25 + type: number + name: + description: Name or reason for the loyalty ledger transaction. + example: Reward 50 points for each $500 purchase + maxLength: 255 + type: string + startDate: + description: | + When points become active. Possible values: + - `immediate`: Points are immediately active. + - a timestamp value: Points become active at a given date and time. + example: 2022-01-02T15:04:05Z07:00 + maxLength: 64 + type: string + expiryDate: + description: | + When points expire. Possible values: + - `unlimited`: Points have no expiration date. + - a timestamp value: Points expire at a given date and time. + example: 2022-01-02T15:04:05Z07:00 + type: string + customerProfileId: + description: Customer profile integration ID used in the loyalty program. + example: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + maxLength: 255 + type: string + cardIdentifier: + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + type: string + subledgerId: + description: ID of the subledger. + example: sub-123 + maxLength: 64 + type: string + customerSessionId: + description: ID of the customer session where the transaction occurred. + example: 05c2da0d-48fa-4aa1-b629-898f58f1584d + maxLength: 255 + type: string + importId: + description: ID of the import where the transaction occurred. + example: 4 + type: integer + userId: + description: ID of the user who manually added or deducted points. Applies + only for manual transactions. + example: 5 + type: integer + userEmail: + description: The email of the user who manually added or deducted points. + Applies only for manual transactions. + example: john.doe@example.com + type: string + rulesetId: + description: ID of the ruleset containing the rule that triggered the effect. + Applies only for transactions that resulted from a customer session. + example: 11 + type: integer + ruleName: + description: Name of the rule that triggered the effect. Applies only for + transactions that resulted from a customer session. + example: 10 points for every $100 spent + type: string + required: + - amount + - created + - expiryDate + - id + - name + - programId + - startDate + - subledgerId + - type + type: object + TransferLoyaltyCard: + example: + newCardIdentifier: summer-loyalty-card-0543 + properties: + newCardIdentifier: + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + type: string + required: + - newCardIdentifier + type: object UpdateLoyaltyCard: + example: + status: active properties: status: description: | - Status of the loyalty card. Can be one of: ['active', 'disabled'] + Status of the loyalty card. Can be one of: ['active', 'inactive'] + example: active type: string required: - status type: object LoyaltyCardProfileRegistration: example: - integrationId: integrationId + integrationId: R195412 timestamp: 2021-09-12T10:12:42Z properties: integrationId: - description: Integration ID of the customer associated with the card. + description: Integration ID of the customer profile linked to the card. + example: R195412 maxLength: 1000 type: string timestamp: @@ -12335,10 +14956,12 @@ components: - timestamp type: object LoyaltyCardRegistration: + example: + integrationId: R195412 properties: integrationId: description: The integrationId of the customer profile. - example: my_customer_profile + example: R195412 title: Customer Profile Id type: string required: @@ -12349,7 +14972,7 @@ components: properties: currentBalance: description: Sum of currently active points. - example: 46.0 + example: 100.0 title: Current balance type: number pendingBalance: @@ -12358,21 +14981,32 @@ components: title: Pending balance type: number expiredBalance: - description: Sum of expired points. - example: 30.0 + description: | + **DEPRECATED** Value is shown as 0. + example: 0.0 title: Expired balance type: number spentBalance: - description: Sum of spent points. - example: 84.0 + description: | + **DEPRECATED** Value is shown as 0. + example: 0.0 title: Spent balance type: number tentativeCurrentBalance: - description: Sum of currently active points, including points added and - deducted in open sessions. - example: 56.0 + description: Sum of the tentative active points (including additions and + deductions) inside the currently open session. The `currentBalance` is + updated to this value when you close the session, and the effects are + applied. + example: 100.0 title: Tentative current balance type: number + tentativePendingBalance: + description: Sum of pending points (including additions and deductions) + inside the currently open session. The `pendingBalance` is updated to + this value when you close the session, and the effects are applied. + example: 20.0 + title: Tentative pending balance + type: number required: - currentBalance - expiredBalance @@ -12380,82 +15014,6 @@ components: - spentBalance - tentativeCurrentBalance type: object - LoyaltyProjection: - description: Group of all loyalty points expected in the future. - example: - 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: - projections: - items: - $ref: '#/components/schemas/LoyaltyProjectionData' - maxItems: 31 - type: array - 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: @@ -12490,12 +15048,28 @@ components: properties: {} type: object type: object + EvaluableCampaignIds: + properties: + evaluableCampaignIds: + description: | + When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. + + These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + example: + - 10 + - 12 + items: + type: integer + title: Campaigns to evaluate + type: array + type: object CustomerProfile: description: "" example: accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -12515,13 +15089,12 @@ components: id: 2 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. The exact moment - this entity was created. + description: The time this entity was created. The time this entity was + created. format: date-time type: string integrationId: @@ -12549,7 +15122,12 @@ components: title: Closed sessions type: integer totalSales: - description: Sum of all purchases made by this customer. + description: | + The total amount of money spent by the customer **before** discounts are applied. + + The total sales amount excludes the following: + - Cancelled or reopened sessions. + - Returned items. example: 299.99 title: Total Sales type: number @@ -12561,7 +15139,7 @@ components: title: Loyalty programed joined type: array audienceMemberships: - description: A list of audiences the customer belongs to. + description: The audiences the customer belongs to. items: $ref: '#/components/schemas/AudienceMembership' title: Audience memberships @@ -12572,11 +15150,18 @@ components: 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 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 type: string + sandbox: + description: | + Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). + example: false + title: Sandbox + type: boolean required: - accountId - attributes @@ -12598,16 +15183,18 @@ components: profileRedemptionCount: 5 usageCounter: 10 batchId: 32535-43255 - discountCounter: 0.8008281904610115 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 state: active value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -12619,7 +15206,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 6.027456183070403 + discountRemainder: 5.0 + isReservationMandatory: false - recipientIntegrationId: URNGV8294NV created: 2020-06-10T09:05:27.993483Z campaignId: 211 @@ -12628,16 +15216,18 @@ components: profileRedemptionCount: 5 usageCounter: 10 batchId: 32535-43255 - discountCounter: 0.8008281904610115 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 1 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 state: active value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -12649,7 +15239,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 6.027456183070403 + discountRemainder: 5.0 + isReservationMandatory: false referrals: - code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -12659,9 +15250,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 5 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web referredCustomers: - referredCustomers - referredCustomers @@ -12675,9 +15267,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 5 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web referredCustomers: - referredCustomers - referredCustomers @@ -12687,6 +15280,7 @@ components: accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -12708,234 +15302,100 @@ components: cards: - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active programs: key: ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 subLedgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 @@ -12943,20 +15403,24 @@ components: id: 5 title: My loyalty program giveaways: - - code: code - importId: 5 + - profileIntegrationId: R195412 + code: GIVEAWAY1 + importId: 4 endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z - poolId: 4 + profileId: 1 + poolId: 1 attributes: '{}' id: 6 used: true startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - importId: 5 + - profileIntegrationId: R195412 + code: GIVEAWAY1 + importId: 4 endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z - poolId: 4 + profileId: 1 + poolId: 1 attributes: '{}' id: 6 used: true @@ -12993,11 +15457,13 @@ components: type: string coupon: description: Any coupon code entered. + example: XMAS-2021 maxLength: 100 title: Coupon entered in session type: string referral: description: Any referral code entered. + example: 2740-tbjua-6720 maxLength: 100 title: Referral code entered in session type: string @@ -13011,12 +15477,13 @@ components: 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` - For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). enum: - open - closed - partially_returned - cancelled + example: open title: Customer's session state type: string cartItems: @@ -13030,12 +15497,13 @@ 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. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). + 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: type: string maxItems: 5 + title: Session identifiers type: array total: description: The total sum of the cart in one session. @@ -13048,7 +15516,7 @@ components: type: object type: object NewCustomerSessionV2: - description: "" + description: The representation of the customer session. example: couponCodes: - XMAS-20-2021 @@ -13060,6 +15528,9 @@ components: profileId: URNGV8294NV identifiers: - 91.11.156.141 + evaluableCampaignIds: + - 10 + - 12 referralCode: NT2K54D9 attributes: ShippingCity: Berlin @@ -13111,6 +15582,18 @@ components: **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string + evaluableCampaignIds: + description: | + When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. + + These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + example: + - 10 + - 12 + items: + type: integer + title: Campaigns to evaluate + type: array couponCodes: description: | Any coupon codes entered. @@ -13152,9 +15635,10 @@ components: 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)) + - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` - For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). enum: - open - closed @@ -13179,7 +15663,7 @@ components: 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/). + 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 @@ -13190,15 +15674,18 @@ 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/). + 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. + **Important**: Ensure the session contains an identifier by the time you close it if: + - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign. + - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). example: - 91.11.156.141 items: type: string maxItems: 5 + title: Session identifiers type: array attributes: description: | @@ -13276,7 +15763,7 @@ components: maxLength: 1000 type: string created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-02-07T08:15:22Z format: date-time type: string @@ -13331,13 +15818,13 @@ components: CustomerSession: description: "" example: - coupon: coupon + coupon: XMAS-2021 created: 2020-02-07T08:15:22Z identifiers: - 91.11.156.141 integrationId: integrationId total: 0.8008281904610115 - referral: referral + referral: 2740-tbjua-6720 discounts: key: 6.027456183070403 profileId: URNGV8294NV @@ -13392,7 +15879,7 @@ components: maxLength: 1000 type: string created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-02-07T08:15:22Z format: date-time type: string @@ -13409,11 +15896,13 @@ components: type: string coupon: description: Any coupon code entered. + example: XMAS-2021 maxLength: 100 title: Coupon entered in session type: string referral: description: Any referral code entered. + example: 2740-tbjua-6720 maxLength: 100 title: Referral code entered in session type: string @@ -13427,12 +15916,13 @@ components: 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` - For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). enum: - open - closed - partially_returned - cancelled + example: open title: Customer's session state type: string cartItems: @@ -13446,12 +15936,13 @@ 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. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). + 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: type: string maxItems: 5 + title: Session identifiers type: array total: description: The total sum of the cart in one session. @@ -13513,6 +16004,9 @@ components: price: 9 additionalCostTotal: 20.0 profileId: URNGV8294NV + evaluableCampaignIds: + - 10 + - 12 referralCode: NT2K54D9 attributes: ShippingCity: Berlin @@ -13563,13 +16057,12 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. The exact moment - this entity was created. + description: The time this entity was created. The time this entity was + created. format: date-time type: string integrationId: @@ -13589,6 +16082,18 @@ components: **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string + evaluableCampaignIds: + description: | + When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. + + These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + example: + - 10 + - 12 + items: + type: integer + title: Campaigns to evaluate + type: array couponCodes: description: | Any coupon codes entered. @@ -13630,9 +16135,10 @@ components: 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)) + - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` - For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). enum: - open - closed @@ -13657,7 +16163,7 @@ components: 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/). + 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 @@ -13668,15 +16174,18 @@ 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/). + 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. + **Important**: Ensure the session contains an identifier by the time you close it if: + - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) + for your campaign. + - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). example: - 91.11.156.141 items: type: string maxItems: 5 + title: Session identifiers type: array attributes: description: | @@ -13756,7 +16265,6 @@ components: name: description: Name of item. example: Air Glide - minLength: 1 title: Name of item type: string sku: @@ -13767,7 +16275,7 @@ components: type: string quantity: description: | - Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items), + Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening), 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 @@ -13787,7 +16295,7 @@ components: type: integer price: 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. + 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 @@ -13833,7 +16341,7 @@ components: $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/). + 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 @@ -13843,8 +16351,6 @@ components: title: The catalog item ID type: integer required: - - name - - price - quantity - sku type: object @@ -13871,7 +16377,7 @@ components: type: description: A string representing the event. Must not be a reserved event name. - example: pageViews + example: pageViewed minLength: 1 title: Event Type type: string @@ -13892,7 +16398,7 @@ components: attributes: myAttribute: myValue sessionId: 175KJPS947296 - type: pageViews + type: pageViewed properties: profileId: description: | @@ -13904,7 +16410,7 @@ components: type: description: A string representing the event. Must not be a reserved event name. - example: pageViews + example: pageViewed minLength: 1 title: Event Type type: string @@ -13970,15 +16476,14 @@ components: id: 6 sessionId: 175KJPS947296 applicationId: 322 - type: pageViews + type: pageViewed 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -13996,7 +16501,7 @@ components: type: description: A string representing the event. Must not be a reserved event name. - example: pageViews + example: pageViewed minLength: 1 title: Event Type type: string @@ -14015,7 +16520,7 @@ components: description: | 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). + You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). items: properties: {} type: object @@ -14048,15 +16553,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -14068,15 +16575,16 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false session: - coupon: coupon + coupon: XMAS-2021 created: 2020-02-07T08:15:22Z identifiers: - 91.11.156.141 integrationId: integrationId total: 0.8008281904610115 - referral: referral + referral: 2740-tbjua-6720 discounts: key: 6.027456183070403 profileId: URNGV8294NV @@ -14128,6 +16636,7 @@ components: accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -14149,234 +16658,100 @@ components: cards: - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active programs: key: ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 subLedgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 @@ -14427,7 +16802,7 @@ components: id: 6 sessionId: 175KJPS947296 applicationId: 322 - type: pageViews + type: pageViewed properties: session: $ref: '#/components/schemas/CustomerSession' @@ -14446,12 +16821,13 @@ components: type: object IntegrationStateV2: description: | - Contains all entities that might interest Talon.One integrations. This is the response type returned by the V2 PUT customer_session endpoint + Contains all entities that might interest Talon.One integrations. example: customerProfile: accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -14473,234 +16849,100 @@ components: cards: - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active - ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 - identifier: identifier + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z profiles: - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z - - integrationId: integrationId + - integrationId: R195412 timestamp: 2021-09-12T10:12:42Z subledgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 modified: 2021-09-12T10:12:42Z id: 6 + newCardIdentifier: summer-loyalty-card-0543 programID: 125 - status: status + status: active programs: key: ledger: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 subLedgers: key: pendingBalance: 10.0 - currentBalance: 46.0 - spentBalance: 84.0 - tentativeCurrentBalance: 56.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.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 + expiredBalance: 0.0 currentTier: name: bronze id: 11 @@ -14708,20 +16950,24 @@ components: id: 5 title: My loyalty program awardedGiveaways: - - code: code - importId: 5 + - profileIntegrationId: R195412 + code: GIVEAWAY1 + importId: 4 endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z - poolId: 4 + profileId: 1 + poolId: 1 attributes: '{}' id: 6 used: true startDate: 2000-01-23T04:56:07.000+00:00 - - code: code - importId: 5 + - profileIntegrationId: R195412 + code: GIVEAWAY1 + importId: 4 endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z - poolId: 4 + profileId: 1 + poolId: 1 attributes: '{}' id: 6 used: true @@ -14734,15 +16980,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -14754,7 +17002,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false - recipientIntegrationId: URNGV8294NV created: 2020-06-10T09:05:27.993483Z campaignId: 211 @@ -14762,15 +17011,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -14782,7 +17033,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false createdReferrals: - code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -14792,9 +17044,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web id: 6 startDate: 2020-11-10T23:00:00Z - code: 27G47Y54VH9L @@ -14805,9 +17058,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web id: 6 startDate: 2020-11-10T23:00:00Z effects: @@ -14836,9 +17090,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 5 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web referredCustomers: - referredCustomers - referredCustomers @@ -14863,10 +17118,39 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" startTime: 2021-07-20T22:00:00Z - id: 3 + id: 4 state: enabled limits: - period: yearly @@ -14879,12 +17163,13 @@ components: - Coupon limit: 1000.0 action: createCoupon - activeRulesetId: 4 + activeRulesetId: 6 + reservecouponEffectCount: 9 updatedBy: Jane Doe - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 couponRedemptionCount: 163 - userId: 2 + userId: 388 couponCreationCount: 16 campaignGroups: - 1 @@ -14906,8 +17191,37 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z @@ -14932,10 +17246,39 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" startTime: 2021-07-20T22:00:00Z - id: 3 + id: 4 state: enabled limits: - period: yearly @@ -14948,12 +17291,13 @@ components: - Coupon limit: 1000.0 action: createCoupon - activeRulesetId: 4 + activeRulesetId: 6 + reservecouponEffectCount: 9 updatedBy: Jane Doe - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 couponRedemptionCount: 163 - userId: 2 + userId: 388 couponCreationCount: 16 campaignGroups: - 1 @@ -14975,8 +17319,37 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z @@ -14989,17 +17362,20 @@ components: campaignId: 211 usageLimit: 100 referralId: 326632952 + profileRedemptionCount: 5 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -15011,23 +17387,27 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false - recipientIntegrationId: URNGV8294NV created: 2020-06-10T09:05:27.993483Z campaignId: 211 usageLimit: 100 referralId: 326632952 + profileRedemptionCount: 5 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -15039,7 +17419,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false customerSession: couponCodes: - XMAS-20-2021 @@ -15055,6 +17436,9 @@ components: price: 9 additionalCostTotal: 20.0 profileId: URNGV8294NV + evaluableCampaignIds: + - 10 + - 12 referralCode: NT2K54D9 attributes: ShippingCity: Berlin @@ -15178,27 +17562,27 @@ components: id: 6 sessionId: 175KJPS947296 applicationId: 322 - type: pageViews + type: pageViewed ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue @@ -15233,13 +17617,15 @@ components: $ref: '#/components/schemas/InventoryReferral' coupons: items: - $ref: '#/components/schemas/Coupon' + $ref: '#/components/schemas/IntegrationCoupon' type: array triggeredCampaigns: items: $ref: '#/components/schemas/Campaign' type: array effects: + description: The effects generated by the rules in your running campaigns. + See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). items: $ref: '#/components/schemas/Effect' type: array @@ -15263,13 +17649,76 @@ components: $ref: '#/components/schemas/Return' previousReturns: items: - $ref: '#/components/schemas/Return' + $ref: '#/components/schemas/Return' + type: array + required: + - createdCoupons + - createdReferrals + - effects + type: object + ReopenSessionResponse: + description: | + This is the response type returned by the Reopen customer sessions endpoint. It contains the rolled back effects. + 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: '{}' + properties: + effects: + description: The effects generated by the rules in your running campaigns. + See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + items: + $ref: '#/components/schemas/Effect' type: array required: - - createdCoupons - - createdReferrals - effects type: object + CustomerProfileUpdateV2Response: + description: | + Contains the updated customer profiles entities. This is the response type returned by the V2 PUT customer_profiles endpoint + example: + customerProfile: + accountId: 31 + closedSessions: 3 + created: 2000-01-23T04:56:07.000+00:00 + sandbox: false + 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 + properties: + customerProfile: + $ref: '#/components/schemas/CustomerProfile' + required: + - customerProfile + type: object IntegrationCustomerSessionResponse: example: effects: @@ -15304,6 +17753,9 @@ components: price: 9 additionalCostTotal: 20.0 profileId: URNGV8294NV + evaluableCampaignIds: + - 10 + - 12 referralCode: NT2K54D9 attributes: ShippingCity: Berlin @@ -15363,16 +17815,17 @@ components: ApplicationCustomer: description: "" example: - accountId: 1 + accountId: 6 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: integrationId attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 6 + id: 0 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 @@ -15386,15 +17839,11 @@ components: id: 2 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. - 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. + description: Internal ID of this entity. Internal ID of this entity. type: integer created: - description: 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. + description: The time this entity was created. The time this entity was + created. The time this entity was created. The time this entity was created. format: date-time type: string integrationId: @@ -15421,7 +17870,12 @@ components: title: Closed sessions type: integer totalSales: - description: Sum of all purchases made by this customer. + description: | + The total amount of money spent by the customer **before** discounts are applied. + + The total sales amount excludes the following: + - Cancelled or reopened sessions. + - Returned items. example: 299.99 title: Total Sales type: number @@ -15433,7 +17887,7 @@ components: title: Loyalty programed joined type: array audienceMemberships: - description: A list of audiences the customer belongs to. + description: The audiences the customer belongs to. items: $ref: '#/components/schemas/AudienceMembership' title: Audience memberships @@ -15444,11 +17898,18 @@ components: 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 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 type: string + sandbox: + description: | + Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). + example: false + title: Sandbox + type: boolean advocateIntegrationId: description: The Integration ID of the Customer Profile that referred this Customer in the Application. @@ -15464,6 +17925,113 @@ components: - lastActivity - totalSales type: object + AudienceCustomer: + description: "" + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time this entity was created. The time this entity was + created. + format: date-time + type: string + integrationId: + 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. + example: + Language: english + ShippingCountry: DE + properties: {} + 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: + description: The total amount of closed sessions by a customer. A closed + session is a successful purchase. + example: 3 + title: Closed sessions + type: integer + totalSales: + description: | + The total amount of money spent by the customer **before** discounts are applied. + + The total sales amount excludes the following: + - Cancelled or reopened sessions. + - Returned items. + example: 299.99 + title: Total Sales + type: number + loyaltyMemberships: + description: | + **DEPRECATED** A list of loyalty programs joined by the customer. + items: + $ref: '#/components/schemas/LoyaltyMembership' + title: Loyalty programed joined + type: array + audienceMemberships: + description: The 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. + 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 + type: string + sandbox: + description: | + Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). + example: false + title: Sandbox + type: boolean + connectedApplicationsIds: + description: A list of the IDs of the Applications that are connected to + this customer profile. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + connectedAudiences: + description: A list of the IDs of the audiences that are connected to this + customer profile. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + required: + - accountId + - attributes + - closedSessions + - created + - id + - integrationId + - lastActivity + - totalSales + type: object ApplicationReferee: description: "" example: @@ -15565,13 +18133,12 @@ components: height: 0.8008281904610115 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. The exact moment - this entity was created. + description: The time this entity was created. The time this entity was + created. format: date-time type: string applicationId: @@ -15611,7 +18178,7 @@ components: 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` - For more information, see [Customer session states](/docs/dev/concepts/entities#customer-session). + For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). enum: - open - closed @@ -15661,8 +18228,22 @@ components: description: "" 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: '{}' created: 2020-06-10T09:05:27.993483Z profileId: 138 attributes: '{}' @@ -15671,25 +18252,25 @@ components: applicationId: 322 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue @@ -15697,12 +18278,11 @@ components: couponValue: couponValue 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -15731,8 +18311,7 @@ components: description: An array containing the effects that were applied as a result of this event. items: - properties: {} - type: object + $ref: '#/components/schemas/Effect' type: array ruleFailureReasons: description: An array containing the rule failure reasons which happened @@ -15981,17 +18560,16 @@ components: userLimit: 6 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -16109,9 +18687,11 @@ components: properties: name: description: The user name. + example: John Doe type: string policy: - description: ACL Json. + description: The `Access Control List` json defining the role of the user. + This represents the access control on the user level. example: "" type: string state: @@ -16138,9 +18718,11 @@ components: properties: password: description: Your old password. + example: Admin&12943!7 type: string newPassword: description: Your new password. + example: Admin*4552$70 type: string required: - newPassword @@ -16172,13 +18754,15 @@ components: type: object NewPassword: example: - password: password - resetToken: resetToken + password: Admin&12943!7 + resetToken: Z2VgacVNkexLKBUIzsRDDZSGxnIkC53y properties: password: description: The new password for your account. + example: Admin&12943!7 type: string resetToken: + example: Z2VgacVNkexLKBUIzsRDDZSGxnIkC53y minLength: 1 type: string required: @@ -16189,12 +18773,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -16297,6 +18880,7 @@ components: - boolean - number - time + - (list string) minLength: 1 type: string description: @@ -16309,11 +18893,6 @@ components: type: object TemplateArgDef: description: "" - example: - ui: '{}' - description: description - type: string - title: title properties: type: description: The type of value this argument expects. @@ -16322,6 +18901,7 @@ components: - boolean - number - time + - (list string) minLength: 1 type: string description: @@ -16338,6 +18918,13 @@ components: this argument. properties: {} type: object + picklistID: + description: ID of the picklist linked to a template. + type: integer + restrictedByPicklist: + description: Whether or not this attribute's value is restricted by picklist + (`picklist` property) + type: boolean required: - description - title @@ -16370,9 +18957,15 @@ components: - type type: object CampaignTemplateParams: + example: + attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number properties: name: description: Name of the campaign template parameter. + example: discount_value minLength: 1 type: string type: @@ -16384,10 +18977,12 @@ components: - percent - (list string) - time + example: number 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. + example: This is a template parameter of type `number`. type: string attributeId: description: ID of the corresponding attribute. @@ -16414,12 +19009,12 @@ components: to create a new campaign. type: string campaignAttributes: - description: The Campaign Attributes that Campaigns created from this template + description: The campaign attributes that campaigns created from this template will have by default. properties: {} type: object couponAttributes: - description: The Campaign Attributes that Coupons created from this template + description: The campaign attributes that coupons created from this template will have by default. properties: {} type: object @@ -16447,6 +19042,7 @@ components: - referrals - loyalty - giveaways + - strikethrough type: string type: array couponSettings: @@ -16459,8 +19055,7 @@ components: $ref: '#/components/schemas/TemplateLimitConfig' type: array templateParams: - description: Template parameters are fields which can be used to replace - values in a rule. + description: Fields which can be used to replace values in a rule. items: $ref: '#/components/schemas/CampaignTemplateParams' type: array @@ -16471,7 +19066,7 @@ components: $ref: '#/components/schemas/CampaignTemplateCollection' type: array defaultCampaignGroupId: - description: The default campaignGroupId. + description: The default campaign group ID. example: 42 type: integer required: @@ -16484,40 +19079,47 @@ components: properties: name: description: The campaign template name. + example: Discount campaign minLength: 1 type: string description: description: Customer-facing text that explains the objective of the template. + example: This is a template for a discount campaign. type: string instructions: description: Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. + example: Use this template for discount campaigns. Set the campaign properties + according to the campaign goals, and don't forget to set an end date. type: string campaignAttributes: - description: The Campaign Attributes that Campaigns created from this template + description: The campaign attributes that campaigns created from this template will have by default. properties: {} type: object couponAttributes: - description: The Campaign Attributes that Coupons created from this template + description: The campaign attributes that coupons created from this template will have by default. properties: {} type: object state: - description: Only Campaign Templates in 'available' state may be used to - create Campaigns. + description: Only campaign templates in 'available' state may be used to + create campaigns. enum: - draft - enabled - disabled type: string activeRulesetId: - description: The ID of the Ruleset this Campaign Template will use. + description: The ID of the ruleset this campaign template will use. + example: 5 type: integer tags: description: A list of tags for the campaign template. + example: + - discount items: maxLength: 50 minLength: 1 @@ -16532,6 +19134,7 @@ components: - referrals - loyalty - giveaways + - strikethrough type: string type: array couponSettings: @@ -16539,19 +19142,22 @@ 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 operate for this campaign template. items: $ref: '#/components/schemas/TemplateLimitConfig' type: array templateParams: - description: Template parameters are fields which can be used to replace - values in a rule. + description: Fields which can be used to replace values in a rule. items: $ref: '#/components/schemas/CampaignTemplateParams' type: array applicationsIds: - description: A list of the IDs of the applications that are subscribed to - this campaign template. + description: A list of IDs of the Applications that are subscribed to this + campaign template. + example: + - 1 + - 2 + - 3 items: type: integer type: array @@ -16562,7 +19168,7 @@ components: $ref: '#/components/schemas/CampaignTemplateCollection' type: array defaultCampaignGroupId: - description: The default campaignGroupId. + description: The default campaign group ID. example: 42 type: integer required: @@ -16573,6 +19179,9 @@ components: - state type: object CampaignTemplateCollection: + example: + name: My collection + description: My collection of SKUs properties: name: description: The name of this collection. @@ -16589,14 +19198,144 @@ components: type: object CampaignTemplate: description: "" + example: + activeRulesetId: 5 + instructions: Use this template for discount campaigns. Set the campaign properties + according to the campaign goals, and don't forget to set an end date. + campaignAttributes: '{}' + applicationsIds: + - 0 + - 0 + updatedBy: Jane Doe + campaignCollections: + - name: My collection + description: My collection of SKUs + - name: My collection + description: My collection of SKUs + created: 2020-06-10T09:05:27.993483Z + defaultCampaignGroupId: 42 + description: This is a template for a discount campaign. + userId: 388 + tags: + - discount + accountId: 3886 + features: + - coupons + - coupons + validApplicationIds: + - 1 + - 2 + - 3 + name: Discount campaign + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + templateParams: + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + id: 6 + couponAttributes: '{}' + state: draft + updated: 2022-08-24T14:15:22Z + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -16605,44 +19344,52 @@ components: example: 3886 type: integer userId: - description: The ID of the account that owns this entity. + description: The ID of the user associated with this entity. + example: 388 type: integer name: description: The campaign template name. + example: Discount campaign minLength: 1 type: string description: description: Customer-facing text that explains the objective of the template. + example: This is a template for a discount campaign. type: string instructions: description: Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. + example: Use this template for discount campaigns. Set the campaign properties + according to the campaign goals, and don't forget to set an end date. type: string campaignAttributes: - description: The Campaign Attributes that Campaigns created from this template + description: The campaign attributes that campaigns created from this template will have by default. properties: {} type: object couponAttributes: - description: The Campaign Attributes that Coupons created from this template + description: The campaign attributes that coupons created from this template will have by default. properties: {} type: object state: - description: Only Campaign Templates in 'available' state may be used to - create Campaigns. + description: Only campaign templates in 'available' state may be used to + create campaigns. enum: - draft - enabled - disabled type: string activeRulesetId: - description: The ID of the Ruleset this Campaign Template will use. + description: The ID of the ruleset this campaign template will use. + example: 5 type: integer tags: description: A list of tags for the campaign template. + example: + - discount items: maxLength: 50 minLength: 1 @@ -16657,6 +19404,7 @@ components: - referrals - loyalty - giveaways + - strikethrough type: string type: array couponSettings: @@ -16664,20 +19412,18 @@ 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 operate for this campaign template. items: $ref: '#/components/schemas/TemplateLimitConfig' type: array templateParams: - description: Template parameters are fields which can be used to replace - values in a rule. + description: Fields which can be used to replace values in a rule. items: $ref: '#/components/schemas/CampaignTemplateParams' 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. + description: A list of IDs of the Applications that are subscribed to this + campaign template. items: description: "" type: integer @@ -16689,20 +19435,26 @@ components: $ref: '#/components/schemas/CampaignTemplateCollection' type: array defaultCampaignGroupId: - description: The default campaignGroupId. + description: The default campaign group ID. example: 42 type: integer updated: description: Timestamp of the most recent update to the campaign template or any of its elements. + example: 2022-08-24T14:15:22Z format: date-time type: string updatedBy: - description: Name of the user who last updated this campaign template if + description: Name of the user who last updated this campaign template, if available. + example: Jane Doe type: string validApplicationIds: - description: The IDs of the applications that are related to this entity. + description: The IDs of the Applications that are related to this entity. + example: + - 1 + - 2 + - 3 items: type: integer type: array @@ -16789,7 +19541,7 @@ components: type: array campaignGroups: description: | - The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. example: - 1 - 3 @@ -16885,7 +19637,9 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - condition: - and - - couponValid @@ -16915,10 +19669,77 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 id: 6 + strikethroughRules: + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 templateId: 3 - userId: 6 + userId: 388 campaign: callApiEffectCount: 0 createdLoyaltyPointsEffectCount: 2 @@ -16938,10 +19759,39 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" startTime: 2021-07-20T22:00:00Z - id: 3 + id: 4 state: enabled limits: - period: yearly @@ -16954,12 +19804,13 @@ components: - Coupon limit: 1000.0 action: createCoupon - activeRulesetId: 4 + activeRulesetId: 6 + reservecouponEffectCount: 9 updatedBy: Jane Doe - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 couponRedemptionCount: 163 - userId: 2 + userId: 388 couponCreationCount: 16 campaignGroups: - 1 @@ -16981,8 +19832,37 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z @@ -17046,12 +19926,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -17112,18 +19991,19 @@ components: example: editable: true subscribedApplicationsIds: - - 0 - - 0 - description: description + - 1 + - 4 + - 9 + description: Event triggered when a customer displays a page. restrictedBySuggestions: false - eventType: eventType - title: title + eventType: pageViewed + title: Page view event type: string hasAllowedList: false allowedSubscriptions: - application - - application - name: name + - catalog + name: pageViewed suggestions: - suggestions - suggestions @@ -17131,9 +20011,9 @@ components: - suggestions - suggestions subscribedCatalogsIds: - - 6 - - 6 - entity: Account + - 2 + - 5 + entity: Event properties: entity: description: The name of the entity that can have this attribute. When creating @@ -17151,19 +20031,23 @@ components: - Event - Giveaway - Referral + example: Event type: string eventType: + example: pageViewed type: string name: 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. + example: pageViewed 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. + example: Page view event pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string type: @@ -17180,9 +20064,11 @@ components: - (list time) - location - (list location) + example: string type: string description: description: A description of this attribute. + example: Event triggered when a customer displays a page. type: string suggestions: description: A list of suggestions for the attribute. @@ -17195,24 +20081,34 @@ components: default: false description: Whether or not this attribute has an allowed list of values associated with it. + example: false 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). + example: false type: boolean editable: description: Whether or not this attribute can be edited. + example: true type: boolean subscribedApplicationsIds: description: A list of the IDs of the applications where this attribute is available. + example: + - 1 + - 4 + - 9 items: type: integer type: array subscribedCatalogsIds: description: A list of the IDs of the catalogs where this attribute is available. + example: + - 2 + - 5 items: type: integer type: array @@ -17221,6 +20117,9 @@ components: A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. + example: + - application + - catalog items: enum: - application @@ -17243,20 +20142,21 @@ components: created: 2020-06-10T09:05:27.993483Z editable: true subscribedApplicationsIds: - - 6 - - 6 - description: description + - 1 + - 4 + - 9 + description: Event triggered when a customer displays a page. restrictedBySuggestions: false - eventType: eventType - title: title + eventType: pageViewed + title: Page view event type: string accountId: 3886 eventTypeId: 22 hasAllowedList: false allowedSubscriptions: - application - - application - name: name + - catalog + name: pageViewed suggestions: - suggestions - suggestions @@ -17265,17 +20165,16 @@ components: - suggestions id: 6 subscribedCatalogsIds: - - 1 - - 1 - entity: Account + - 2 + - 5 + entity: Event 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -17299,19 +20198,23 @@ components: - Event - Giveaway - Referral + example: Event type: string eventType: + example: pageViewed type: string name: 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. + example: pageViewed 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. + example: Page view event pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string type: @@ -17328,9 +20231,11 @@ components: - (list time) - location - (list location) + example: string type: string description: description: A description of this attribute. + example: Event triggered when a customer displays a page. type: string suggestions: description: A list of suggestions for the attribute. @@ -17343,24 +20248,34 @@ components: default: false description: Whether or not this attribute has an allowed list of values associated with it. + example: false 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). + example: false type: boolean editable: description: Whether or not this attribute can be edited. + example: true type: boolean subscribedApplicationsIds: description: A list of the IDs of the applications where this attribute is available. + example: + - 1 + - 4 + - 9 items: type: integer type: array subscribedCatalogsIds: description: A list of the IDs of the catalogs where this attribute is available. + example: + - 2 + - 5 items: type: integer type: array @@ -17369,6 +20284,9 @@ components: A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. + example: + - application + - catalog items: enum: - application @@ -17394,47 +20312,51 @@ components: NewAdditionalCost: description: "" example: - name: name + name: shippingFee subscribedApplicationsIds: - - 0 - - 0 - description: description - title: title + - 3 + - 13 + description: A shipping fee + title: Shipping fee 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. + description: The internal name used in API requests. + example: shippingFee 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. + example: Shipping fee pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string description: description: A description of this additional cost. + example: A shipping fee type: string subscribedApplicationsIds: description: A list of the IDs of the applications that are subscribed to this additional cost. + example: + - 3 + - 13 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, + The type of additional cost. Possible value: + - `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 + example: session type: string required: - description @@ -17446,22 +20368,21 @@ components: example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z - name: name + name: shippingFee subscribedApplicationsIds: - - 6 - - 6 - description: description + - 3 + - 13 + description: A shipping fee id: 6 - title: title + title: Shipping fee type: session 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -17470,38 +20391,42 @@ components: example: 3886 type: integer 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. + description: The internal name used in API requests. + example: shippingFee 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. + example: Shipping fee pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string description: description: A description of this additional cost. + example: A shipping fee type: string subscribedApplicationsIds: description: A list of the IDs of the applications that are subscribed to this additional cost. + example: + - 3 + - 13 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, + The type of additional cost. Possible value: + - `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 + example: session type: string required: - accountId @@ -17515,21 +20440,20 @@ components: description: "" properties: title: - description: The human-friendly display name for this event type. Use a - short, past-tense, description of the event. + description: The human-friendly name for this event type. + example: Survey Completed minLength: 1 type: string name: - description: 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: The integration name for this event type. This will be used + in URLs and cannot be changed after an event type has been created. + example: surveyCompleted minLength: 1 type: string description: description: | - 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. + A description of what the event represents. + example: The survey was submitted by the customer. type: string required: - name @@ -17539,37 +20463,35 @@ components: description: "" example: created: 2020-06-10T09:05:27.993483Z - name: name - description: description + name: surveyCompleted + description: The survey was submitted by the customer. id: 6 - title: title + title: Survey Completed 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string title: - description: The human-friendly display name for this event type. Use a - short, past-tense, description of the event. + description: The human-friendly name for this event type. + example: Survey Completed minLength: 1 type: string name: - description: 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: The integration name for this event type. This will be used + in URLs and cannot be changed after an event type has been created. + example: surveyCompleted minLength: 1 type: string description: description: | - 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. + A description of what the event represents. + example: The survey was submitted by the customer. type: string required: - created @@ -17581,13 +20503,14 @@ components: description: "" properties: applicationIds: - description: The IDs of the applications that are related to this entity. + description: The IDs of the Applications that are related to this entity. items: type: integer minItems: 1 type: array title: - description: Friendly title for this webhook. + description: Name or title for this webhook. + example: Send message pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string verb: @@ -17598,12 +20521,17 @@ components: - GET - DELETE - PATCH + example: POST type: string url: - description: API url (supports templating using parameters) for this webhook. + description: API URL (supports templating using parameters) for this webhook. + example: www.my-company.com/my-endpoint-name type: string headers: description: List of API HTTP headers for this webhook. + example: + - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' + - '{"Content-Type": "application/json"}' items: pattern: ^([^:,]*):([^]*|[^,]*)$ type: string @@ -17611,14 +20539,17 @@ components: payload: description: API payload (supports templating using parameters) for this webhook. + example: "{\n\t\"message\": \"${message}\"\n}" type: string params: description: Array of template argument definitions. + example: [] 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 the Rule Builder. + example: true type: boolean required: - applicationIds @@ -17633,54 +20564,46 @@ components: description: "" example: headers: - - headers - - headers - payload: payload + - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' + - '{"Content-Type": "application/json"}' + payload: "{\n\t\"message\": \"${message}\"\n}" created: 2020-06-10T09:05:27.993483Z verb: POST modified: 2021-09-12T10:12:42Z id: 6 - title: title - params: - - ui: '{}' - description: description - type: string - title: title - - ui: '{}' - description: description - type: string - title: title - url: url + title: Send message + params: [] + url: www.my-company.com/my-endpoint-name enabled: true applicationIds: - - 6 - - 6 + - 0 + - 0 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time 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. - The IDs of the applications that are related to this entity. + description: The IDs of the Applications that are related to this entity. + The IDs of the Applications that are related to this entity. items: description: "" type: integer minItems: 1 type: array title: - description: Friendly title for this webhook. + description: Name or title for this webhook. + example: Send message pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string verb: @@ -17691,12 +20614,17 @@ components: - GET - DELETE - PATCH + example: POST type: string url: - description: API url (supports templating using parameters) for this webhook. + description: API URL (supports templating using parameters) for this webhook. + example: www.my-company.com/my-endpoint-name type: string headers: description: List of API HTTP headers for this webhook. + example: + - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' + - '{"Content-Type": "application/json"}' items: pattern: ^([^:,]*):([^]*|[^,]*)$ type: string @@ -17704,14 +20632,17 @@ components: payload: description: API payload (supports templating using parameters) for this webhook. + example: "{\n\t\"message\": \"${message}\"\n}" type: string params: description: Array of template argument definitions. + example: [] 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 the Rule Builder. + example: true type: boolean required: - applicationIds @@ -17778,12 +20709,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -17835,6 +20765,7 @@ components: NewAudience: description: "" example: + lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true integration: mparticle @@ -17877,6 +20808,11 @@ components: description: Determines if this audience is a 3rd party audience or not. example: false type: boolean + lastUpdate: + description: The last time that the audience memberships changed. + example: 2022-04-26T11:02:38Z + format: date-time + type: string required: - name type: object @@ -17897,6 +20833,7 @@ components: example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z + lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true integration: mparticle @@ -17910,12 +20847,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -17954,6 +20890,11 @@ components: description: Determines if this audience is a 3rd party audience or not. example: false type: boolean + lastUpdate: + description: The last time that the audience memberships changed. + example: 2022-04-26T11:02:38Z + format: date-time + type: string required: - accountId - created @@ -17986,16 +20927,15 @@ components: accountId: 3886 created: 2020-06-10T09:05:27.993483Z id: 6 - userId: 6 + userId: 388 entity: Coupon 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -18004,7 +20944,8 @@ components: example: 3886 type: integer userId: - description: The ID of the account that owns this entity. + description: The ID of the user associated with this entity. + example: 388 type: integer entity: description: The name of the entity that was exported. @@ -18037,16 +20978,15 @@ components: amount: 10 created: 2020-06-10T09:05:27.993483Z id: 6 - userId: 0 + userId: 388 entity: AttributeAllowedList 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -18055,7 +20995,8 @@ components: example: 3886 type: integer userId: - description: The ID of the account that owns this entity. + description: The ID of the user associated with this entity. + example: 388 type: integer entity: description: | @@ -18142,33 +21083,111 @@ components: - title - type type: object + TalangAttribute: + description: "" + properties: + entity: + description: The name of the entity of the attribute. + enum: + - AdvocateProfile + - Account + - Application + - AwardedGiveaway + - Bundle + - Campaign + - CartItem + - Coupon + - CustomerProfile + - CustomerSession + - Event + - Item + - Loyalty + - Profile + - Giveaway + - Referral + - Session + type: string + name: + 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. + type: string + title: + description: The name of the attribute that is displayed to the user in + the Campaign Manager. + type: string + type: + description: The talang type of the attribute. + type: string + description: + description: A description of the attribute. + type: string + visible: + default: true + description: Indicates whether the attribute is visible in the UI or not. + type: boolean + kind: + description: Indicate the kind of the attribute. + enum: + - built-in + - custom + type: string + campaignsCount: + description: The number of campaigns that refer to the attribute. + type: integer + exampleValue: + description: Examples of values that can be assigned to the attribute. + items: + type: string + type: array + required: + - campaignsCount + - kind + - name + - type + - visible + type: object + TalangAttributeVisibility: + properties: + invisible: + description: List of attribute names to hide in the UI. + items: + type: string + type: array + visible: + description: List of attribute names to show in the UI. + items: + type: string + type: array + type: object Role: description: "" example: accountId: 3886 created: 2020-06-10T09:05:27.993483Z - campaignGroupID: 6 + campaignGroupID: 3 members: - - 1 - - 1 - name: name + - 48 + - 562 + - 475 + - 18 + name: Campaign Reviewer modified: 2021-09-12T10:12:42Z - description: description + description: Reviews the campaigns id: 6 - acl: '{}' + acl: + Role: 127 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -18178,22 +21197,33 @@ components: type: integer campaignGroupID: description: | - The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups/) + The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups) this role was created for. + example: 3 type: integer name: description: Name of the role. + example: Campaign Reviewer type: string description: description: Description of the role. + example: Reviews the campaigns type: string members: description: A list of user identifiers assigned to this role. + example: + - 48 + - 562 + - 475 + - 18 items: type: integer type: array acl: - description: Role ACL Policy. + description: The `Access Control List` json defining the role of the user. + This represents the access control on the user level. + example: + Role: 127 properties: {} type: object required: @@ -18209,15 +21239,24 @@ components: properties: name: description: Name of the role. + example: Campaign Manager type: string description: description: Description of the role. + example: Manages the campaigns type: string acl: - description: Role Policy this should be a stringified blob of json. + description: The `Access Control List` json defining the role of the user. + This represents the access control on the user level. + example: "" type: string members: description: An array of user identifiers. + example: + - 48 + - 562 + - 475 + - 18 items: type: integer type: array @@ -18230,15 +21269,24 @@ components: properties: name: description: Name of the role. + example: Campaign Manager type: string description: description: Description of the role. + example: Manages the campaigns type: string acl: - description: Role Policy this should be a stringified blob of json. + description: The `Access Control List` json defining the role of the user. + This represents the access control on the user level. + example: "" type: string members: description: An array of user identifiers. + example: + - 48 + - 562 + - 475 + - 18 items: type: integer type: array @@ -18248,17 +21296,102 @@ components: properties: users: description: An array of userIDs. + example: + - 48 + - 562 + - 475 + - 18 items: type: integer type: array roles: description: An array of roleIDs. + example: + - 128 + - 147 + items: + type: integer + type: array + required: + - roles + - users + type: object + RoleV2: + properties: + name: + description: Name of the role. + example: Campaign manager + type: string + description: + description: Description of the role. + example: Manages the campaigns + type: string + isAdmin: + description: Indicates whether the role grants admin permissions. + example: true + type: boolean + permissions: + $ref: '#/components/schemas/RoleV2Permissions' + members: + description: An array of user identifiers. + example: + - 48 + - 562 + - 475 + - 18 + items: + type: integer + type: array + type: object + RoleV2Permissions: + properties: + permissionSets: + description: List of grouped operation IDs to use as a reference in the + roles section. Each group of operation IDs has a name. + items: + $ref: '#/components/schemas/RoleV2PermissionSet' + maxItems: 100 + type: array + roles: + $ref: '#/components/schemas/RoleV2Permissions_roles' + type: object + RoleV2Application: + additionalProperties: + $ref: '#/components/schemas/RoleV2ApplicationDetails' + type: object + RoleV2ApplicationDetails: + properties: + application: + description: Name of the Application-level permission set. + type: string + campaign: + description: Name of the campaign-level permission set. + type: string + draftCampaign: + description: Name of the draft campaign-level permission set. + type: string + type: object + RoleV2LoyaltyGroup: + additionalProperties: + type: string + type: object + RoleV2CampaignAccessGroup: + additionalProperties: + type: string + type: object + RoleV2PermissionSet: + properties: + name: + description: Name of the permission set. + type: string + operationIds: items: - type: integer + type: string + maxItems: 1000 type: array required: - - roles - - users + - name + - operationIds type: object RoleMembership: properties: @@ -18275,16 +21408,17 @@ components: CouponReservations: example: integrationIDs: - - ty238-32fke9 - - 3gy32-008ye9 + - URNGV8294NV + - BZGGC2454PA properties: integrationIDs: description: List of customer integration IDs. example: - - ty238-32fke9 - - 3gy32-008ye9 + - URNGV8294NV + - BZGGC2454PA items: type: string + maxItems: 1000 type: array required: - integrationIDs @@ -18304,12 +21438,11 @@ components: referenceId: 6 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -18340,7 +21473,7 @@ components: example: Customer appeasement. type: string expiryDate: - description: Expiry date of the points. + description: Expiration date of the points. example: 2022-04-26T11:02:38Z format: date-time type: string @@ -18427,7 +21560,6 @@ components: enum: - CouponNotFound - CouponPartOfNotRunningCampaign - - CouponLimitReached - CampaignLimitReached - ProfileLimitReached - CouponRecipientDoesNotMatch @@ -18435,6 +21567,9 @@ components: - CouponStartDateInFuture - CouponRejectedByCondition - EffectCouldNotBeApplied + - CouponPartOfNotTriggeredCampaign + - CouponReservationRequired + - ProfileRequired example: CouponNotFound type: string required: @@ -18468,6 +21603,8 @@ components: - ReferralStartDateInFuture - ReferralRejectedByCondition - EffectCouldNotBeApplied + - ReferralPartOfNotTriggeredCampaign + example: ReferralNotFound type: string required: - campaignId @@ -18642,6 +21779,17 @@ components: items: $ref: '#/components/schemas/Endpoint' type: array + allowedApplicationIds: + description: | + A list of Application IDs that you can access with the management key. + An empty or missing list means the management key can be used for all Applications in the account. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array required: - endpoints - expiryDate @@ -18664,6 +21812,17 @@ components: items: $ref: '#/components/schemas/Endpoint' type: array + allowedApplicationIds: + description: | + A list of Application IDs that you can access with the management key. + An empty or missing list means the management key can be used for all Applications in the account. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array id: description: ID of the management key. example: 34 @@ -18707,6 +21866,17 @@ components: items: $ref: '#/components/schemas/Endpoint' type: array + allowedApplicationIds: + description: | + A list of Application IDs that you can access with the management key. + An empty or missing list means the management key can be used for all Applications in the account. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array id: description: ID of the management key. example: 34 @@ -18775,6 +21945,7 @@ components: type: string accountId: description: The ID of the account that owns this entity. + example: 3885 type: integer name: description: ID of the SAML service. @@ -18803,12 +21974,11 @@ 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. Not to be confused with the Integration - ID, which is set by your integration layer and used in most endpoints. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -18832,6 +22002,7 @@ components: type: string accountId: description: The ID of the account that owns this entity. + example: 3885 type: integer name: description: ID of the SAML service. @@ -18892,6 +22063,7 @@ components: properties: accountId: description: The ID of the account that owns this entity. + example: 3885 type: integer name: description: ID of the SAML service. @@ -18971,7 +22143,7 @@ components: example: Give 20% discount type: string effectType: - description: The type of effect that was triggered. + description: The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). example: rejectCoupon type: string triggeredByCoupon: @@ -18985,6 +22157,7 @@ components: example: 786 type: integer props: + description: The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). type: object required: - campaignId @@ -19017,7 +22190,7 @@ components: example: Give 20% discount type: string effectType: - description: The type of effect that was triggered. + description: The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). example: rejectCoupon type: string triggeredByCoupon: @@ -19038,6 +22211,7 @@ components: - rulesetId type: object EffectProps: + description: The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). type: object AcceptCouponEffectProps: description: The properties specific to the "acceptCoupon" effect. This gets @@ -19161,7 +22335,7 @@ 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. @@ -19198,7 +22372,7 @@ components: type: number subPosition: description: | - Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. + Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. type: number desiredValue: @@ -19224,7 +22398,7 @@ components: from the same bundle definition. type: integer bundleName: - description: The name of the bundle binding. + description: The name of the bundle definition. type: string required: - name @@ -19238,7 +22412,7 @@ components: on a specific additional cost in a specific item. 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. @@ -19252,7 +22426,7 @@ components: type: number subPosition: description: | - Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. + Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. type: number additionalCost: @@ -19270,6 +22444,25 @@ components: - position - value type: object + ReserveCouponEffectProps: + description: The properties specific to the "reserveCoupon" effect. This gets + triggered whenever a validated rule contained a "reserve coupon" effect. This + reserves the coupon currently on scope to the profile on scope. + properties: + couponValue: + description: The value of the coupon currently on scope. + type: string + profileIntegrationId: + description: The ID of this customer profile in the third-party integration. + type: string + isNewReservation: + description: Indicates whether this is a new coupon reservation or not. + type: boolean + required: + - couponValue + - isNewReservation + - profileIntegrationId + type: object SetDiscountPerAdditionalCostEffectProps: description: The properties specific to the "setDiscountPerAdditionalCost" effect. This gets triggered whenever a validated rule contained a "set per additional @@ -19277,7 +22470,7 @@ 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. @@ -19318,7 +22511,7 @@ components: 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 reason of the point addition. + description: The name / description of this loyalty point addition. type: string programId: description: The ID of the loyalty program where these points were added. @@ -19335,6 +22528,7 @@ components: type: number recipientIntegrationId: description: The user for whom these points were added. + example: URNGV8294NV maxLength: 1000 type: string startDate: @@ -19358,7 +22552,17 @@ components: 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. + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 + type: string + 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 definition. type: string required: - name @@ -19396,7 +22600,10 @@ components: 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. + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 type: string required: - name @@ -19415,7 +22622,7 @@ components: example: SKU1241028 type: string name: - description: The name/description of the effect. + description: The name / description of the effect type: string required: - name @@ -19537,6 +22744,7 @@ components: type: number recipientIntegrationId: description: The user for whom these points were originally added. + example: URNGV8294NV maxLength: 1000 type: string transactionUUID: @@ -19549,11 +22757,14 @@ components: 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. + The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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. + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 type: string required: - programId @@ -19579,6 +22790,7 @@ components: type: number recipientIntegrationId: description: The user for whom these points were reimbursed. + example: URNGV8294NV maxLength: 1000 type: string startDate: @@ -19594,7 +22806,10 @@ components: the `deductLoyaltyPoints` effect is rolled back. type: string cardIdentifier: - description: The card on which these points were added. + description: | + The alphanumeric identifier of the loyalty card. + example: summer-loyalty-card-0543 + maxLength: 108 type: string required: - programId @@ -19634,19 +22849,24 @@ components: properties: poolId: description: The ID of the giveaways pool the code was taken from. + example: 2 type: integer poolName: description: The name of the giveaways pool the code was taken from. + example: My pool type: string recipientIntegrationId: description: The integration ID of the profile that was awarded the giveaway. + example: URNGV8294NV maxLength: 1000 type: string giveawayId: description: The internal ID for the giveaway that was awarded. + example: 5 type: integer code: description: The giveaway code that was awarded. + example: 57638t-67439hty type: string required: - code @@ -19663,13 +22883,16 @@ components: properties: poolId: description: The ID of the giveaways pool the code will be taken from. + example: 2 type: integer poolName: description: The name of the giveaways pool the code will be taken from. + example: My pool type: string recipientIntegrationId: description: The integration ID of the profile that will be awarded the giveaway. + example: URNGV8294NV maxLength: 1000 type: string required: @@ -19692,9 +22915,31 @@ components: properties: effectId: description: The ID of the custom effect that was triggered. + example: 1 type: integer name: description: The type of the custom effect. + example: my_custom_effect + type: string + cartItemPosition: + description: The index of the item in the cart item list to which the custom + effect is applied. + example: 1.0 + type: number + cartItemSubPosition: + description: | + When cart item flattening is enabled, the sub position indicates to which item unit + the custom effect is applied, for cart items with quantity > 1. + example: 2.0 + type: number + bundleIndex: + description: The position of the bundle in a list of item bundles created + from the same bundle definition. + example: 1 + type: integer + bundleName: + description: The name of the bundle definition. + example: my_bundle type: string payload: description: The JSON payload of the custom effect. @@ -19722,6 +22967,9 @@ components: profileId: URNGV8294NV identifiers: - 91.11.156.141 + evaluableCampaignIds: + - 10 + - 12 referralCode: NT2K54D9 attributes: ShippingCity: Berlin @@ -19773,11 +23021,8 @@ components: $ref: '#/components/schemas/NewCustomerSessionV2' 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`. + Extends the response with the chosen data entities. Use this property to get as much data + as you need in one _Update customer session_ request instead of sending extra requests to other endpoints. example: - customerSession - customerProfile @@ -19817,11 +23062,8 @@ components: $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`. + Extends the response with the chosen data entities. Use this property to get as much data + as you need in one _Update customer session_ request instead of sending extra requests to other endpoints. example: - customerSession - customerProfile @@ -19843,6 +23085,9 @@ components: CustomerProfileIntegrationRequestV2: description: "" example: + evaluableCampaignIds: + - 10 + - 12 attributes: Language: english ShippingCountry: DE @@ -19863,15 +23108,24 @@ components: ShippingCountry: DE properties: {} type: object + evaluableCampaignIds: + description: | + When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. + + These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + example: + - 10 + - 12 + items: + type: integer + title: Campaigns to evaluate + type: array audiencesChanges: $ref: '#/components/schemas/ProfileAudiencesChanges' 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`. + Extends the response with the chosen data entities. Use this property to get as much data + as you need in one _Update customer profile_ request instead of sending extra requests to other endpoints. example: - triggeredCampaigns - customerProfile @@ -19945,818 +23199,47 @@ components: attributes: Language: english ShippingCountry: DE - properties: - customerProfiles: - items: - $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequestItem' - type: array - type: object - MultipleCustomerProfileIntegrationRequestItem: - description: "" - example: - integrationId: R195412 - attributes: - Language: english - ShippingCountry: DE - properties: - attributes: - description: Arbitrary properties associated with this item. - example: - Language: english - ShippingCountry: DE - properties: {} - type: object - integrationId: - description: | - 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 - type: object - MultipleCustomerProfileIntegrationResponseV2: - example: - integrationStates: - - 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 - effectType: rejectCoupon - props: '{}' - - rulesetId: 73 - ruleIndex: 2 - triggeredForCatalogItem: 786 - campaignId: 244 - ruleName: Give 20% discount - triggeredByCoupon: 4928 - effectType: rejectCoupon - props: '{}' - referral: - 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 - triggeredCampaigns: - - 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 - - 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 - coupons: - - 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 - 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 - 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 - 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 - sessionId: 123 - applicationId: 322 - event: - effects: - - '{}' - - '{}' - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - meta: - campaigns: '{}' - coupons: '{}' - referralRejectionReason: - reason: ReferralNotFound - campaignId: 1 - referralId: 5 - warnings: '{}' - couponRejectionReason: - reason: CouponNotFound - campaignId: 244 - couponId: 4928 - ledgerEntries: - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - attributes: - myAttribute: myValue - id: 6 - sessionId: 175KJPS947296 - applicationId: 322 - 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 + properties: + customerProfiles: + items: + $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequestItem' + type: array + type: object + MultipleCustomerProfileIntegrationRequestItem: + description: "" + example: + integrationId: R195412 + attributes: + Language: english + ShippingCountry: DE + properties: + attributes: + description: Arbitrary properties associated with this item. + example: + Language: english + ShippingCountry: DE + properties: {} + type: object + integrationId: + description: | + 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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2). + example: R195412 + maxLength: 1000 + type: string + required: + - integrationId + type: object + MultipleCustomerProfileIntegrationResponseV2: + example: + integrationStates: - customerProfile: accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -20774,761 +23257,32 @@ components: 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 - effectType: rejectCoupon - props: '{}' - - rulesetId: 73 - ruleIndex: 2 - triggeredForCatalogItem: 786 - campaignId: 244 - ruleName: Give 20% discount - triggeredByCoupon: 4928 - effectType: rejectCoupon - props: '{}' - referral: - 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 - triggeredCampaigns: - - 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 - - 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 - coupons: - - 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 - customerSession: - couponCodes: - - XMAS-20-2021 + - customerProfile: + accountId: 31 + closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 - identifiers: - - 91.11.156.141 + sandbox: false 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 - 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 - 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 + Language: english + ShippingCountry: DE + totalSales: 299.99 + lastActivity: 2020-02-08T14:15:20Z id: 6 - sessionId: 123 - applicationId: 322 - event: - effects: - - '{}' - - '{}' - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV - meta: - campaigns: '{}' - coupons: '{}' - referralRejectionReason: - reason: ReferralNotFound - campaignId: 1 - referralId: 5 - warnings: '{}' - couponRejectionReason: - reason: CouponNotFound - campaignId: 244 - couponId: 4928 - ledgerEntries: - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV + loyaltyMemberships: + - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - - expiryDate: 2022-04-26T11:02:38Z - accountId: 0 - eventId: 3 - reason: Customer appeasement. - amount: 100 - created: 2020-06-10T09:05:27.993483Z - profileId: URNGV8294NV + - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 - id: 6 - referenceId: 6 - attributes: - myAttribute: myValue - id: 6 - sessionId: 175KJPS947296 - applicationId: 322 - 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 + audienceMemberships: + - name: Travel audience + id: 2 + - name: Travel audience + id: 2 properties: integrationStates: items: - $ref: '#/components/schemas/IntegrationStateV2' + $ref: '#/components/schemas/CustomerProfileUpdateV2Response' type: array type: object CustomerProfileAudienceRequest: @@ -21676,13 +23430,13 @@ components: RuleFailureReason: description: Details about why a rule failed. example: - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue @@ -21740,31 +23494,34 @@ components: Giveaway: description: "" example: - code: code - importId: 5 + profileIntegrationId: R195412 + code: GIVEAWAY1 + importId: 4 endDate: 2000-01-23T04:56:07.000+00:00 created: 2020-06-10T09:05:27.993483Z - poolId: 4 + profileId: 1 + poolId: 1 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string code: description: The code value of this giveaway. + example: GIVEAWAY1 type: string poolId: description: The ID of the pool to return giveaway codes from. + example: 1 type: integer startDate: description: Timestamp at which point the giveaway becomes valid. @@ -21780,9 +23537,21 @@ components: type: object used: description: Indicates whether this giveaway code was given before. + example: true type: boolean importId: description: The ID of the Import which created this giveaway. + example: 4 + type: integer + profileIntegrationId: + description: The third-party integration ID of the customer profile that + was awarded the giveaway, if the giveaway was awarded. + example: R195412 + type: string + profileId: + description: The internal ID of the customer profile that was awarded the + giveaway, if the giveaway was awarded and an internal ID exists. + example: 1 type: integer required: - code @@ -21794,29 +23563,40 @@ components: properties: name: description: The name of this giveaways pool. + example: My giveaway pool type: string description: description: The description of this giveaways pool. + example: Generic pool type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this giveaways pool is enabled for. + example: + - 2 + - 4 items: type: integer type: array + sandbox: + description: Indicates if this program is a live or sandbox program. Programs + of a given type can only be connected to Applications of the same type. + example: true + title: Sandbox + type: boolean required: - name + - sandbox 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -21826,16 +23606,27 @@ components: type: integer name: description: The name of this giveaways pool. + example: My giveaway pool type: string description: description: The description of this giveaways pool. + example: Generic pool type: string subscribedApplicationsIds: description: A list of the IDs of the applications that this giveaways pool is enabled for. + example: + - 2 + - 4 items: type: integer type: array + sandbox: + description: Indicates if this program is a live or sandbox program. Programs + of a given type can only be connected to Applications of the same type. + example: true + title: Sandbox + type: boolean modified: description: Timestamp of the most recent update to the giveaways pool. format: date-time @@ -21852,16 +23643,21 @@ components: - createdBy - id - name + - sandbox type: object NewCustomEffect: description: "" properties: applicationIds: - description: The IDs of the applications that are related to this entity. + description: The IDs of the Applications that are related to this entity. items: type: integer minItems: 1 type: array + isPerItem: + description: Indicates if this effect is per item or not. + type: boolean + x-fieldType: bool name: description: The name of this effect. pattern: ^[A-Za-z](\w|\s)*$ @@ -21891,15 +23687,128 @@ components: - payload - title type: object + NewPicklist: + properties: + type: + description: The type of allowed values in the picklist. If type time is + chosen, it must be an RFC3339 timestamp string. + enum: + - string + - boolean + - number + - time + example: 2012-11-01T22:08:41+00:00 + type: string + values: + description: The list of allowed values provided by this picklist. + example: + - Jeans + - Shirt + - Coat + items: + type: string + maxItems: 20 + type: array + required: + - type + - values + type: object + Picklist: + description: "" + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + type: + description: The type of allowed values in the picklist. If type time is + chosen, it must be an RFC3339 timestamp string. + enum: + - string + - boolean + - number + - time + example: 2012-11-01T22:08:41+00:00 + type: string + values: + description: The list of allowed values provided by this picklist. + example: + - Jeans + - Shirt + - Coat + items: + type: string + maxItems: 20 + type: array + modifiedBy: + description: ID of the user who last updated this effect if available. + example: 124 + type: integer + createdBy: + description: ID of the user who created this effect. + example: 134 + type: integer + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + imported: + description: Imported flag shows that a picklist is imported by a CSV file + or not + example: true + type: boolean + required: + - created + - createdBy + - id + - type + - values + type: object + UpdatePicklist: + description: "" + properties: + type: + description: The type of allowed values in the picklist. If type time is + chosen, it must be an RFC3339 timestamp string. + enum: + - string + - boolean + - number + - time + example: 2012-11-01T22:08:41+00:00 + type: string + values: + description: The list of allowed values provided by this picklist. + example: + - Jeans + - Shirt + - Coat + items: + type: string + maxItems: 20 + type: array + required: + - type + - values + type: object UpdateCustomEffect: description: "" properties: applicationIds: - description: The IDs of the applications that are related to this entity. + description: The IDs of the Applications that are related to this entity. items: type: integer minItems: 1 type: array + isPerItem: + description: Indicates if this effect is per item or not. + type: boolean + x-fieldType: bool name: description: The name of this effect. pattern: ^[A-Za-z](\w|\s)*$ @@ -21933,12 +23842,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -21947,16 +23855,20 @@ components: example: 3886 type: integer modified: - description: The exact moment this entity was last modified. + description: The time 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. + description: The IDs of the Applications that are related to this entity. items: type: integer minItems: 1 type: array + isPerItem: + description: Indicates if this effect is per item or not. + type: boolean + x-fieldType: bool name: description: The name of this effect. pattern: ^[A-Za-z](\w|\s)*$ @@ -21981,9 +23893,11 @@ components: type: array modifiedBy: description: ID of the user who last updated this effect if available. + example: 334 type: integer createdBy: description: ID of the user who created this effect. + example: 216 type: integer required: - accountId @@ -22029,12 +23943,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -22043,7 +23956,7 @@ components: example: 3886 type: integer modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -22085,12 +23998,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -22099,7 +24011,7 @@ components: example: 3886 type: integer modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -22221,12 +24133,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -22235,7 +24146,7 @@ components: example: 3886 type: integer modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -22305,12 +24216,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -22319,7 +24229,7 @@ components: example: 3886 type: integer modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -22389,8 +24299,9 @@ components: NewCouponCreationJob: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 + expiryDate: 2023-08-24T14:15:22Z usageLimit: 100 + reservationLimit: 45 numberOfCoupons: 200000 couponSettings: couponPattern: SUMMER-####-#### @@ -22400,11 +24311,40 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" attributes: '{}' discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z properties: usageLimit: description: | @@ -22415,25 +24355,34 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z 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 + minimum: 1 type: integer couponSettings: $ref: '#/components/schemas/CodeGeneratorSettings' @@ -22450,12 +24399,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -22481,25 +24429,34 @@ components: type: integer discountLimit: description: | - The amount of discounts that can be given with this coupon code. + The total discount value that the code can give. Typically used to represent a gift card value. example: 30.0 maximum: 999999 minimum: 0 type: number + reservationLimit: + description: | + The number of reservations that can be made with this coupon code. + example: 45 + maximum: 999999 + minimum: 0 + type: integer startDate: description: Timestamp at which point the coupon becomes valid. + example: 2020-01-24T14:15:22Z format: date-time type: string expiryDate: - description: Expiry date of the coupon. Coupon never expires if this is - omitted, zero, or negative. + description: Expiration date of the coupon. Coupon never expires if this + is omitted, zero, or negative. + example: 2023-08-24T14:15:22Z 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 + minimum: 1 type: integer couponSettings: $ref: '#/components/schemas/CodeGeneratorSettings' @@ -22620,27 +24577,34 @@ components: type: string profileId: description: The profile ID for which this limit counter is used. + example: 335 type: integer profileIntegrationId: description: The profile integration ID for which this limit counter is used. + example: URNGV8294NV maxLength: 1000 type: string couponId: - description: The coupon ID for which this limit counter is used. + description: The internal coupon ID for which this limit counter is used. + example: 34 type: integer couponValue: description: The coupon value for which this limit counter is used. + example: XMAS-20-2021 type: string referralId: description: The referral ID for which this limit counter is used. + example: 4 type: integer referralValue: description: The referral value for which this limit counter is used. + example: "" type: string identifier: description: The arbitrary identifier for which this limit counter is used. - type: integer + example: 91.11.156.141 + type: string period: description: The time period for which this limit counter is used. example: Y2021M8 @@ -22665,6 +24629,7 @@ components: BulkCampaignNotification: properties: totalResultSize: + example: 1 type: integer data: items: @@ -22679,6 +24644,7 @@ components: 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'] + example: campaign_state_changed type: string required: - event @@ -22686,6 +24652,7 @@ components: BulkApplicationNotification: properties: totalResultSize: + example: 1 type: integer data: items: @@ -22712,101 +24679,514 @@ components: oldState: description: | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + example: disabled type: string newState: description: | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + example: running + type: string + ruleset: + $ref: '#/components/schemas/Ruleset' + required: + - campaign + - newState + - oldState + type: object + CampaignRulesetChangedNotification: + description: A notification regarding a campaign whose ruleset was changed. + properties: + campaign: + allOf: + - $ref: '#/definitions/Campaign' + - $ref: '#/definitions/FrontendState' + type: object + oldRuleset: + $ref: '#/components/schemas/Ruleset' + ruleset: + $ref: '#/components/schemas/Ruleset' + required: + - campaign + type: object + CampaignEditedNotification: + description: A notification regarding a campaign which was edited. + properties: + campaign: + allOf: + - $ref: '#/definitions/Campaign' + - $ref: '#/definitions/FrontendState' + type: object + oldCampaign: + allOf: + - $ref: '#/definitions/Campaign' + - $ref: '#/definitions/FrontendState' + type: object + ruleset: + $ref: '#/components/schemas/Ruleset' + required: + - campaign + - oldCampaign + type: object + CampaignCreatedNotification: + description: A notification regarding a campaign that was created. + properties: + campaign: + allOf: + - $ref: '#/definitions/Campaign' + - $ref: '#/definitions/FrontendState' + type: object + ruleset: + $ref: '#/components/schemas/Ruleset' + priority: + $ref: '#/components/schemas/PriorityPosition' + required: + - campaign + - priority + type: object + FrontendState: + description: A campaign state described exactly as in the Campaign Manager. + enum: + - expired + - scheduled + - running + - draft + - disabled + example: running + type: string + PriorityPosition: + description: The campaign priority. + properties: + set: + default: universal + description: The name of the priority set where the campaign is located. + enum: + - universal + - stackable + - exclusive + example: universal + type: string + position: + description: The position of the campaign in the priority order starting + from 1. + example: 1 + type: integer + required: + - position + - set + type: object + CampaignDeletedNotification: + description: A notification regarding a campaign that was deleted. + properties: + campaign: + allOf: + - $ref: '#/definitions/Campaign' + - $ref: '#/definitions/FrontendState' + type: object + deletedAt: + description: Time when the campaign was deleted. + example: 2022-11-10T23:00:00Z + format: date-time + type: string + required: + - campaign + - deletedAt + type: object + CampaignPrioritiesChangedNotification: + description: Notification about an Application whose campaigns' priorities changed. + properties: + applicationId: + description: The ID of the Application whose campaigns' priorities changed. + example: 78 + type: integer + oldPriorities: + $ref: '#/components/schemas/CampaignSet' + priorities: + $ref: '#/components/schemas/CampaignSet' + required: + - applicationId + - priorities + type: object + StrikethroughLabelingNotification: + description: The strikethrough labels notification for an application. + properties: + applicationId: + description: The ID of the application that catalog items labels belongs + to. + example: 322 + type: integer + currentBatch: + description: The batch number of the notification. Notifications might be + sent in different batches. + example: 1 + type: integer + totalBatches: + description: The total number of batches for the notification. + example: 10 + type: integer + trigger: + $ref: '#/components/schemas/StrikethroughTrigger' + changedItems: + items: + $ref: '#/components/schemas/StrikethroughChangedItem' + type: array + required: + - applicationId + - changedItems + - currentBatch + - totalBatches + - trigger + type: object + StrikethroughTrigger: + description: Information about the event that triggered the strikethrough labeling. + properties: + id: + description: The ID of the event that triggered the strikethrough labeling. + example: 1 + type: integer + type: + description: The type of event that triggered the strikethrough labeling. + example: CATALOG_SYNC + type: string + triggeredAt: + description: The creation time of the event that triggered the strikethrough + labeling. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + totalAffectedItems: + description: The total number of items affected by the event that triggered + the strikethrough labeling. + example: 1500 + format: date-time + type: integer + payload: + description: The arbitrary properties associated with this trigger type. + example: + catalogId: 2 + catalogVersion: 100 + properties: {} + type: object + required: + - id + - payload + - totalAffectedItems + - triggeredAt + - type + type: object + StrikethroughChangedItem: + description: The information of affected items. + properties: + id: + description: The ID of the event that triggered the strikethrough labeling. + example: 1 + type: integer + catalogId: + description: The ID of the catalog that the changed item belongs to. + example: 10 + type: integer + sku: + description: The unique SKU of the changed item. + example: SKU1241028 + type: string + version: + description: The version of the changed item. + example: 6 + minimum: 1 + type: integer + price: + description: The price of the changed item. + example: 99.99 + type: number + evaluatedAt: + description: The evaluation time of the changed item. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + effects: + items: + $ref: '#/components/schemas/StrikethroughEffect' + type: array + required: + - catalogId + - evaluatedAt + - id + - price + - sku + - version + type: object + StrikethroughEffect: + description: The effect produced for the catalog item. + properties: + campaignId: + description: The ID of the campaign that effect belongs to. + example: 3 + type: integer + rulesetId: + description: The ID of the ruleset containing the rule that triggered this + effect. + example: 11 + type: integer + ruleIndex: + description: The position of the rule that triggered this effect within + the ruleset. + example: 2 + type: integer + ruleName: + description: The name of the rule that triggered this effect. + example: Add 2 points + type: string + type: + description: The type of this effect. + example: setDiscountPerItem + type: string + props: + type: object + required: + - campaignId + - props + - ruleIndex + - ruleName + - rulesetId + - type + type: object + StrikethroughEffectProps: + type: object + StrikethroughSetDiscountPerItemEffectProps: + description: setDiscountPerItem effect in strikethrough pricing payload. + properties: + name: + description: effect name. + example: 1EuroOff + type: string + value: + description: discount value. + example: "1" + type: object + required: + - name + - value + type: object + StrikethroughCustomEffectPerItemProps: + description: customEffectPerItem effect in strikethrough pricing payload. + properties: + effectId: + description: ID of the effect. + example: 1 + type: integer + name: + description: The type of the custom effect. + example: my_custom_effect + type: string + payload: + description: The JSON payload of the custom effect. + properties: {} + type: object + x-arbitraryJSON: true + required: + - effectId + - name + - payload + type: object + NewBaseNotification: + description: "" + example: + webhook: + headers: 'content-type: application/json' + url: www.my-company.com/my-endpoint-name + policy: '{}' + properties: + policy: + type: object + webhook: + $ref: '#/components/schemas/NewNotificationWebhook' + required: + - policy + - webhook + type: object + BaseNotificationEntity: + properties: + policy: + type: object + required: + - policy + type: object + BaseNotificationPolicy: + type: object + ExpiringPointsNotificationPolicy: + properties: + name: + description: Notification name. + example: notification to google. + minLength: 1 type: string + triggers: + items: + $ref: '#/components/schemas/ExpiringPointsNotificationTrigger' + maxItems: 3 + minItems: 1 + type: array required: - - campaign - - newState - - oldState + - name + - triggers type: object - CampaignRulesetChangedNotification: - description: A notification regarding a campaign whose ruleset was changed. + AddedDeductedPointsNotificationPolicy: properties: - campaign: - $ref: '#/components/schemas/Campaign' - oldRuleset: - $ref: '#/components/schemas/Ruleset' - ruleset: - $ref: '#/components/schemas/Ruleset' + name: + description: Notification name. + example: Christmas Sale + minLength: 1 + type: string + scopes: + items: + enum: + - all + - campaign_manager + - management_api + - rule_engine + type: string + maxItems: 4 + minItems: 1 + type: array required: - - campaign - - ruleset + - name + - scopes type: object - CampaignEditedNotification: - description: A notification regarding a campaign which was edited. + CouponsNotificationPolicy: properties: - campaign: - $ref: '#/components/schemas/Campaign' - oldCampaign: - $ref: '#/components/schemas/Campaign' + name: + description: Notification name. + example: Christmas Sale + minLength: 1 + type: string + scopes: + items: + enum: + - all + - campaign_manager + - management_api + - rule_engine + type: string + maxItems: 4 + minItems: 1 + type: array required: - - campaign - - oldCampaign + - name + - scopes type: object - CampaignCreatedNotification: - description: A notification regarding a campaign that was created. + CatalogsStrikethroughNotificationPolicy: properties: - campaign: - $ref: '#/components/schemas/Campaign' + name: + description: Notification name. + example: Christmas Sale + minLength: 1 + type: string required: - - campaign + - name type: object - CampaignDeletedNotification: - description: A notification regarding a campaign that was deleted. + ExpiringPointsNotificationTrigger: properties: - campaign: - $ref: '#/components/schemas/Campaign' + amount: + description: The amount of period. + minimum: 1 + type: integer + period: + description: Notification period indicated by a letter; "w" means week, + "d" means day. + enum: + - w + - d + type: string required: - - campaign + - amount + - period type: object - CampaignPrioritiesChangedNotification: - description: Notification about an Application whose campaigns' priorities changed. + BaseNotifications: 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'] + data: + description: List of notifications. + items: + $ref: '#/components/schemas/BaseNotification' + type: array + type: object + BaseNotification: + description: "" + example: + webhook: + headers: 'content-type: application/json' + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + id: 6 + url: www.my-company.com/my-endpoint-name + id: 6 + policy: '{}' + properties: + policy: type: object + webhook: + $ref: '#/components/schemas/BaseNotificationWebhook' + id: + description: Unique ID for this entity. + example: 6 + minimum: 1 + type: integer required: - - application - - priorities + - id + - policy + - webhook type: object - CampaignPriorities: - additionalProperties: - items: + BaseNotificationWebhook: + description: "" + example: + headers: 'content-type: application/json' + created: 2020-06-10T09:05:27.993483Z + modified: 2021-09-12T10:12:42Z + id: 6 + url: www.my-company.com/my-endpoint-name + properties: + id: + description: Internal ID of this entity. + example: 6 type: integer - type: array - description: | - Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive'] + created: + description: The time this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + modified: + description: The time this entity was last modified. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + url: + description: API URL for the given webhook-based notification. + example: www.my-company.com/my-endpoint-name + type: string + headers: + description: List of API HTTP headers for the given webhook-based notification. + example: 'content-type: application/json' + items: + pattern: ^[^:,]+:[^,]*$ + type: string + type: array + required: + - created + - headers + - id + - modified + - url type: object NewNotificationWebhook: example: - headers: - - headers - - headers - url: url + headers: 'content-type: application/json' + url: www.my-company.com/my-endpoint-name properties: url: - description: API url for this notification webhook. + description: API URL for the given webhook-based notification. + example: www.my-company.com/my-endpoint-name type: string headers: - description: List of API HTTP headers for this notification webhook. + description: List of API HTTP headers for the given webhook-based notification. + example: 'content-type: application/json' items: pattern: ^[^:,]+:[^,]*$ type: string @@ -22818,27 +25198,24 @@ components: NotificationWebhook: description: "" example: - headers: - - headers - - headers + headers: 'content-type: application/json' created: 2020-06-10T09:05:27.993483Z modified: 2021-09-12T10:12:42Z id: 6 applicationId: 322 - url: url + url: www.my-company.com/my-endpoint-name 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time 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. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -22847,10 +25224,12 @@ components: example: 322 type: integer url: - description: API url for this notification webhook. + description: API URL for the given webhook-based notification. + example: www.my-company.com/my-endpoint-name type: string headers: - description: List of API HTTP headers for this notification webhook. + description: List of API HTTP headers for the given webhook-based notification. + example: 'content-type: application/json' items: pattern: ^[^:,]+:[^,]*$ type: string @@ -22863,6 +25242,160 @@ components: - modified - url type: object + OutgoingIntegrationTypes: + properties: + data: + description: List of outgoing integrations. + items: + $ref: '#/components/schemas/OutgoingIntegrationType' + type: array + type: object + OutgoingIntegrationType: + properties: + id: + description: Unique ID for this entity. + example: 6 + type: integer + name: + description: Name of the outgoing integration. + example: braze + maxLength: 64 + minLength: 1 + type: string + description: + description: Description of the outgoing integration. + example: Braze is a customer data platform + maxLength: 1000 + minLength: 1 + type: string + category: + description: Category of the outgoing integration. + example: customer engagement platform + maxLength: 64 + minLength: 1 + type: string + documentationLink: + description: Http link to the outgoing integration's documentation. + example: https://docs.talon.one/docs/dev/technology-partners/braze + maxLength: 255 + minLength: 1 + type: string + required: + - id + - name + type: object + OutgoingIntegrationConfiguration: + properties: + id: + description: Unique ID for this entity. + example: 6 + type: integer + accountId: + description: The ID of the account to which this configuration belongs. + example: 3886 + type: integer + typeId: + description: The outgoing integration type ID. + example: 12 + type: integer + policy: + type: object + required: + - accountId + - id + - policy + - typeId + type: object + OutgoingIntegrationConfigurationPolicy: + type: object + OutgoingIntegrationBrazePolicy: + properties: + baseUrl: + description: The base URL of your Braze deployment. + example: your-braze-url.com + type: string + apiKey: + description: The API key of your Braze deployment. + example: Your-REST-API-Key + type: string + required: + - apiKey + - baseUrl + type: object + OutgoingIntegrationWebhookTemplates: + properties: + data: + description: The list of webhook templates for a given outgoing integration + type. + items: + $ref: '#/components/schemas/OutgoingIntegrationWebhookTemplate' + type: array + type: object + OutgoingIntegrationWebhookTemplate: + properties: + id: + description: Unique Id for this entity. + example: 6 + type: integer + integrationType: + description: Unique Id of outgoing integration type. + example: 2 + type: integer + title: + description: Title of the webhook template. + example: Send email via braze + maxLength: 255 + minLength: 1 + type: string + description: + description: General description for the specific outgoing integration webhook + template. + example: Waiting for docs team + maxLength: 1000 + minLength: 1 + type: string + payload: + description: API payload (supports templating using parameters) for this + webhook template. + example: "{\n\t\"message\": \"${message}\"\n}" + type: string + method: + description: API method for this webhook. + enum: + - POST + - PUT + - GET + - DELETE + - PATCH + example: POST + type: string + required: + - description + - id + - integrationType + - method + - payload + - title + type: object + NewOutgoingIntegrationWebhook: + properties: + title: + description: Webhook title. + example: Send email to customer via Braze + type: string + applicationIds: + description: IDs of the Applications to which a webhook must be linked. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + required: + - applicationIds + - title + type: object CouponLimitConfigs: properties: limits: @@ -22896,12 +25429,11 @@ components: applicationId: 322 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -22990,7 +25522,7 @@ components: 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) + Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. example: 1 type: integer @@ -23007,15 +25539,29 @@ components: **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string + evaluableCampaignIds: + description: | + When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. + + These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + example: + - 10 + - 12 + items: + type: integer + title: Campaigns to evaluate + type: array type: - description: A string representing the event. Must not be a reserved event - name. - example: email_opened + description: | + A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. + example: pageViewed minLength: 1 title: Event Type type: string attributes: - description: Arbitrary additional JSON data associated with the event. + description: Arbitrary additional JSON properties associated with the event. + They must be created in the Campaign Manager before setting them with + this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). example: myAttribute: myValue properties: {} @@ -23027,9 +25573,12 @@ components: description: "" example: profileId: URNGV8294NV + evaluableCampaignIds: + - 10 + - 12 attributes: myAttribute: myValue - type: email_opened + type: pageViewed responseContent: - triggeredCampaigns - customerProfile @@ -23041,15 +25590,29 @@ components: **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. example: URNGV8294NV type: string + evaluableCampaignIds: + description: | + When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. + + These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + example: + - 10 + - 12 + items: + type: integer + title: Campaigns to evaluate + type: array type: - description: A string representing the event. Must not be a reserved event - name. - example: email_opened + description: | + A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. + example: pageViewed minLength: 1 title: Event Type type: string attributes: - description: Arbitrary additional JSON data associated with the event. + description: Arbitrary additional JSON properties associated with the event. + They must be created in the Campaign Manager before setting them with + this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). example: myAttribute: myValue properties: {} @@ -23150,12 +25713,11 @@ components: version: 6 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -23164,7 +25726,7 @@ components: example: 3886 type: integer modified: - description: The exact moment this entity was last modified. + description: The time this entity was last modified. example: 2021-09-12T10:12:42Z format: date-time type: string @@ -23228,6 +25790,7 @@ components: version: description: The version number of the catalog to apply the actions on. example: 244 + minimum: 1 type: integer required: - actions @@ -23375,12 +25938,11 @@ components: 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. + description: Internal ID of this entity. example: 6 type: integer created: - description: The exact moment this entity was created. + description: The time this entity was created. example: 2020-06-10T09:05:27.993483Z format: date-time type: string @@ -23399,6 +25961,7 @@ components: type: integer version: description: The version of the catalog item. + example: 5 minimum: 1 type: integer attributes: @@ -23446,6 +26009,126 @@ components: required: - userIds type: object + AccountDashboardStatisticRevenue: + properties: + total: + description: All revenue that went through the client's shop (including + purchases that didn’t trigger an effect). + type: number + influenced: + description: The revenue that was created by a purchase that triggered an + effect (excluding web hooks, notifications). + type: number + datetime: + description: Values aggregated for the specified date. + format: date-time + type: string + required: + - datetime + - influenced + - total + type: object + AccountDashboardStatisticDiscount: + properties: + total: + description: Total discount value redeemed by users. + type: number + average: + description: Average discount percentage. + type: number + datetime: + description: Values aggregated for the specified date. + format: date-time + type: string + required: + - average + - datetime + - total + type: object + AccountDashboardStatisticLoyaltyPoints: + properties: + total: + description: Total loyalty points earned by users. + type: number + datetime: + description: Values aggregated for the specified date. + format: date-time + type: string + required: + - datetime + - total + type: object + AccountDashboardStatisticReferrals: + properties: + total: + description: Total number of referrals initiated by users. + type: number + datetime: + description: Values aggregated for the specified date. + format: date-time + type: string + required: + - datetime + - total + type: object + AccountDashboardStatisticApiCalls: + properties: + total: + description: Total number of API calls received. + type: number + datetime: + description: Values aggregated for the specified date. + format: date-time + type: string + required: + - datetime + - total + type: object + AccountDashboardStatisticCampaigns: + properties: + live: + description: Number of campaigns that are active and live (across all Applications). + type: integer + endingSoon: + description: Campaigns with a schedule ending in 7 days or with only 10% + of budget left. + type: integer + required: + - endingSoon + - live + type: object + AccountDashboardStatistic: + properties: + revenue: + description: Aggregated statistic for account revenue. + items: + $ref: '#/components/schemas/AccountDashboardStatisticRevenue' + type: array + discounts: + description: Aggregated statistic for account discount. + items: + $ref: '#/components/schemas/AccountDashboardStatisticDiscount' + type: array + loyaltyPoints: + description: Aggregated statistic for account loyalty points. + items: + $ref: '#/components/schemas/AccountDashboardStatisticLoyaltyPoints' + type: array + referrals: + description: Aggregated statistic for account referrals. + items: + $ref: '#/components/schemas/AccountDashboardStatisticReferrals' + type: array + apiCalls: + description: Aggregated statistic for the number of account API calls. + items: + $ref: '#/components/schemas/AccountDashboardStatisticApiCalls' + type: array + campaigns: + $ref: '#/components/schemas/AccountDashboardStatisticCampaigns' + required: + - campaigns + type: object inline_response_201: example: data: @@ -23457,9 +26140,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web id: 6 startDate: 2020-11-10T23:00:00Z - code: 27G47Y54VH9L @@ -23470,14 +26154,16 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web id: 6 startDate: 2020-11-10T23:00:00Z - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -23492,6 +26178,7 @@ components: - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -23512,6 +26199,7 @@ components: - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -23529,9 +26217,10 @@ components: id: 2 - name: Travel audience id: 2 - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -23543,7 +26232,48 @@ components: inline_response_200_1: example: data: - - expiryDate: 2022-01-02T15:04:05Z07:00 + - rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + type: addition + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + ruleName: Add 2 points + id: 123 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + - rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + type: addition + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + ruleName: Add 2 points + id: 123 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + hasMore: true + properties: + hasMore: + example: true + type: boolean + data: + items: + $ref: '#/components/schemas/CardLedgerTransactionLogEntryIntegrationAPI' + type: array + required: + - data + - hasMore + inline_response_200_2: + example: + data: + - expiryDate: 2022-08-02T15:04:05Z07:00 rulesetId: 11 amount: 10.25 created: 2000-01-23T04:56:07.000+00:00 @@ -23555,7 +26285,7 @@ components: type: addition programId: 324 startDate: 2022-01-02T15:04:05Z07:00 - - expiryDate: 2022-01-02T15:04:05Z07:00 + - expiryDate: 2022-08-02T15:04:05Z07:00 rulesetId: 11 amount: 10.25 created: 2000-01-23T04:56:07.000+00:00 @@ -23570,6 +26300,7 @@ components: hasMore: true properties: hasMore: + example: true type: boolean data: items: @@ -23578,7 +26309,7 @@ components: required: - data - hasMore - inline_response_200_2: + inline_response_200_3: example: data: - enableFlattenedCartItems: true @@ -23619,17 +26350,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 - cardBased: true tiers: - name: Gold @@ -23650,17 +26382,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 name: My Application exclusiveCampaignsStrategy: listOrder modified: 2021-09-12T10:12:42Z @@ -23719,17 +26452,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 - cardBased: true tiers: - name: Gold @@ -23750,17 +26484,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 name: My Application exclusiveCampaignsStrategy: listOrder modified: 2021-09-12T10:12:42Z @@ -23781,9 +26516,10 @@ components: limit: 1000.0 action: createCoupon enablePartialDiscounts: false - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -23792,7 +26528,7 @@ components: required: - data - totalResultSize - inline_response_200_3: + inline_response_200_4: example: data: - callApiEffectCount: 0 @@ -23813,10 +26549,39 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" startTime: 2021-07-20T22:00:00Z - id: 3 + id: 4 state: enabled limits: - period: yearly @@ -23829,12 +26594,13 @@ components: - Coupon limit: 1000.0 action: createCoupon - activeRulesetId: 4 + activeRulesetId: 6 + reservecouponEffectCount: 9 updatedBy: Jane Doe - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 couponRedemptionCount: 163 - userId: 2 + userId: 388 couponCreationCount: 16 campaignGroups: - 1 @@ -23856,8 +26622,37 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" attributes: '{}' lastActivity: 2022-11-10T23:00:00Z endTime: 2021-09-22T22:00:00Z @@ -23882,10 +26677,39 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" startTime: 2021-07-20T22:00:00Z - id: 3 + id: 4 state: enabled limits: - period: yearly @@ -23898,12 +26722,13 @@ components: - Coupon limit: 1000.0 action: createCoupon - activeRulesetId: 4 + activeRulesetId: 6 + reservecouponEffectCount: 9 updatedBy: Jane Doe - created: 2000-01-23T04:56:07.000+00:00 + created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 couponRedemptionCount: 163 - userId: 2 + userId: 388 couponCreationCount: 16 campaignGroups: - 1 @@ -23925,17 +26750,47 @@ components: - C - D - E - - "2" + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" 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 - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -23944,28 +26799,25 @@ components: required: - data - totalResultSize - inline_response_200_4: + inline_response_200_5: example: data: - - headers: - - headers - - headers + - headers: 'content-type: application/json' created: 2020-06-10T09:05:27.993483Z modified: 2021-09-12T10:12:42Z id: 6 applicationId: 322 - url: url - - headers: - - headers - - headers + url: www.my-company.com/my-endpoint-name + - headers: 'content-type: application/json' created: 2020-06-10T09:05:27.993483Z modified: 2021-09-12T10:12:42Z id: 6 applicationId: 322 - url: url - totalResultSize: 0 + url: www.my-company.com/my-endpoint-name + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -23974,7 +26826,7 @@ components: required: - data - totalResultSize - inline_response_200_5: + inline_response_200_6: example: data: - rbVersion: v2 @@ -24013,7 +26865,9 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - condition: - and - - couponValid @@ -24043,10 +26897,77 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 id: 6 + strikethroughRules: + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 templateId: 3 - userId: 6 + userId: 388 - rbVersion: v2 created: 2020-06-10T09:05:27.993483Z campaignId: 320 @@ -24083,7 +27004,75 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 + id: 6 + strikethroughRules: + - 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 + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 - condition: - and - - couponValid @@ -24113,13 +27102,15 @@ components: name: my property type: templateParameter description: Creates a discount when a coupon is valid + id: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 title: Give discount via coupon - id: 6 + parentId: 7fa800a8-ac8d-4792-85dc-c4650dcc8f23 templateId: 3 - userId: 6 - totalResultSize: 0 + userId: 388 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -24128,7 +27119,7 @@ components: required: - data - totalResultSize - inline_response_200_6: + inline_response_200_7: example: data: - recipientIntegrationId: URNGV8294NV @@ -24138,15 +27129,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -24158,7 +27151,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false - recipientIntegrationId: URNGV8294NV created: 2020-06-10T09:05:27.993483Z campaignId: 211 @@ -24166,15 +27160,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -24186,10 +27182,12 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 - totalResultSize: 0 + discountRemainder: 5.0 + isReservationMandatory: false + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -24198,7 +27196,7 @@ components: required: - data - totalResultSize - inline_response_200_7: + inline_response_200_8: example: data: - recipientIntegrationId: URNGV8294NV @@ -24208,15 +27206,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -24228,7 +27228,8 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false - recipientIntegrationId: URNGV8294NV created: 2020-06-10T09:05:27.993483Z campaignId: 211 @@ -24236,15 +27237,17 @@ components: referralId: 326632952 usageCounter: 10 batchId: 32535-43255 - discountCounter: 2.3021358869347655 - expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 9 + discountCounter: 10.0 + expiryDate: 2023-08-24T14:15:22Z + importId: 4 + reservationLimit: 45 + reservationCounter: 1.0 reservation: false attributes: '{}' id: 6 value: XMAS-20-2021 discountLimit: 30.0 - startDate: 2000-01-23T04:56:07.000+00:00 + startDate: 2020-01-24T14:15:22Z limits: - period: yearly entities: @@ -24256,10 +27259,12 @@ components: - Coupon limit: 1000.0 action: createCoupon - discountRemainder: 7.061401241503109 + discountRemainder: 5.0 + isReservationMandatory: false hasMore: true properties: hasMore: + example: true type: boolean data: items: @@ -24268,7 +27273,7 @@ components: required: - data - hasMore - inline_response_200_8: + inline_response_200_9: example: data: - code: 27G47Y54VH9L @@ -24279,9 +27284,10 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web id: 6 startDate: 2020-11-10T23:00:00Z - code: 27G47Y54VH9L @@ -24292,14 +27298,16 @@ components: batchId: tqyrgahe advocateProfileIntegrationId: URNGV8294NV expiryDate: 2021-11-10T23:00:00Z - importId: 1 + importId: 4 friendProfileIntegrationId: BZGGC2454PA - attributes: '{}' + attributes: + channel: web id: 6 startDate: 2020-11-10T23:00:00Z hasMore: true properties: hasMore: + example: true type: boolean data: items: @@ -24308,7 +27316,284 @@ components: required: - data - hasMore - inline_response_200_9: + inline_response_200_10: + example: + data: + - activeRulesetId: 5 + instructions: Use this template for discount campaigns. Set the campaign + properties according to the campaign goals, and don't forget to set an + end date. + campaignAttributes: '{}' + applicationsIds: + - 0 + - 0 + updatedBy: Jane Doe + campaignCollections: + - name: My collection + description: My collection of SKUs + - name: My collection + description: My collection of SKUs + created: 2020-06-10T09:05:27.993483Z + defaultCampaignGroupId: 42 + description: This is a template for a discount campaign. + userId: 388 + tags: + - discount + accountId: 3886 + features: + - coupons + - coupons + validApplicationIds: + - 1 + - 2 + - 3 + name: Discount campaign + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + templateParams: + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + id: 6 + couponAttributes: '{}' + state: draft + updated: 2022-08-24T14:15:22Z + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - activeRulesetId: 5 + instructions: Use this template for discount campaigns. Set the campaign + properties according to the campaign goals, and don't forget to set an + end date. + campaignAttributes: '{}' + applicationsIds: + - 0 + - 0 + updatedBy: Jane Doe + campaignCollections: + - name: My collection + description: My collection of SKUs + - name: My collection + description: My collection of SKUs + created: 2020-06-10T09:05:27.993483Z + defaultCampaignGroupId: 42 + description: This is a template for a discount campaign. + userId: 388 + tags: + - discount + accountId: 3886 + features: + - coupons + - coupons + validApplicationIds: + - 1 + - 2 + - 3 + name: Discount campaign + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + templateParams: + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + id: 6 + couponAttributes: '{}' + state: draft + updated: 2022-08-24T14:15:22Z + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + hasMore: true + properties: + hasMore: + example: true + type: boolean + data: + items: + $ref: '#/components/schemas/CampaignTemplate' + type: array + required: + - data + - hasMore + inline_response_200_11: example: data: - cardBased: true @@ -24331,17 +27616,18 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 + id: 0 - cardBased: true tiers: - name: Gold @@ -24362,20 +27648,22 @@ components: usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection subscribedApplications: - 132 - 97 accountID: 1 - defaultValidity: unlimited + defaultValidity: 2W_U defaultPending: immediate allowSubledger: false name: my_program - id: 6 - totalResultSize: 0 + id: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -24384,7 +27672,188 @@ components: required: - data - totalResultSize - inline_response_200_10: + inline_response_200_12: + example: + data: + - rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + type: addition + userId: 5 + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-01-02T15:04:05Z07:00 + importId: 4 + customerProfileId: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + subledgerId: sub-123 + name: Reward 50 points for each $500 purchase + ruleName: 10 points for every $100 spent + userEmail: john.doe@example.com + id: 123 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + - rulesetId: 11 + amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + type: addition + userId: 5 + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-01-02T15:04:05Z07:00 + importId: 4 + customerProfileId: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9 + subledgerId: sub-123 + name: Reward 50 points for each $500 purchase + ruleName: 10 points for every $100 spent + userEmail: john.doe@example.com + id: 123 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + hasMore: true + properties: + hasMore: + example: true + type: boolean + data: + items: + $ref: '#/components/schemas/LoyaltyProgramTransaction' + type: array + required: + - data + - hasMore + inline_response_200_13: + example: + data: + - ledger: + pendingBalance: 10.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.0 + pointsToNextTier: 20.0 + expiredBalance: 0.0 + currentTier: + name: bronze + id: 11 + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.0 + pointsToNextTier: 20.0 + expiredBalance: 0.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + newCardIdentifier: summer-loyalty-card-0543 + programID: 125 + status: active + - ledger: + pendingBalance: 10.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.0 + pointsToNextTier: 20.0 + expiredBalance: 0.0 + currentTier: + name: bronze + id: 11 + identifier: summer-loyalty-card-0543 + oldCardIdentifier: summer-loyalty-card-0543 + usersPerCardLimit: 111 + created: 2020-06-10T09:05:27.993483Z + profiles: + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + - integrationId: R195412 + timestamp: 2021-09-12T10:12:42Z + subledgers: + key: + pendingBalance: 10.0 + currentBalance: 100.0 + spentBalance: 0.0 + tentativeCurrentBalance: 100.0 + tentativePendingBalance: 20.0 + pointsToNextTier: 20.0 + expiredBalance: 0.0 + currentTier: + name: bronze + id: 11 + modified: 2021-09-12T10:12:42Z + id: 6 + newCardIdentifier: summer-loyalty-card-0543 + programID: 125 + status: active + hasMore: true + properties: + hasMore: + example: true + type: boolean + data: + items: + $ref: '#/components/schemas/LoyaltyCard' + type: array + required: + - data + - hasMore + inline_response_200_14: + example: + data: + - amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + sessionId: 233 + type: addition + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + id: 123 + applicationId: 322 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + - amount: 10.25 + created: 2000-01-23T04:56:07.000+00:00 + customerSessionId: 05c2da0d-48fa-4aa1-b629-898f58f1584d + sessionId: 233 + type: addition + cardIdentifier: summer-loyalty-card-0543 + expiryDate: 2022-08-02T15:04:05Z07:00 + subledgerId: sub-123 + name: Reward 10% points of a purchase's current total + id: 123 + applicationId: 322 + programId: 324 + startDate: 2022-01-02T15:04:05Z07:00 + hasMore: true + properties: + hasMore: + description: true means there is more data in the source collection to request.. + example: true + type: boolean + data: + description: List of loyalty card transaction logs. + items: + $ref: '#/components/schemas/CardLedgerTransactionLogEntry' + type: array + required: + - data + - hasMore + inline_response_200_15: example: data: - accountId: 3886 @@ -24416,11 +27885,12 @@ components: id: 6 applicationId: 1 hasMore: true - totalResultSize: 0 + totalResultSize: 1 properties: hasMore: type: boolean totalResultSize: + example: 1 type: integer data: items: @@ -24428,7 +27898,7 @@ components: type: array required: - data - inline_response_200_11: + inline_response_200_16: example: data: - item: item @@ -24444,7 +27914,7 @@ components: required: - data - hasMore - inline_response_200_12: + inline_response_200_17: example: data: - accountId: 3886 @@ -24482,11 +27952,12 @@ components: id: 6 applicationId: 1 hasMore: true - totalResultSize: 0 + totalResultSize: 1 properties: hasMore: type: boolean totalResultSize: + example: 1 type: integer data: items: @@ -24494,23 +27965,35 @@ components: type: array required: - data - inline_response_200_13: + inline_response_200_18: example: data: - - method: method - requestPayload: requestPayload - responsePayload: responsePayload - requestUri: requestUri - time: 2000-01-23T04:56:07.000+00:00 - uuid: uuid - status: 0 - - method: method - requestPayload: requestPayload - responsePayload: responsePayload - requestUri: requestUri - time: 2000-01-23T04:56:07.000+00:00 - uuid: uuid - status: 0 + - method: PUT + requestPayload: |- + { + "customerSession": { + "profileId": "customer123", + "state": "closed", + ... + } + responsePayload: '{"coupons":[],"createdCoupons":[],...}' + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z + uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 + - method: PUT + requestPayload: |- + { + "customerSession": { + "profileId": "customer123", + "state": "closed", + ... + } + responsePayload: '{"coupons":[],"createdCoupons":[],...}' + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z + uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 hasMore: true properties: hasMore: @@ -24522,26 +28005,39 @@ components: required: - data - hasMore - inline_response_200_14: + inline_response_200_19: example: data: - - method: method - requestPayload: requestPayload - responsePayload: responsePayload - requestUri: requestUri - time: 2000-01-23T04:56:07.000+00:00 - uuid: uuid - status: 0 - - method: method - requestPayload: requestPayload - responsePayload: responsePayload - requestUri: requestUri - time: 2000-01-23T04:56:07.000+00:00 - uuid: uuid - status: 0 - totalResultSize: 0 + - method: PUT + requestPayload: |- + { + "customerSession": { + "profileId": "customer123", + "state": "closed", + ... + } + responsePayload: '{"coupons":[],"createdCoupons":[],...}' + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z + uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 + - method: PUT + requestPayload: |- + { + "customerSession": { + "profileId": "customer123", + "state": "closed", + ... + } + responsePayload: '{"coupons":[],"createdCoupons":[],...}' + requestUri: /v2/customer_sessions/Session136667 + time: 2023-01-16T16:00:00.700763Z + uuid: 606e7d34-2d36-4d53-ac71-d4442c325985 + status: 200 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -24550,62 +28046,63 @@ components: required: - data - totalResultSize - inline_response_200_15: + inline_response_200_20: example: data: - - date: 2000-01-23T04:56:07.000+00:00 - couponRolledbackRedemptions: 1 - totalCouponRolledbackRedemptions: 1 - campaignRefundedDiscounts: 9.301444243932576 - totalDeductedLoyaltyPoints: 9.018348186070783 - couponRedemptions: 7 - totalCampaignDiscountCosts: 7.061401241503109 - referralRedemptions: 6 - totalCampaignRevenue: 1.4658129805029452 - campaignRevenue: 6.027456183070403 - campaignDiscountCosts: 2.3021358869347655 - totalReferralRedemptions: 7 + - date: 2021-10-12T10:12:42Z + couponRolledbackRedemptions: 2 + totalCouponRolledbackRedemptions: 4 + campaignRefundedDiscounts: 5.637376656633329 + totalDeductedLoyaltyPoints: 220.0 + couponRedemptions: 9 + totalCampaignDiscountCosts: 5.962133916683182 + referralRedemptions: 7 + totalCampaignRevenue: 5784.63 + campaignRevenue: 3539.76 + campaignDiscountCosts: 1.4658129805029452 + totalReferralRedemptions: 1 couponsCreated: 1 - addedLoyaltyPoints: 9.369310271410669 - campaignRefund: 5.962133916683182 - campaignFreeItems: 2 - totalAddedLoyaltyPoints: 6.683562403749608 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 - totalCampaignRefund: 5.637376656633329 - totalCouponsCreated: 4 - deductedLoyaltyPoints: 8.762042012749001 - totalCouponRedemptions: 1 - referralsCreated: 5 - totalReferralsCreated: 9 - - date: 2000-01-23T04:56:07.000+00:00 - couponRolledbackRedemptions: 1 - totalCouponRolledbackRedemptions: 1 - campaignRefundedDiscounts: 9.301444243932576 - totalDeductedLoyaltyPoints: 9.018348186070783 - couponRedemptions: 7 - totalCampaignDiscountCosts: 7.061401241503109 - referralRedemptions: 6 - totalCampaignRevenue: 1.4658129805029452 - campaignRevenue: 6.027456183070403 - campaignDiscountCosts: 2.3021358869347655 - totalReferralRedemptions: 7 + addedLoyaltyPoints: 250.0 + campaignRefund: 0.8008281904610115 + campaignFreeItems: 7 + totalAddedLoyaltyPoints: 340.0 + totalCampaignFreeItems: 86 + totalCampaignRefundedDiscounts: 2.3021358869347655 + totalCampaignRefund: 6.027456183070403 + totalCouponsCreated: 1 + deductedLoyaltyPoints: 120.0 + totalCouponRedemptions: 3 + referralsCreated: 6 + totalReferralsCreated: 7 + - date: 2021-10-12T10:12:42Z + couponRolledbackRedemptions: 2 + totalCouponRolledbackRedemptions: 4 + campaignRefundedDiscounts: 5.637376656633329 + totalDeductedLoyaltyPoints: 220.0 + couponRedemptions: 9 + totalCampaignDiscountCosts: 5.962133916683182 + referralRedemptions: 7 + totalCampaignRevenue: 5784.63 + campaignRevenue: 3539.76 + campaignDiscountCosts: 1.4658129805029452 + totalReferralRedemptions: 1 couponsCreated: 1 - addedLoyaltyPoints: 9.369310271410669 - campaignRefund: 5.962133916683182 - campaignFreeItems: 2 - totalAddedLoyaltyPoints: 6.683562403749608 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 - totalCampaignRefund: 5.637376656633329 - totalCouponsCreated: 4 - deductedLoyaltyPoints: 8.762042012749001 - totalCouponRedemptions: 1 - referralsCreated: 5 - totalReferralsCreated: 9 - totalResultSize: 0 + addedLoyaltyPoints: 250.0 + campaignRefund: 0.8008281904610115 + campaignFreeItems: 7 + totalAddedLoyaltyPoints: 340.0 + totalCampaignFreeItems: 86 + totalCampaignRefundedDiscounts: 2.3021358869347655 + totalCampaignRefund: 6.027456183070403 + totalCouponsCreated: 1 + deductedLoyaltyPoints: 120.0 + totalCouponRedemptions: 3 + referralsCreated: 6 + totalReferralsCreated: 7 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -24614,19 +28111,20 @@ components: required: - data - totalResultSize - inline_response_200_16: + inline_response_200_21: example: data: - - accountId: 1 + - accountId: 6 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: integrationId attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 6 + id: 0 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 @@ -24638,16 +28136,17 @@ components: id: 2 - name: Travel audience id: 2 - - accountId: 1 + - accountId: 6 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: integrationId attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 6 + id: 0 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 @@ -24660,9 +28159,10 @@ components: - name: Travel audience id: 2 hasMore: true - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer hasMore: type: boolean @@ -24672,19 +28172,20 @@ components: type: array required: - data - inline_response_200_17: + inline_response_200_22: example: data: - - accountId: 1 + - accountId: 6 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: integrationId attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 6 + id: 0 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 @@ -24696,16 +28197,17 @@ components: id: 2 - name: Travel audience id: 2 - - accountId: 1 + - accountId: 6 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: integrationId attributes: Language: english ShippingCountry: DE totalSales: 299.99 lastActivity: 2020-02-08T14:15:20Z - id: 6 + id: 0 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 loyaltyProgramId: 323414846 @@ -24718,22 +28220,83 @@ components: - name: Travel audience id: 2 hasMore: true + totalResultSize: 0 properties: hasMore: type: boolean + totalResultSize: + type: integer data: items: $ref: '#/components/schemas/ApplicationCustomer' type: array required: - data - - hasMore - inline_response_200_18: + inline_response_200_23: + example: + data: + - accountId: 31 + closedSessions: 3 + created: 2000-01-23T04:56:07.000+00:00 + sandbox: false + 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 + - accountId: 31 + closedSessions: 3 + created: 2000-01-23T04:56:07.000+00:00 + sandbox: false + 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 + hasMore: true + totalResultSize: 0 + properties: + hasMore: + type: boolean + totalResultSize: + type: integer + data: + items: + $ref: '#/components/schemas/CustomerProfile' + type: array + required: + - data + inline_response_200_24: example: data: - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -24754,6 +28317,7 @@ components: - accountId: 31 closedSessions: 3 created: 2000-01-23T04:56:07.000+00:00 + sandbox: false integrationId: URNGV8294NV attributes: Language: english @@ -24782,7 +28346,7 @@ components: required: - data - hasMore - inline_response_200_19: + inline_response_200_25: example: data: - couponUseAttempts: 1 @@ -24822,7 +28386,7 @@ components: required: - data - hasMore - inline_response_200_20: + inline_response_200_26: example: data: - coupon: BKDB946 @@ -24941,12 +28505,26 @@ components: type: array required: - data - inline_response_200_21: + inline_response_200_27: example: data: - 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: '{}' created: 2020-06-10T09:05:27.993483Z profileId: 138 attributes: '{}' @@ -24955,33 +28533,47 @@ components: applicationId: 322 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - 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: '{}' created: 2020-06-10T09:05:27.993483Z profileId: 138 attributes: '{}' @@ -24990,25 +28582,25 @@ components: applicationId: 322 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 1 - campaignID: 7 - referralID: 1 + - rulesetID: 2 + ruleIndex: 9 + campaignID: 5 + referralID: 7 ruleName: ruleName - conditionIndex: 6 - effectIndex: 7 + conditionIndex: 3 + effectIndex: 2 details: details couponID: 4928 referralValue: referralValue @@ -25025,14 +28617,15 @@ components: required: - data - hasMore - inline_response_200_22: + inline_response_200_28: example: data: - data - data - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25041,11 +28634,12 @@ components: required: - data - totalResultSize - inline_response_200_23: + inline_response_200_29: example: data: - accountId: 3886 created: 2020-06-10T09:05:27.993483Z + lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true integration: mparticle @@ -25055,6 +28649,7 @@ components: createdIn3rdParty: false - accountId: 3886 created: 2020-06-10T09:05:27.993483Z + lastUpdate: 2022-04-26T11:02:38Z name: Travel audience sandbox: true integration: mparticle @@ -25063,11 +28658,12 @@ components: id: 6 createdIn3rdParty: false hasMore: true - totalResultSize: 0 + totalResultSize: 1 properties: hasMore: type: boolean totalResultSize: + example: 1 type: integer data: items: @@ -25075,7 +28671,7 @@ components: type: array required: - data - inline_response_200_24: + inline_response_200_30: example: data: - friendIntegrationId: friendIntegrationId @@ -25091,11 +28687,12 @@ components: advocateIntegrationId: advocateIntegrationId applicationId: 322 hasMore: true - totalResultSize: 0 + totalResultSize: 1 properties: hasMore: type: boolean totalResultSize: + example: 1 type: integer data: items: @@ -25103,28 +28700,27 @@ components: type: array required: - data - - hasMore - - totalResultSize - inline_response_200_25: + inline_response_200_31: example: data: - created: 2020-06-10T09:05:27.993483Z editable: true subscribedApplicationsIds: - - 6 - - 6 - description: description + - 1 + - 4 + - 9 + description: Event triggered when a customer displays a page. restrictedBySuggestions: false - eventType: eventType - title: title + eventType: pageViewed + title: Page view event type: string accountId: 3886 eventTypeId: 22 hasAllowedList: false allowedSubscriptions: - application - - application - name: name + - catalog + name: pageViewed suggestions: - suggestions - suggestions @@ -25133,26 +28729,27 @@ components: - suggestions id: 6 subscribedCatalogsIds: - - 1 - - 1 - entity: Account + - 2 + - 5 + entity: Event - created: 2020-06-10T09:05:27.993483Z editable: true subscribedApplicationsIds: - - 6 - - 6 - description: description + - 1 + - 4 + - 9 + description: Event triggered when a customer displays a page. restrictedBySuggestions: false - eventType: eventType - title: title + eventType: pageViewed + title: Page view event type: string accountId: 3886 eventTypeId: 22 hasAllowedList: false allowedSubscriptions: - application - - application - name: name + - catalog + name: pageViewed suggestions: - suggestions - suggestions @@ -25161,12 +28758,13 @@ components: - suggestions id: 6 subscribedCatalogsIds: - - 1 - - 1 - entity: Account - totalResultSize: 0 + - 2 + - 5 + entity: Event + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25175,32 +28773,33 @@ components: required: - data - totalResultSize - inline_response_200_26: + inline_response_200_32: example: data: - accountId: 3886 created: 2020-06-10T09:05:27.993483Z - name: name + name: shippingFee subscribedApplicationsIds: - - 6 - - 6 - description: description + - 3 + - 13 + description: A shipping fee id: 6 - title: title + title: Shipping fee type: session - accountId: 3886 created: 2020-06-10T09:05:27.993483Z - name: name + name: shippingFee subscribedApplicationsIds: - - 6 - - 6 - description: description + - 3 + - 13 + description: A shipping fee id: 6 - title: title + title: Shipping fee type: session - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25209,58 +28808,43 @@ components: required: - data - totalResultSize - inline_response_200_27: + inline_response_200_33: example: data: - headers: - - headers - - headers - payload: payload + - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' + - '{"Content-Type": "application/json"}' + payload: "{\n\t\"message\": \"${message}\"\n}" created: 2020-06-10T09:05:27.993483Z verb: POST modified: 2021-09-12T10:12:42Z id: 6 - title: title - params: - - ui: '{}' - description: description - type: string - title: title - - ui: '{}' - description: description - type: string - title: title - url: url + title: Send message + params: [] + url: www.my-company.com/my-endpoint-name enabled: true applicationIds: - - 6 - - 6 + - 0 + - 0 - headers: - - headers - - headers - payload: payload + - '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}' + - '{"Content-Type": "application/json"}' + payload: "{\n\t\"message\": \"${message}\"\n}" created: 2020-06-10T09:05:27.993483Z verb: POST modified: 2021-09-12T10:12:42Z id: 6 - title: title - params: - - ui: '{}' - description: description - type: string - title: title - - ui: '{}' - description: description - type: string - title: title - url: url + title: Send message + params: [] + url: www.my-company.com/my-endpoint-name enabled: true applicationIds: - - 6 - - 6 - totalResultSize: 0 + - 0 + - 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25269,22 +28853,23 @@ components: required: - data - totalResultSize - inline_response_200_28: + inline_response_200_34: example: data: - - webhookId: 6 - campaignId: 5 - created: 2000-01-23T04:56:07.000+00:00 - integrationRequestUuid: integrationRequestUuid - applicationId: 1 - - webhookId: 6 - campaignId: 5 - created: 2000-01-23T04:56:07.000+00:00 - integrationRequestUuid: integrationRequestUuid - applicationId: 1 - totalResultSize: 0 + - webhookId: 1 + campaignId: 86 + created: 2023-03-21T13:55:08.571144Z + integrationRequestUuid: 6d3699cf-95bd-444a-b62f-80d6e8391dc9 + applicationId: 13 + - webhookId: 1 + campaignId: 86 + created: 2023-03-21T13:55:08.571144Z + integrationRequestUuid: 6d3699cf-95bd-444a-b62f-80d6e8391dc9 + applicationId: 13 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25293,32 +28878,39 @@ components: required: - data - totalResultSize - inline_response_200_29: + inline_response_200_35: example: data: - - requestTime: 2000-01-23T04:56:07.000+00:00 - request: request - webhookId: 6 - response: response - responseTime: 2000-01-23T04:56:07.000+00:00 - integrationRequestUuid: integrationRequestUuid - id: id - applicationId: 1 - url: url - status: 5 - - requestTime: 2000-01-23T04:56:07.000+00:00 - request: request - webhookId: 6 - response: response - responseTime: 2000-01-23T04:56:07.000+00:00 - integrationRequestUuid: integrationRequestUuid - id: id - applicationId: 1 - url: url - status: 5 - totalResultSize: 0 + - requestTime: 2021-07-20T22:00:00Z + request: | + { + mydata: "somevalue" + } + webhookId: 5 + response: "" + responseTime: 2021-07-20T22:00:50Z + integrationRequestUuid: "472075793" + id: "2" + applicationId: 12 + url: www.my-company.com/my-endpoint-name + status: 204 + - requestTime: 2021-07-20T22:00:00Z + request: | + { + mydata: "somevalue" + } + webhookId: 5 + response: "" + responseTime: 2021-07-20T22:00:50Z + integrationRequestUuid: "472075793" + id: "2" + applicationId: 12 + url: www.my-company.com/my-endpoint-name + status: 204 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25327,22 +28919,23 @@ components: required: - data - totalResultSize - inline_response_200_30: + inline_response_200_36: example: data: - created: 2020-06-10T09:05:27.993483Z - name: name - description: description + name: surveyCompleted + description: The survey was submitted by the customer. id: 6 - title: title + title: Survey Completed - created: 2020-06-10T09:05:27.993483Z - name: name - description: description + name: surveyCompleted + description: The survey was submitted by the customer. id: 6 - title: title - totalResultSize: 0 + title: Survey Completed + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25351,7 +28944,7 @@ components: required: - data - totalResultSize - inline_response_200_31: + inline_response_200_37: example: data: - created: 2020-06-10T09:05:27.993483Z @@ -25384,9 +28977,10 @@ components: email: john.doe@example.com policy: Role: 127 - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25395,7 +28989,7 @@ components: required: - data - totalResultSize - inline_response_200_32: + inline_response_200_38: example: data: - new: @@ -25412,8 +29006,9 @@ components: old: '{}' id: 6 applicationId: 359 - userId: 6 + userId: 388 entity: /v1/applications/359/campaigns/6727 + managementKeyId: 3 - new: applicationId": 359 attributes": {} @@ -25428,12 +29023,14 @@ components: old: '{}' id: 6 applicationId: 359 - userId: 6 + userId: 388 entity: /v1/applications/359/campaigns/6727 + managementKeyId: 3 hasMore: true - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer hasMore: type: boolean @@ -25443,24 +29040,25 @@ components: type: array required: - data - inline_response_200_33: + inline_response_200_39: example: data: - filter: '{}' accountId: 3886 created: 2020-06-10T09:05:27.993483Z id: 6 - userId: 6 + userId: 388 entity: Coupon - filter: '{}' accountId: 3886 created: 2020-06-10T09:05:27.993483Z id: 6 - userId: 6 + userId: 388 entity: Coupon - totalResultSize: 0 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25469,34 +29067,41 @@ components: required: - data - totalResultSize - inline_response_200_34: + inline_response_200_40: example: data: - accountId: 3886 created: 2020-06-10T09:05:27.993483Z - campaignGroupID: 6 + campaignGroupID: 3 members: - - 1 - - 1 - name: name + - 48 + - 562 + - 475 + - 18 + name: Campaign Reviewer modified: 2021-09-12T10:12:42Z - description: description + description: Reviews the campaigns id: 6 - acl: '{}' + acl: + Role: 127 - accountId: 3886 created: 2020-06-10T09:05:27.993483Z - campaignGroupID: 6 + campaignGroupID: 3 members: - - 1 - - 1 - name: name + - 48 + - 562 + - 475 + - 18 + name: Campaign Reviewer modified: 2021-09-12T10:12:42Z - description: description + description: Reviews the campaigns id: 6 - acl: '{}' - totalResultSize: 0 + acl: + Role: 127 + totalResultSize: 1 properties: totalResultSize: + example: 1 type: integer data: items: @@ -25505,17 +29110,31 @@ components: required: - data - totalResultSize + RoleV2Permissions_roles: + properties: + applications: + additionalProperties: + $ref: '#/components/schemas/RoleV2ApplicationDetails' + type: object + loyaltyPrograms: + additionalProperties: + type: string + type: object + campaignAccessGroups: + additionalProperties: + type: string + type: object securitySchemes: api_key_v1: description: | - To authenticate in order to use the Integration API, generate an API key in the Campaign Manager + To authenticate to use the Integration API, generate an API key in the Campaign Manager then prefix it with `ApiKey-v1`. To generate an API key: - 1. Log on to the Campaign Manager and open the Application of your choice, or create one. + 1. Log into the Campaign Manager and open the Application of your choice, or create one. 1. Click **Settings** > **Developer settings**. - 1. Click **Create API Key** and give it a title and an expiration date, then click **Create API Key**. + 1. Click **Create API Key** and give it a name and an expiration date, then click **Create API Key**. You can now use the API key in the HTTP header, prefixing it with `ApiKey-v1`: @@ -25523,7 +29142,7 @@ components: Authorization: ApiKey-v1 dbc644d33aa74d582bd9479c59e16f970fe13bf3 ``` - Or use it inside [an SDK](/docs/dev/sdks/overview), for example, with the JAVA SDK: + Or use it inside [an SDK](https://docs.talon.one/docs/dev/sdks/overview), for example, with the JAVA SDK: ``` iApi.getApiClient().setApiKeyPrefix("ApiKey-v1"); @@ -25534,7 +29153,9 @@ components: type: apiKey manager_auth: description: | - To authenticate in order to use the Management API: + This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API. + + To create the token: 1. Get a bearer token by calling the [createSession](#operation/createSession) endpoint. 1. Use the `token` property of the response in the HTTP header of your next queries: @@ -25542,6 +29163,31 @@ components: 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. + + **Note:** We recommend that you use a [Management API key](https://docs.talon.one/management-api#section/Authentication/management_key) + instead of a bearer token. + in: header + name: Authorization + type: apiKey + management_key: + description: | + The API key authentication gives you access to the endpoints selected by the admin who created the key. + Using an API key is the recommended authentication method. + + The key must be generated by an admin and given to the developer that requires it: + + 1. Log into the Campaign Manager and click **Account** > **Management API keys**. + 1. Click **Create Key** and give it a name. + 1. Set an expiration date. + 1. Choose the endpoints the key should give access to. + 1. Click **Create Key**. + 1. Share it with your developer. + + The developer can now use the API key in the HTTP header, prefixing it with `ManagementKey-v1`: + + ``` + Authorization: ManagementKey-v1 bd9479c59e16f9dbc644d33aa74d58270fe13bf3 + ``` in: header name: Authorization type: apiKey diff --git a/api_integration.go b/api_integration.go index 4efb44f6..0abc4ef4 100644 --- a/api_integration.go +++ b/api_integration.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -41,6 +41,8 @@ func (r apiCreateAudienceV2Request) Body(body NewAudience) apiCreateAudienceV2Re CreateAudienceV2 Create audience Create an audience. The audience can be created directly from scratch or can come from third party platforms. +**Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). + 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. @@ -218,28 +220,39 @@ func (r apiCreateCouponReservationRequest) Body(body CouponReservations) apiCrea /* CreateCouponReservation Create coupon reservation Create a coupon reservation for specified customer profiles on the specified coupon. +You can also create a reservation via the Campaign Manager using the +[Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer -with the [List customer data endpoint](/integration-api/#operation/getCustomerInventory). +with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. -If a coupon gets created for a specific user, it will automatically show up in their coupons. +If a coupon gets created for a specific user, it will automatically appear in their coupons. 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 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. +the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. 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. +
+ +

Important

+ + This endpoint creates a **soft** reservation. _Any_ customer + can use a reserved coupon code and proceed to checkout. + + To create a hard reservation, you can: + - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, + - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) + endpoint setting the `recipientsIntegrationId` property or, + - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). + +
+ +To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. + - @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. @@ -845,6 +858,8 @@ Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. +**Note:** Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-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). @@ -1129,7 +1144,7 @@ Delete all attributes on the customer profile and on entities that reference thi **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 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). + - @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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. @return apiDeleteCustomerDataRequest */ @@ -1225,132 +1240,1029 @@ func (r apiDeleteCustomerDataRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, newErr } newErr.model = v - return localVarHTTPResponse, newErr + 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 + } + + return localVarHTTPResponse, nil +} + +type apiGetCustomerInventoryRequest struct { + ctx _context.Context + apiService *IntegrationApiService + integrationId string + profile *bool + referrals *bool + coupons *bool + loyalty *bool + giveaways *bool +} + +func (r apiGetCustomerInventoryRequest) Profile(profile bool) apiGetCustomerInventoryRequest { + r.profile = &profile + return r +} + +func (r apiGetCustomerInventoryRequest) Referrals(referrals bool) apiGetCustomerInventoryRequest { + r.referrals = &referrals + return r +} + +func (r apiGetCustomerInventoryRequest) Coupons(coupons bool) apiGetCustomerInventoryRequest { + r.coupons = &coupons + return r +} + +func (r apiGetCustomerInventoryRequest) Loyalty(loyalty bool) apiGetCustomerInventoryRequest { + r.loyalty = &loyalty + return r +} + +func (r apiGetCustomerInventoryRequest) Giveaways(giveaways bool) apiGetCustomerInventoryRequest { + r.giveaways = &giveaways + return r +} + +/* +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, loyalty cards and reserved coupons. +Reserved coupons also include redeemed coupons. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. + +@return apiGetCustomerInventoryRequest +*/ +func (a *IntegrationApiService) GetCustomerInventory(ctx _context.Context, integrationId string) apiGetCustomerInventoryRequest { + return apiGetCustomerInventoryRequest{ + apiService: a, + ctx: ctx, + integrationId: integrationId, + } +} + +/* +Execute executes the request + + @return CustomerInventory +*/ +func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue CustomerInventory + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetCustomerInventory") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/customer_profiles/{integrationId}/inventory" + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.profile != nil { + localVarQueryParams.Add("profile", parameterToString(*r.profile, "")) + } + if r.referrals != nil { + localVarQueryParams.Add("referrals", parameterToString(*r.referrals, "")) + } + if r.coupons != nil { + localVarQueryParams.Add("coupons", parameterToString(*r.coupons, "")) + } + if r.loyalty != nil { + localVarQueryParams.Add("loyalty", parameterToString(*r.loyalty, "")) + } + if r.giveaways != nil { + localVarQueryParams.Add("giveaways", parameterToString(*r.giveaways, "")) + } + // 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 CustomerInventory + 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 apiGetCustomerSessionRequest struct { + ctx _context.Context + apiService *IntegrationApiService + customerSessionId string +} + +/* +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 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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. + +@return apiGetCustomerSessionRequest +*/ +func (a *IntegrationApiService) GetCustomerSession(ctx _context.Context, customerSessionId string) apiGetCustomerSessionRequest { + return apiGetCustomerSessionRequest{ + apiService: a, + ctx: ctx, + customerSessionId: customerSessionId, + } +} + +/* +Execute executes the request + + @return IntegrationCustomerSessionResponse +*/ +func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue IntegrationCustomerSessionResponse + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetCustomerSession") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + 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{} + 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 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() + 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 apiGetLoyaltyBalancesRequest struct { + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + integrationId string + endDate *time.Time +} + +func (r apiGetLoyaltyBalancesRequest) EndDate(endDate time.Time) apiGetLoyaltyBalancesRequest { + r.endDate = &endDate + return r +} + +/* +GetLoyaltyBalances Get customer's loyalty points +Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. +You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. + +Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. + +**Note:** For more information, see [our documentation on managing loyalty data](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-data#obtaining-the-loyalty-balances-of-a-customer). + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @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 apiGetLoyaltyBalancesRequest +*/ +func (a *IntegrationApiService) GetLoyaltyBalances(ctx _context.Context, loyaltyProgramId int32, integrationId string) apiGetLoyaltyBalancesRequest { + return apiGetLoyaltyBalancesRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, + } +} + +/* +Execute executes the request + + @return LoyaltyBalances +*/ +func (r apiGetLoyaltyBalancesRequest) Execute() (LoyaltyBalances, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyBalances + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyBalances") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances" + 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.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) + } + // 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 LoyaltyBalances + 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 apiGetLoyaltyCardBalancesRequest struct { + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + loyaltyCardId string + endDate *time.Time +} + +func (r apiGetLoyaltyCardBalancesRequest) EndDate(endDate time.Time) apiGetLoyaltyCardBalancesRequest { + r.endDate = &endDate + return r +} + +/* +GetLoyaltyCardBalances Get card's point balances +Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. +If no filtering options are applied, all loyalty balances for the given loyalty card are returned. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + +@return apiGetLoyaltyCardBalancesRequest +*/ +func (a *IntegrationApiService) GetLoyaltyCardBalances(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiGetLoyaltyCardBalancesRequest { + return apiGetLoyaltyCardBalancesRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, + } +} + +/* +Execute executes the request + + @return LoyaltyBalances +*/ +func (r apiGetLoyaltyCardBalancesRequest) Execute() (LoyaltyBalances, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyBalances + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyCardBalances") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") + } + + if r.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) + } + // 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 LoyaltyBalances + 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 apiGetLoyaltyCardTransactionsRequest struct { + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + loyaltyCardId string + subledgerId *string + startDate *time.Time + endDate *time.Time + pageSize *int32 + skip *int32 +} + +func (r apiGetLoyaltyCardTransactionsRequest) SubledgerId(subledgerId string) apiGetLoyaltyCardTransactionsRequest { + r.subledgerId = &subledgerId + return r +} + +func (r apiGetLoyaltyCardTransactionsRequest) StartDate(startDate time.Time) apiGetLoyaltyCardTransactionsRequest { + r.startDate = &startDate + return r +} + +func (r apiGetLoyaltyCardTransactionsRequest) EndDate(endDate time.Time) apiGetLoyaltyCardTransactionsRequest { + r.endDate = &endDate + return r +} + +func (r apiGetLoyaltyCardTransactionsRequest) PageSize(pageSize int32) apiGetLoyaltyCardTransactionsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetLoyaltyCardTransactionsRequest) Skip(skip int32) apiGetLoyaltyCardTransactionsRequest { + r.skip = &skip + return r +} + +/* +GetLoyaltyCardTransactions List card's transactions +Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. +If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + +@return apiGetLoyaltyCardTransactionsRequest +*/ +func (a *IntegrationApiService) GetLoyaltyCardTransactions(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiGetLoyaltyCardTransactionsRequest { + return apiGetLoyaltyCardTransactionsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, + } +} + +/* +Execute executes the request + + @return InlineResponse2001 +*/ +func (r apiGetLoyaltyCardTransactionsRequest) Execute() (InlineResponse2001, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse2001 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyCardTransactions") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") + } + + if r.subledgerId != nil { + localVarQueryParams.Add("subledgerId", parameterToString(*r.subledgerId, "")) + } + if r.startDate != nil { + localVarQueryParams.Add("startDate", parameterToString(*r.startDate, "")) + } + 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{} + + // 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 InlineResponse2001 + 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 localVarHTTPResponse, newErr + return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v } - return localVarHTTPResponse, newErr + 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 apiGetCustomerInventoryRequest struct { - ctx _context.Context - apiService *IntegrationApiService - integrationId string - profile *bool - referrals *bool - coupons *bool - loyalty *bool - giveaways *bool - loyaltyProjectionEndDate *time.Time + return localVarReturnValue, localVarHTTPResponse, nil } -func (r apiGetCustomerInventoryRequest) Profile(profile bool) apiGetCustomerInventoryRequest { - r.profile = &profile - return r +type apiGetLoyaltyProgramProfileTransactionsRequest struct { + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + integrationId string + subledgerId *string + startDate *time.Time + endDate *time.Time + pageSize *int32 + skip *int32 } -func (r apiGetCustomerInventoryRequest) Referrals(referrals bool) apiGetCustomerInventoryRequest { - r.referrals = &referrals +func (r apiGetLoyaltyProgramProfileTransactionsRequest) SubledgerId(subledgerId string) apiGetLoyaltyProgramProfileTransactionsRequest { + r.subledgerId = &subledgerId return r } -func (r apiGetCustomerInventoryRequest) Coupons(coupons bool) apiGetCustomerInventoryRequest { - r.coupons = &coupons +func (r apiGetLoyaltyProgramProfileTransactionsRequest) StartDate(startDate time.Time) apiGetLoyaltyProgramProfileTransactionsRequest { + r.startDate = &startDate return r } -func (r apiGetCustomerInventoryRequest) Loyalty(loyalty bool) apiGetCustomerInventoryRequest { - r.loyalty = &loyalty +func (r apiGetLoyaltyProgramProfileTransactionsRequest) EndDate(endDate time.Time) apiGetLoyaltyProgramProfileTransactionsRequest { + r.endDate = &endDate return r } -func (r apiGetCustomerInventoryRequest) Giveaways(giveaways bool) apiGetCustomerInventoryRequest { - r.giveaways = &giveaways +func (r apiGetLoyaltyProgramProfileTransactionsRequest) PageSize(pageSize int32) apiGetLoyaltyProgramProfileTransactionsRequest { + r.pageSize = &pageSize return r } -func (r apiGetCustomerInventoryRequest) LoyaltyProjectionEndDate(loyaltyProjectionEndDate time.Time) apiGetCustomerInventoryRequest { - r.loyaltyProjectionEndDate = &loyaltyProjectionEndDate +func (r apiGetLoyaltyProgramProfileTransactionsRequest) Skip(skip int32) apiGetLoyaltyProgramProfileTransactionsRequest { + r.skip = &skip return r } /* -GetCustomerInventory List customer data -Return the customer inventory regarding entities referencing this customer profile's `integrationId`. +GetLoyaltyProgramProfileTransactions List customer's loyalty transactions +Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. -Typical entities returned are: customer profile information, referral codes, loyalty points and reserved coupons. -Reserved coupons also include redeemed coupons. +You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. -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. +**Note:** To retrieve all loyalty program transaction logs in a given loyalty program, +use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @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). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @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 apiGetCustomerInventoryRequest +@return apiGetLoyaltyProgramProfileTransactionsRequest */ -func (a *IntegrationApiService) GetCustomerInventory(ctx _context.Context, integrationId string) apiGetCustomerInventoryRequest { - return apiGetCustomerInventoryRequest{ - apiService: a, - ctx: ctx, - integrationId: integrationId, +func (a *IntegrationApiService) GetLoyaltyProgramProfileTransactions(ctx _context.Context, loyaltyProgramId int32, integrationId string) apiGetLoyaltyProgramProfileTransactionsRequest { + return apiGetLoyaltyProgramProfileTransactionsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, } } /* Execute executes the request - @return CustomerInventory + @return InlineResponse2002 */ -func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramProfileTransactionsRequest) Execute() (InlineResponse2002, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerInventory + localVarReturnValue InlineResponse2002 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetCustomerInventory") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyProgramProfileTransactions") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/customer_profiles/{integrationId}/inventory" + 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.profile != nil { - localVarQueryParams.Add("profile", parameterToString(*r.profile, "")) + if r.subledgerId != nil { + localVarQueryParams.Add("subledgerId", parameterToString(*r.subledgerId, "")) } - if r.referrals != nil { - localVarQueryParams.Add("referrals", parameterToString(*r.referrals, "")) - } - if r.coupons != nil { - localVarQueryParams.Add("coupons", parameterToString(*r.coupons, "")) + if r.startDate != nil { + localVarQueryParams.Add("startDate", parameterToString(*r.startDate, "")) } - if r.loyalty != nil { - localVarQueryParams.Add("loyalty", parameterToString(*r.loyalty, "")) + if r.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) } - if r.giveaways != nil { - localVarQueryParams.Add("giveaways", parameterToString(*r.giveaways, "")) + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } - if r.loyaltyProjectionEndDate != nil { - localVarQueryParams.Add("loyaltyProjectionEndDate", parameterToString(*r.loyaltyProjectionEndDate, "")) + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -1405,7 +2317,17 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerInventory + 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() @@ -1448,56 +2370,55 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerSessionRequest struct { - ctx _context.Context - apiService *IntegrationApiService - customerSessionId string +type apiGetReservedCustomersRequest struct { + ctx _context.Context + apiService *IntegrationApiService + couponValue string } /* -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: +GetReservedCustomers List customers that have this coupon reserved +Return all customers that have this coupon marked as reserved. -- [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) -- [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) +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](https://docs.talon.one/management-api#operation/createCoupons) or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoints. - @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). + - @param couponValue The code of the coupon. -@return apiGetCustomerSessionRequest +@return apiGetReservedCustomersRequest */ -func (a *IntegrationApiService) GetCustomerSession(ctx _context.Context, customerSessionId string) apiGetCustomerSessionRequest { - return apiGetCustomerSessionRequest{ - apiService: a, - ctx: ctx, - customerSessionId: customerSessionId, +func (a *IntegrationApiService) GetReservedCustomers(ctx _context.Context, couponValue string) apiGetReservedCustomersRequest { + return apiGetReservedCustomersRequest{ + apiService: a, + ctx: ctx, + couponValue: couponValue, } } /* Execute executes the request - @return IntegrationCustomerSessionResponse + @return InlineResponse200 */ -func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionResponse, *_nethttp.Response, error) { +func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue IntegrationCustomerSessionResponse + localVarReturnValue InlineResponse200 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetCustomerSession") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetReservedCustomers") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v2/customer_sessions/{customerSessionId}" - localVarPath = strings.Replace(localVarPath, "{"+"customerSessionId"+"}", _neturl.QueryEscape(parameterToString(r.customerSessionId, "")), -1) + 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{} @@ -1556,7 +2477,7 @@ func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionRespo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v IntegrationCustomerSessionResponse + var v InlineResponse200 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1566,7 +2487,7 @@ func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionRespo return localVarReturnValue, localVarHTTPResponse, newErr } if localVarHTTPResponse.StatusCode == 400 { - var v ErrorResponse + var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1583,6 +2504,16 @@ func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionRespo 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 } @@ -1599,99 +2530,83 @@ func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionRespo return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyTransactionsRequest struct { +type apiLinkLoyaltyCardToProfileRequest struct { ctx _context.Context apiService *IntegrationApiService loyaltyProgramId int32 - integrationId string - startDate *time.Time - endDate *time.Time - pageSize *int32 - skip *int32 -} - -func (r apiGetLoyaltyTransactionsRequest) StartDate(startDate time.Time) apiGetLoyaltyTransactionsRequest { - r.startDate = &startDate - return r + loyaltyCardId string + body *LoyaltyCardRegistration } -func (r apiGetLoyaltyTransactionsRequest) EndDate(endDate time.Time) apiGetLoyaltyTransactionsRequest { - r.endDate = &endDate +func (r apiLinkLoyaltyCardToProfileRequest) Body(body LoyaltyCardRegistration) apiLinkLoyaltyCardToProfileRequest { + r.body = &body return r } -func (r apiGetLoyaltyTransactionsRequest) PageSize(pageSize int32) apiGetLoyaltyTransactionsRequest { - r.pageSize = &pageSize - return r -} +/* +LinkLoyaltyCardToProfile Link customer profile to card +[Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect +and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). +They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. -func (r apiGetLoyaltyTransactionsRequest) Skip(skip int32) apiGetLoyaltyTransactionsRequest { - r.skip = &skip - return r -} +Link a customer profile to a given loyalty card for the card to be set as **Registered**. +This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). -/* -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. +**Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @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. + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. -@return apiGetLoyaltyTransactionsRequest +@return apiLinkLoyaltyCardToProfileRequest */ -func (a *IntegrationApiService) GetLoyaltyTransactions(ctx _context.Context, loyaltyProgramId int32, integrationId string) apiGetLoyaltyTransactionsRequest { - return apiGetLoyaltyTransactionsRequest{ +func (a *IntegrationApiService) LinkLoyaltyCardToProfile(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiLinkLoyaltyCardToProfileRequest { + return apiLinkLoyaltyCardToProfileRequest{ apiService: a, ctx: ctx, loyaltyProgramId: loyaltyProgramId, - integrationId: integrationId, + loyaltyCardId: loyaltyCardId, } } /* Execute executes the request - @return InlineResponse2001 + @return LoyaltyCard */ -func (r apiGetLoyaltyTransactionsRequest) Execute() (InlineResponse2001, *_nethttp.Response, error) { +func (r apiLinkLoyaltyCardToProfileRequest) Execute() (LoyaltyCard, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2001 + localVarReturnValue LoyaltyCard ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyTransactions") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.LinkLoyaltyCardToProfile") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions" + localVarPath := localBasePath + "/v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile" localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.startDate != nil { - localVarQueryParams.Add("startDate", parameterToString(*r.startDate, "")) - } - if r.endDate != nil { - localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) - } - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + + 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) @@ -1707,6 +2622,8 @@ func (r apiGetLoyaltyTransactionsRequest) Execute() (InlineResponse2001, *_netht 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 { @@ -1743,7 +2660,7 @@ func (r apiGetLoyaltyTransactionsRequest) Execute() (InlineResponse2001, *_netht error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2001 + var v LoyaltyCard err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1796,55 +2713,82 @@ func (r apiGetLoyaltyTransactionsRequest) Execute() (InlineResponse2001, *_netht return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetReservedCustomersRequest struct { - ctx _context.Context - apiService *IntegrationApiService - couponValue string +type apiReopenCustomerSessionRequest struct { + ctx _context.Context + apiService *IntegrationApiService + customerSessionId string } /* -GetReservedCustomers List customers that have this coupon reserved -Return all customers that have this coupon marked as reserved. +ReopenCustomerSession Reopen customer session +Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). +For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. +A reopen session is treated like a standard open session. -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. +When reopening a session: +- The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. +- The session state is updated to `open`. +- Modified budgets and triggered effects when the session was closed are rolled back except for the list below. + +
+ + Effects and budgets unimpacted by a session reopening +
+

The following effects and budgets are left the way they were once the session was originally closed:

+
    +
  • Add free item effect
    • +
  • Any not pending pending loyalty points.
    • +
  • Award giveaway
    • +
  • Coupon and referral creation
    • +
  • Coupon reservation
    • +
  • Custom effect
    • +
  • Update attribute value
    • +
  • Update cart item attribute value
    • +
+
+ +

To see an example of roll back, see the Cancelling a session with campaign budgets tutorial.

+
+ +**Note:** If your order workflow requires you to create a new session instead of reopening a session, use the +[Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel +a closed session and create a new one. - @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. + - @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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. -@return apiGetReservedCustomersRequest +@return apiReopenCustomerSessionRequest */ -func (a *IntegrationApiService) GetReservedCustomers(ctx _context.Context, couponValue string) apiGetReservedCustomersRequest { - return apiGetReservedCustomersRequest{ - apiService: a, - ctx: ctx, - couponValue: couponValue, +func (a *IntegrationApiService) ReopenCustomerSession(ctx _context.Context, customerSessionId string) apiReopenCustomerSessionRequest { + return apiReopenCustomerSessionRequest{ + apiService: a, + ctx: ctx, + customerSessionId: customerSessionId, } } /* Execute executes the request - @return InlineResponse200 + @return ReopenSessionResponse */ -func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp.Response, error) { +func (r apiReopenCustomerSessionRequest) Execute() (ReopenSessionResponse, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPut localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse200 + localVarReturnValue ReopenSessionResponse ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetReservedCustomers") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.ReopenCustomerSession") 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}/reopen" + localVarPath = strings.Replace(localVarPath, "{"+"customerSessionId"+"}", _neturl.QueryEscape(parameterToString(r.customerSessionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1903,7 +2847,7 @@ func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse200 + var v ReopenSessionResponse err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1913,7 +2857,7 @@ func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp. return localVarReturnValue, localVarHTTPResponse, newErr } if localVarHTTPResponse.StatusCode == 400 { - var v ErrorResponseWithStatus + var v ErrorResponse err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1930,16 +2874,6 @@ func (r apiGetReservedCustomersRequest) Execute() (InlineResponse200, *_nethttp. 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 } @@ -1980,7 +2914,7 @@ 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) +Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled for the Application. **Note:** This will roll back any effects associated with these cart items. For more information, see @@ -1988,7 +2922,7 @@ is enabled for the Application. 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). + - @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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. @return apiReturnCartItemsRequest */ @@ -2154,7 +3088,7 @@ Perform one or more of the following sync actions on this cart item catalog, up - 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). +**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 @@ -2162,7 +3096,7 @@ Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools 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: +The `filters` array contains an object with 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. @@ -2208,7 +3142,8 @@ Synchronization actions are sent as `PUT` requests. See the structure for each a "type": "shoe" }, "replaceIfExists": true, - "sku": "SKU1241028" + "sku": "SKU1241028", + "price": 100 }, "type": "ADD" } @@ -2357,7 +3292,7 @@ Synchronization actions are sent as `PUT` requests. See the structure for each a - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param catalogId + - @param catalogId The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. @return apiSyncCatalogRequest */ @@ -2527,19 +3462,21 @@ func (r apiTrackEventRequest) Dry(dry bool) apiTrackEventRequest { /* TrackEvent Track event -**Important:** This endpoint is **DEPRECATED**. Use [Track Event V2](https://docs.talon.one/integration-api/#tag/Events/operation/trackEventV2) instead. +
-
+

Deprecation warning

+

This endpoint is DEPRECATED and will be sunset on March 31st 2023. + Use Track Event V2 instead.

+

See Migrating to V2.

- 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). +Triggers a custom event in a customer session. You can then check this event in your rules. - 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. +Before using this endpoint, create your event as a custom attribute of type `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(). @@ -2718,9 +3655,9 @@ func (r apiTrackEventV2Request) Dry(dry bool) apiTrackEventV2Request { /* TrackEventV2 Track event V2 -Triggers a custom event. You can then check this event in your rules. +Triggers a custom event. You can build a condition around this event in your rules. -Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create +Talon.One offers a set of [built-in events](https://docs.talon.one/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. @@ -2729,7 +3666,10 @@ See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incen **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). +See the [Developer docs](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event). + +When you successfully sent an event to Talon.One, you can list received events in the +**Events** view in the Campaign Manager. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -3028,7 +3968,7 @@ func (r apiUpdateAudienceV2Request) Body(body UpdateAudience) apiUpdateAudienceV 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. -To update the audience's members, use the [Update customer profile endpoint](#tag/Customer-profiles/operation/updateCustomerProfileV2). +To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. - @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). @@ -3343,7 +4283,7 @@ func (r apiUpdateCustomerProfileV2Request) Dry(dry bool) apiUpdateCustomerProfil /* UpdateCustomerProfileV2 Update customer profile -Update or create a [Customer Profile](/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. +Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. @@ -3537,13 +4477,13 @@ func (r apiUpdateCustomerProfilesV2Request) Silent(silent string) apiUpdateCusto /* UpdateCustomerProfilesV2 Update multiple customer profiles -Update (or create) up to 1000 [customer profiles](/docs/dev/concepts/entities#customer-profile) in 1 request. +Update (or create) up to 1000 [customer profiles](https://docs.talon.one/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). +A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -3707,46 +4647,44 @@ func (r apiUpdateCustomerSessionV2Request) Dry(dry bool) apiUpdateCustomerSessio /* UpdateCustomerSessionV2 Update customer session -Update or create a [customer session](/docs/dev/concepts/entities#customer-session). -For example, use this endpoint to share the content of a customer's cart with Talon.One and to check which -promotion rules apply. +Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). +The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. +For example, use this endpoint to share the contents of a customer's cart with Talon.One. -**Note:** The currency for the session and the cart items in the session is the same as the +**Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### 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: - -- Track multiple independent sessions or, -- Use the same session across all of them. - -You should share sessions when application access points share other state, such as the user's cart. -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 the [documentation](/docs/dev/concepts/entities#customer-session). +To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session) +and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - 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. +- A profile can be linked to simultaneous sessions in different Applications. Either: + - Use unique session integration IDs or, + - Use the same session integration ID across all of the Applications. -**Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. +**Note:** If the specified profile does not exist, an empty profile is **created automatically**. +You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).

Performance tips

- 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). + Updating a customer session returns a response with the new 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 introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). +- 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 `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). + - @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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. @return apiUpdateCustomerSessionV2Request */ diff --git a/api_management.go b/api_management.go index 1f8f838d..39150c90 100644 --- a/api_management.go +++ b/api_management.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -26,25 +26,193 @@ var ( // ManagementApiService ManagementApi service type ManagementApiService service +type apiAddLoyaltyCardPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string + body *AddLoyaltyPoints +} + +func (r apiAddLoyaltyCardPointsRequest) Body(body AddLoyaltyPoints) apiAddLoyaltyCardPointsRequest { + r.body = &body + return r +} + +/* +AddLoyaltyCardPoints Add points to card +Add points to the given loyalty card in the specified card-based loyalty program. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + +@return apiAddLoyaltyCardPointsRequest +*/ +func (a *ManagementApiService) AddLoyaltyCardPoints(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiAddLoyaltyCardPointsRequest { + return apiAddLoyaltyCardPointsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, + } +} + +/* +Execute executes the request +*/ +func (r apiAddLoyaltyCardPointsRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.AddLoyaltyCardPoints") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if strlen(r.loyaltyCardId) > 108 { + return nil, reportError("loyaltyCardId must have less than 108 elements") + } + + if r.body == nil { + return 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 + } + } + } + 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, + } + 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 + } + + return localVarHTTPResponse, nil +} + type apiAddLoyaltyPointsRequest struct { ctx _context.Context apiService *ManagementApiService loyaltyProgramId string integrationId string - body *LoyaltyPoints + body *AddLoyaltyPoints } -func (r apiAddLoyaltyPointsRequest) Body(body LoyaltyPoints) apiAddLoyaltyPointsRequest { +func (r apiAddLoyaltyPointsRequest) Body(body AddLoyaltyPoints) apiAddLoyaltyPointsRequest { r.body = &body return r } /* -AddLoyaltyPoints Add points in loyalty program for given customer +AddLoyaltyPoints Add points to customer profile Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the -[Update customer session](/integration-api/#operation/updateCustomerSessionV2). +[Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - @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. @@ -123,6 +291,20 @@ func (r apiAddLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -193,8 +375,8 @@ func (r apiCopyCampaignToApplicationsRequest) Body(body CampaignCopy) apiCopyCam } /* -CopyCampaignToApplications Copy the campaign into the specified application -Copy the campaign into all specified application. +CopyCampaignToApplications Copy the campaign into the specified Application +Copy the campaign into all specified Applications. - @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. @@ -213,16 +395,16 @@ func (a *ManagementApiService) CopyCampaignToApplications(ctx _context.Context, /* Execute executes the request - @return InlineResponse2003 + @return InlineResponse2004 */ -func (r apiCopyCampaignToApplicationsRequest) Execute() (InlineResponse2003, *_nethttp.Response, error) { +func (r apiCopyCampaignToApplicationsRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2003 + localVarReturnValue InlineResponse2004 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CopyCampaignToApplications") @@ -275,6 +457,20 @@ func (r apiCopyCampaignToApplicationsRequest) Execute() (InlineResponse2003, *_n } } } + 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 @@ -297,7 +493,7 @@ func (r apiCopyCampaignToApplicationsRequest) Execute() (InlineResponse2003, *_n error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2003 + var v InlineResponse2004 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -408,6 +604,20 @@ func (r apiCreateAccountCollectionRequest) Execute() (Collection, *_nethttp.Resp } } } + 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 @@ -496,7 +706,7 @@ func (r apiCreateAdditionalCostRequest) Body(body NewAdditionalCost) apiCreateAd /* CreateAdditionalCost Create additional cost -Create an [additional cost](/docs/product/account/dev-tools/managing-additional-costs/). +Create an [additional cost](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). These additional costs are shared across all applications in your account, and are never required. @@ -574,6 +784,20 @@ func (r apiCreateAdditionalCostRequest) Execute() (AccountAdditionalCost, *_neth } } } + 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 @@ -632,15 +856,18 @@ func (r apiCreateAttributeRequest) Body(body NewAttribute) apiCreateAttributeReq /* 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, +Create a _custom attribute_ in this account. +[Custom attributes](https://docs.talon.one/docs/dev/concepts/attributes) allow you +to add data to Talon.One domain entities 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, +These attributes can then be given values when creating/updating these entities, 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. +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(). @@ -716,6 +943,20 @@ func (r apiCreateAttributeRequest) Execute() (Attribute, *_nethttp.Response, err } } } + 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 @@ -858,6 +1099,20 @@ func (r apiCreateCampaignFromTemplateRequest) Execute() (CreateTemplateCampaignR } } } + 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 @@ -999,6 +1254,20 @@ func (r apiCreateCollectionRequest) Execute() (Collection, *_nethttp.Response, e } } } + 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 @@ -1084,16 +1353,16 @@ func (a *ManagementApiService) CreateCoupons(ctx _context.Context, applicationId /* Execute executes the request - @return InlineResponse2006 + @return InlineResponse2007 */ -func (r apiCreateCouponsRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { +func (r apiCreateCouponsRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2006 + localVarReturnValue InlineResponse2007 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCoupons") @@ -1149,6 +1418,20 @@ func (r apiCreateCouponsRequest) Execute() (InlineResponse2006, *_nethttp.Respon } } } + 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 @@ -1171,7 +1454,7 @@ func (r apiCreateCouponsRequest) Execute() (InlineResponse2006, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2006 + var v InlineResponse2007 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1210,7 +1493,10 @@ func (r apiCreateCouponsAsyncRequest) Body(body NewCouponCreationJob) apiCreateC /* CreateCouponsAsync Create coupons asynchronously -Create any number of coupons from 20,001 to 5,000,000. +Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. + +If you want to create less than 20,001 coupons, you can use the [Create coupons](https://docs.talon.one/management-api#tag/Coupons/operation/createCoupons) endpoint. + - @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. @@ -1291,6 +1577,20 @@ func (r apiCreateCouponsAsyncRequest) Execute() (AsyncCouponCreationResponse, *_ } } } + 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 @@ -1376,16 +1676,16 @@ func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.C /* Execute executes the request - @return InlineResponse2006 + @return InlineResponse2007 */ -func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { +func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2006 + localVarReturnValue InlineResponse2007 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsForMultipleRecipients") @@ -1441,6 +1741,20 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 } } } + 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 @@ -1463,7 +1777,7 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2006 + var v InlineResponse2007 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1500,9 +1814,19 @@ func (r apiCreateNotificationWebhookRequest) Body(body NewNotificationWebhook) a } /* -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). +CreateNotificationWebhook Create notification about campaign-related changes +Create a +[notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + +A notification about campaign-related changes is different from regular webhooks +in that it is Application-scoped and has a predefined payload. +[Regular webhooks](https://docs.talon.one/docs/dev/getting-started/webhooks) have user-definable payloads. + +**Tip:** + +- You can create these notifications using the Campaign Manager. +See [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). +- You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_created/post). - @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. @@ -1581,6 +1905,20 @@ func (r apiCreateNotificationWebhookRequest) Execute() (NotificationWebhook, *_n } } } + 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 @@ -1641,6 +1979,8 @@ func (r apiCreatePasswordRecoveryEmailRequest) Body(body NewPasswordEmail) apiCr CreatePasswordRecoveryEmail Request a password reset Send an email with a password recovery link to the email address of an existing account. +**Note:** The password recovery link expires 30 minutes after this endpoint is triggered. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return apiCreatePasswordRecoveryEmailRequest @@ -1715,6 +2055,20 @@ func (r apiCreatePasswordRecoveryEmailRequest) Execute() (NewPasswordEmail, *_ne } } } + 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 @@ -1781,8 +2135,13 @@ 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. +
+ +

Granular API key

+ Instead of using a session, you can also use the Management API key feature + in the Campaign Manager to decide which endpoints can be used with a given key. + +
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -1858,6 +2217,20 @@ func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) } } } + 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 @@ -1903,54 +2276,73 @@ func (r apiCreateSessionRequest) Execute() (Session, *_nethttp.Response, error) return localVarReturnValue, localVarHTTPResponse, nil } -type apiDeleteAccountCollectionRequest struct { - ctx _context.Context - apiService *ManagementApiService - collectionId int32 +type apiDeductLoyaltyCardPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string + body *DeductLoyaltyPoints +} + +func (r apiDeductLoyaltyCardPointsRequest) Body(body DeductLoyaltyPoints) apiDeductLoyaltyCardPointsRequest { + r.body = &body + return r } /* -DeleteAccountCollection Delete account-level collection -Delete the given account-level collection. +DeductLoyaltyCardPoints Deduct points from card +Deduct points from the given loyalty card in the specified card-based loyalty program. + - @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). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. -@return apiDeleteAccountCollectionRequest +@return apiDeductLoyaltyCardPointsRequest */ -func (a *ManagementApiService) DeleteAccountCollection(ctx _context.Context, collectionId int32) apiDeleteAccountCollectionRequest { - return apiDeleteAccountCollectionRequest{ - apiService: a, - ctx: ctx, - collectionId: collectionId, +func (a *ManagementApiService) DeductLoyaltyCardPoints(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiDeductLoyaltyCardPointsRequest { + return apiDeductLoyaltyCardPointsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, } } /* Execute executes the request */ -func (r apiDeleteAccountCollectionRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeductLoyaltyCardPointsRequest) Execute() (*_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodDelete + localVarHTTPMethod = _nethttp.MethodPut localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteAccountCollection") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeductLoyaltyCardPoints") if err != nil { return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/collections/{collectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if strlen(r.loyaltyCardId) > 108 { + return nil, reportError("loyaltyCardId must have less than 108 elements") + } + + if r.body == nil { + return 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) @@ -1966,6 +2358,22 @@ func (r apiDeleteAccountCollectionRequest) Execute() (*_nethttp.Response, error) 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -2001,6 +2409,26 @@ func (r apiDeleteAccountCollectionRequest) 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")) @@ -2016,35 +2444,32 @@ func (r apiDeleteAccountCollectionRequest) Execute() (*_nethttp.Response, error) return localVarHTTPResponse, nil } -type apiDeleteCampaignRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 +type apiDeleteAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 } /* -DeleteCampaign Delete campaign -Delete the given campaign. +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 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](#operation/listCollectionsInApplication) endpoint. -@return apiDeleteCampaignRequest +@return apiDeleteAccountCollectionRequest */ -func (a *ManagementApiService) DeleteCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiDeleteCampaignRequest { - return apiDeleteCampaignRequest{ - 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, } } /* Execute executes the request */ -func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeleteAccountCollectionRequest) Execute() (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} @@ -2053,14 +2478,13 @@ func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { localVarFileBytes []byte ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteCampaign") + 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}" - 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{} @@ -2076,7 +2500,7 @@ func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2097,6 +2521,20 @@ func (r apiDeleteCampaignRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -2118,44 +2556,175 @@ func (r apiDeleteCampaignRequest) 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 apiDeleteCollectionRequest struct { +type apiDeleteCampaignRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - collectionId int32 } /* -DeleteCollection Delete collection -Delete the given collection. +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 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 +@return apiDeleteCampaignRequest */ -func (a *ManagementApiService) DeleteCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiDeleteCollectionRequest { - return apiDeleteCollectionRequest{ +func (a *ManagementApiService) DeleteCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiDeleteCampaignRequest { + return apiDeleteCampaignRequest{ apiService: a, ctx: ctx, applicationId: applicationId, campaignId: campaignId, - collectionId: collectionId, } } /* Execute executes the request */ -func (r apiDeleteCollectionRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeleteCampaignRequest) 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.DeleteCampaign") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + 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{} + + // 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 + } + } + } + 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 apiDeleteCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 +} + +/* +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(). + - @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](#operation/listCollectionsInApplication) endpoint. + +@return apiDeleteCollectionRequest +*/ +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, + } +} + +/* +Execute executes the request +*/ +func (r apiDeleteCollectionRequest) Execute() (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} @@ -2209,6 +2778,20 @@ func (r apiDeleteCollectionRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -2259,7 +2842,7 @@ 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 + - @param couponId The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. @return apiDeleteCouponRequest */ @@ -2330,6 +2913,20 @@ func (r apiDeleteCouponRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -2555,6 +3152,20 @@ func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -2582,35 +3193,35 @@ func (r apiDeleteCouponsRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } -type apiDeleteNotificationWebhookRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - notificationWebhookId int32 +type apiDeleteLoyaltyCardRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string } /* -DeleteNotificationWebhook Delete notification webhook -Remove the given existing outbound notification webhook. +DeleteLoyaltyCard Delete loyalty card +Delete the given loyalty card. - @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 + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. -@return apiDeleteNotificationWebhookRequest +@return apiDeleteLoyaltyCardRequest */ -func (a *ManagementApiService) DeleteNotificationWebhook(ctx _context.Context, applicationId int32, notificationWebhookId int32) apiDeleteNotificationWebhookRequest { - return apiDeleteNotificationWebhookRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - notificationWebhookId: notificationWebhookId, +func (a *ManagementApiService) DeleteLoyaltyCard(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiDeleteLoyaltyCardRequest { + return apiDeleteLoyaltyCardRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, } } /* Execute executes the request */ -func (r apiDeleteNotificationWebhookRequest) Execute() (*_nethttp.Response, error) { +func (r apiDeleteLoyaltyCardRequest) Execute() (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} @@ -2619,19 +3230,23 @@ func (r apiDeleteNotificationWebhookRequest) Execute() (*_nethttp.Response, erro localVarFileBytes []byte ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteNotificationWebhook") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DeleteLoyaltyCard") 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) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if strlen(r.loyaltyCardId) > 108 { + return nil, reportError("loyaltyCardId must have less than 108 elements") + } + // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -2642,7 +3257,7 @@ func (r apiDeleteNotificationWebhookRequest) Execute() (*_nethttp.Response, erro } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -2663,6 +3278,20 @@ func (r apiDeleteNotificationWebhookRequest) Execute() (*_nethttp.Response, erro } } } + 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 @@ -2684,40 +3313,183 @@ func (r apiDeleteNotificationWebhookRequest) Execute() (*_nethttp.Response, erro 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 } return localVarHTTPResponse, nil } -type apiDeleteReferralRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - referralId string +type apiDeleteNotificationWebhookRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + notificationWebhookId int32 } /* -DeleteReferral Delete referral -Delete the specified referral. +DeleteNotificationWebhook Delete notification about campaign-related changes +Remove the given existing +[notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + - @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 + - @param notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. -@return apiDeleteReferralRequest +@return apiDeleteNotificationWebhookRequest */ -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, - } -} - +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 + } + } + } + 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. + +@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 */ @@ -2775,6 +3547,20 @@ func (r apiDeleteReferralRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -2875,6 +3661,20 @@ func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -2911,8 +3711,11 @@ type apiExportAccountCollectionItemsRequest struct { /* ExportAccountCollectionItems Export account-level collection's items Download a CSV file containing items from an account-level collection. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + - @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). + - @param collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. @return apiExportAccountCollectionItemsRequest */ @@ -2982,6 +3785,20 @@ func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Res } } } + 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 @@ -3058,10 +3875,13 @@ type apiExportCollectionItemsRequest struct { /* ExportCollectionItems Export a collection's items Download a CSV file containing a collection's items. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + - @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). + - @param collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. @return apiExportCollectionItemsRequest */ @@ -3135,6 +3955,20 @@ func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, } } } + 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 @@ -3287,7 +4121,63 @@ func (r apiExportCouponsRequest) CampaignState(campaignState string) apiExportCo /* ExportCoupons Export coupons Download a CSV file containing the coupons that match the given properties. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +The CSV file contains the following columns: + + - `accountid`: The ID of your deployment. + + - `applicationid`: The ID of the Application this coupon is related to. + + - `attributes`: A json object describing _custom_ referral attribute names and their values. + + - `batchid`: The ID of the batch this coupon is part of. + + - `campaignid`: The ID of the campaign this coupon is related to. + + - `counter`: The number of times this coupon has been redeemed. + + - `created`: The creation date of the coupon code. + + - `deleted`: Whether the coupon code is deleted. + + - `deleted_changelogid`: The ID of the delete event in the logs. + + - `discount_counter`: The amount of discount given by this coupon. + + - `discount_limitval`: The maximum discount amount that can be given be this coupon. + + - `expirydate`: The end date in RFC3339 of the code redemption period. + + - `id`: The internal ID of the coupon code. + + - `importid`: The ID of the import job that created this coupon. + + - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. + + - `limits`: The limits set on this coupon. + + - `limitval`: The maximum number of redemptions of this code. + + - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. + Only the customer with this integration ID can redeem the corresponding coupon code. + Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). + + - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). + + - `reservation`: Whether the coupon is reserved. + + - `reservation_counter`: How many times this coupon has been reserved. + + - `reservation_limitval`: The maximum of number of reservations this coupon can have. + + - `startdate`: The start date in RFC3339 of the code redemption period. + + - `value`: The coupon code. + - @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 @@ -3397,6 +4287,20 @@ func (r apiExportCouponsRequest) Execute() (string, *_nethttp.Response, error) { } } } + 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 @@ -3484,6 +4388,28 @@ 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). +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +- `id`: The internal ID of the session. +- `firstsession`: Whether this is a first session. +- `integrationid`: The integration ID of the session. +- `applicationid`: The ID of the Application. +- `profileid`: The internal ID of the customer profile. +- `profileintegrationid`: The integration ID of the customer profile. +- `created`: The timestamp when the session was created. +- `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) of the session. +- `cartitems`: The cart items in the session. +- `discounts`: The discounts in the session. +- `total`: The total value of the session. +- `attributes`: The attributes set in the session. +- `closedat`: Timestamp when the session was closed. +- `cancelledat`: Timestamp when the session was cancelled. +- `referral`: The referral code in the session. +- `identifiers`: The identifiers in the session. +- `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. +- `updated`: Timestamp of the last session update. +- `coupons`: Coupon codes in the session. + - @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. @@ -3570,6 +4496,20 @@ func (r apiExportCustomerSessionsRequest) Execute() (string, *_nethttp.Response, } } } + 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 @@ -3649,6 +4589,26 @@ func (r apiExportEffectsRequest) DateFormat(dateFormat string) apiExportEffectsR ExportEffects Export triggered effects Download a CSV file containing the triggered effects that match the given attributes. +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +The generated file can contain the following columns: + +- `applicationid`: The ID of the Application. +- `campaignid`: The ID of the campaign. +- `couponid`: The ID of the coupon, when applicable to the effect. +- `created`: The timestamp of the effect. +- `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/events). +- `eventid`: The internal ID of the effect. +- `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). +- `profileintegrationid`: The ID of the customer profile, when applicable. +- `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. +- `ruleindex`: The index of the rule. +- `rulesetid`: The ID of the rule set. +- `sessionid`: The internal ID of the session that triggered the effect. +- `profileid`: The internal ID of the customer profile. +- `sessionintegrationid`: The integration ID of the session. +- `total_revenue`: The total revenue. + - @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. @@ -3732,9 +4692,23 @@ func (r apiExportEffectsRequest) Execute() (string, *_nethttp.Response, error) { } } } - 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.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) @@ -3781,11 +4755,23 @@ type apiExportLoyaltyBalanceRequest struct { ctx _context.Context apiService *ManagementApiService loyaltyProgramId string + endDate *time.Time +} + +func (r apiExportLoyaltyBalanceRequest) EndDate(endDate time.Time) apiExportLoyaltyBalanceRequest { + r.endDate = &endDate + return r } /* -ExportLoyaltyBalance Export customer loyalty balance to a CSV file +ExportLoyaltyBalance Export customer loyalty balance to CSV +⚠️ Deprecation notice: Support for requests to this endpoint will end soon. +To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. + Download a CSV file containing the balance of each customer in the loyalty program. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + - @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. @@ -3826,6 +4812,9 @@ func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, e localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -3857,6 +4846,20 @@ func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, e } } } + 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 @@ -3922,46 +4925,45 @@ func (r apiExportLoyaltyBalanceRequest) Execute() (string, *_nethttp.Response, e return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportLoyaltyLedgerRequest struct { +type apiExportLoyaltyBalancesRequest struct { ctx _context.Context apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time loyaltyProgramId string - integrationId string - dateFormat *string + endDate *time.Time } -func (r apiExportLoyaltyLedgerRequest) RangeStart(rangeStart time.Time) apiExportLoyaltyLedgerRequest { - r.rangeStart = &rangeStart +func (r apiExportLoyaltyBalancesRequest) EndDate(endDate time.Time) apiExportLoyaltyBalancesRequest { + r.endDate = &endDate return r } -func (r apiExportLoyaltyLedgerRequest) RangeEnd(rangeEnd time.Time) apiExportLoyaltyLedgerRequest { - r.rangeEnd = &rangeEnd - return r -} +/* +ExportLoyaltyBalances Export customer loyalty balances +Download a CSV file containing the balance of each customer in the loyalty program. -func (r apiExportLoyaltyLedgerRequest) DateFormat(dateFormat string) apiExportLoyaltyLedgerRequest { - r.dateFormat = &dateFormat - return r -} +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +The generated file can contain the following columns: + +- `loyaltyProgramID`: The ID of the loyalty program. +- `loyaltySubledger`: The name of the subdleger, when applicatble. +- `profileIntegrationID`: The integration ID of the customer profile. +- `currentBalance`: The current point balance. +- `pendingBalance`: The number of pending points. +- `expiredBalance`: The number of expired points. +- `spentBalance`: The number of spent points. +- `currentTier`: The tier that the customer is in at the time of the export. -/* -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 +@return apiExportLoyaltyBalancesRequest */ -func (a *ManagementApiService) ExportLoyaltyLedger(ctx _context.Context, loyaltyProgramId string, integrationId string) apiExportLoyaltyLedgerRequest { - return apiExportLoyaltyLedgerRequest{ +func (a *ManagementApiService) ExportLoyaltyBalances(ctx _context.Context, loyaltyProgramId string) apiExportLoyaltyBalancesRequest { + return apiExportLoyaltyBalancesRequest{ apiService: a, ctx: ctx, loyaltyProgramId: loyaltyProgramId, - integrationId: integrationId, } } @@ -3970,7 +4972,7 @@ Execute executes the request @return string */ -func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiExportLoyaltyBalancesRequest) Execute() (string, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} @@ -3980,31 +4982,20 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyLedger") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyBalances") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log" + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances" 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, "")) + if r.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4037,6 +5028,20 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er } } } + 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 @@ -4066,6 +5071,26 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er 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 } @@ -4082,67 +5107,44 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er 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 +type apiExportLoyaltyCardBalancesRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + endDate *time.Time } -func (r apiExportReferralsRequest) Valid(valid string) apiExportReferralsRequest { - r.valid = &valid +func (r apiExportLoyaltyCardBalancesRequest) EndDate(endDate time.Time) apiExportLoyaltyCardBalancesRequest { + r.endDate = &endDate return r } -func (r apiExportReferralsRequest) Usable(usable string) apiExportReferralsRequest { - r.usable = &usable - return r -} +/* +ExportLoyaltyCardBalances Export all card transaction logs +Download a CSV file containing the balances of all cards in the loyalty program. -func (r apiExportReferralsRequest) BatchId(batchId string) apiExportReferralsRequest { - r.batchId = &batchId - return r -} +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). -func (r apiExportReferralsRequest) DateFormat(dateFormat string) apiExportReferralsRequest { - r.dateFormat = &dateFormat - return r -} +The CSV file contains the following columns: +- `loyaltyProgramID`: The ID of the loyalty program. +- `loyaltySubledger`: The name of the subdleger, when applicatble. +- `cardIdentifier`: The alphanumeric identifier of the loyalty card. +- `cardState`:The state of the loyalty card. It can be `active` or `inactive`. +- `currentBalance`: The current point balance. +- `pendingBalance`: The number of pending points. +- `expiredBalance`: The number of expired points. +- `spentBalance`: The number of spent points. -/* -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. + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiExportReferralsRequest +@return apiExportLoyaltyCardBalancesRequest */ -func (a *ManagementApiService) ExportReferrals(ctx _context.Context, applicationId int32) apiExportReferralsRequest { - return apiExportReferralsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) ExportLoyaltyCardBalances(ctx _context.Context, loyaltyProgramId int32) apiExportLoyaltyCardBalancesRequest { + return apiExportLoyaltyCardBalancesRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } @@ -4151,7 +5153,7 @@ Execute executes the request @return string */ -func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiExportLoyaltyCardBalancesRequest) Execute() (string, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} @@ -4161,38 +5163,20 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportReferrals") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyCardBalances") 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) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/export_card_balances" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -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, "")) + if r.endDate != nil { + localVarQueryParams.Add("endDate", parameterToString(*r.endDate, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4225,6 +5209,20 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) } } } + 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 @@ -4254,6 +5252,26 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, 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 } @@ -4270,104 +5288,84 @@ func (r apiExportReferralsRequest) Execute() (string, *_nethttp.Response, error) 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 +type apiExportLoyaltyCardLedgerRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string + rangeStart *time.Time + rangeEnd *time.Time + dateFormat *string } -func (r apiGetAccessLogsWithoutTotalCountRequest) RangeStart(rangeStart time.Time) apiGetAccessLogsWithoutTotalCountRequest { +func (r apiExportLoyaltyCardLedgerRequest) RangeStart(rangeStart time.Time) apiExportLoyaltyCardLedgerRequest { r.rangeStart = &rangeStart return r } -func (r apiGetAccessLogsWithoutTotalCountRequest) RangeEnd(rangeEnd time.Time) apiGetAccessLogsWithoutTotalCountRequest { +func (r apiExportLoyaltyCardLedgerRequest) RangeEnd(rangeEnd time.Time) apiExportLoyaltyCardLedgerRequest { 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 +func (r apiExportLoyaltyCardLedgerRequest) DateFormat(dateFormat string) apiExportLoyaltyCardLedgerRequest { + r.dateFormat = &dateFormat return r } /* -GetAccessLogsWithoutTotalCount Get access logs for Application -Retrieve the list of API calls to this Application matching the specified criteria. +ExportLoyaltyCardLedger Export card's ledger log +Download a CSV file containing a loyalty card ledger log of the loyalty program. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - @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 loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. -@return apiGetAccessLogsWithoutTotalCountRequest +@return apiExportLoyaltyCardLedgerRequest */ -func (a *ManagementApiService) GetAccessLogsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetAccessLogsWithoutTotalCountRequest { - return apiGetAccessLogsWithoutTotalCountRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) ExportLoyaltyCardLedger(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiExportLoyaltyCardLedgerRequest { + return apiExportLoyaltyCardLedgerRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, } } /* Execute executes the request - @return InlineResponse20013 + @return string */ -func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { +func (r apiExportLoyaltyCardLedgerRequest) Execute() (string, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20013 + localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccessLogsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyCardLedger") 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) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") + } + if r.rangeStart == nil { return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") } @@ -4376,25 +5374,10 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20013 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, "")) + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4406,7 +5389,7 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20013 } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} + localVarHTTPHeaderAccepts := []string{"application/csv"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -4427,6 +5410,20 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20013 } } } + 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 @@ -4449,7 +5446,27 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20013 error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20013 + 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() @@ -4472,56 +5489,110 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20013 return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAccountRequest struct { - ctx _context.Context - apiService *ManagementApiService - accountId int32 +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 } /* -GetAccount Get account details -Return the details of your companies Talon.One account. +ExportLoyaltyLedger Export customer's transaction logs +Download a CSV file containing a customer's transaction logs in the loyalty program. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +The generated file can contain the following columns: + +- `customerprofileid`: The ID of the profile. +- `customersessionid`: The ID of the customer session. +- `rulesetid`: The ID of the rule set. +- `rulename`: The name of the rule. +- `programid`: The ID of the loyalty program. +- `type`: The type of the loyalty program. +- `name`: The name of the loyalty program. +- `subledgerid`: The ID of the subledger, when applicable. +- `startdate`: The start date of the program. +- `expirydate`: The expiration date of the program. +- `id`: The ID of the transaction. +- `created`: The timestamp of the creation of the loyalty program. +- `amount`: The number of points in that transaction. +- `archived`: Whether the session related to the transaction is archived. - @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. + - @param loyaltyProgramId The identifier for the loyalty program. + - @param integrationId The identifier of the profile. -@return apiGetAccountRequest +@return apiExportLoyaltyLedgerRequest */ -func (a *ManagementApiService) GetAccount(ctx _context.Context, accountId int32) apiGetAccountRequest { - return apiGetAccountRequest{ - apiService: a, - ctx: ctx, - accountId: accountId, +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 Account + @return string */ -func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { +func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Account + localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyLedger") 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/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{} @@ -4532,7 +5603,7 @@ func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} + localVarHTTPHeaderAccepts := []string{"application/csv"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -4553,6 +5624,20 @@ func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { } } } + 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 @@ -4575,7 +5660,7 @@ func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Account + var v string err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4598,56 +5683,130 @@ func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAccountAnalyticsRequest struct { - ctx _context.Context - apiService *ManagementApiService - accountId int32 +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 } -/* -GetAccountAnalytics Get account analytics -Return the analytics of your Talon.One account. +func (r apiExportReferralsRequest) CampaignId(campaignId float32) apiExportReferralsRequest { + r.campaignId = &campaignId + return r +} - - @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. +func (r apiExportReferralsRequest) CreatedBefore(createdBefore time.Time) apiExportReferralsRequest { + r.createdBefore = &createdBefore + return r +} -@return apiGetAccountAnalyticsRequest -*/ -func (a *ManagementApiService) GetAccountAnalytics(ctx _context.Context, accountId int32) apiGetAccountAnalyticsRequest { - return apiGetAccountAnalyticsRequest{ - apiService: a, - ctx: ctx, - accountId: accountId, - } +func (r apiExportReferralsRequest) CreatedAfter(createdAfter time.Time) apiExportReferralsRequest { + r.createdAfter = &createdAfter + return r } -/* -Execute executes the request +func (r apiExportReferralsRequest) Valid(valid string) apiExportReferralsRequest { + r.valid = &valid + return r +} - @return AccountAnalytics -*/ -func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodGet - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue AccountAnalytics - ) +func (r apiExportReferralsRequest) Usable(usable string) apiExportReferralsRequest { + r.usable = &usable + return r +} - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountAnalytics") - if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} - } +func (r apiExportReferralsRequest) BatchId(batchId string) apiExportReferralsRequest { + r.batchId = &batchId + return r +} - localVarPath := localBasePath + "/v1/accounts/{accountId}/analytics" - localVarPath = strings.Replace(localVarPath, "{"+"accountId"+"}", _neturl.QueryEscape(parameterToString(r.accountId, "")), -1) +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. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +The CSV file contains the following columns: + +- `code`: The referral code. +- `advocateprofileintegrationid`: 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 number of redemptions of this code. Defaults to `1` when left blank. +- `attributes`: A json object describing _custom_ referral attribute names and their values. + + - @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{} @@ -4658,7 +5817,7 @@ func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Re } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} + localVarHTTPHeaderAccepts := []string{"application/csv"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -4679,6 +5838,20 @@ func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Re } } } + 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 @@ -4701,7 +5874,7 @@ func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Re error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v AccountAnalytics + var v string err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4724,55 +5897,132 @@ func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Re return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAccountCollectionRequest struct { - ctx _context.Context - apiService *ManagementApiService - collectionId int32 +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 } /* -GetAccountCollection Get account-level collection -Retrieve a given account-level collection. +GetAccessLogsWithoutTotalCount Get access logs for Application +Retrieve the list of API calls sent to the specified Application. + - @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). + - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetAccountCollectionRequest +@return apiGetAccessLogsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetAccountCollection(ctx _context.Context, collectionId int32) apiGetAccountCollectionRequest { - return apiGetAccountCollectionRequest{ - apiService: a, - ctx: ctx, - collectionId: collectionId, +func (a *ManagementApiService) GetAccessLogsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetAccessLogsWithoutTotalCountRequest { + return apiGetAccessLogsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return Collection + @return InlineResponse20018 */ -func (r apiGetAccountCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { +func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Collection + localVarReturnValue InlineResponse20018 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountCollection") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccessLogsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/collections/{collectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + 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{} @@ -4804,6 +6054,20 @@ func (r apiGetAccountCollectionRequest) Execute() (Collection, *_nethttp.Respons } } } + 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 @@ -4826,17 +6090,7 @@ func (r apiGetAccountCollectionRequest) Execute() (Collection, *_nethttp.Respons 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 + var v InlineResponse20018 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4859,51 +6113,51 @@ func (r apiGetAccountCollectionRequest) Execute() (Collection, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAdditionalCostRequest struct { - ctx _context.Context - apiService *ManagementApiService - additionalCostId int32 +type apiGetAccountRequest struct { + ctx _context.Context + apiService *ManagementApiService + accountId int32 } /* -GetAdditionalCost Get additional cost -Returns the additional cost. +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 additionalCostId + - @param accountId The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. -@return apiGetAdditionalCostRequest +@return apiGetAccountRequest */ -func (a *ManagementApiService) GetAdditionalCost(ctx _context.Context, additionalCostId int32) apiGetAdditionalCostRequest { - return apiGetAdditionalCostRequest{ - apiService: a, - ctx: ctx, - additionalCostId: additionalCostId, +func (a *ManagementApiService) GetAccount(ctx _context.Context, accountId int32) apiGetAccountRequest { + return apiGetAccountRequest{ + apiService: a, + ctx: ctx, + accountId: accountId, } } /* Execute executes the request - @return AccountAdditionalCost + @return Account */ -func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp.Response, error) { +func (r apiGetAccountRequest) Execute() (Account, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue AccountAdditionalCost + localVarReturnValue Account ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCost") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccount") 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/accounts/{accountId}" + localVarPath = strings.Replace(localVarPath, "{"+"accountId"+"}", _neturl.QueryEscape(parameterToString(r.accountId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4940,6 +6194,20 @@ func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp } } } + 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 @@ -4962,7 +6230,7 @@ func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v AccountAdditionalCost + var v Account err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4985,79 +6253,56 @@ func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAdditionalCostsRequest struct { +type apiGetAccountAnalyticsRequest struct { ctx _context.Context apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string -} - -func (r apiGetAdditionalCostsRequest) PageSize(pageSize int32) apiGetAdditionalCostsRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetAdditionalCostsRequest) Skip(skip int32) apiGetAdditionalCostsRequest { - r.skip = &skip - return r -} - -func (r apiGetAdditionalCostsRequest) Sort(sort string) apiGetAdditionalCostsRequest { - r.sort = &sort - return r + accountId int32 } /* -GetAdditionalCosts List additional costs -Returns all the defined additional costs for the account. +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](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. -@return apiGetAdditionalCostsRequest +@return apiGetAccountAnalyticsRequest */ -func (a *ManagementApiService) GetAdditionalCosts(ctx _context.Context) apiGetAdditionalCostsRequest { - return apiGetAdditionalCostsRequest{ +func (a *ManagementApiService) GetAccountAnalytics(ctx _context.Context, accountId int32) apiGetAccountAnalyticsRequest { + return apiGetAccountAnalyticsRequest{ apiService: a, ctx: ctx, + accountId: accountId, } } /* Execute executes the request - @return InlineResponse20026 + @return AccountAnalytics */ -func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20026, *_nethttp.Response, error) { +func (r apiGetAccountAnalyticsRequest) Execute() (AccountAnalytics, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20026 + localVarReturnValue AccountAnalytics ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCosts") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountAnalytics") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/additional_costs" + 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{} - 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{} @@ -5089,6 +6334,20 @@ func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20026, *_nethttp. } } } + 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 @@ -5111,7 +6370,7 @@ func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20026, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20026 + var v AccountAnalytics err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5134,128 +6393,55 @@ func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20026, *_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 -} - -func (r apiGetAllAccessLogsRequest) RangeStart(rangeStart time.Time) apiGetAllAccessLogsRequest { - r.rangeStart = &rangeStart - return r -} - -func (r apiGetAllAccessLogsRequest) RangeEnd(rangeEnd time.Time) apiGetAllAccessLogsRequest { - r.rangeEnd = &rangeEnd - return r -} - -func (r apiGetAllAccessLogsRequest) Path(path string) apiGetAllAccessLogsRequest { - r.path = &path - return r -} - -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 +type apiGetAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 } /* -GetAllAccessLogs List access logs -Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. - +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 collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. -@return apiGetAllAccessLogsRequest +@return apiGetAccountCollectionRequest */ -func (a *ManagementApiService) GetAllAccessLogs(ctx _context.Context) apiGetAllAccessLogsRequest { - return apiGetAllAccessLogsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetAccountCollection(ctx _context.Context, collectionId int32) apiGetAccountCollectionRequest { + return apiGetAccountCollectionRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, } } /* Execute executes the request - @return InlineResponse20014 + @return Collection */ -func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse20014, *_nethttp.Response, error) { +func (r apiGetAccountCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20014 + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllAccessLogs") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccountCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/access_logs" + 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.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, "")) - } - 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{} @@ -5287,6 +6473,20 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse20014, *_nethttp.Re } } } + 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 @@ -5309,7 +6509,17 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse20014, *_nethttp.Re error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20014 + 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() @@ -5332,46 +6542,51 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse20014, *_nethttp.Re return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAllRolesRequest struct { - ctx _context.Context - apiService *ManagementApiService +type apiGetAdditionalCostRequest struct { + ctx _context.Context + apiService *ManagementApiService + additionalCostId int32 } /* -GetAllRoles List roles -List all roles. +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 The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. -@return apiGetAllRolesRequest +@return apiGetAdditionalCostRequest */ -func (a *ManagementApiService) GetAllRoles(ctx _context.Context) apiGetAllRolesRequest { - return apiGetAllRolesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetAdditionalCost(ctx _context.Context, additionalCostId int32) apiGetAdditionalCostRequest { + return apiGetAdditionalCostRequest{ + apiService: a, + ctx: ctx, + additionalCostId: additionalCostId, } } /* Execute executes the request - @return InlineResponse20034 + @return AccountAdditionalCost */ -func (r apiGetAllRolesRequest) Execute() (InlineResponse20034, *_nethttp.Response, error) { +func (r apiGetAdditionalCostRequest) Execute() (AccountAdditionalCost, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20034 + localVarReturnValue AccountAdditionalCost ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllRoles") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCost") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/roles" + 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{} @@ -5408,6 +6623,20 @@ func (r apiGetAllRolesRequest) Execute() (InlineResponse20034, *_nethttp.Respons } } } + 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 @@ -5430,7 +6659,7 @@ func (r apiGetAllRolesRequest) Execute() (InlineResponse20034, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20034 + var v AccountAdditionalCost err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5453,55 +6682,79 @@ func (r apiGetAllRolesRequest) Execute() (InlineResponse20034, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 +type apiGetAdditionalCostsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string +} + +func (r apiGetAdditionalCostsRequest) PageSize(pageSize int32) apiGetAdditionalCostsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetAdditionalCostsRequest) Skip(skip int32) apiGetAdditionalCostsRequest { + r.skip = &skip + return r +} + +func (r apiGetAdditionalCostsRequest) Sort(sort string) apiGetAdditionalCostsRequest { + r.sort = &sort + return r } /* -GetApplication Get application -Get the application specified by the ID. +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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetApplicationRequest +@return apiGetAdditionalCostsRequest */ -func (a *ManagementApiService) GetApplication(ctx _context.Context, applicationId int32) apiGetApplicationRequest { - return apiGetApplicationRequest{ - 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 Application + @return InlineResponse20032 */ -func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, error) { +func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20032, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Application + localVarReturnValue InlineResponse20032 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplication") + 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}" - 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.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{} @@ -5533,6 +6786,20 @@ func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, er } } } + 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 @@ -5555,7 +6822,7 @@ func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, er error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Application + var v InlineResponse20032 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5578,57 +6845,128 @@ func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, er return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationApiHealthRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 +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 apiGetAllAccessLogsRequest) RangeStart(rangeStart time.Time) apiGetAllAccessLogsRequest { + r.rangeStart = &rangeStart + return r +} + +func (r apiGetAllAccessLogsRequest) RangeEnd(rangeEnd time.Time) apiGetAllAccessLogsRequest { + r.rangeEnd = &rangeEnd + return r +} + +func (r apiGetAllAccessLogsRequest) Path(path string) apiGetAllAccessLogsRequest { + r.path = &path + return r +} + +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 } /* -GetApplicationApiHealth Get report of health of application API -Display the health of the application and show the last time the Application -was used. +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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetApplicationApiHealthRequest +@return apiGetAllAccessLogsRequest */ -func (a *ManagementApiService) GetApplicationApiHealth(ctx _context.Context, applicationId int32) apiGetApplicationApiHealthRequest { - return apiGetApplicationApiHealthRequest{ - 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 ApplicationApiHealth + @return InlineResponse20019 */ -func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_nethttp.Response, error) { +func (r apiGetAllAccessLogsRequest) 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.GetAllAccessLogs") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/health_report" - 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.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, "")) + } + 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{} @@ -5660,6 +6998,20 @@ func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_ne } } } + 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 @@ -5682,7 +7034,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() @@ -5705,55 +7057,46 @@ func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationCustomerRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - customerId int32 +type apiGetAllRolesRequest struct { + ctx _context.Context + apiService *ManagementApiService } /* -GetApplicationCustomer Get application's customer -Retrieve the customers of the specified application. - +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 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 +@return apiGetAllRolesRequest */ -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) GetAllRoles(ctx _context.Context) apiGetAllRolesRequest { + return apiGetAllRolesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return ApplicationCustomer + @return InlineResponse20040 */ -func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_nethttp.Response, error) { +func (r apiGetAllRolesRequest) Execute() (InlineResponse20040, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue ApplicationCustomer + localVarReturnValue InlineResponse20040 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomer") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllRoles") 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/roles" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5790,9 +7133,23 @@ func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_neth } } } - 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.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) @@ -5812,7 +7169,7 @@ func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v ApplicationCustomer + var v InlineResponse20040 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5835,96 +7192,55 @@ 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 apiGetApplicationRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 } /* -GetApplicationCustomerFriends List friends referred by customer profile -List the friends referred by the specified customer profile in this Application. - +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 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 +@return apiGetApplicationRequest */ -func (a *ManagementApiService) GetApplicationCustomerFriends(ctx _context.Context, applicationId int32, integrationId string) apiGetApplicationCustomerFriendsRequest { - return apiGetApplicationCustomerFriendsRequest{ +func (a *ManagementApiService) GetApplication(ctx _context.Context, applicationId int32) apiGetApplicationRequest { + return apiGetApplicationRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - integrationId: integrationId, } } /* Execute executes the request - @return InlineResponse20024 + @return Application */ -func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20024, *_nethttp.Response, error) { +func (r apiGetApplicationRequest) Execute() (Application, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20024 + localVarReturnValue Application ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomerFriends") + 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}/profile/{integrationId}/friends" + localVarPath := localBasePath + "/v1/applications/{applicationId}" 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{} @@ -5956,6 +7272,20 @@ func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20024, } } } + 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 @@ -5978,7 +7308,7 @@ func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20024, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20024 + var v Application err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6001,46 +7331,27 @@ func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20024, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationCustomersRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - integrationId *string - pageSize *int32 - skip *int32 - withTotalResultSize *bool -} - -func (r apiGetApplicationCustomersRequest) IntegrationId(integrationId string) apiGetApplicationCustomersRequest { - r.integrationId = &integrationId - return r -} - -func (r apiGetApplicationCustomersRequest) PageSize(pageSize int32) apiGetApplicationCustomersRequest { - r.pageSize = &pageSize - return r +type apiGetApplicationApiHealthRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 } -func (r apiGetApplicationCustomersRequest) Skip(skip int32) apiGetApplicationCustomersRequest { - r.skip = &skip - return r -} +/* +GetApplicationApiHealth Get Application health +Display the health of the Application and show the last time the Application +was used. -func (r apiGetApplicationCustomersRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersRequest { - r.withTotalResultSize = &withTotalResultSize - return r -} +You can also display this information from the **Settings** of an Application, in the **Developer Settings** menu. +See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status). -/* -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 applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetApplicationCustomersRequest +@return apiGetApplicationApiHealthRequest */ -func (a *ManagementApiService) GetApplicationCustomers(ctx _context.Context, applicationId int32) apiGetApplicationCustomersRequest { - return apiGetApplicationCustomersRequest{ +func (a *ManagementApiService) GetApplicationApiHealth(ctx _context.Context, applicationId int32) apiGetApplicationApiHealthRequest { + return apiGetApplicationApiHealthRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -6050,42 +7361,30 @@ func (a *ManagementApiService) GetApplicationCustomers(ctx _context.Context, app /* Execute executes the request - @return InlineResponse20016 + @return ApplicationApiHealth */ -func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20016, *_nethttp.Response, error) { +func (r apiGetApplicationApiHealthRequest) Execute() (ApplicationApiHealth, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20016 + localVarReturnValue ApplicationApiHealth ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomers") + 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}/customers" + 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.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{} @@ -6117,6 +7416,20 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20016, *_net } } } + 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 @@ -6139,7 +7452,7 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20016, *_net error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20016 + var v ApplicationApiHealth err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6162,97 +7475,62 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20016, *_net return localVarReturnValue, localVarHTTPResponse, nil } -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 +type apiGetApplicationCustomerRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + customerId int32 } /* -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. +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 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](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. -@return apiGetApplicationCustomersByAttributesRequest +@return apiGetApplicationCustomerRequest */ -func (a *ManagementApiService) GetApplicationCustomersByAttributes(ctx _context.Context, applicationId int32) apiGetApplicationCustomersByAttributesRequest { - return apiGetApplicationCustomersByAttributesRequest{ +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 InlineResponse20017 + @return ApplicationCustomer */ -func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { +func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20017 + localVarReturnValue ApplicationCustomer ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomersByAttributes") + 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}/customer_search" + 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.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{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -6268,8 +7546,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 { @@ -6284,8 +7560,22 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse } } } - req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) - if err != nil { + 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 } @@ -6306,7 +7596,7 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20017 + var v ApplicationCustomer err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6329,71 +7619,79 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationEventTypesRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - pageSize *int32 - skip *int32 - sort *string +type apiGetApplicationCustomerFriendsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + integrationId string + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool } -func (r apiGetApplicationEventTypesRequest) PageSize(pageSize int32) apiGetApplicationEventTypesRequest { +func (r apiGetApplicationCustomerFriendsRequest) PageSize(pageSize int32) apiGetApplicationCustomerFriendsRequest { r.pageSize = &pageSize return r } -func (r apiGetApplicationEventTypesRequest) Skip(skip int32) apiGetApplicationEventTypesRequest { +func (r apiGetApplicationCustomerFriendsRequest) Skip(skip int32) apiGetApplicationCustomerFriendsRequest { r.skip = &skip return r } -func (r apiGetApplicationEventTypesRequest) Sort(sort string) apiGetApplicationEventTypesRequest { +func (r apiGetApplicationCustomerFriendsRequest) Sort(sort string) apiGetApplicationCustomerFriendsRequest { r.sort = &sort return r } -/* -GetApplicationEventTypes List Applications event types -Get all of the distinct values of the Event `type` property for events recorded in the application. +func (r apiGetApplicationCustomerFriendsRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomerFriendsRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} -See also: [Track an event](/integration-api/#operation/trackEvent) +/* +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 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 apiGetApplicationEventTypesRequest +@return apiGetApplicationCustomerFriendsRequest */ -func (a *ManagementApiService) GetApplicationEventTypes(ctx _context.Context, applicationId int32) apiGetApplicationEventTypesRequest { - return apiGetApplicationEventTypesRequest{ +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 InlineResponse20022 + @return InlineResponse20030 */ -func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20022, *_nethttp.Response, error) { +func (r apiGetApplicationCustomerFriendsRequest) Execute() (InlineResponse20030, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20022 + localVarReturnValue InlineResponse20030 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventTypes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomerFriends") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/event_types" + 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{} @@ -6408,6 +7706,9 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20022, *_ne 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{} @@ -6439,6 +7740,20 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20022, *_ne } } } + 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 @@ -6461,7 +7776,7 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20022, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20022 + var v InlineResponse20030 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6484,107 +7799,46 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20022, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -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 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 +type apiGetApplicationCustomersRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + integrationId *string + pageSize *int32 + skip *int32 + withTotalResultSize *bool } -func (r apiGetApplicationEventsWithoutTotalCountRequest) CouponCode(couponCode string) apiGetApplicationEventsWithoutTotalCountRequest { - r.couponCode = &couponCode +func (r apiGetApplicationCustomersRequest) IntegrationId(integrationId string) apiGetApplicationCustomersRequest { + r.integrationId = &integrationId return r } -func (r apiGetApplicationEventsWithoutTotalCountRequest) ReferralCode(referralCode string) apiGetApplicationEventsWithoutTotalCountRequest { - r.referralCode = &referralCode +func (r apiGetApplicationCustomersRequest) PageSize(pageSize int32) apiGetApplicationCustomersRequest { + r.pageSize = &pageSize return r } -func (r apiGetApplicationEventsWithoutTotalCountRequest) RuleQuery(ruleQuery string) apiGetApplicationEventsWithoutTotalCountRequest { - r.ruleQuery = &ruleQuery +func (r apiGetApplicationCustomersRequest) Skip(skip int32) apiGetApplicationCustomersRequest { + r.skip = &skip return r } -func (r apiGetApplicationEventsWithoutTotalCountRequest) CampaignQuery(campaignQuery string) apiGetApplicationEventsWithoutTotalCountRequest { - r.campaignQuery = &campaignQuery +func (r apiGetApplicationCustomersRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersRequest { + r.withTotalResultSize = &withTotalResultSize 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 mentions whether there are more results. - +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 applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetApplicationEventsWithoutTotalCountRequest +@return apiGetApplicationCustomersRequest */ -func (a *ManagementApiService) GetApplicationEventsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetApplicationEventsWithoutTotalCountRequest { - return apiGetApplicationEventsWithoutTotalCountRequest{ +func (a *ManagementApiService) GetApplicationCustomers(ctx _context.Context, applicationId int32) apiGetApplicationCustomersRequest { + return apiGetApplicationCustomersRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -6596,7 +7850,7 @@ Execute executes the request @return InlineResponse20021 */ -func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineResponse20021, *_nethttp.Response, error) { +func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20021, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} @@ -6606,59 +7860,29 @@ func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineRespon localVarReturnValue InlineResponse20021 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomers") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/events/no_total" + 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.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, "")) + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6691,6 +7915,20 @@ func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineRespon } } } + 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 @@ -6736,63 +7974,97 @@ func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineRespon return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationSessionRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - sessionId int32 -} - -/* -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. +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 +} + +/* +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 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 +@return apiGetApplicationCustomersByAttributesRequest */ -func (a *ManagementApiService) GetApplicationSession(ctx _context.Context, applicationId int32, sessionId int32) apiGetApplicationSessionRequest { - return apiGetApplicationSessionRequest{ +func (a *ManagementApiService) GetApplicationCustomersByAttributes(ctx _context.Context, applicationId int32) apiGetApplicationCustomersByAttributesRequest { + return apiGetApplicationCustomersByAttributesRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - sessionId: sessionId, } } /* Execute executes the request - @return ApplicationSession + @return InlineResponse20022 */ -func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethttp.Response, error) { +func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse20022, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue ApplicationSession + localVarReturnValue InlineResponse20022 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSession") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomersByAttributes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/sessions/{sessionId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_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.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) @@ -6808,6 +8080,22 @@ 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 { + 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.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -6844,7 +8132,7 @@ func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethtt error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v ApplicationSession + var v InlineResponse20022 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6867,83 +8155,43 @@ func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethtt return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationSessionsRequest struct { +type apiGetApplicationEventTypesRequest 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 } -func (r apiGetApplicationSessionsRequest) PageSize(pageSize int32) apiGetApplicationSessionsRequest { +func (r apiGetApplicationEventTypesRequest) PageSize(pageSize int32) apiGetApplicationEventTypesRequest { r.pageSize = &pageSize return r } -func (r apiGetApplicationSessionsRequest) Skip(skip int32) apiGetApplicationSessionsRequest { +func (r apiGetApplicationEventTypesRequest) Skip(skip int32) apiGetApplicationEventTypesRequest { r.skip = &skip return r } -func (r apiGetApplicationSessionsRequest) Sort(sort string) apiGetApplicationSessionsRequest { +func (r apiGetApplicationEventTypesRequest) Sort(sort string) apiGetApplicationEventTypesRequest { r.sort = &sort return r } -func (r apiGetApplicationSessionsRequest) Profile(profile string) apiGetApplicationSessionsRequest { - r.profile = &profile - return r -} - -func (r apiGetApplicationSessionsRequest) State(state string) apiGetApplicationSessionsRequest { - r.state = &state - return r -} - -func (r apiGetApplicationSessionsRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationSessionsRequest { - r.createdBefore = &createdBefore - return r -} - -func (r apiGetApplicationSessionsRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationSessionsRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiGetApplicationSessionsRequest) Coupon(coupon string) apiGetApplicationSessionsRequest { - r.coupon = &coupon - return r -} - -func (r apiGetApplicationSessionsRequest) Referral(referral string) apiGetApplicationSessionsRequest { - r.referral = &referral - return r -} - -func (r apiGetApplicationSessionsRequest) IntegrationId(integrationId string) apiGetApplicationSessionsRequest { - r.integrationId = &integrationId - return r -} - /* -GetApplicationSessions List Application sessions -List all the sessions of the specified Application. +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](https://docs.talon.one/integration-api#operation/trackEvent) - @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 apiGetApplicationSessionsRequest +@return apiGetApplicationEventTypesRequest */ -func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, applicationId int32) apiGetApplicationSessionsRequest { - return apiGetApplicationSessionsRequest{ +func (a *ManagementApiService) GetApplicationEventTypes(ctx _context.Context, applicationId int32) apiGetApplicationEventTypesRequest { + return apiGetApplicationEventTypesRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -6953,24 +8201,24 @@ func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, appl /* Execute executes the request - @return InlineResponse20020 + @return InlineResponse20028 */ -func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20020, *_nethttp.Response, error) { +func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20028, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20020 + localVarReturnValue InlineResponse20028 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSessions") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventTypes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/sessions" + localVarPath := localBasePath + "/v1/applications/{applicationId}/event_types" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) @@ -6986,27 +8234,6 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20020, *_neth 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{} @@ -7038,6 +8265,20 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20020, *_neth } } } + 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 @@ -7060,7 +8301,7 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20020, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20020 + var v InlineResponse20028 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7083,64 +8324,135 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20020, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetApplicationsRequest struct { - ctx _context.Context - apiService *ManagementApiService - 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 apiGetApplicationsRequest) PageSize(pageSize int32) apiGetApplicationsRequest { +func (r apiGetApplicationEventsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetApplicationEventsWithoutTotalCountRequest { r.pageSize = &pageSize return r } -func (r apiGetApplicationsRequest) Skip(skip int32) apiGetApplicationsRequest { +func (r apiGetApplicationEventsWithoutTotalCountRequest) Skip(skip int32) apiGetApplicationEventsWithoutTotalCountRequest { r.skip = &skip return r } -func (r apiGetApplicationsRequest) Sort(sort string) apiGetApplicationsRequest { +func (r apiGetApplicationEventsWithoutTotalCountRequest) Sort(sort string) apiGetApplicationEventsWithoutTotalCountRequest { 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(). - -@return apiGetApplicationsRequest -*/ -func (a *ManagementApiService) GetApplications(ctx _context.Context) apiGetApplicationsRequest { - return apiGetApplicationsRequest{ - apiService: a, - ctx: ctx, - } +func (r apiGetApplicationEventsWithoutTotalCountRequest) Type_(type_ string) apiGetApplicationEventsWithoutTotalCountRequest { + r.type_ = &type_ + return r } -/* -Execute executes the request +func (r apiGetApplicationEventsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationEventsWithoutTotalCountRequest { + r.createdBefore = &createdBefore + return r +} - @return InlineResponse2002 -*/ -func (r apiGetApplicationsRequest) Execute() (InlineResponse2002, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodGet - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue InlineResponse2002 - ) +func (r apiGetApplicationEventsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationEventsWithoutTotalCountRequest { + r.createdAfter = &createdAfter + return r +} - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplications") +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 +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) ReferralCode(referralCode string) apiGetApplicationEventsWithoutTotalCountRequest { + r.referralCode = &referralCode + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) RuleQuery(ruleQuery string) apiGetApplicationEventsWithoutTotalCountRequest { + r.ruleQuery = &ruleQuery + return r +} + +func (r apiGetApplicationEventsWithoutTotalCountRequest) CampaignQuery(campaignQuery string) apiGetApplicationEventsWithoutTotalCountRequest { + r.campaignQuery = &campaignQuery + 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 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 The ID of the Application. It is displayed in your Talon.One deployment URL. + +@return apiGetApplicationEventsWithoutTotalCountRequest +*/ +func (a *ManagementApiService) GetApplicationEventsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetApplicationEventsWithoutTotalCountRequest { + return apiGetApplicationEventsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + } +} + +/* +Execute executes the request + + @return InlineResponse20027 +*/ +func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineResponse20027, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse20027 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications" + 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{} @@ -7155,6 +8467,39 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2002, *_nethttp.Resp 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{} @@ -7186,6 +8531,20 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2002, *_nethttp.Resp } } } + 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 @@ -7208,7 +8567,7 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2002, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2002 + var v InlineResponse20027 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7231,51 +8590,56 @@ func (r apiGetApplicationsRequest) Execute() (InlineResponse2002, *_nethttp.Resp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAttributeRequest struct { - ctx _context.Context - apiService *ManagementApiService - attributeId int32 +type apiGetApplicationSessionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + sessionId int32 } /* -GetAttribute Get custom attribute -Returns custom attribute for the account by its id. +GetApplicationSession Get Application session +Get the details of the given session. +You can list the sessions with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param attributeId + - @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](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. -@return apiGetAttributeRequest +@return apiGetApplicationSessionRequest */ -func (a *ManagementApiService) GetAttribute(ctx _context.Context, attributeId int32) apiGetAttributeRequest { - return apiGetAttributeRequest{ - apiService: a, - ctx: ctx, - attributeId: attributeId, +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 Attribute + @return ApplicationSession */ -func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) { +func (r apiGetApplicationSessionRequest) Execute() (ApplicationSession, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Attribute + localVarReturnValue ApplicationSession ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttribute") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSession") 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}/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{} @@ -7312,6 +8676,20 @@ func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) } } } + 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 @@ -7334,7 +8712,7 @@ func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Attribute + var v ApplicationSession err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7357,71 +8735,111 @@ 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 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 } -func (r apiGetAttributesRequest) PageSize(pageSize int32) apiGetAttributesRequest { +func (r apiGetApplicationSessionsRequest) PageSize(pageSize int32) apiGetApplicationSessionsRequest { r.pageSize = &pageSize return r } -func (r apiGetAttributesRequest) Skip(skip int32) apiGetAttributesRequest { +func (r apiGetApplicationSessionsRequest) Skip(skip int32) apiGetApplicationSessionsRequest { r.skip = &skip return r } -func (r apiGetAttributesRequest) Sort(sort string) apiGetAttributesRequest { +func (r apiGetApplicationSessionsRequest) Sort(sort string) apiGetApplicationSessionsRequest { r.sort = &sort return r } -func (r apiGetAttributesRequest) Entity(entity string) apiGetAttributesRequest { - r.entity = &entity +func (r apiGetApplicationSessionsRequest) Profile(profile string) apiGetApplicationSessionsRequest { + r.profile = &profile + return r +} + +func (r apiGetApplicationSessionsRequest) State(state string) apiGetApplicationSessionsRequest { + r.state = &state + return r +} + +func (r apiGetApplicationSessionsRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationSessionsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetApplicationSessionsRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationSessionsRequest { + r.createdAfter = &createdAfter + return r +} + +func (r apiGetApplicationSessionsRequest) Coupon(coupon string) apiGetApplicationSessionsRequest { + r.coupon = &coupon + return r +} + +func (r apiGetApplicationSessionsRequest) Referral(referral string) apiGetApplicationSessionsRequest { + r.referral = &referral + return r +} + +func (r apiGetApplicationSessionsRequest) IntegrationId(integrationId string) apiGetApplicationSessionsRequest { + r.integrationId = &integrationId return r } /* -GetAttributes List custom attributes -Returns all the defined custom attributes for the account. +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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetAttributesRequest +@return apiGetApplicationSessionsRequest */ -func (a *ManagementApiService) GetAttributes(ctx _context.Context) apiGetAttributesRequest { - return apiGetAttributesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, applicationId int32) apiGetApplicationSessionsRequest { + return apiGetApplicationSessionsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return InlineResponse20025 + @return InlineResponse20026 */ -func (r apiGetAttributesRequest) Execute() (InlineResponse20025, *_nethttp.Response, error) { +func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20026, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20025 + localVarReturnValue InlineResponse20026 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSessions") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/attributes" + 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{} @@ -7436,8 +8854,26 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20025, *_nethttp.Respo if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.entity != nil { - localVarQueryParams.Add("entity", parameterToString(*r.entity, "")) + 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{} @@ -7470,6 +8906,20 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20025, *_nethttp.Respo } } } + 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 @@ -7492,7 +8942,7 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20025, *_nethttp.Respo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20025 + var v InlineResponse20026 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7515,45 +8965,38 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20025, *_nethttp.Respo return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetAudiencesRequest struct { - ctx _context.Context - apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string - withTotalResultSize *bool +type apiGetApplicationsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string } -func (r apiGetAudiencesRequest) PageSize(pageSize int32) apiGetAudiencesRequest { +func (r apiGetApplicationsRequest) PageSize(pageSize int32) apiGetApplicationsRequest { r.pageSize = &pageSize return r } -func (r apiGetAudiencesRequest) Skip(skip int32) apiGetAudiencesRequest { +func (r apiGetApplicationsRequest) Skip(skip int32) apiGetApplicationsRequest { r.skip = &skip return r } -func (r apiGetAudiencesRequest) Sort(sort string) apiGetAudiencesRequest { +func (r apiGetApplicationsRequest) Sort(sort string) apiGetApplicationsRequest { r.sort = &sort return r } -func (r apiGetAudiencesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetAudiencesRequest { - r.withTotalResultSize = &withTotalResultSize - return r -} - /* -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). - +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(). -@return apiGetAudiencesRequest +@return apiGetApplicationsRequest */ -func (a *ManagementApiService) GetAudiences(ctx _context.Context) apiGetAudiencesRequest { - return apiGetAudiencesRequest{ +func (a *ManagementApiService) GetApplications(ctx _context.Context) apiGetApplicationsRequest { + return apiGetApplicationsRequest{ apiService: a, ctx: ctx, } @@ -7562,24 +9005,24 @@ func (a *ManagementApiService) GetAudiences(ctx _context.Context) apiGetAudience /* Execute executes the request - @return InlineResponse20023 + @return InlineResponse2003 */ -func (r apiGetAudiencesRequest) Execute() (InlineResponse20023, *_nethttp.Response, error) { +func (r apiGetApplicationsRequest) Execute() (InlineResponse2003, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20023 + localVarReturnValue InlineResponse2003 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAudiences") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplications") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/audiences" + localVarPath := localBasePath + "/v1/applications" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -7594,9 +9037,6 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20023, *_nethttp.Respon 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{} @@ -7628,6 +9068,20 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20023, *_nethttp.Respon } } } + 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 @@ -7650,7 +9104,7 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20023, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20023 + var v InlineResponse2003 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7673,54 +9127,51 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20023, *_nethttp.Respon return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 +type apiGetAttributeRequest struct { + ctx _context.Context + apiService *ManagementApiService + attributeId int32 } /* -GetCampaign Get campaign -Retrieve the given campaign. +GetAttribute Get custom attribute +Retrieve the specified custom attribute. + - @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 attributeId The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. -@return apiGetCampaignRequest +@return apiGetAttributeRequest */ -func (a *ManagementApiService) GetCampaign(ctx _context.Context, applicationId int32, campaignId int32) apiGetCampaignRequest { - return apiGetCampaignRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) GetAttribute(ctx _context.Context, attributeId int32) apiGetAttributeRequest { + return apiGetAttributeRequest{ + apiService: a, + ctx: ctx, + attributeId: attributeId, } } /* Execute executes the request - @return Campaign + @return Attribute */ -func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { +func (r apiGetAttributeRequest) Execute() (Attribute, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Campaign + localVarReturnValue Attribute ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaign") + 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}/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 := localBasePath + "/v1/attributes/{attributeId}" + localVarPath = strings.Replace(localVarPath, "{"+"attributeId"+"}", _neturl.QueryEscape(parameterToString(r.attributeId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -7757,6 +9208,20 @@ func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { } } } + 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 @@ -7779,7 +9244,7 @@ func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - 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() @@ -7802,89 +9267,87 @@ func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignAnalyticsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - rangeStart *time.Time - rangeEnd *time.Time - granularity *string +type apiGetAttributesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + entity *string } -func (r apiGetCampaignAnalyticsRequest) RangeStart(rangeStart time.Time) apiGetCampaignAnalyticsRequest { - r.rangeStart = &rangeStart +func (r apiGetAttributesRequest) PageSize(pageSize int32) apiGetAttributesRequest { + r.pageSize = &pageSize return r } -func (r apiGetCampaignAnalyticsRequest) RangeEnd(rangeEnd time.Time) apiGetCampaignAnalyticsRequest { - r.rangeEnd = &rangeEnd +func (r apiGetAttributesRequest) Skip(skip int32) apiGetAttributesRequest { + r.skip = &skip return r } -func (r apiGetCampaignAnalyticsRequest) Granularity(granularity string) apiGetCampaignAnalyticsRequest { - r.granularity = &granularity +func (r apiGetAttributesRequest) Sort(sort string) apiGetAttributesRequest { + r.sort = &sort + return r +} + +func (r apiGetAttributesRequest) Entity(entity string) apiGetAttributesRequest { + r.entity = &entity return r } /* -GetCampaignAnalytics Get analytics of campaigns -Retrieve statistical data about the performance of the given campaign. +GetAttributes List custom attributes +Return all the 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 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 +@return apiGetAttributesRequest */ -func (a *ManagementApiService) GetCampaignAnalytics(ctx _context.Context, applicationId int32, campaignId int32) apiGetCampaignAnalyticsRequest { - return apiGetCampaignAnalyticsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) GetAttributes(ctx _context.Context) apiGetAttributesRequest { + return apiGetAttributesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse20015 + @return InlineResponse20031 */ -func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20015, *_nethttp.Response, error) { +func (r apiGetAttributesRequest) Execute() (InlineResponse20031, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20015 + localVarReturnValue InlineResponse20031 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignAnalytics") + 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}/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) + localVarPath := localBasePath + "/v1/attributes" 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.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.granularity != nil { - localVarQueryParams.Add("granularity", parameterToString(*r.granularity, "")) + 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{} @@ -7917,19 +9380,33 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20015, *_nethtt } } } - 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 { + 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 } @@ -7939,7 +9416,7 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20015, *_nethtt error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20015 + var v InlineResponse20031 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7962,90 +9439,76 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20015, *_nethtt return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCampaignByAttributesRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - body *CampaignSearch - pageSize *int32 - skip *int32 - sort *string - campaignState *string -} - -func (r apiGetCampaignByAttributesRequest) Body(body CampaignSearch) apiGetCampaignByAttributesRequest { - r.body = &body - return r +type apiGetAudiencesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool } -func (r apiGetCampaignByAttributesRequest) PageSize(pageSize int32) apiGetCampaignByAttributesRequest { +func (r apiGetAudiencesRequest) PageSize(pageSize int32) apiGetAudiencesRequest { r.pageSize = &pageSize return r } -func (r apiGetCampaignByAttributesRequest) Skip(skip int32) apiGetCampaignByAttributesRequest { +func (r apiGetAudiencesRequest) Skip(skip int32) apiGetAudiencesRequest { r.skip = &skip return r } -func (r apiGetCampaignByAttributesRequest) Sort(sort string) apiGetCampaignByAttributesRequest { +func (r apiGetAudiencesRequest) Sort(sort string) apiGetAudiencesRequest { r.sort = &sort return r } -func (r apiGetCampaignByAttributesRequest) CampaignState(campaignState string) apiGetCampaignByAttributesRequest { - r.campaignState = &campaignState +func (r apiGetAudiencesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetAudiencesRequest { + r.withTotalResultSize = &withTotalResultSize return r } /* -GetCampaignByAttributes List campaigns that match the given attributes -Get a list of all the campaigns that match a set of attributes. +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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetCampaignByAttributesRequest +@return apiGetAudiencesRequest */ -func (a *ManagementApiService) GetCampaignByAttributes(ctx _context.Context, applicationId int32) apiGetCampaignByAttributesRequest { - return apiGetCampaignByAttributesRequest{ - 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 InlineResponse2003 + @return InlineResponse20029 */ -func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2003, *_nethttp.Response, error) { +func (r apiGetAudiencesRequest) Execute() (InlineResponse20029, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2003 + localVarReturnValue InlineResponse20029 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignByAttributes") + 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}/campaigns_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, "")) } @@ -8055,11 +9518,11 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2003, *_neth if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.campaignState != nil { - localVarQueryParams.Add("campaignState", parameterToString(*r.campaignState, "")) + 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) @@ -8075,8 +9538,20 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2003, *_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 { + 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.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -8113,7 +9588,7 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2003, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2003 + var v InlineResponse20029 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8136,146 +9611,59 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2003, *_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 -} - -func (r apiGetCampaignsRequest) CreatedAfter(createdAfter time.Time) apiGetCampaignsRequest { - r.createdAfter = &createdAfter - return r -} - -func (r apiGetCampaignsRequest) CampaignGroupId(campaignGroupId int32) apiGetCampaignsRequest { - r.campaignGroupId = &campaignGroupId - return r -} - -func (r apiGetCampaignsRequest) TemplateId(templateId int32) apiGetCampaignsRequest { - r.templateId = &templateId - return r +type apiGetCampaignRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 } /* -GetCampaigns List campaigns -List the campaigns of the specified application that match your filter criteria. - +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 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 apiGetCampaignsRequest +@return apiGetCampaignRequest */ -func (a *ManagementApiService) GetCampaigns(ctx _context.Context, applicationId int32) apiGetCampaignsRequest { - return apiGetCampaignsRequest{ +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 InlineResponse2003 + @return Campaign */ -func (r apiGetCampaignsRequest) Execute() (InlineResponse2003, *_nethttp.Response, error) { +func (r apiGetCampaignRequest) Execute() (Campaign, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2003 + localVarReturnValue Campaign ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaigns") + 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}/campaigns" + 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, "")) - } - 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{} @@ -8307,6 +9695,20 @@ func (r apiGetCampaignsRequest) Execute() (InlineResponse2003, *_nethttp.Respons } } } + 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 @@ -8329,17 +9731,7 @@ func (r apiGetCampaignsRequest) Execute() (InlineResponse2003, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2003 - 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 + var v Campaign err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8362,141 +9754,89 @@ func (r apiGetCampaignsRequest) Execute() (InlineResponse2003, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -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 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 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 +type apiGetCampaignAnalyticsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + rangeStart *time.Time + rangeEnd *time.Time + granularity *string } -func (r apiGetChangesRequest) CreatedAfter(createdAfter time.Time) apiGetChangesRequest { - r.createdAfter = &createdAfter +func (r apiGetCampaignAnalyticsRequest) RangeStart(rangeStart time.Time) apiGetCampaignAnalyticsRequest { + r.rangeStart = &rangeStart return r } -func (r apiGetChangesRequest) WithTotalResultSize(withTotalResultSize bool) apiGetChangesRequest { - r.withTotalResultSize = &withTotalResultSize +func (r apiGetCampaignAnalyticsRequest) RangeEnd(rangeEnd time.Time) apiGetCampaignAnalyticsRequest { + r.rangeEnd = &rangeEnd return r } -func (r apiGetChangesRequest) IncludeOld(includeOld bool) apiGetChangesRequest { - r.includeOld = &includeOld +func (r apiGetCampaignAnalyticsRequest) Granularity(granularity string) apiGetCampaignAnalyticsRequest { + r.granularity = &granularity return r } /* -GetChanges Get audit logs for an account -Export the audit logs displayed in **Accounts > Audit logs**. - +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 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 apiGetChangesRequest +@return apiGetCampaignAnalyticsRequest */ -func (a *ManagementApiService) GetChanges(ctx _context.Context) apiGetChangesRequest { - return apiGetChangesRequest{ - apiService: a, - ctx: ctx, +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 InlineResponse20032 + @return InlineResponse20020 */ -func (r apiGetChangesRequest) Execute() (InlineResponse20032, *_nethttp.Response, error) { +func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20020, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20032 + localVarReturnValue InlineResponse20020 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetChanges") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignAnalytics") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/changes" + 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.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.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") } - if r.withTotalResultSize != nil { - localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") } - if r.includeOld != nil { - localVarQueryParams.Add("includeOld", parameterToString(*r.includeOld, "")) + + 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{} @@ -8529,6 +9869,20 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20032, *_nethttp.Response } } } + 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 @@ -8551,7 +9905,7 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20032, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20032 + var v InlineResponse20020 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8574,65 +9928,104 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20032, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCollectionRequest struct { +type apiGetCampaignByAttributesRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 - campaignId int32 - collectionId 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 } /* -GetCollection Get collection -Retrieve a given collection. +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 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 +@return apiGetCampaignByAttributesRequest */ -func (a *ManagementApiService) GetCollection(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiGetCollectionRequest { - return apiGetCollectionRequest{ +func (a *ManagementApiService) GetCampaignByAttributes(ctx _context.Context, applicationId int32) apiGetCampaignByAttributesRequest { + return apiGetCampaignByAttributesRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, - collectionId: collectionId, } } /* Execute executes the request - @return Collection + @return InlineResponse2004 */ -func (r apiGetCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { +func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Collection + localVarReturnValue InlineResponse2004 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCollection") + 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}/campaigns/{campaignId}/collections/{collectionId}" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns_search" 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") + } + + 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) @@ -8648,6 +10041,22 @@ func (r apiGetCollectionRequest) Execute() (Collection, *_nethttp.Response, erro 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -8684,17 +10093,7 @@ func (r apiGetCollectionRequest) Execute() (Collection, *_nethttp.Response, erro 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 + var v InlineResponse2004 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8717,62 +10116,88 @@ func (r apiGetCollectionRequest) Execute() (Collection, *_nethttp.Response, erro return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCollectionItemsRequest struct { - ctx _context.Context - apiService *ManagementApiService - collectionId int32 - pageSize *int32 - skip *int32 +type apiGetCampaignTemplatesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + state *string + name *string + tags *string + userId *int32 } -func (r apiGetCollectionItemsRequest) PageSize(pageSize int32) apiGetCollectionItemsRequest { +func (r apiGetCampaignTemplatesRequest) PageSize(pageSize int32) apiGetCampaignTemplatesRequest { r.pageSize = &pageSize return r } -func (r apiGetCollectionItemsRequest) Skip(skip int32) apiGetCollectionItemsRequest { +func (r apiGetCampaignTemplatesRequest) Skip(skip int32) apiGetCampaignTemplatesRequest { r.skip = &skip return r } +func (r apiGetCampaignTemplatesRequest) Sort(sort string) apiGetCampaignTemplatesRequest { + r.sort = &sort + return r +} + +func (r apiGetCampaignTemplatesRequest) State(state string) apiGetCampaignTemplatesRequest { + r.state = &state + return r +} + +func (r apiGetCampaignTemplatesRequest) Name(name string) apiGetCampaignTemplatesRequest { + r.name = &name + return r +} + +func (r apiGetCampaignTemplatesRequest) Tags(tags string) apiGetCampaignTemplatesRequest { + r.tags = &tags + return r +} + +func (r apiGetCampaignTemplatesRequest) UserId(userId int32) apiGetCampaignTemplatesRequest { + r.userId = &userId + return r +} + /* -GetCollectionItems Get collection items -Retrieve the items from the given collection. +GetCampaignTemplates List campaign templates +Retrieve a list of campaign templates. - @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 apiGetCollectionItemsRequest +@return apiGetCampaignTemplatesRequest */ -func (a *ManagementApiService) GetCollectionItems(ctx _context.Context, collectionId int32) apiGetCollectionItemsRequest { - return apiGetCollectionItemsRequest{ - apiService: a, - ctx: ctx, - collectionId: collectionId, +func (a *ManagementApiService) GetCampaignTemplates(ctx _context.Context) apiGetCampaignTemplatesRequest { + return apiGetCampaignTemplatesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return InlineResponse20011 + @return InlineResponse20010 */ -func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { +func (r apiGetCampaignTemplatesRequest) Execute() (InlineResponse20010, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20011 + localVarReturnValue InlineResponse20010 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCollectionItems") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignTemplates") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/collections/{collectionId}/items" - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + localVarPath := localBasePath + "/v1/campaign_templates" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -8784,6 +10209,21 @@ func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20011, *_nethttp. if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) + } + 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.userId != nil { + localVarQueryParams.Add("userId", parameterToString(*r.userId, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -8815,6 +10255,20 @@ func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20011, *_nethttp. } } } + 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 @@ -8837,17 +10291,7 @@ func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20011, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - 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 + var v InlineResponse20010 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8870,127 +10314,111 @@ func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20011, *_nethttp. 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 +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 apiGetCouponsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCouponsWithoutTotalCountRequest { +func (r apiGetCampaignsRequest) PageSize(pageSize int32) apiGetCampaignsRequest { r.pageSize = &pageSize return r } -func (r apiGetCouponsWithoutTotalCountRequest) Skip(skip int32) apiGetCouponsWithoutTotalCountRequest { +func (r apiGetCampaignsRequest) Skip(skip int32) apiGetCampaignsRequest { r.skip = &skip return r } -func (r apiGetCouponsWithoutTotalCountRequest) Sort(sort string) apiGetCouponsWithoutTotalCountRequest { +func (r apiGetCampaignsRequest) Sort(sort string) apiGetCampaignsRequest { 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 +func (r apiGetCampaignsRequest) CampaignState(campaignState string) apiGetCampaignsRequest { + r.campaignState = &campaignState return r } -func (r apiGetCouponsWithoutTotalCountRequest) Valid(valid string) apiGetCouponsWithoutTotalCountRequest { - r.valid = &valid +func (r apiGetCampaignsRequest) Name(name string) apiGetCampaignsRequest { + r.name = &name return r } -func (r apiGetCouponsWithoutTotalCountRequest) Usable(usable string) apiGetCouponsWithoutTotalCountRequest { - r.usable = &usable +func (r apiGetCampaignsRequest) Tags(tags string) apiGetCampaignsRequest { + r.tags = &tags return r } -func (r apiGetCouponsWithoutTotalCountRequest) ReferralId(referralId int32) apiGetCouponsWithoutTotalCountRequest { - r.referralId = &referralId +func (r apiGetCampaignsRequest) CreatedBefore(createdBefore time.Time) apiGetCampaignsRequest { + r.createdBefore = &createdBefore return r } -func (r apiGetCouponsWithoutTotalCountRequest) RecipientIntegrationId(recipientIntegrationId string) apiGetCouponsWithoutTotalCountRequest { - r.recipientIntegrationId = &recipientIntegrationId +func (r apiGetCampaignsRequest) CreatedAfter(createdAfter time.Time) apiGetCampaignsRequest { + r.createdAfter = &createdAfter return r } -func (r apiGetCouponsWithoutTotalCountRequest) BatchId(batchId string) apiGetCouponsWithoutTotalCountRequest { - r.batchId = &batchId +func (r apiGetCampaignsRequest) CampaignGroupId(campaignGroupId int32) apiGetCampaignsRequest { + r.campaignGroupId = &campaignGroupId return r } -func (r apiGetCouponsWithoutTotalCountRequest) ExactMatch(exactMatch bool) apiGetCouponsWithoutTotalCountRequest { - r.exactMatch = &exactMatch +func (r apiGetCampaignsRequest) TemplateId(templateId int32) apiGetCampaignsRequest { + r.templateId = &templateId return r } /* -GetCouponsWithoutTotalCount List coupons -List all the coupons matching the specified criteria. +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 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 +@return apiGetCampaignsRequest */ -func (a *ManagementApiService) GetCouponsWithoutTotalCount(ctx _context.Context, applicationId int32, campaignId int32) apiGetCouponsWithoutTotalCountRequest { - return apiGetCouponsWithoutTotalCountRequest{ +func (a *ManagementApiService) GetCampaigns(ctx _context.Context, applicationId int32) apiGetCampaignsRequest { + return apiGetCampaignsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, - campaignId: campaignId, } } /* Execute executes the request - @return InlineResponse2007 + @return InlineResponse2004 */ -func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { +func (r apiGetCampaignsRequest) 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.GetCouponsWithoutTotalCount") + 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}/campaigns/{campaignId}/coupons/no_total" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns" 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{} @@ -9005,8 +10433,14 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_ if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - if r.value != nil { - localVarQueryParams.Add("value", parameterToString(*r.value, "")) + 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, "")) @@ -9014,23 +10448,11 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_ 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.campaignGroupId != nil { + localVarQueryParams.Add("campaignGroupId", parameterToString(*r.campaignGroupId, "")) } - if r.exactMatch != nil { - localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) + if r.templateId != nil { + localVarQueryParams.Add("templateId", parameterToString(*r.templateId, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9063,6 +10485,20 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_ } } } + 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 @@ -9085,7 +10521,17 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_ 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() + 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() @@ -9108,99 +10554,151 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_ return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerActivityReportRequest struct { - ctx _context.Context - apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time - applicationId int32 - customerId int32 - pageSize *int32 - skip *int32 +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 + managementKeyId *int32 + includeOld *bool } -func (r apiGetCustomerActivityReportRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportRequest { - r.rangeStart = &rangeStart +func (r apiGetChangesRequest) PageSize(pageSize int32) apiGetChangesRequest { + r.pageSize = &pageSize return r } -func (r apiGetCustomerActivityReportRequest) RangeEnd(rangeEnd time.Time) apiGetCustomerActivityReportRequest { - r.rangeEnd = &rangeEnd +func (r apiGetChangesRequest) Skip(skip int32) apiGetChangesRequest { + r.skip = &skip return r } -func (r apiGetCustomerActivityReportRequest) PageSize(pageSize int32) apiGetCustomerActivityReportRequest { - r.pageSize = &pageSize +func (r apiGetChangesRequest) Sort(sort string) apiGetChangesRequest { + r.sort = &sort return r } -func (r apiGetCustomerActivityReportRequest) Skip(skip int32) apiGetCustomerActivityReportRequest { - r.skip = &skip +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) ManagementKeyId(managementKeyId int32) apiGetChangesRequest { + r.managementKeyId = &managementKeyId + return r +} + +func (r apiGetChangesRequest) IncludeOld(includeOld bool) apiGetChangesRequest { + r.includeOld = &includeOld return r } /* -GetCustomerActivityReport Get customer's activity report -Fetch the summary report of a given customer in the given application, in a time range. +GetChanges Get audit logs for an account +Retrieve 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(). - - @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 +@return apiGetChangesRequest */ -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) GetChanges(ctx _context.Context) apiGetChangesRequest { + return apiGetChangesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return CustomerActivityReport + @return InlineResponse20038 */ -func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, *_nethttp.Response, error) { +func (r apiGetChangesRequest) Execute() (InlineResponse20038, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerActivityReport + localVarReturnValue InlineResponse20038 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReport") + 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/{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/changes" 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.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.managementKeyId != nil { + localVarQueryParams.Add("managementKeyId", parameterToString(*r.managementKeyId, "")) + } + if r.includeOld != nil { + localVarQueryParams.Add("includeOld", parameterToString(*r.includeOld, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9232,6 +10730,20 @@ func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, } } } + 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 @@ -9254,7 +10766,7 @@ func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerActivityReport + var v InlineResponse20038 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9277,142 +10789,63 @@ func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerActivityReportsWithoutTotalCountRequest struct { +type apiGetCollectionRequest 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 -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) CampaignName(campaignName string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.campaignName = &campaignName - return r -} - -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) AdvocateName(advocateName string) apiGetCustomerActivityReportsWithoutTotalCountRequest { - r.advocateName = &advocateName - return r + campaignId int32 + collectionId int32 } /* -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. - +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 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](#operation/listCollectionsInApplication) endpoint. -@return apiGetCustomerActivityReportsWithoutTotalCountRequest +@return apiGetCollectionRequest */ -func (a *ManagementApiService) GetCustomerActivityReportsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { - return apiGetCustomerActivityReportsWithoutTotalCountRequest{ +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 InlineResponse20019 + @return Collection */ -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (InlineResponse20019, *_nethttp.Response, error) { +func (r apiGetCollectionRequest) Execute() (Collection, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20019 + localVarReturnValue Collection ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReportsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCollection") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/customer_activity_reports/no_total" + 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.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, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9444,6 +10877,20 @@ func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (Inline } } } + 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 @@ -9466,7 +10913,17 @@ func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (Inline error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20019 + 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() @@ -9489,72 +10946,62 @@ 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 +type apiGetCollectionItemsRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 + pageSize *int32 + skip *int32 } -func (r apiGetCustomerAnalyticsRequest) PageSize(pageSize int32) apiGetCustomerAnalyticsRequest { +func (r apiGetCollectionItemsRequest) PageSize(pageSize int32) apiGetCollectionItemsRequest { r.pageSize = &pageSize return r } -func (r apiGetCustomerAnalyticsRequest) Skip(skip int32) apiGetCustomerAnalyticsRequest { +func (r apiGetCollectionItemsRequest) Skip(skip int32) apiGetCollectionItemsRequest { r.skip = &skip return r } -func (r apiGetCustomerAnalyticsRequest) Sort(sort string) apiGetCustomerAnalyticsRequest { - r.sort = &sort - return r -} - /* -GetCustomerAnalytics Get customer's analytics report -Fetch analytics for a given customer in the given application. +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(). - - @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. + - @param collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. -@return apiGetCustomerAnalyticsRequest +@return apiGetCollectionItemsRequest */ -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) GetCollectionItems(ctx _context.Context, collectionId int32) apiGetCollectionItemsRequest { + return apiGetCollectionItemsRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, } } /* Execute executes the request - @return CustomerAnalytics + @return InlineResponse20016 */ -func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp.Response, error) { +func (r apiGetCollectionItemsRequest) Execute() (InlineResponse20016, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerAnalytics + localVarReturnValue InlineResponse20016 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerAnalytics") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCollectionItems") 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/collections/{collectionId}/items" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -9566,9 +11013,6 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. 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{} @@ -9600,6 +11044,20 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. } } } + 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 @@ -9622,7 +11080,17 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerAnalytics + var v InlineResponse20016 + 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() @@ -9645,206 +11113,167 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomerProfileRequest struct { - ctx _context.Context - apiService *ManagementApiService - customerId int32 +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 } -/* -GetCustomerProfile Get customer profile -Return the details of the specified customer profile. +func (r apiGetCouponsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCouponsWithoutTotalCountRequest { + r.pageSize = &pageSize + return r +} -
+func (r apiGetCouponsWithoutTotalCountRequest) Skip(skip int32) apiGetCouponsWithoutTotalCountRequest { + r.skip = &skip + return r +} -

Performance tips

+func (r apiGetCouponsWithoutTotalCountRequest) Sort(sort string) apiGetCouponsWithoutTotalCountRequest { + r.sort = &sort + return r +} - You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: +func (r apiGetCouponsWithoutTotalCountRequest) Value(value string) apiGetCouponsWithoutTotalCountRequest { + r.value = &value + return r +} - - 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`. +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 +} + +func (r apiGetCouponsWithoutTotalCountRequest) Usable(usable string) apiGetCouponsWithoutTotalCountRequest { + r.usable = &usable + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) ReferralId(referralId int32) apiGetCouponsWithoutTotalCountRequest { + r.referralId = &referralId + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) RecipientIntegrationId(recipientIntegrationId string) apiGetCouponsWithoutTotalCountRequest { + r.recipientIntegrationId = &recipientIntegrationId + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) BatchId(batchId string) apiGetCouponsWithoutTotalCountRequest { + r.batchId = &batchId + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) ExactMatch(exactMatch bool) apiGetCouponsWithoutTotalCountRequest { + r.exactMatch = &exactMatch + return r +} + +/* +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(). - - @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. + - @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 apiGetCustomerProfileRequest +@return apiGetCouponsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetCustomerProfile(ctx _context.Context, customerId int32) apiGetCustomerProfileRequest { - return apiGetCustomerProfileRequest{ - apiService: a, - ctx: ctx, - customerId: customerId, +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 CustomerProfile + @return InlineResponse2008 */ -func (r apiGetCustomerProfileRequest) Execute() (CustomerProfile, *_nethttp.Response, error) { +func (r apiGetCouponsWithoutTotalCountRequest) 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.GetCouponsWithoutTotalCount") 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/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{} localVarFormParams := _neturl.Values{} - // to determine the Content-Type header - localVarHTTPContentTypes := []string{} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - 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.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } - 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.value != nil { + localVarQueryParams.Add("value", parameterToString(*r.value, "")) } - - localVarHTTPResponse, err := r.apiService.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) } - - localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - if localVarHTTPResponse.StatusCode == 200 { - var v CustomerProfile - 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.valid != nil { + localVarQueryParams.Add("valid", parameterToString(*r.valid, "")) } - - 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.usable != nil { + localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) } - - 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 -} - -/* -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 apiGetCustomerProfilesRequest -*/ -func (a *ManagementApiService) GetCustomerProfiles(ctx _context.Context) apiGetCustomerProfilesRequest { - return apiGetCustomerProfilesRequest{ - apiService: a, - ctx: ctx, + if r.referralId != nil { + localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) } -} - -/* -Execute executes the request - - @return InlineResponse20018 -*/ -func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodGet - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue InlineResponse20018 - ) - - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfiles") - if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + if r.recipientIntegrationId != nil { + localVarQueryParams.Add("recipientIntegrationId", parameterToString(*r.recipientIntegrationId, "")) } - - localVarPath := localBasePath + "/v1/customers/no_total" - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := _neturl.Values{} - localVarFormParams := _neturl.Values{} - - if r.pageSize != nil { - localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) } - if r.skip != nil { - localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + if r.exactMatch != nil { + localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -9877,6 +11306,20 @@ func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20018, *_nethttp } } } + 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 @@ -9899,7 +11342,7 @@ func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20018, *_nethttp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20018 + var v InlineResponse2008 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9922,74 +11365,89 @@ func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20018, *_nethttp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetCustomersByAttributesRequest struct { - ctx _context.Context - apiService *ManagementApiService - body *CustomerProfileSearchQuery - pageSize *int32 - skip *int32 +type apiGetCustomerActivityReportRequest struct { + ctx _context.Context + apiService *ManagementApiService + rangeStart *time.Time + rangeEnd *time.Time + applicationId int32 + customerId int32 + pageSize *int32 + skip *int32 } -func (r apiGetCustomersByAttributesRequest) Body(body CustomerProfileSearchQuery) apiGetCustomersByAttributesRequest { - r.body = &body +func (r apiGetCustomerActivityReportRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportRequest { + r.rangeStart = &rangeStart return r } -func (r apiGetCustomersByAttributesRequest) PageSize(pageSize int32) apiGetCustomersByAttributesRequest { +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 apiGetCustomersByAttributesRequest) Skip(skip int32) apiGetCustomersByAttributesRequest { +func (r apiGetCustomerActivityReportRequest) Skip(skip int32) apiGetCustomerActivityReportRequest { r.skip = &skip return r } /* -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. - +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 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](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. -@return apiGetCustomersByAttributesRequest +@return apiGetCustomerActivityReportRequest */ -func (a *ManagementApiService) GetCustomersByAttributes(ctx _context.Context) apiGetCustomersByAttributesRequest { - return apiGetCustomersByAttributesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetCustomerActivityReport(ctx _context.Context, applicationId int32, customerId int32) apiGetCustomerActivityReportRequest { + return apiGetCustomerActivityReportRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + customerId: customerId, } } /* Execute executes the request - @return InlineResponse20018 + @return CustomerActivityReport */ -func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { +func (r apiGetCustomerActivityReportRequest) Execute() (CustomerActivityReport, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20018 + localVarReturnValue CustomerActivityReport ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomersByAttributes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReport") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/customer_search/no_total" + 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) 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.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 { @@ -9998,8 +11456,10 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20018, *_ne 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{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10015,8 +11475,20 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20018, *_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 { + 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.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -10053,7 +11525,7 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20018, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20018 + var v CustomerActivityReport err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10076,88 +11548,119 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20018, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetEventTypesRequest struct { - ctx _context.Context - apiService *ManagementApiService - name *string - includeOldVersions *bool - pageSize *int32 - skip *int32 - sort *string +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 apiGetEventTypesRequest) Name(name string) apiGetEventTypesRequest { - r.name = &name +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) RangeStart(rangeStart time.Time) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.rangeStart = &rangeStart return r } -func (r apiGetEventTypesRequest) IncludeOldVersions(includeOldVersions bool) apiGetEventTypesRequest { - r.includeOldVersions = &includeOldVersions +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) RangeEnd(rangeEnd time.Time) apiGetCustomerActivityReportsWithoutTotalCountRequest { + r.rangeEnd = &rangeEnd return r } -func (r apiGetEventTypesRequest) PageSize(pageSize int32) apiGetEventTypesRequest { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { r.pageSize = &pageSize return r } -func (r apiGetEventTypesRequest) Skip(skip int32) apiGetEventTypesRequest { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Skip(skip int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { r.skip = &skip return r } -func (r apiGetEventTypesRequest) Sort(sort string) apiGetEventTypesRequest { +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 +} + /* -GetEventTypes List event types -Fetch all event type definitions for your account. +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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiGetEventTypesRequest +@return apiGetCustomerActivityReportsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetEventTypes(ctx _context.Context) apiGetEventTypesRequest { - return apiGetEventTypesRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) GetCustomerActivityReportsWithoutTotalCount(ctx _context.Context, applicationId int32) apiGetCustomerActivityReportsWithoutTotalCountRequest { + return apiGetCustomerActivityReportsWithoutTotalCountRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return InlineResponse20030 + @return InlineResponse20025 */ -func (r apiGetEventTypesRequest) Execute() (InlineResponse20030, *_nethttp.Response, error) { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (InlineResponse20025, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20030 + localVarReturnValue InlineResponse20025 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetEventTypes") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReportsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/event_types" + 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.name != nil { - localVarQueryParams.Add("name", parameterToString(*r.name, "")) + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") } - if r.includeOldVersions != nil { - localVarQueryParams.Add("includeOldVersions", parameterToString(*r.includeOldVersions, "")) + + 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, "")) } @@ -10167,6 +11670,20 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20030, *_nethttp.Respo 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{} @@ -10198,6 +11715,20 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20030, *_nethttp.Respo } } } + 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 @@ -10220,7 +11751,7 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20030, *_nethttp.Respo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20030 + var v InlineResponse20025 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10243,77 +11774,72 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20030, *_nethttp.Respo return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetExportsRequest struct { +type apiGetCustomerAnalyticsRequest struct { ctx _context.Context apiService *ManagementApiService + applicationId int32 + customerId int32 pageSize *int32 skip *int32 - applicationId *float32 - campaignId *int32 - entity *string + sort *string } -func (r apiGetExportsRequest) PageSize(pageSize int32) apiGetExportsRequest { +func (r apiGetCustomerAnalyticsRequest) PageSize(pageSize int32) apiGetCustomerAnalyticsRequest { r.pageSize = &pageSize return r } -func (r apiGetExportsRequest) Skip(skip int32) apiGetExportsRequest { +func (r apiGetCustomerAnalyticsRequest) Skip(skip int32) apiGetCustomerAnalyticsRequest { r.skip = &skip return r } -func (r apiGetExportsRequest) ApplicationId(applicationId float32) apiGetExportsRequest { - r.applicationId = &applicationId - return r -} - -func (r apiGetExportsRequest) CampaignId(campaignId int32) apiGetExportsRequest { - r.campaignId = &campaignId - return r -} - -func (r apiGetExportsRequest) Entity(entity string) apiGetExportsRequest { - r.entity = &entity +func (r apiGetCustomerAnalyticsRequest) Sort(sort string) apiGetCustomerAnalyticsRequest { + r.sort = &sort return r } /* -GetExports Get exports -List all past exports - +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 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](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. -@return apiGetExportsRequest +@return apiGetCustomerAnalyticsRequest */ -func (a *ManagementApiService) GetExports(ctx _context.Context) apiGetExportsRequest { - return apiGetExportsRequest{ - apiService: a, - ctx: ctx, +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 InlineResponse20033 + @return CustomerAnalytics */ -func (r apiGetExportsRequest) Execute() (InlineResponse20033, *_nethttp.Response, error) { +func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20033 + localVarReturnValue CustomerAnalytics ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetExports") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerAnalytics") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/exports" + 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{} @@ -10325,14 +11851,8 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20033, *_nethttp.Response if r.skip != nil { localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) } - 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, "")) + if r.sort != nil { + localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -10365,6 +11885,20 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20033, *_nethttp.Response } } } + 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 @@ -10387,7 +11921,7 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20033, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20033 + var v CustomerAnalytics err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10410,58 +11944,63 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20033, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyPointsRequest struct { - ctx _context.Context - apiService *ManagementApiService - loyaltyProgramId string - integrationId string +type apiGetCustomerProfileRequest struct { + ctx _context.Context + apiService *ManagementApiService + customerId int32 } /* -GetLoyaltyPoints Get the Loyalty Ledger for this integrationID -Get the loyalty ledger for this profile integration ID. +GetCustomerProfile Get customer profile +Return the details of the specified customer profile. -To get the `integrationId` of the profile from a `sessionId`, use the -[Update customer session](/integration-api/#operation/updateCustomerSessionV2). +
+ +

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`. + +
- @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. + - @param customerId The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. -@return apiGetLoyaltyPointsRequest +@return apiGetCustomerProfileRequest */ -func (a *ManagementApiService) GetLoyaltyPoints(ctx _context.Context, loyaltyProgramId string, integrationId string) apiGetLoyaltyPointsRequest { - return apiGetLoyaltyPointsRequest{ - apiService: a, - ctx: ctx, - loyaltyProgramId: loyaltyProgramId, - integrationId: integrationId, +func (a *ManagementApiService) GetCustomerProfile(ctx _context.Context, customerId int32) apiGetCustomerProfileRequest { + return apiGetCustomerProfileRequest{ + apiService: a, + ctx: ctx, + customerId: customerId, } } /* Execute executes the request - @return LoyaltyLedger + @return CustomerProfile */ -func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response, error) { +func (r apiGetCustomerProfileRequest) Execute() (CustomerProfile, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyLedger + localVarReturnValue CustomerProfile ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPoints") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfile") 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) + localVarPath := localBasePath + "/v1/customers/{customerId}" + localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -10498,6 +12037,20 @@ func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response } } } + 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 @@ -10520,7 +12073,7 @@ func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyLedger + var v CustomerProfile err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10543,60 +12096,78 @@ func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyProgramRequest struct { - ctx _context.Context - apiService *ManagementApiService - loyaltyProgramId int32 +type apiGetCustomerProfilesRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sandbox *bool } -/* -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 apiGetCustomerProfilesRequest) PageSize(pageSize int32) apiGetCustomerProfilesRequest { + r.pageSize = &pageSize + 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) +func (r apiGetCustomerProfilesRequest) Skip(skip int32) apiGetCustomerProfilesRequest { + r.skip = &skip + return r +} + +func (r apiGetCustomerProfilesRequest) Sandbox(sandbox bool) apiGetCustomerProfilesRequest { + r.sandbox = &sandbox + return r +} +/* +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(). - - @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 +@return apiGetCustomerProfilesRequest */ -func (a *ManagementApiService) GetLoyaltyProgram(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyProgramRequest { - return apiGetLoyaltyProgramRequest{ - apiService: a, - ctx: ctx, - loyaltyProgramId: loyaltyProgramId, +func (a *ManagementApiService) GetCustomerProfiles(ctx _context.Context) apiGetCustomerProfilesRequest { + return apiGetCustomerProfilesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return LoyaltyProgram + @return InlineResponse20024 */ -func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Response, error) { +func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20024, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyProgram + localVarReturnValue InlineResponse20024 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyProgram") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfiles") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}" - localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath := localBasePath + "/v1/customers/no_total" 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.sandbox != nil { + localVarQueryParams.Add("sandbox", parameterToString(*r.sandbox, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -10628,6 +12199,20 @@ func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Respon } } } + 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 @@ -10650,7 +12235,7 @@ func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyProgram + var v InlineResponse20024 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10673,20 +12258,47 @@ func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Respon return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyProgramsRequest struct { +type apiGetCustomersByAttributesRequest struct { ctx _context.Context apiService *ManagementApiService + body *CustomerProfileSearchQuery + pageSize *int32 + skip *int32 + sandbox *bool +} + +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 +} + +func (r apiGetCustomersByAttributesRequest) Sandbox(sandbox bool) apiGetCustomersByAttributesRequest { + r.sandbox = &sandbox + return r } /* -GetLoyaltyPrograms List loyalty programs -List the loyalty programs of the account. +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. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiGetLoyaltyProgramsRequest +@return apiGetCustomersByAttributesRequest */ -func (a *ManagementApiService) GetLoyaltyPrograms(ctx _context.Context) apiGetLoyaltyProgramsRequest { - return apiGetLoyaltyProgramsRequest{ +func (a *ManagementApiService) GetCustomersByAttributes(ctx _context.Context) apiGetCustomersByAttributesRequest { + return apiGetCustomersByAttributesRequest{ apiService: a, ctx: ctx, } @@ -10695,31 +12307,44 @@ func (a *ManagementApiService) GetLoyaltyPrograms(ctx _context.Context) apiGetLo /* Execute executes the request - @return InlineResponse2009 + @return InlineResponse20023 */ -func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { +func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20023, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2009 + localVarReturnValue InlineResponse20023 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPrograms") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomersByAttributes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs" + localVarPath := localBasePath + "/v1/customer_search/no_total" 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.sandbox != nil { + localVarQueryParams.Add("sandbox", parameterToString(*r.sandbox, "")) + } // to determine the Content-Type header - localVarHTTPContentTypes := []string{} + localVarHTTPContentTypes := []string{"application/json"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -10735,6 +12360,22 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2009, *_nethttp.R 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -10771,7 +12412,7 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2009, *_nethttp.R error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2009 + var v InlineResponse20023 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10794,57 +12435,97 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2009, *_nethttp.R return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetLoyaltyStatisticsRequest struct { - ctx _context.Context - apiService *ManagementApiService - loyaltyProgramId int32 +type apiGetEventTypesRequest struct { + ctx _context.Context + apiService *ManagementApiService + name *string + includeOldVersions *bool + pageSize *int32 + skip *int32 + sort *string +} + +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 } /* -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. +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 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 +@return apiGetEventTypesRequest */ -func (a *ManagementApiService) GetLoyaltyStatistics(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyStatisticsRequest { - return apiGetLoyaltyStatisticsRequest{ - apiService: a, - ctx: ctx, - loyaltyProgramId: loyaltyProgramId, +func (a *ManagementApiService) GetEventTypes(ctx _context.Context) apiGetEventTypesRequest { + return apiGetEventTypesRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - @return LoyaltyStatistics + @return InlineResponse20036 */ -func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp.Response, error) { +func (r apiGetEventTypesRequest) Execute() (InlineResponse20036, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyStatistics + localVarReturnValue InlineResponse20036 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyStatistics") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetEventTypes") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/statistics" - localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -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, "")) + } + 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{} @@ -10876,6 +12557,20 @@ func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp. } } } + 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 @@ -10898,7 +12593,7 @@ func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyStatistics + var v InlineResponse20036 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10921,59 +12616,97 @@ func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetNotificationWebhookRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - notificationWebhookId int32 +type apiGetExportsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + applicationId *float32 + campaignId *int32 + entity *string } -/* -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(). - - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - - @param notificationWebhookId +func (r apiGetExportsRequest) PageSize(pageSize int32) apiGetExportsRequest { + r.pageSize = &pageSize + return r +} -@return apiGetNotificationWebhookRequest -*/ -func (a *ManagementApiService) GetNotificationWebhook(ctx _context.Context, applicationId int32, notificationWebhookId int32) apiGetNotificationWebhookRequest { - return apiGetNotificationWebhookRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - notificationWebhookId: notificationWebhookId, - } +func (r apiGetExportsRequest) Skip(skip int32) apiGetExportsRequest { + r.skip = &skip + return r } -/* -Execute executes the request +func (r apiGetExportsRequest) ApplicationId(applicationId float32) apiGetExportsRequest { + r.applicationId = &applicationId + return r +} - @return NotificationWebhook +func (r apiGetExportsRequest) CampaignId(campaignId int32) apiGetExportsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiGetExportsRequest) Entity(entity string) apiGetExportsRequest { + r.entity = &entity + return r +} + +/* +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(). + +@return apiGetExportsRequest */ -func (r apiGetNotificationWebhookRequest) Execute() (NotificationWebhook, *_nethttp.Response, error) { +func (a *ManagementApiService) GetExports(ctx _context.Context) apiGetExportsRequest { + return apiGetExportsRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return InlineResponse20039 +*/ +func (r apiGetExportsRequest) Execute() (InlineResponse20039, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue NotificationWebhook + localVarReturnValue InlineResponse20039 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetNotificationWebhook") + 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}/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) + localVarPath := localBasePath + "/v1/exports" 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.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{} @@ -11005,6 +12738,20 @@ func (r apiGetNotificationWebhookRequest) Execute() (NotificationWebhook, *_neth } } } + 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 @@ -11027,7 +12774,7 @@ func (r apiGetNotificationWebhookRequest) Execute() (NotificationWebhook, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v NotificationWebhook + var v InlineResponse20039 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11050,55 +12797,63 @@ func (r apiGetNotificationWebhookRequest) Execute() (NotificationWebhook, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetNotificationWebhooksRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 +type apiGetLoyaltyCardRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string } /* -GetNotificationWebhooks List notification webhooks -List all outbound notification webhooks for this application. +GetLoyaltyCard Get loyalty card +Get the given loyalty card. - @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 loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. -@return apiGetNotificationWebhooksRequest +@return apiGetLoyaltyCardRequest */ -func (a *ManagementApiService) GetNotificationWebhooks(ctx _context.Context, applicationId int32) apiGetNotificationWebhooksRequest { - return apiGetNotificationWebhooksRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, +func (a *ManagementApiService) GetLoyaltyCard(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiGetLoyaltyCardRequest { + return apiGetLoyaltyCardRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, } } /* Execute executes the request - @return InlineResponse2004 + @return LoyaltyCard */ -func (r apiGetNotificationWebhooksRequest) Execute() (InlineResponse2004, *_nethttp.Response, error) { +func (r apiGetLoyaltyCardRequest) Execute() (LoyaltyCard, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2004 + localVarReturnValue LoyaltyCard ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetNotificationWebhooks") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyCard") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/notification_webhooks" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") + } + // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -11130,6 +12885,20 @@ func (r apiGetNotificationWebhooksRequest) Execute() (InlineResponse2004, *_neth } } } + 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 @@ -11152,7 +12921,37 @@ func (r apiGetNotificationWebhooksRequest) Execute() (InlineResponse2004, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2004 + var v LoyaltyCard + 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() @@ -11175,139 +12974,110 @@ func (r apiGetNotificationWebhooksRequest) Execute() (InlineResponse2004, *_neth 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 -} - -func (r apiGetReferralsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetReferralsWithoutTotalCountRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) Skip(skip int32) apiGetReferralsWithoutTotalCountRequest { - r.skip = &skip - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) Sort(sort string) apiGetReferralsWithoutTotalCountRequest { - r.sort = &sort - return r -} - -func (r apiGetReferralsWithoutTotalCountRequest) Code(code string) apiGetReferralsWithoutTotalCountRequest { - r.code = &code - return r +type apiGetLoyaltyCardTransactionLogsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string + startDate *time.Time + endDate *time.Time + pageSize *int32 + skip *int32 + subledgerId *string } -func (r apiGetReferralsWithoutTotalCountRequest) CreatedBefore(createdBefore time.Time) apiGetReferralsWithoutTotalCountRequest { - r.createdBefore = &createdBefore +func (r apiGetLoyaltyCardTransactionLogsRequest) StartDate(startDate time.Time) apiGetLoyaltyCardTransactionLogsRequest { + r.startDate = &startDate return r } -func (r apiGetReferralsWithoutTotalCountRequest) CreatedAfter(createdAfter time.Time) apiGetReferralsWithoutTotalCountRequest { - r.createdAfter = &createdAfter +func (r apiGetLoyaltyCardTransactionLogsRequest) EndDate(endDate time.Time) apiGetLoyaltyCardTransactionLogsRequest { + r.endDate = &endDate return r } -func (r apiGetReferralsWithoutTotalCountRequest) Valid(valid string) apiGetReferralsWithoutTotalCountRequest { - r.valid = &valid +func (r apiGetLoyaltyCardTransactionLogsRequest) PageSize(pageSize int32) apiGetLoyaltyCardTransactionLogsRequest { + r.pageSize = &pageSize return r } -func (r apiGetReferralsWithoutTotalCountRequest) Usable(usable string) apiGetReferralsWithoutTotalCountRequest { - r.usable = &usable +func (r apiGetLoyaltyCardTransactionLogsRequest) Skip(skip int32) apiGetLoyaltyCardTransactionLogsRequest { + r.skip = &skip return r } -func (r apiGetReferralsWithoutTotalCountRequest) Advocate(advocate string) apiGetReferralsWithoutTotalCountRequest { - r.advocate = &advocate +func (r apiGetLoyaltyCardTransactionLogsRequest) SubledgerId(subledgerId string) apiGetLoyaltyCardTransactionLogsRequest { + r.subledgerId = &subledgerId return r } /* -GetReferralsWithoutTotalCount List referrals -List all referrals of the specified campaign. +GetLoyaltyCardTransactionLogs List card's transactions +Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) +within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. +If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned. + - @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 loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. -@return apiGetReferralsWithoutTotalCountRequest +@return apiGetLoyaltyCardTransactionLogsRequest */ -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) GetLoyaltyCardTransactionLogs(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiGetLoyaltyCardTransactionLogsRequest { + return apiGetLoyaltyCardTransactionLogsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, } } /* Execute executes the request - @return InlineResponse2008 + @return InlineResponse20014 */ -func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { +func (r apiGetLoyaltyCardTransactionLogsRequest) Execute() (InlineResponse20014, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2008 + localVarReturnValue InlineResponse20014 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetReferralsWithoutTotalCount") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyCardTransactionLogs") 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/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") + } + + if r.startDate != nil { + localVarQueryParams.Add("startDate", parameterToString(*r.startDate, "")) + } + 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, "")) } - 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, "")) + if r.subledgerId != nil { + localVarQueryParams.Add("subledgerId", parameterToString(*r.subledgerId, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -11340,6 +13110,20 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2008, } } } + 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 @@ -11362,15 +13146,35 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2008, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2008 + var v InlineResponse20014 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 + 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")) @@ -11385,56 +13189,101 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2008, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetRoleRequest struct { - ctx _context.Context - apiService *ManagementApiService - roleId int32 +type apiGetLoyaltyCardsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + pageSize *int32 + skip *int32 + sort *string + identifier *string + profileId *int32 +} + +func (r apiGetLoyaltyCardsRequest) PageSize(pageSize int32) apiGetLoyaltyCardsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetLoyaltyCardsRequest) Skip(skip int32) apiGetLoyaltyCardsRequest { + r.skip = &skip + return r +} + +func (r apiGetLoyaltyCardsRequest) Sort(sort string) apiGetLoyaltyCardsRequest { + r.sort = &sort + return r +} + +func (r apiGetLoyaltyCardsRequest) Identifier(identifier string) apiGetLoyaltyCardsRequest { + r.identifier = &identifier + return r +} + +func (r apiGetLoyaltyCardsRequest) ProfileId(profileId int32) apiGetLoyaltyCardsRequest { + r.profileId = &profileId + return r } /* -GetRole Get role -Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles). +GetLoyaltyCards List loyalty cards +For the given card-based loyalty program, list the loyalty cards that match your filter criteria. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param roleId The Id of role. + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiGetRoleRequest +@return apiGetLoyaltyCardsRequest */ -func (a *ManagementApiService) GetRole(ctx _context.Context, roleId int32) apiGetRoleRequest { - return apiGetRoleRequest{ - apiService: a, - ctx: ctx, - roleId: roleId, +func (a *ManagementApiService) GetLoyaltyCards(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyCardsRequest { + return apiGetLoyaltyCardsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return Role + @return InlineResponse20013 */ -func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { +func (r apiGetLoyaltyCardsRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Role + localVarReturnValue InlineResponse20013 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRole") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyCards") 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/loyalty_programs/{loyaltyProgramId}/cards" + 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, "")) + } + if r.identifier != nil { + localVarQueryParams.Add("identifier", parameterToString(*r.identifier, "")) + } + if r.profileId != nil { + localVarQueryParams.Add("profileId", parameterToString(*r.profileId, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -11466,6 +13315,20 @@ func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { } } } + 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 @@ -11488,7 +13351,27 @@ func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Role + var v InlineResponse20013 + 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() @@ -11511,58 +13394,61 @@ 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 apiGetLoyaltyPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId string + integrationId string } /* -GetRuleset Get ruleset -Retrieve the specified ruleset. +GetLoyaltyPoints Get customer's full loyalty ledger +Get the loyalty ledger for this profile integration ID. + +To get the `integrationId` of the profile from a `sessionId`, use the +[Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. + +**Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, +we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions). + - @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 rulesetId + - @param loyaltyProgramId The identifier for the loyalty program. + - @param integrationId The identifier of the profile. -@return apiGetRulesetRequest +@return apiGetLoyaltyPointsRequest */ -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) GetLoyaltyPoints(ctx _context.Context, loyaltyProgramId string, integrationId string) apiGetLoyaltyPointsRequest { + return apiGetLoyaltyPointsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, } } /* Execute executes the request - @return Ruleset + @return LoyaltyLedger */ -func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { +func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Ruleset + localVarReturnValue LoyaltyLedger ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRuleset") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPoints") 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/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{} @@ -11599,6 +13485,20 @@ func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { } } } + 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 @@ -11621,7 +13521,7 @@ func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Ruleset + var v LoyaltyLedger err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11644,89 +13544,60 @@ func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -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 +type apiGetLoyaltyProgramRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 } /* -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. +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). + +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) - @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 loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiGetRulesetsRequest +@return apiGetLoyaltyProgramRequest */ -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) GetLoyaltyProgram(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyProgramRequest { + return apiGetLoyaltyProgramRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return InlineResponse2005 + @return LoyaltyProgram */ -func (r apiGetRulesetsRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramRequest) Execute() (LoyaltyProgram, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2005 + localVarReturnValue LoyaltyProgram ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRulesets") + 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}/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/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{} @@ -11758,8 +13629,22 @@ func (r apiGetRulesetsRequest) Execute() (InlineResponse2005, *_nethttp.Response } } } - req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) - if err != nil { + 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 } @@ -11780,7 +13665,7 @@ func (r apiGetRulesetsRequest) Execute() (InlineResponse2005, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2005 + var v LoyaltyProgram err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11803,56 +13688,114 @@ func (r apiGetRulesetsRequest) Execute() (InlineResponse2005, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetUserRequest struct { - ctx _context.Context - apiService *ManagementApiService - userId int32 +type apiGetLoyaltyProgramTransactionsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyTransactionType *string + subledgerId *string + startDate *time.Time + endDate *time.Time + pageSize *int32 + skip *int32 +} + +func (r apiGetLoyaltyProgramTransactionsRequest) LoyaltyTransactionType(loyaltyTransactionType string) apiGetLoyaltyProgramTransactionsRequest { + r.loyaltyTransactionType = &loyaltyTransactionType + return r +} + +func (r apiGetLoyaltyProgramTransactionsRequest) SubledgerId(subledgerId string) apiGetLoyaltyProgramTransactionsRequest { + r.subledgerId = &subledgerId + return r +} + +func (r apiGetLoyaltyProgramTransactionsRequest) StartDate(startDate time.Time) apiGetLoyaltyProgramTransactionsRequest { + r.startDate = &startDate + return r +} + +func (r apiGetLoyaltyProgramTransactionsRequest) EndDate(endDate time.Time) apiGetLoyaltyProgramTransactionsRequest { + r.endDate = &endDate + return r +} + +func (r apiGetLoyaltyProgramTransactionsRequest) PageSize(pageSize int32) apiGetLoyaltyProgramTransactionsRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetLoyaltyProgramTransactionsRequest) Skip(skip int32) apiGetLoyaltyProgramTransactionsRequest { + r.skip = &skip + return r } /* -GetUser Get user -Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile. +GetLoyaltyProgramTransactions List loyalty program transactions +Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. +If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. + +**Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, +we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions). - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param userId The ID of the user. + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiGetUserRequest +@return apiGetLoyaltyProgramTransactionsRequest */ -func (a *ManagementApiService) GetUser(ctx _context.Context, userId int32) apiGetUserRequest { - return apiGetUserRequest{ - apiService: a, - ctx: ctx, - userId: userId, +func (a *ManagementApiService) GetLoyaltyProgramTransactions(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyProgramTransactionsRequest { + return apiGetLoyaltyProgramTransactionsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return User + @return InlineResponse20012 */ -func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramTransactionsRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue User + localVarReturnValue InlineResponse20012 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUser") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyProgramTransactions") 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/loyalty_programs/{loyaltyProgramId}/transactions" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.loyaltyTransactionType != nil { + localVarQueryParams.Add("loyaltyTransactionType", parameterToString(*r.loyaltyTransactionType, "")) + } + if r.subledgerId != nil { + localVarQueryParams.Add("subledgerId", parameterToString(*r.subledgerId, "")) + } + if r.startDate != nil { + localVarQueryParams.Add("startDate", parameterToString(*r.startDate, "")) + } + 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{} @@ -11884,6 +13827,20 @@ func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { } } } + 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 @@ -11906,7 +13863,37 @@ func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v User + 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 + } + 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() @@ -11929,39 +13916,20 @@ func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetUsersRequest struct { +type apiGetLoyaltyProgramsRequest struct { ctx _context.Context apiService *ManagementApiService - pageSize *int32 - skip *int32 - sort *string -} - -func (r apiGetUsersRequest) PageSize(pageSize int32) apiGetUsersRequest { - r.pageSize = &pageSize - return r -} - -func (r apiGetUsersRequest) Skip(skip int32) apiGetUsersRequest { - r.skip = &skip - return r -} - -func (r apiGetUsersRequest) Sort(sort string) apiGetUsersRequest { - r.sort = &sort - return r } /* -GetUsers List users in account -Retrieve all users in your account. - +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(). -@return apiGetUsersRequest +@return apiGetLoyaltyProgramsRequest */ -func (a *ManagementApiService) GetUsers(ctx _context.Context) apiGetUsersRequest { - return apiGetUsersRequest{ +func (a *ManagementApiService) GetLoyaltyPrograms(ctx _context.Context) apiGetLoyaltyProgramsRequest { + return apiGetLoyaltyProgramsRequest{ apiService: a, ctx: ctx, } @@ -11970,38 +13938,29 @@ func (a *ManagementApiService) GetUsers(ctx _context.Context) apiGetUsersRequest /* Execute executes the request - @return InlineResponse20031 + @return InlineResponse20011 */ -func (r apiGetUsersRequest) Execute() (InlineResponse20031, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20031 + localVarReturnValue InlineResponse20011 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUsers") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPrograms") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/users" + localVarPath := localBasePath + "/v1/loyalty_programs" 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{} @@ -12033,6 +13992,20 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20031, *_nethttp.Response, } } } + 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 @@ -12055,7 +14028,7 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20031, *_nethttp.Response, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20031 + var v InlineResponse20011 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12078,50 +14051,55 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20031, *_nethttp.Response, return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetWebhookRequest struct { - ctx _context.Context - apiService *ManagementApiService - webhookId int32 +type apiGetLoyaltyStatisticsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 } /* -GetWebhook Get webhook -Returns a webhook by its id. +GetLoyaltyStatistics Get loyalty program statistics +Retrieve the statistics of the specified loyalty program such as the +total active points, pending points, spent points, and expired points. + +**Important:** The returned data does not include the current day. All statistics +are updated daily at 11:59 PM in the loyalty program time zone. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param webhookId + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiGetWebhookRequest +@return apiGetLoyaltyStatisticsRequest */ -func (a *ManagementApiService) GetWebhook(ctx _context.Context, webhookId int32) apiGetWebhookRequest { - return apiGetWebhookRequest{ - apiService: a, - ctx: ctx, - webhookId: webhookId, +func (a *ManagementApiService) GetLoyaltyStatistics(ctx _context.Context, loyaltyProgramId int32) apiGetLoyaltyStatisticsRequest { + return apiGetLoyaltyStatisticsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return Webhook + @return LoyaltyStatistics */ -func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { +func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Webhook + localVarReturnValue LoyaltyStatistics ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhook") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyStatistics") 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/loyalty_programs/{loyaltyProgramId}/statistics" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -12158,6 +14136,20 @@ func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { } } } + 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 @@ -12180,7 +14172,7 @@ func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Webhook + var v LoyaltyStatistics err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12203,132 +14195,61 @@ 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 -} - -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 +type apiGetNotificationWebhookRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + notificationWebhookId int32 } /* -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. +GetNotificationWebhook Get notification about campaign-related changes +Return the given +[notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + - @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 The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. -@return apiGetWebhookActivationLogsRequest +@return apiGetNotificationWebhookRequest */ -func (a *ManagementApiService) GetWebhookActivationLogs(ctx _context.Context) apiGetWebhookActivationLogsRequest { - return apiGetWebhookActivationLogsRequest{ - 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 InlineResponse20028 + @return NotificationWebhook */ -func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20028, *_nethttp.Response, error) { +func (r apiGetNotificationWebhookRequest) Execute() (NotificationWebhook, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20028 + localVarReturnValue NotificationWebhook ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookActivationLogs") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetNotificationWebhook") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhook_activation_logs" + 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.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{} @@ -12360,6 +14281,20 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20028, *_ne } } } + 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 @@ -12382,7 +14317,7 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20028, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20028 + var v NotificationWebhook err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12405,141 +14340,58 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20028, *_ne return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetWebhookLogsRequest struct { +type apiGetNotificationWebhooksRequest 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 -} - -func (r apiGetWebhookLogsRequest) Skip(skip int32) apiGetWebhookLogsRequest { - r.skip = &skip - return r -} - -func (r apiGetWebhookLogsRequest) Sort(sort string) apiGetWebhookLogsRequest { - r.sort = &sort - return r -} - -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 + applicationId int32 } /* -GetWebhookLogs List webhook log entries -Retrieve all webhook log entries. +GetNotificationWebhooks List notifications about campaign-related changes +List all +[notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) +for the given Application. + - @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 apiGetWebhookLogsRequest +@return apiGetNotificationWebhooksRequest */ -func (a *ManagementApiService) GetWebhookLogs(ctx _context.Context) apiGetWebhookLogsRequest { - return apiGetWebhookLogsRequest{ - 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 InlineResponse20029 + @return InlineResponse2005 */ -func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20029, *_nethttp.Response, error) { +func (r apiGetNotificationWebhooksRequest) Execute() (InlineResponse2005, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20029 + localVarReturnValue InlineResponse2005 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookLogs") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetNotificationWebhooks") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhook_logs" + 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.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{} @@ -12571,6 +14423,20 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20029, *_nethttp.Resp } } } + 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 @@ -12593,7 +14459,7 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20029, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20029 + var v InlineResponse2005 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12616,87 +14482,280 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20029, *_nethttp.Resp return localVarReturnValue, localVarHTTPResponse, nil } -type apiGetWebhooksRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationIds *string - sort *string - pageSize *int32 - skip *int32 +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 } -func (r apiGetWebhooksRequest) ApplicationIds(applicationIds string) apiGetWebhooksRequest { - r.applicationIds = &applicationIds +func (r apiGetReferralsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetReferralsWithoutTotalCountRequest { + r.pageSize = &pageSize return r } -func (r apiGetWebhooksRequest) Sort(sort string) apiGetWebhooksRequest { +func (r apiGetReferralsWithoutTotalCountRequest) Skip(skip int32) apiGetReferralsWithoutTotalCountRequest { + r.skip = &skip + return r +} + +func (r apiGetReferralsWithoutTotalCountRequest) Sort(sort string) apiGetReferralsWithoutTotalCountRequest { r.sort = &sort return r } -func (r apiGetWebhooksRequest) PageSize(pageSize int32) apiGetWebhooksRequest { - r.pageSize = &pageSize +func (r apiGetReferralsWithoutTotalCountRequest) Code(code string) apiGetReferralsWithoutTotalCountRequest { + r.code = &code return r } -func (r apiGetWebhooksRequest) Skip(skip int32) apiGetWebhooksRequest { - r.skip = &skip +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 } /* -GetWebhooks List webhooks -List all webhooks. +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(). + - @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 apiGetWebhooksRequest +@return apiGetReferralsWithoutTotalCountRequest */ -func (a *ManagementApiService) GetWebhooks(ctx _context.Context) apiGetWebhooksRequest { - return apiGetWebhooksRequest{ - 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 InlineResponse20027 + @return InlineResponse2009 */ -func (r apiGetWebhooksRequest) Execute() (InlineResponse20027, *_nethttp.Response, error) { +func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20027 + localVarReturnValue InlineResponse2009 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhooks") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetReferralsWithoutTotalCount") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/webhooks" + 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{} 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, "")) } + 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{} + + // 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 + } + } + } + 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 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 + } + + 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 apiGetRoleRequest struct { + ctx _context.Context + apiService *ManagementApiService + roleId int32 +} + +/* +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 roleId The Id of role. + +@return apiGetRoleRequest +*/ +func (a *ManagementApiService) GetRole(ctx _context.Context, roleId int32) apiGetRoleRequest { + return apiGetRoleRequest{ + apiService: a, + ctx: ctx, + roleId: roleId, + } +} + +/* +Execute executes the request + + @return Role +*/ +func (r apiGetRoleRequest) Execute() (Role, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Role + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRole") + 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) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -12728,6 +14787,1959 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20027, *_nethttp.Respons } } } + 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 Role + 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 apiGetRulesetRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + rulesetId int32 +} + +/* +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 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 The ID of the ruleset. + +@return apiGetRulesetRequest +*/ +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 Ruleset +*/ +func (r apiGetRulesetRequest) Execute() (Ruleset, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Ruleset + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRuleset") + 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) + + 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 + } + } + } + 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 Ruleset + 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 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 +} + +/* +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(). + - @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) GetRulesets(ctx _context.Context, applicationId int32, campaignId int32) apiGetRulesetsRequest { + return apiGetRulesetsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + } +} + +/* +Execute executes the request + + @return InlineResponse2006 +*/ +func (r apiGetRulesetsRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse2006 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetRulesets") + 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) + + 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{} + + // 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 + } + } + } + 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 apiGetUserRequest struct { + ctx _context.Context + apiService *ManagementApiService + userId int32 +} + +/* +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 userId The ID of the user. + +@return apiGetUserRequest +*/ +func (a *ManagementApiService) GetUser(ctx _context.Context, userId int32) apiGetUserRequest { + return apiGetUserRequest{ + apiService: a, + ctx: ctx, + userId: userId, + } +} + +/* +Execute executes the request + + @return User +*/ +func (r apiGetUserRequest) Execute() (User, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue User + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUser") + 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) + + 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 + } + } + } + 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 User + 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 apiGetUsersRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string +} + +func (r apiGetUsersRequest) PageSize(pageSize int32) apiGetUsersRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetUsersRequest) Skip(skip int32) apiGetUsersRequest { + r.skip = &skip + return r +} + +func (r apiGetUsersRequest) Sort(sort string) apiGetUsersRequest { + r.sort = &sort + return r +} + +/* +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(). + +@return apiGetUsersRequest +*/ +func (a *ManagementApiService) GetUsers(ctx _context.Context) apiGetUsersRequest { + return apiGetUsersRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return InlineResponse20037 +*/ +func (r apiGetUsersRequest) Execute() (InlineResponse20037, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse20037 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUsers") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/users" + + 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{} + + // 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 + } + } + } + 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 InlineResponse20037 + 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 apiGetWebhookRequest struct { + ctx _context.Context + apiService *ManagementApiService + webhookId int32 +} + +/* +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 webhookId The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**. + +@return apiGetWebhookRequest +*/ +func (a *ManagementApiService) GetWebhook(ctx _context.Context, webhookId int32) apiGetWebhookRequest { + return apiGetWebhookRequest{ + apiService: a, + ctx: ctx, + webhookId: webhookId, + } +} + +/* +Execute executes the request + + @return Webhook +*/ +func (r apiGetWebhookRequest) Execute() (Webhook, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Webhook + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhook") + 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) + + 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 + } + } + } + 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 Webhook + 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 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 +} + +/* +GetWebhookActivationLogs List webhook activation log entries +Webhook activation log entries are created as soon as an integration request +triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks). + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiGetWebhookActivationLogsRequest +*/ +func (a *ManagementApiService) GetWebhookActivationLogs(ctx _context.Context) apiGetWebhookActivationLogsRequest { + return apiGetWebhookActivationLogsRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return InlineResponse20034 +*/ +func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20034, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse20034 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookActivationLogs") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + 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{} + + // 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 + } + } + } + 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 InlineResponse20034 + 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 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 +} + +func (r apiGetWebhookLogsRequest) Skip(skip int32) apiGetWebhookLogsRequest { + r.skip = &skip + return r +} + +func (r apiGetWebhookLogsRequest) Sort(sort string) apiGetWebhookLogsRequest { + r.sort = &sort + return r +} + +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(). + +@return apiGetWebhookLogsRequest +*/ +func (a *ManagementApiService) GetWebhookLogs(ctx _context.Context) apiGetWebhookLogsRequest { + return apiGetWebhookLogsRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return InlineResponse20035 +*/ +func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20035, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse20035 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookLogs") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/webhook_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.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{} + + // 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 + } + } + } + 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 InlineResponse20035 + 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 apiGetWebhooksRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationIds *string + sort *string + pageSize *int32 + skip *int32 +} + +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(). + +@return apiGetWebhooksRequest +*/ +func (a *ManagementApiService) GetWebhooks(ctx _context.Context) apiGetWebhooksRequest { + return apiGetWebhooksRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return InlineResponse20033 +*/ +func (r apiGetWebhooksRequest) Execute() (InlineResponse20033, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse20033 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhooks") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + 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{} + + // 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 + } + } + } + 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 InlineResponse20033 + 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 apiImportAccountCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 + upFile *string +} + +func (r apiImportAccountCollectionRequest) UpFile(upFile string) apiImportAccountCollectionRequest { + r.upFile = &upFile + 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. + +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. + + - @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](#operation/listCollectionsInApplication) endpoint. + +@return apiImportAccountCollectionRequest +*/ +func (a *ManagementApiService) ImportAccountCollection(ctx _context.Context, collectionId int32) apiImportAccountCollectionRequest { + return apiImportAccountCollectionRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, + } +} + +/* +Execute executes the request + + @return Import +*/ +func (r apiImportAccountCollectionRequest) Execute() (Import, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Import + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportAccountCollection") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + 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{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"multipart/form-data"} + + // 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.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 { + 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.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 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() + 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 apiImportAllowedListRequest struct { + ctx _context.Context + apiService *ManagementApiService + attributeId int32 + upFile *string +} + +func (r apiImportAllowedListRequest) UpFile(upFile string) apiImportAllowedListRequest { + r.upFile = &upFile + return r +} + +/* +ImportAllowedList Import allowed values for attribute +Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. + +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 attributeId The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. + +@return apiImportAllowedListRequest +*/ +func (a *ManagementApiService) ImportAllowedList(ctx _context.Context, attributeId int32) apiImportAllowedListRequest { + return apiImportAllowedListRequest{ + apiService: a, + ctx: ctx, + attributeId: attributeId, + } +} + +/* +Execute executes the request + + @return Import +*/ +func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Import + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportAllowedList") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + 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{"multipart/form-data"} + + // 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.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 { + 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.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 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() + 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 apiImportCollectionRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 + upFile *string +} + +func (r apiImportCollectionRequest) UpFile(upFile string) apiImportCollectionRequest { + r.upFile = &upFile + 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. + +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. + + - @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](#operation/listCollectionsInApplication) endpoint. + +@return apiImportCollectionRequest +*/ +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 Import +*/ +func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Import + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCollection") + 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) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"multipart/form-data"} + + // 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.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 { + 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.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 @@ -12750,7 +16762,17 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20027, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20027 + 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() @@ -12773,52 +16795,63 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20027, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportAccountCollectionRequest struct { - ctx _context.Context - apiService *ManagementApiService - collectionId int32 - upFile *string +type apiImportCouponsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + upFile *string } -func (r apiImportAccountCollectionRequest) UpFile(upFile string) apiImportAccountCollectionRequest { +func (r apiImportCouponsRequest) UpFile(upFile string) apiImportCouponsRequest { r.upFile = &upFile 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. +ImportCoupons Import coupons +Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. -The import **replaces** the initial content of the collection. +The CSV file contains the following columns: -The CSV file **must** only contain the following column: + - `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. + - `recipientintegrationid`: The integration ID of the customer who receives the coupon. + Only the customer with this integration ID can redeem the corresponding coupon code. + Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). + - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. + - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. + - `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 coupon entity, set it with `"{""category"": ""10_off""}"`. -- `item`: the values in your collection. +You can use the time zone of your choice. It is converted to UTC internally by Talon.One. -A collection is limited to 500,000 items. +**Note:** We recommend limiting your file size to 500MB. -Example: +**Example:** -``` -item -Addidas -Nike -Asics +```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 ``` -**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. +Once imported, you can find the `batchId` in the Campaign Manager or by +using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). - @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). + - @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 apiImportAccountCollectionRequest +@return apiImportCouponsRequest */ -func (a *ManagementApiService) ImportAccountCollection(ctx _context.Context, collectionId int32) apiImportAccountCollectionRequest { - return apiImportAccountCollectionRequest{ - apiService: a, - ctx: ctx, - collectionId: collectionId, +func (a *ManagementApiService) ImportCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiImportCouponsRequest { + return apiImportCouponsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } @@ -12827,7 +16860,7 @@ Execute executes the request @return Import */ -func (r apiImportAccountCollectionRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -12837,13 +16870,14 @@ func (r apiImportAccountCollectionRequest) Execute() (Import, *_nethttp.Response localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportAccountCollection") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCoupons") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/collections/{collectionId}/import" - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + 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{} @@ -12883,6 +16917,20 @@ func (r apiImportAccountCollectionRequest) Execute() (Import, *_nethttp.Response } } } + 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 @@ -12912,26 +16960,6 @@ func (r apiImportAccountCollectionRequest) Execute() (Import, *_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 } @@ -12948,51 +16976,48 @@ func (r apiImportAccountCollectionRequest) Execute() (Import, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportAllowedListRequest struct { - ctx _context.Context - apiService *ManagementApiService - attributeId int32 - upFile *string +type apiImportLoyaltyCardsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + upFile *string } -func (r apiImportAllowedListRequest) UpFile(upFile string) apiImportAllowedListRequest { +func (r apiImportLoyaltyCardsRequest) UpFile(upFile string) apiImportLoyaltyCardsRequest { r.upFile = &upFile return r } /* -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. +ImportLoyaltyCards Import loyalty cards +Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. +Send the file as multipart data. -The import **replaces** the previous list of allowed values for this attribute, if any. +It contains the following columns for each card: -The CSV file **must** only contain the following column: -- `item` (required): the values in your allowed list, for example a list of SKU's. +- `identifier` (required): The alphanumeric identifier of the loyalty card. +- `state` (required): The state of the loyalty card. It can be `active` or `inactive`. +- `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. -An allowed list is limited to 500,000 items. +**Note:** We recommend limiting your file size to 500MB. -Example: +**Example:** -```text -item -CS-VG-04032021-UP-50D-10 -CS-DV-04042021-UP-49D-12 -CS-DG-02082021-UP-50G-07 +```csv +identifier,state,customerprofileids +123-456-789AT,active,Alexa001;UserA ``` - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param attributeId + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiImportAllowedListRequest +@return apiImportLoyaltyCardsRequest */ -func (a *ManagementApiService) ImportAllowedList(ctx _context.Context, attributeId int32) apiImportAllowedListRequest { - return apiImportAllowedListRequest{ - apiService: a, - ctx: ctx, - attributeId: attributeId, +func (a *ManagementApiService) ImportLoyaltyCards(ctx _context.Context, loyaltyProgramId int32) apiImportLoyaltyCardsRequest { + return apiImportLoyaltyCardsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } @@ -13001,7 +17026,7 @@ Execute executes the request @return Import */ -func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportLoyaltyCardsRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -13011,13 +17036,13 @@ func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, erro localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportAllowedList") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportLoyaltyCards") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/attributes/{attributeId}/allowed_list/import" - localVarPath = strings.Replace(localVarPath, "{"+"attributeId"+"}", _neturl.QueryEscape(parameterToString(r.attributeId, "")), -1) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/import_cards" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -13057,6 +17082,20 @@ func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, erro } } } + 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 @@ -13088,16 +17127,6 @@ func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, erro 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")) @@ -13132,58 +17161,67 @@ func (r apiImportAllowedListRequest) Execute() (Import, *_nethttp.Response, erro return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportCollectionRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - collectionId int32 - upFile *string +type apiImportLoyaltyPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + upFile *string } -func (r apiImportCollectionRequest) UpFile(upFile string) apiImportCollectionRequest { +func (r apiImportLoyaltyPointsRequest) UpFile(upFile string) apiImportLoyaltyPointsRequest { r.upFile = &upFile 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. +ImportLoyaltyPoints Import loyalty points +Upload a CSV file containing the loyalty points you want to import into a given loyalty program. +Send the file as multipart data. -The import **replaces** the initial content of the collection. +Depending on the loyalty program type, you can import the points into a given customer profile or into a given _active_ loyalty card. -The CSV file **must** only contain the following column: +The CSV file contains the following columns: -- `item`: the values in your collection. +- `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. +- `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. +- `amount`: The amount of points to award to the customer profile. +- `startdate`: The earliest date when the points can be redeemed. On this date and until the expiration 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): The reason why these points are awarded. -A collection is limited to 500,000 items. +You can use the time zone of your choice. It is converted to UTC internally by Talon.One. -Example: +**Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the +value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until +the date provided for `startdate` is reached. -``` -item -Addidas -Nike -Asics +**Note:** We recommend limiting your file size to 500MB. + +**Example for profile-based programs:** + +```text +customerprofileid,amount,startdate,expirydate,subledgerid,reason +URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` -**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. +**Example for card-based programs:** + +```text +identifier,amount,startdate,expirydate,subledgerid,reason +summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement +``` - @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). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiImportCollectionRequest +@return apiImportLoyaltyPointsRequest */ -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) ImportLoyaltyPoints(ctx _context.Context, loyaltyProgramId int32) apiImportLoyaltyPointsRequest { + return apiImportLoyaltyPointsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } @@ -13192,7 +17230,7 @@ Execute executes the request @return Import */ -func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -13202,15 +17240,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.ImportLoyaltyPoints") 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/loyalty_programs/{loyaltyProgramId}/import_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -13250,6 +17286,20 @@ func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error } } } + 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 @@ -13279,16 +17329,6 @@ func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, 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 } @@ -13305,60 +17345,54 @@ func (r apiImportCollectionRequest) Execute() (Import, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportCouponsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - upFile *string +type apiImportPoolGiveawaysRequest struct { + ctx _context.Context + apiService *ManagementApiService + poolId int32 + upFile *string } -func (r apiImportCouponsRequest) UpFile(upFile string) apiImportCouponsRequest { +func (r apiImportPoolGiveawaysRequest) UpFile(upFile string) apiImportPoolGiveawaysRequest { r.upFile = &upFile return r } /* -ImportCoupons Import coupons -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: +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. - - `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""}"`. +The CSV file contains 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 time zone of your choice. It is converted to UTC internally by Talon.One. -You can use the timezone of your choice. It is converted to UTC internally by Talon.One. +**Note:** We recommend limiting your file size to 500MB. **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 +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""}" ``` -Once imported, you can find the `batchId` in the Campaign Manager or by -using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount). - - @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 poolId The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. -@return apiImportCouponsRequest +@return apiImportPoolGiveawaysRequest */ -func (a *ManagementApiService) ImportCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiImportCouponsRequest { - return apiImportCouponsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) ImportPoolGiveaways(ctx _context.Context, poolId int32) apiImportPoolGiveawaysRequest { + return apiImportPoolGiveawaysRequest{ + apiService: a, + ctx: ctx, + poolId: poolId, } } @@ -13367,7 +17401,7 @@ Execute executes the request @return Import */ -func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -13377,14 +17411,13 @@ 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.ImportPoolGiveaways") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - 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) + 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{} @@ -13424,6 +17457,20 @@ func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { } } } + 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 @@ -13469,56 +17516,60 @@ func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { return localVarReturnValue, localVarHTTPResponse, nil } -type apiImportLoyaltyPointsRequest struct { - ctx _context.Context - apiService *ManagementApiService - loyaltyProgramId int32 - upFile *string +type apiImportReferralsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + upFile *string } -func (r apiImportLoyaltyPointsRequest) UpFile(upFile string) apiImportLoyaltyPointsRequest { +func (r apiImportReferralsRequest) UpFile(upFile string) apiImportReferralsRequest { r.upFile = &upFile 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. +ImportReferrals Import referrals +Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. -**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 contains the following columns: -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 number 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. -- `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. + 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""}"`. -**Important:** Do not leave empty columns in the file. +You can use the time zone of your choice. It is converted to UTC internally by Talon.One. -You can use the timezone of your choice. It is converted to UTC internally by Talon.One. +**Note:** We recommend limiting your file size to 500MB. **Example:** ```text -customerprofileid,amount,startdate,expirydate,subledgerid,reason -URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement +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 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 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 apiImportLoyaltyPointsRequest +@return apiImportReferralsRequest */ -func (a *ManagementApiService) ImportLoyaltyPoints(ctx _context.Context, loyaltyProgramId int32) apiImportLoyaltyPointsRequest { - return apiImportLoyaltyPointsRequest{ - apiService: a, - ctx: ctx, - loyaltyProgramId: loyaltyProgramId, +func (a *ManagementApiService) ImportReferrals(ctx _context.Context, applicationId int32, campaignId int32) apiImportReferralsRequest { + return apiImportReferralsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } @@ -13527,7 +17578,7 @@ Execute executes the request @return Import */ -func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} @@ -13537,13 +17588,14 @@ func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, er localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportLoyaltyPoints") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportReferrals") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/import_points" - localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + 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) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -13583,6 +17635,20 @@ func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, er } } } + 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 @@ -13628,86 +17694,98 @@ 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 apiListAccountCollectionsRequest struct { + ctx _context.Context + apiService *ManagementApiService + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool + name *string } -func (r apiImportPoolGiveawaysRequest) UpFile(upFile string) apiImportPoolGiveawaysRequest { - r.upFile = &upFile +func (r apiListAccountCollectionsRequest) PageSize(pageSize int32) apiListAccountCollectionsRequest { + 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. - -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. +func (r apiListAccountCollectionsRequest) Skip(skip int32) apiListAccountCollectionsRequest { + r.skip = &skip + 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 apiListAccountCollectionsRequest) Sort(sort string) apiListAccountCollectionsRequest { + r.sort = &sort + return r +} -**Example:** +func (r apiListAccountCollectionsRequest) WithTotalResultSize(withTotalResultSize bool) apiListAccountCollectionsRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} -```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""}" -``` +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 poolId -@return apiImportPoolGiveawaysRequest +@return apiListAccountCollectionsRequest */ -func (a *ManagementApiService) ImportPoolGiveaways(ctx _context.Context, poolId int32) apiImportPoolGiveawaysRequest { - return apiImportPoolGiveawaysRequest{ +func (a *ManagementApiService) ListAccountCollections(ctx _context.Context) apiListAccountCollectionsRequest { + return apiListAccountCollectionsRequest{ apiService: a, ctx: ctx, - poolId: poolId, } } /* Execute executes the request - @return Import + @return InlineResponse20015 */ -func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiListAccountCollectionsRequest) Execute() (InlineResponse20015, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Import + localVarReturnValue InlineResponse20015 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportPoolGiveaways") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListAccountCollections") 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/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) @@ -13723,8 +17801,19 @@ 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 { + 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.ctx != nil { // API Key Authentication @@ -13762,7 +17851,37 @@ func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, er error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Import + var v InlineResponse20015 + 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() @@ -13785,54 +17904,54 @@ 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 apiListCollectionsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + pageSize *int32 + skip *int32 + sort *string + withTotalResultSize *bool + name *string } -func (r apiImportReferralsRequest) UpFile(upFile string) apiImportReferralsRequest { - r.upFile = &upFile +func (r apiListCollectionsRequest) PageSize(pageSize int32) apiListCollectionsRequest { + r.pageSize = &pageSize return r } -/* -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: - -- `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""}"`. +func (r apiListCollectionsRequest) Skip(skip int32) apiListCollectionsRequest { + r.skip = &skip + return r +} -You can use the timezone of your choice. It is converted to UTC internally by Talon.One. +func (r apiListCollectionsRequest) Sort(sort string) apiListCollectionsRequest { + r.sort = &sort + return r +} -**Example:** +func (r apiListCollectionsRequest) WithTotalResultSize(withTotalResultSize bool) apiListCollectionsRequest { + r.withTotalResultSize = &withTotalResultSize + return r +} -```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""}" -``` +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 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 +@return apiListCollectionsRequest */ -func (a *ManagementApiService) ImportReferrals(ctx _context.Context, applicationId int32, campaignId int32) apiImportReferralsRequest { - return apiImportReferralsRequest{ +func (a *ManagementApiService) ListCollections(ctx _context.Context, applicationId int32, campaignId int32) apiListCollectionsRequest { + return apiListCollectionsRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -13843,24 +17962,24 @@ func (a *ManagementApiService) ImportReferrals(ctx _context.Context, application /* Execute executes the request - @return Import + @return InlineResponse20017 */ -func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) { +func (r apiListCollectionsRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue Import + localVarReturnValue InlineResponse20017 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportReferrals") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListCollections") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals" + 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) @@ -13868,8 +17987,23 @@ func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) 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) @@ -13885,8 +18019,19 @@ 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 { + 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.ctx != nil { // API Key Authentication @@ -13924,7 +18069,17 @@ func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v Import + var v InlineResponse20017 + 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() @@ -13947,9 +18102,10 @@ func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) return localVarReturnValue, localVarHTTPResponse, nil } -type apiListAccountCollectionsRequest struct { +type apiListCollectionsInApplicationRequest struct { ctx _context.Context apiService *ManagementApiService + applicationId int32 pageSize *int32 skip *int32 sort *string @@ -13957,66 +18113,69 @@ type apiListAccountCollectionsRequest struct { name *string } -func (r apiListAccountCollectionsRequest) PageSize(pageSize int32) apiListAccountCollectionsRequest { +func (r apiListCollectionsInApplicationRequest) PageSize(pageSize int32) apiListCollectionsInApplicationRequest { r.pageSize = &pageSize return r } -func (r apiListAccountCollectionsRequest) Skip(skip int32) apiListAccountCollectionsRequest { +func (r apiListCollectionsInApplicationRequest) Skip(skip int32) apiListCollectionsInApplicationRequest { r.skip = &skip return r } -func (r apiListAccountCollectionsRequest) Sort(sort string) apiListAccountCollectionsRequest { +func (r apiListCollectionsInApplicationRequest) Sort(sort string) apiListCollectionsInApplicationRequest { r.sort = &sort return r } -func (r apiListAccountCollectionsRequest) WithTotalResultSize(withTotalResultSize bool) apiListAccountCollectionsRequest { +func (r apiListCollectionsInApplicationRequest) WithTotalResultSize(withTotalResultSize bool) apiListCollectionsInApplicationRequest { r.withTotalResultSize = &withTotalResultSize return r } -func (r apiListAccountCollectionsRequest) Name(name string) apiListAccountCollectionsRequest { +func (r apiListCollectionsInApplicationRequest) Name(name string) apiListCollectionsInApplicationRequest { r.name = &name return r } /* -ListAccountCollections List collections in account -List collections in account. +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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiListAccountCollectionsRequest +@return apiListCollectionsInApplicationRequest */ -func (a *ManagementApiService) ListAccountCollections(ctx _context.Context) apiListAccountCollectionsRequest { - return apiListAccountCollectionsRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) ListCollectionsInApplication(ctx _context.Context, applicationId int32) apiListCollectionsInApplicationRequest { + return apiListCollectionsInApplicationRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, } } /* Execute executes the request - @return InlineResponse20010 + @return InlineResponse20017 */ -func (r apiListAccountCollectionsRequest) Execute() (InlineResponse20010, *_nethttp.Response, error) { +func (r apiListCollectionsInApplicationRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20010 + localVarReturnValue InlineResponse20017 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListAccountCollections") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListCollectionsInApplication") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/collections" + localVarPath := localBasePath + "/v1/applications/{applicationId}/collections" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -14068,6 +18227,20 @@ func (r apiListAccountCollectionsRequest) Execute() (InlineResponse20010, *_neth } } } + 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 @@ -14077,40 +18250,20 @@ func (r apiListAccountCollectionsRequest) Execute() (InlineResponse20010, *_neth 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 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 == 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 + + 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 == 401 { - var v ErrorResponseWithStatus + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse20017 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -14143,106 +18296,72 @@ func (r apiListAccountCollectionsRequest) Execute() (InlineResponse20010, *_neth return localVarReturnValue, localVarHTTPResponse, nil } -type apiListCollectionsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - pageSize *int32 - skip *int32 - sort *string - withTotalResultSize *bool - name *string -} - -func (r apiListCollectionsRequest) PageSize(pageSize int32) apiListCollectionsRequest { - r.pageSize = &pageSize - return r -} - -func (r apiListCollectionsRequest) Skip(skip int32) apiListCollectionsRequest { - r.skip = &skip - return r +type apiPostAddedDeductedPointsNotificationRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + body *NewBaseNotification } -func (r apiListCollectionsRequest) Sort(sort string) apiListCollectionsRequest { - r.sort = &sort +func (r apiPostAddedDeductedPointsNotificationRequest) Body(body NewBaseNotification) apiPostAddedDeductedPointsNotificationRequest { + r.body = &body return r } -func (r apiListCollectionsRequest) WithTotalResultSize(withTotalResultSize bool) apiListCollectionsRequest { - r.withTotalResultSize = &withTotalResultSize - return r -} +/* +PostAddedDeductedPointsNotification Create notification about added or deducted loyalty points +Create a notification about added or deducted loyalty points in a given profile-based loyalty program. +A notification for added or deducted loyalty points is different from regular webhooks +in that it is loyalty program-scoped and has a predefined payload. -func (r apiListCollectionsRequest) Name(name string) apiListCollectionsRequest { - r.name = &name - return r -} +For more information, see [Managing notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications). -/* -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 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 loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiListCollectionsRequest +@return apiPostAddedDeductedPointsNotificationRequest */ -func (a *ManagementApiService) ListCollections(ctx _context.Context, applicationId int32, campaignId int32) apiListCollectionsRequest { - return apiListCollectionsRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - campaignId: campaignId, +func (a *ManagementApiService) PostAddedDeductedPointsNotification(ctx _context.Context, loyaltyProgramId int32) apiPostAddedDeductedPointsNotificationRequest { + return apiPostAddedDeductedPointsNotificationRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, } } /* Execute executes the request - @return InlineResponse20012 + @return BaseNotification */ -func (r apiListCollectionsRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { +func (r apiPostAddedDeductedPointsNotificationRequest) Execute() (BaseNotification, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20012 + localVarReturnValue BaseNotification ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListCollections") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.PostAddedDeductedPointsNotification") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - 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) + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_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.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, "")) + 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) @@ -14258,6 +18377,22 @@ func (r apiListCollectionsRequest) Execute() (InlineResponse20012, *_nethttp.Res 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -14294,7 +18429,27 @@ func (r apiListCollectionsRequest) Execute() (InlineResponse20012, *_nethttp.Res error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20012 + var v BaseNotification + 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() @@ -14327,52 +18482,32 @@ func (r apiListCollectionsRequest) Execute() (InlineResponse20012, *_nethttp.Res return localVarReturnValue, localVarHTTPResponse, nil } -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 +type apiPostCatalogsStrikethroughNotificationRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + body *NewBaseNotification } -func (r apiListCollectionsInApplicationRequest) Sort(sort string) apiListCollectionsInApplicationRequest { - r.sort = &sort +func (r apiPostCatalogsStrikethroughNotificationRequest) Body(body NewBaseNotification) apiPostCatalogsStrikethroughNotificationRequest { + r.body = &body return r } -func (r apiListCollectionsInApplicationRequest) WithTotalResultSize(withTotalResultSize bool) apiListCollectionsInApplicationRequest { - r.withTotalResultSize = &withTotalResultSize - return r -} +/* +PostCatalogsStrikethroughNotification Create strikethrough notification +Create a notification for the in the given Application. +For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). -func (r apiListCollectionsInApplicationRequest) Name(name string) apiListCollectionsInApplicationRequest { - r.name = &name - return r -} +See the [payload](https://docs.talon.one/outbound-notifications) you will receive. -/* -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 The ID of the Application. It is displayed in your Talon.One deployment URL. -@return apiListCollectionsInApplicationRequest +@return apiPostCatalogsStrikethroughNotificationRequest */ -func (a *ManagementApiService) ListCollectionsInApplication(ctx _context.Context, applicationId int32) apiListCollectionsInApplicationRequest { - return apiListCollectionsInApplicationRequest{ +func (a *ManagementApiService) PostCatalogsStrikethroughNotification(ctx _context.Context, applicationId int32) apiPostCatalogsStrikethroughNotificationRequest { + return apiPostCatalogsStrikethroughNotificationRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -14382,47 +18517,36 @@ func (a *ManagementApiService) ListCollectionsInApplication(ctx _context.Context /* Execute executes the request - @return InlineResponse20012 + @return BaseNotification */ -func (r apiListCollectionsInApplicationRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { +func (r apiPostCatalogsStrikethroughNotificationRequest) Execute() (BaseNotification, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20012 + localVarReturnValue BaseNotification ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ListCollectionsInApplication") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.PostCatalogsStrikethroughNotification") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/collections" + localVarPath := localBasePath + "/v1/catalogs/{applicationId}/notifications/strikethrough" 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.withTotalResultSize != nil { - localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) - } - if r.name != nil { - localVarQueryParams.Add("name", parameterToString(*r.name, "")) + 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) @@ -14438,6 +18562,22 @@ func (r apiListCollectionsInApplicationRequest) Execute() (InlineResponse20012, 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -14474,7 +18614,27 @@ func (r apiListCollectionsInApplicationRequest) Execute() (InlineResponse20012, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20012 + var v BaseNotification + 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() @@ -14512,20 +18672,20 @@ type apiRemoveLoyaltyPointsRequest struct { apiService *ManagementApiService loyaltyProgramId string integrationId string - body *LoyaltyPoints + body *DeductLoyaltyPoints } -func (r apiRemoveLoyaltyPointsRequest) Body(body LoyaltyPoints) apiRemoveLoyaltyPointsRequest { +func (r apiRemoveLoyaltyPointsRequest) Body(body DeductLoyaltyPoints) apiRemoveLoyaltyPointsRequest { r.body = &body return r } /* -RemoveLoyaltyPoints Deduct points in loyalty program for given customer -Remove points from the specified loyalty program and specified customer profile. +RemoveLoyaltyPoints Deduct points from customer profile +Deduct points from the specified loyalty program and specified customer profile. To get the `integrationId` of the profile from a `sessionId`, use the -[Update customer session](/integration-api/#operation/updateCustomerSessionV2). +[Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - @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. @@ -14604,6 +18764,20 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -14734,8 +18908,22 @@ func (r apiResetPasswordRequest) Execute() (NewPassword, *_nethttp.Response, err if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body + // 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -14910,16 +19098,16 @@ func (a *ManagementApiService) SearchCouponsAdvancedApplicationWideWithoutTotalC /* Execute executes the request - @return InlineResponse2007 + @return InlineResponse2008 */ -func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { +func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2007 + localVarReturnValue InlineResponse2008 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.SearchCouponsAdvancedApplicationWideWithoutTotalCount") @@ -15010,6 +19198,20 @@ func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute } } } + 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 @@ -15032,7 +19234,7 @@ func (r apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest) Execute error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2007 + var v InlineResponse2008 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -15168,16 +19370,16 @@ func (a *ManagementApiService) SearchCouponsAdvancedWithoutTotalCount(ctx _conte /* Execute executes the request - @return InlineResponse2007 + @return InlineResponse2008 */ -func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { +func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2007 + localVarReturnValue InlineResponse2008 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.SearchCouponsAdvancedWithoutTotalCount") @@ -15266,6 +19468,20 @@ func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineRespo } } } + 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 @@ -15288,7 +19504,7 @@ func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineRespo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2007 + var v InlineResponse2008 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -15311,6 +19527,179 @@ func (r apiSearchCouponsAdvancedWithoutTotalCountRequest) Execute() (InlineRespo return localVarReturnValue, localVarHTTPResponse, nil } +type apiTransferLoyaltyCardRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string + body *TransferLoyaltyCard +} + +func (r apiTransferLoyaltyCardRequest) Body(body TransferLoyaltyCard) apiTransferLoyaltyCardRequest { + r.body = &body + return r +} + +/* +TransferLoyaltyCard Transfer card data +Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. + +**Important:** + +- The original card is automatically blocked once the new card is created, and it cannot be activated again. +- The default status of the new card is _active_. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + +@return apiTransferLoyaltyCardRequest +*/ +func (a *ManagementApiService) TransferLoyaltyCard(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiTransferLoyaltyCardRequest { + return apiTransferLoyaltyCardRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, + } +} + +/* +Execute executes the request +*/ +func (r apiTransferLoyaltyCardRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.TransferLoyaltyCard") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if strlen(r.loyaltyCardId) > 108 { + return nil, reportError("loyaltyCardId must have less than 108 elements") + } + + if r.body == nil { + return 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 + } + } + } + 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, + } + 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 + } + + return localVarHTTPResponse, nil +} + type apiUpdateAccountCollectionRequest struct { ctx _context.Context apiService *ManagementApiService @@ -15327,7 +19716,7 @@ func (r apiUpdateAccountCollectionRequest) Body(body UpdateCollection) apiUpdate 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). + - @param collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. @return apiUpdateAccountCollectionRequest */ @@ -15403,6 +19792,20 @@ func (r apiUpdateAccountCollectionRequest) Execute() (Collection, *_nethttp.Resp } } } + 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 @@ -15495,7 +19898,7 @@ 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(). - - @param additionalCostId + - @param additionalCostId The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. @return apiUpdateAdditionalCostRequest */ @@ -15571,6 +19974,20 @@ func (r apiUpdateAdditionalCostRequest) Execute() (AccountAdditionalCost, *_neth } } } + 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 @@ -15630,12 +20047,14 @@ func (r apiUpdateAttributeRequest) Body(body NewAttribute) apiUpdateAttributeReq /* 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. +Update an existing custom attribute. Once created, the only property of a custom attribute that can be +changed is the description. -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. +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. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param attributeId + - @param attributeId The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. @return apiUpdateAttributeRequest */ @@ -15711,6 +20130,20 @@ func (r apiUpdateAttributeRequest) Execute() (Attribute, *_nethttp.Response, err } } } + 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 @@ -15836,8 +20269,22 @@ func (r apiUpdateCampaignRequest) Execute() (Campaign, *_nethttp.Response, error if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body + // 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 + } + } + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -15917,7 +20364,7 @@ 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). + - @param collectionId The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. @return apiUpdateCollectionRequest */ @@ -15997,6 +20444,20 @@ func (r apiUpdateCollectionRequest) Execute() (Collection, *_nethttp.Response, e } } } + 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 @@ -16069,10 +20530,20 @@ func (r apiUpdateCouponRequest) Body(body UpdateCoupon) apiUpdateCouponRequest { /* UpdateCoupon Update coupon Update the specified coupon. + +
+ +

Important

+ +

With this PUT endpoint only, any property you do not explicitly set in your request + will be set to null.

+ +
+ - @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 + - @param couponId The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. @return apiUpdateCouponRequest */ @@ -16152,6 +20623,20 @@ func (r apiUpdateCouponRequest) Execute() (Coupon, *_nethttp.Response, error) { } } } + 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 @@ -16212,13 +20697,20 @@ func (r apiUpdateCouponBatchRequest) Body(body UpdateCouponBatch) apiUpdateCoupo /* UpdateCouponBatch Update coupons -Update all coupons of an campaign, or a specific batch of coupons. +Update all coupons, or a specific batch of coupons, in a campaign. You can find the `batchId` in the **Coupons** view of your Application -in the Campaign Manager or by using [List coupons](#operation/getCouponsWithoutTotalCount). +in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). + +
+ +

Important

-**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. +
    +
  • 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). @@ -16299,6 +20791,20 @@ func (r apiUpdateCouponBatchRequest) Execute() (*_nethttp.Response, error) { } } } + 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 @@ -16326,6 +20832,195 @@ func (r apiUpdateCouponBatchRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } +type apiUpdateLoyaltyCardRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + loyaltyCardId string + body *UpdateLoyaltyCard +} + +func (r apiUpdateLoyaltyCardRequest) Body(body UpdateLoyaltyCard) apiUpdateLoyaltyCardRequest { + r.body = &body + return r +} + +/* +UpdateLoyaltyCard Update loyalty card status +Update the status of the given loyalty card. A card can be _active_ or _inactive_. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + - @param loyaltyCardId Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + +@return apiUpdateLoyaltyCardRequest +*/ +func (a *ManagementApiService) UpdateLoyaltyCard(ctx _context.Context, loyaltyProgramId int32, loyaltyCardId string) apiUpdateLoyaltyCardRequest { + return apiUpdateLoyaltyCardRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + loyaltyCardId: loyaltyCardId, + } +} + +/* +Execute executes the request + + @return LoyaltyCard +*/ +func (r apiUpdateLoyaltyCardRequest) Execute() (LoyaltyCard, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyCard + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateLoyaltyCard") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyCardId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyCardId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if strlen(r.loyaltyCardId) > 108 { + return localVarReturnValue, nil, reportError("loyaltyCardId must have less than 108 elements") + } + + 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 + } + } + } + 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 LoyaltyCard + 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 apiUpdateNotificationWebhookRequest struct { ctx _context.Context apiService *ManagementApiService @@ -16340,11 +21035,15 @@ func (r apiUpdateNotificationWebhookRequest) Body(body NewNotificationWebhook) a } /* -UpdateNotificationWebhook Update notification webhook -Update the given outbound notification webhook. +UpdateNotificationWebhook Update notification about campaign-related changes +Update the given +[notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). + +**Tip:** You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_edited/post). + - @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 + - @param notificationWebhookId The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. @return apiUpdateNotificationWebhookRequest */ @@ -16422,6 +21121,20 @@ func (r apiUpdateNotificationWebhookRequest) Execute() (NotificationWebhook, *_n } } } + 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 @@ -16487,7 +21200,7 @@ Update 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 + - @param referralId The ID of the referral code. @return apiUpdateReferralRequest */ @@ -16567,6 +21280,20 @@ func (r apiUpdateReferralRequest) Execute() (Referral, *_nethttp.Response, error } } } + 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 diff --git a/client.go b/client.go index f3b88bb6..a702fcad 100644 --- a/client.go +++ b/client.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -39,7 +39,7 @@ var ( xmlCheck = regexp.MustCompile(`(?i:(?:application|text)/xml)`) ) -// APIClient manages communication with the Talon.One API API v1.0.0 +// APIClient manages communication with the Talon.One API API v // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration diff --git a/configuration.go b/configuration.go index b69c0c5a..93a6cc2f 100644 --- a/configuration.go +++ b/configuration.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -97,7 +97,7 @@ type Configuration struct { func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "OpenAPI-Generator/2.6.1/go", + UserAgent: "OpenAPI-Generator/3.0.0/go", Debug: false, Servers: ServerConfigurations{ { diff --git a/docs/Account.md b/docs/Account.md index 0bcc05f5..c655de3e 100644 --- a/docs/Account.md +++ b/docs/Account.md @@ -4,9 +4,9 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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). | diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md index 027b27ce..4db2b1a6 100644 --- a/docs/AccountAdditionalCost.md +++ b/docs/AccountAdditionalCost.md @@ -4,14 +4,14 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Name** | Pointer to **string** | The internal name used in API requests. | **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] -**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] +**Type** | Pointer to **string** | The type of additional cost. Possible value: - `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 diff --git a/docs/AccountDashboardStatistic.md b/docs/AccountDashboardStatistic.md new file mode 100644 index 00000000..e926bb23 --- /dev/null +++ b/docs/AccountDashboardStatistic.md @@ -0,0 +1,169 @@ +# AccountDashboardStatistic + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Revenue** | Pointer to [**[]AccountDashboardStatisticRevenue**](AccountDashboardStatisticRevenue.md) | Aggregated statistic for account revenue. | [optional] +**Discounts** | Pointer to [**[]AccountDashboardStatisticDiscount**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional] +**LoyaltyPoints** | Pointer to [**[]AccountDashboardStatisticLoyaltyPoints**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional] +**Referrals** | Pointer to [**[]AccountDashboardStatisticReferrals**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional] +**ApiCalls** | Pointer to [**[]AccountDashboardStatisticApiCalls**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional] +**Campaigns** | Pointer to [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) | | + +## Methods + +### GetRevenue + +`func (o *AccountDashboardStatistic) GetRevenue() []AccountDashboardStatisticRevenue` + +GetRevenue returns the Revenue field if non-nil, zero value otherwise. + +### GetRevenueOk + +`func (o *AccountDashboardStatistic) GetRevenueOk() ([]AccountDashboardStatisticRevenue, bool)` + +GetRevenueOk returns a tuple with the Revenue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRevenue + +`func (o *AccountDashboardStatistic) HasRevenue() bool` + +HasRevenue returns a boolean if a field has been set. + +### SetRevenue + +`func (o *AccountDashboardStatistic) SetRevenue(v []AccountDashboardStatisticRevenue)` + +SetRevenue gets a reference to the given []AccountDashboardStatisticRevenue and assigns it to the Revenue field. + +### GetDiscounts + +`func (o *AccountDashboardStatistic) GetDiscounts() []AccountDashboardStatisticDiscount` + +GetDiscounts returns the Discounts field if non-nil, zero value otherwise. + +### GetDiscountsOk + +`func (o *AccountDashboardStatistic) GetDiscountsOk() ([]AccountDashboardStatisticDiscount, bool)` + +GetDiscountsOk returns a tuple with the Discounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscounts + +`func (o *AccountDashboardStatistic) HasDiscounts() bool` + +HasDiscounts returns a boolean if a field has been set. + +### SetDiscounts + +`func (o *AccountDashboardStatistic) SetDiscounts(v []AccountDashboardStatisticDiscount)` + +SetDiscounts gets a reference to the given []AccountDashboardStatisticDiscount and assigns it to the Discounts field. + +### GetLoyaltyPoints + +`func (o *AccountDashboardStatistic) GetLoyaltyPoints() []AccountDashboardStatisticLoyaltyPoints` + +GetLoyaltyPoints returns the LoyaltyPoints field if non-nil, zero value otherwise. + +### GetLoyaltyPointsOk + +`func (o *AccountDashboardStatistic) GetLoyaltyPointsOk() ([]AccountDashboardStatisticLoyaltyPoints, bool)` + +GetLoyaltyPointsOk returns a tuple with the LoyaltyPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyaltyPoints + +`func (o *AccountDashboardStatistic) HasLoyaltyPoints() bool` + +HasLoyaltyPoints returns a boolean if a field has been set. + +### SetLoyaltyPoints + +`func (o *AccountDashboardStatistic) SetLoyaltyPoints(v []AccountDashboardStatisticLoyaltyPoints)` + +SetLoyaltyPoints gets a reference to the given []AccountDashboardStatisticLoyaltyPoints and assigns it to the LoyaltyPoints field. + +### GetReferrals + +`func (o *AccountDashboardStatistic) GetReferrals() []AccountDashboardStatisticReferrals` + +GetReferrals returns the Referrals field if non-nil, zero value otherwise. + +### GetReferralsOk + +`func (o *AccountDashboardStatistic) GetReferralsOk() ([]AccountDashboardStatisticReferrals, 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. + +### HasReferrals + +`func (o *AccountDashboardStatistic) HasReferrals() bool` + +HasReferrals returns a boolean if a field has been set. + +### SetReferrals + +`func (o *AccountDashboardStatistic) SetReferrals(v []AccountDashboardStatisticReferrals)` + +SetReferrals gets a reference to the given []AccountDashboardStatisticReferrals and assigns it to the Referrals field. + +### GetApiCalls + +`func (o *AccountDashboardStatistic) GetApiCalls() []AccountDashboardStatisticApiCalls` + +GetApiCalls returns the ApiCalls field if non-nil, zero value otherwise. + +### GetApiCallsOk + +`func (o *AccountDashboardStatistic) GetApiCallsOk() ([]AccountDashboardStatisticApiCalls, bool)` + +GetApiCallsOk returns a tuple with the ApiCalls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApiCalls + +`func (o *AccountDashboardStatistic) HasApiCalls() bool` + +HasApiCalls returns a boolean if a field has been set. + +### SetApiCalls + +`func (o *AccountDashboardStatistic) SetApiCalls(v []AccountDashboardStatisticApiCalls)` + +SetApiCalls gets a reference to the given []AccountDashboardStatisticApiCalls and assigns it to the ApiCalls field. + +### GetCampaigns + +`func (o *AccountDashboardStatistic) GetCampaigns() AccountDashboardStatisticCampaigns` + +GetCampaigns returns the Campaigns field if non-nil, zero value otherwise. + +### GetCampaignsOk + +`func (o *AccountDashboardStatistic) GetCampaignsOk() (AccountDashboardStatisticCampaigns, bool)` + +GetCampaignsOk returns a tuple with the Campaigns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaigns + +`func (o *AccountDashboardStatistic) HasCampaigns() bool` + +HasCampaigns returns a boolean if a field has been set. + +### SetCampaigns + +`func (o *AccountDashboardStatistic) SetCampaigns(v AccountDashboardStatisticCampaigns)` + +SetCampaigns gets a reference to the given AccountDashboardStatisticCampaigns and assigns it to the Campaigns 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/AccountDashboardStatisticApiCalls.md b/docs/AccountDashboardStatisticApiCalls.md new file mode 100644 index 00000000..c8ca951e --- /dev/null +++ b/docs/AccountDashboardStatisticApiCalls.md @@ -0,0 +1,65 @@ +# AccountDashboardStatisticApiCalls + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Total** | Pointer to **float32** | Total number of API calls received. | +**Datetime** | Pointer to [**time.Time**](time.Time.md) | Values aggregated for the specified date. | + +## Methods + +### GetTotal + +`func (o *AccountDashboardStatisticApiCalls) GetTotal() float32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *AccountDashboardStatisticApiCalls) GetTotalOk() (float32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotal + +`func (o *AccountDashboardStatisticApiCalls) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + +### SetTotal + +`func (o *AccountDashboardStatisticApiCalls) SetTotal(v float32)` + +SetTotal gets a reference to the given float32 and assigns it to the Total field. + +### GetDatetime + +`func (o *AccountDashboardStatisticApiCalls) GetDatetime() time.Time` + +GetDatetime returns the Datetime field if non-nil, zero value otherwise. + +### GetDatetimeOk + +`func (o *AccountDashboardStatisticApiCalls) GetDatetimeOk() (time.Time, bool)` + +GetDatetimeOk returns a tuple with the Datetime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDatetime + +`func (o *AccountDashboardStatisticApiCalls) HasDatetime() bool` + +HasDatetime returns a boolean if a field has been set. + +### SetDatetime + +`func (o *AccountDashboardStatisticApiCalls) SetDatetime(v time.Time)` + +SetDatetime gets a reference to the given time.Time and assigns it to the Datetime 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/AccountDashboardStatisticCampaigns.md b/docs/AccountDashboardStatisticCampaigns.md new file mode 100644 index 00000000..f31a9efb --- /dev/null +++ b/docs/AccountDashboardStatisticCampaigns.md @@ -0,0 +1,65 @@ +# AccountDashboardStatisticCampaigns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Live** | Pointer to **int32** | Number of campaigns that are active and live (across all Applications). | +**EndingSoon** | Pointer to **int32** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. | + +## Methods + +### GetLive + +`func (o *AccountDashboardStatisticCampaigns) GetLive() int32` + +GetLive returns the Live field if non-nil, zero value otherwise. + +### GetLiveOk + +`func (o *AccountDashboardStatisticCampaigns) GetLiveOk() (int32, bool)` + +GetLiveOk returns a tuple with the Live field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLive + +`func (o *AccountDashboardStatisticCampaigns) HasLive() bool` + +HasLive returns a boolean if a field has been set. + +### SetLive + +`func (o *AccountDashboardStatisticCampaigns) SetLive(v int32)` + +SetLive gets a reference to the given int32 and assigns it to the Live field. + +### GetEndingSoon + +`func (o *AccountDashboardStatisticCampaigns) GetEndingSoon() int32` + +GetEndingSoon returns the EndingSoon field if non-nil, zero value otherwise. + +### GetEndingSoonOk + +`func (o *AccountDashboardStatisticCampaigns) GetEndingSoonOk() (int32, bool)` + +GetEndingSoonOk returns a tuple with the EndingSoon field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndingSoon + +`func (o *AccountDashboardStatisticCampaigns) HasEndingSoon() bool` + +HasEndingSoon returns a boolean if a field has been set. + +### SetEndingSoon + +`func (o *AccountDashboardStatisticCampaigns) SetEndingSoon(v int32)` + +SetEndingSoon gets a reference to the given int32 and assigns it to the EndingSoon 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/AccountDashboardStatisticDiscount.md b/docs/AccountDashboardStatisticDiscount.md new file mode 100644 index 00000000..bec63a7e --- /dev/null +++ b/docs/AccountDashboardStatisticDiscount.md @@ -0,0 +1,91 @@ +# AccountDashboardStatisticDiscount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Total** | Pointer to **float32** | Total discount value redeemed by users. | +**Average** | Pointer to **float32** | Average discount percentage. | +**Datetime** | Pointer to [**time.Time**](time.Time.md) | Values aggregated for the specified date. | + +## Methods + +### GetTotal + +`func (o *AccountDashboardStatisticDiscount) GetTotal() float32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *AccountDashboardStatisticDiscount) GetTotalOk() (float32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotal + +`func (o *AccountDashboardStatisticDiscount) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + +### SetTotal + +`func (o *AccountDashboardStatisticDiscount) SetTotal(v float32)` + +SetTotal gets a reference to the given float32 and assigns it to the Total field. + +### GetAverage + +`func (o *AccountDashboardStatisticDiscount) GetAverage() float32` + +GetAverage returns the Average field if non-nil, zero value otherwise. + +### GetAverageOk + +`func (o *AccountDashboardStatisticDiscount) GetAverageOk() (float32, bool)` + +GetAverageOk returns a tuple with the Average field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAverage + +`func (o *AccountDashboardStatisticDiscount) HasAverage() bool` + +HasAverage returns a boolean if a field has been set. + +### SetAverage + +`func (o *AccountDashboardStatisticDiscount) SetAverage(v float32)` + +SetAverage gets a reference to the given float32 and assigns it to the Average field. + +### GetDatetime + +`func (o *AccountDashboardStatisticDiscount) GetDatetime() time.Time` + +GetDatetime returns the Datetime field if non-nil, zero value otherwise. + +### GetDatetimeOk + +`func (o *AccountDashboardStatisticDiscount) GetDatetimeOk() (time.Time, bool)` + +GetDatetimeOk returns a tuple with the Datetime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDatetime + +`func (o *AccountDashboardStatisticDiscount) HasDatetime() bool` + +HasDatetime returns a boolean if a field has been set. + +### SetDatetime + +`func (o *AccountDashboardStatisticDiscount) SetDatetime(v time.Time)` + +SetDatetime gets a reference to the given time.Time and assigns it to the Datetime 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/AccountDashboardStatisticLoyaltyPoints.md b/docs/AccountDashboardStatisticLoyaltyPoints.md new file mode 100644 index 00000000..45798a19 --- /dev/null +++ b/docs/AccountDashboardStatisticLoyaltyPoints.md @@ -0,0 +1,65 @@ +# AccountDashboardStatisticLoyaltyPoints + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Total** | Pointer to **float32** | Total loyalty points earned by users. | +**Datetime** | Pointer to [**time.Time**](time.Time.md) | Values aggregated for the specified date. | + +## Methods + +### GetTotal + +`func (o *AccountDashboardStatisticLoyaltyPoints) GetTotal() float32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *AccountDashboardStatisticLoyaltyPoints) GetTotalOk() (float32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotal + +`func (o *AccountDashboardStatisticLoyaltyPoints) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + +### SetTotal + +`func (o *AccountDashboardStatisticLoyaltyPoints) SetTotal(v float32)` + +SetTotal gets a reference to the given float32 and assigns it to the Total field. + +### GetDatetime + +`func (o *AccountDashboardStatisticLoyaltyPoints) GetDatetime() time.Time` + +GetDatetime returns the Datetime field if non-nil, zero value otherwise. + +### GetDatetimeOk + +`func (o *AccountDashboardStatisticLoyaltyPoints) GetDatetimeOk() (time.Time, bool)` + +GetDatetimeOk returns a tuple with the Datetime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDatetime + +`func (o *AccountDashboardStatisticLoyaltyPoints) HasDatetime() bool` + +HasDatetime returns a boolean if a field has been set. + +### SetDatetime + +`func (o *AccountDashboardStatisticLoyaltyPoints) SetDatetime(v time.Time)` + +SetDatetime gets a reference to the given time.Time and assigns it to the Datetime 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/AccountDashboardStatisticReferrals.md b/docs/AccountDashboardStatisticReferrals.md new file mode 100644 index 00000000..39bb3c0c --- /dev/null +++ b/docs/AccountDashboardStatisticReferrals.md @@ -0,0 +1,65 @@ +# AccountDashboardStatisticReferrals + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Total** | Pointer to **float32** | Total number of referrals initiated by users. | +**Datetime** | Pointer to [**time.Time**](time.Time.md) | Values aggregated for the specified date. | + +## Methods + +### GetTotal + +`func (o *AccountDashboardStatisticReferrals) GetTotal() float32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *AccountDashboardStatisticReferrals) GetTotalOk() (float32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotal + +`func (o *AccountDashboardStatisticReferrals) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + +### SetTotal + +`func (o *AccountDashboardStatisticReferrals) SetTotal(v float32)` + +SetTotal gets a reference to the given float32 and assigns it to the Total field. + +### GetDatetime + +`func (o *AccountDashboardStatisticReferrals) GetDatetime() time.Time` + +GetDatetime returns the Datetime field if non-nil, zero value otherwise. + +### GetDatetimeOk + +`func (o *AccountDashboardStatisticReferrals) GetDatetimeOk() (time.Time, bool)` + +GetDatetimeOk returns a tuple with the Datetime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDatetime + +`func (o *AccountDashboardStatisticReferrals) HasDatetime() bool` + +HasDatetime returns a boolean if a field has been set. + +### SetDatetime + +`func (o *AccountDashboardStatisticReferrals) SetDatetime(v time.Time)` + +SetDatetime gets a reference to the given time.Time and assigns it to the Datetime 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/AccountDashboardStatisticRevenue.md b/docs/AccountDashboardStatisticRevenue.md new file mode 100644 index 00000000..751c74ea --- /dev/null +++ b/docs/AccountDashboardStatisticRevenue.md @@ -0,0 +1,91 @@ +# AccountDashboardStatisticRevenue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Total** | Pointer to **float32** | All revenue that went through the client's shop (including purchases that didn’t trigger an effect). | +**Influenced** | Pointer to **float32** | The revenue that was created by a purchase that triggered an effect (excluding web hooks, notifications). | +**Datetime** | Pointer to [**time.Time**](time.Time.md) | Values aggregated for the specified date. | + +## Methods + +### GetTotal + +`func (o *AccountDashboardStatisticRevenue) GetTotal() float32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *AccountDashboardStatisticRevenue) GetTotalOk() (float32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotal + +`func (o *AccountDashboardStatisticRevenue) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + +### SetTotal + +`func (o *AccountDashboardStatisticRevenue) SetTotal(v float32)` + +SetTotal gets a reference to the given float32 and assigns it to the Total field. + +### GetInfluenced + +`func (o *AccountDashboardStatisticRevenue) GetInfluenced() float32` + +GetInfluenced returns the Influenced field if non-nil, zero value otherwise. + +### GetInfluencedOk + +`func (o *AccountDashboardStatisticRevenue) GetInfluencedOk() (float32, bool)` + +GetInfluencedOk returns a tuple with the Influenced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasInfluenced + +`func (o *AccountDashboardStatisticRevenue) HasInfluenced() bool` + +HasInfluenced returns a boolean if a field has been set. + +### SetInfluenced + +`func (o *AccountDashboardStatisticRevenue) SetInfluenced(v float32)` + +SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. + +### GetDatetime + +`func (o *AccountDashboardStatisticRevenue) GetDatetime() time.Time` + +GetDatetime returns the Datetime field if non-nil, zero value otherwise. + +### GetDatetimeOk + +`func (o *AccountDashboardStatisticRevenue) GetDatetimeOk() (time.Time, bool)` + +GetDatetimeOk returns a tuple with the Datetime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDatetime + +`func (o *AccountDashboardStatisticRevenue) HasDatetime() bool` + +HasDatetime returns a boolean if a field has been set. + +### SetDatetime + +`func (o *AccountDashboardStatisticRevenue) SetDatetime(v time.Time)` + +SetDatetime gets a reference to the given time.Time and assigns it to the Datetime 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/AddFreeItemEffectProps.md b/docs/AddFreeItemEffectProps.md index 77b2f866..e73c3f5d 100644 --- a/docs/AddFreeItemEffectProps.md +++ b/docs/AddFreeItemEffectProps.md @@ -5,7 +5,7 @@ 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. | +**Name** | Pointer to **string** | The name / description of the effect | ## Methods diff --git a/docs/AddLoyaltyPoints.md b/docs/AddLoyaltyPoints.md new file mode 100644 index 00000000..92dfeb42 --- /dev/null +++ b/docs/AddLoyaltyPoints.md @@ -0,0 +1,221 @@ +# AddLoyaltyPoints + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Points** | Pointer to **float32** | Amount of loyalty points. | +**Name** | Pointer to **string** | Name / reason for the point addition. | [optional] +**ValidityDuration** | Pointer to **string** | The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. If passed, `validUntil` should be omitted. | [optional] +**ValidUntil** | Pointer to [**time.Time**](time.Time.md) | Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. | [optional] +**PendingDuration** | Pointer to **string** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. | [optional] +**PendingUntil** | Pointer to [**time.Time**](time.Time.md) | Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. | [optional] +**SubledgerId** | Pointer to **string** | ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. | [optional] +**ApplicationId** | Pointer to **int32** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional] + +## Methods + +### GetPoints + +`func (o *AddLoyaltyPoints) GetPoints() float32` + +GetPoints returns the Points field if non-nil, zero value otherwise. + +### GetPointsOk + +`func (o *AddLoyaltyPoints) GetPointsOk() (float32, bool)` + +GetPointsOk returns a tuple with the Points field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoints + +`func (o *AddLoyaltyPoints) HasPoints() bool` + +HasPoints returns a boolean if a field has been set. + +### SetPoints + +`func (o *AddLoyaltyPoints) SetPoints(v float32)` + +SetPoints gets a reference to the given float32 and assigns it to the Points field. + +### GetName + +`func (o *AddLoyaltyPoints) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AddLoyaltyPoints) 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 *AddLoyaltyPoints) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *AddLoyaltyPoints) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetValidityDuration + +`func (o *AddLoyaltyPoints) GetValidityDuration() string` + +GetValidityDuration returns the ValidityDuration field if non-nil, zero value otherwise. + +### GetValidityDurationOk + +`func (o *AddLoyaltyPoints) GetValidityDurationOk() (string, bool)` + +GetValidityDurationOk returns a tuple with the ValidityDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValidityDuration + +`func (o *AddLoyaltyPoints) HasValidityDuration() bool` + +HasValidityDuration returns a boolean if a field has been set. + +### SetValidityDuration + +`func (o *AddLoyaltyPoints) SetValidityDuration(v string)` + +SetValidityDuration gets a reference to the given string and assigns it to the ValidityDuration field. + +### GetValidUntil + +`func (o *AddLoyaltyPoints) GetValidUntil() time.Time` + +GetValidUntil returns the ValidUntil field if non-nil, zero value otherwise. + +### GetValidUntilOk + +`func (o *AddLoyaltyPoints) GetValidUntilOk() (time.Time, bool)` + +GetValidUntilOk returns a tuple with the ValidUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValidUntil + +`func (o *AddLoyaltyPoints) HasValidUntil() bool` + +HasValidUntil returns a boolean if a field has been set. + +### SetValidUntil + +`func (o *AddLoyaltyPoints) SetValidUntil(v time.Time)` + +SetValidUntil gets a reference to the given time.Time and assigns it to the ValidUntil field. + +### GetPendingDuration + +`func (o *AddLoyaltyPoints) GetPendingDuration() string` + +GetPendingDuration returns the PendingDuration field if non-nil, zero value otherwise. + +### GetPendingDurationOk + +`func (o *AddLoyaltyPoints) GetPendingDurationOk() (string, bool)` + +GetPendingDurationOk returns a tuple with the PendingDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPendingDuration + +`func (o *AddLoyaltyPoints) HasPendingDuration() bool` + +HasPendingDuration returns a boolean if a field has been set. + +### SetPendingDuration + +`func (o *AddLoyaltyPoints) SetPendingDuration(v string)` + +SetPendingDuration gets a reference to the given string and assigns it to the PendingDuration field. + +### GetPendingUntil + +`func (o *AddLoyaltyPoints) GetPendingUntil() time.Time` + +GetPendingUntil returns the PendingUntil field if non-nil, zero value otherwise. + +### GetPendingUntilOk + +`func (o *AddLoyaltyPoints) GetPendingUntilOk() (time.Time, bool)` + +GetPendingUntilOk returns a tuple with the PendingUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPendingUntil + +`func (o *AddLoyaltyPoints) HasPendingUntil() bool` + +HasPendingUntil returns a boolean if a field has been set. + +### SetPendingUntil + +`func (o *AddLoyaltyPoints) SetPendingUntil(v time.Time)` + +SetPendingUntil gets a reference to the given time.Time and assigns it to the PendingUntil field. + +### GetSubledgerId + +`func (o *AddLoyaltyPoints) GetSubledgerId() string` + +GetSubledgerId returns the SubledgerId field if non-nil, zero value otherwise. + +### GetSubledgerIdOk + +`func (o *AddLoyaltyPoints) 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 *AddLoyaltyPoints) HasSubledgerId() bool` + +HasSubledgerId returns a boolean if a field has been set. + +### SetSubledgerId + +`func (o *AddLoyaltyPoints) SetSubledgerId(v string)` + +SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. + +### GetApplicationId + +`func (o *AddLoyaltyPoints) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AddLoyaltyPoints) 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 *AddLoyaltyPoints) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *AddLoyaltyPoints) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId 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 17e286aa..f4217640 100644 --- a/docs/AddLoyaltyPointsEffectProps.md +++ b/docs/AddLoyaltyPointsEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The reason of the point addition. | +**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. | @@ -15,7 +15,9 @@ Name | Type | Description | Notes **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] +**CardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [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 definition. | [optional] ## Methods @@ -319,6 +321,56 @@ HasCardIdentifier returns a boolean if a field has been set. SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. +### GetBundleIndex + +`func (o *AddLoyaltyPointsEffectProps) GetBundleIndex() int32` + +GetBundleIndex returns the BundleIndex field if non-nil, zero value otherwise. + +### GetBundleIndexOk + +`func (o *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) HasBundleIndex() bool` + +HasBundleIndex returns a boolean if a field has been set. + +### SetBundleIndex + +`func (o *AddLoyaltyPointsEffectProps) SetBundleIndex(v int32)` + +SetBundleIndex gets a reference to the given int32 and assigns it to the BundleIndex field. + +### GetBundleName + +`func (o *AddLoyaltyPointsEffectProps) GetBundleName() string` + +GetBundleName returns the BundleName field if non-nil, zero value otherwise. + +### GetBundleNameOk + +`func (o *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) HasBundleName() bool` + +HasBundleName returns a boolean if a field has been set. + +### SetBundleName + +`func (o *AddLoyaltyPointsEffectProps) 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/AddedDeductedPointsNotificationPolicy.md b/docs/AddedDeductedPointsNotificationPolicy.md new file mode 100644 index 00000000..2708805c --- /dev/null +++ b/docs/AddedDeductedPointsNotificationPolicy.md @@ -0,0 +1,65 @@ +# AddedDeductedPointsNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Notification name. | +**Scopes** | Pointer to **[]string** | | + +## Methods + +### GetName + +`func (o *AddedDeductedPointsNotificationPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AddedDeductedPointsNotificationPolicy) 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 *AddedDeductedPointsNotificationPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *AddedDeductedPointsNotificationPolicy) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetScopes + +`func (o *AddedDeductedPointsNotificationPolicy) GetScopes() []string` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *AddedDeductedPointsNotificationPolicy) GetScopesOk() ([]string, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScopes + +`func (o *AddedDeductedPointsNotificationPolicy) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### SetScopes + +`func (o *AddedDeductedPointsNotificationPolicy) SetScopes(v []string)` + +SetScopes gets a reference to the given []string and assigns it to the Scopes 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 2005feb9..01a11db8 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -4,9 +4,9 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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] @@ -19,7 +19,7 @@ Name | Type | Description | Notes **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] +**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#flattening). | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [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] diff --git a/docs/ApplicationApiHealth.md b/docs/ApplicationApiHealth.md index 3b220879..456596d1 100644 --- a/docs/ApplicationApiHealth.md +++ b/docs/ApplicationApiHealth.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Summary** | Pointer to **string** | One-word summary of the health of the API connection of an application. | +**Summary** | Pointer to **string** | One-word summary of the health of the API connection of an application. Possible values are: - `OK`: The Application has received only successful API requests in the last 5 minutes. - `WARNING`: The Application received at least one failed request in the last 50 minutes. - `ERROR`: More than 50% of received requests failed. - `CRITICAL`: All received requests failed. - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests. | **LastUsed** | Pointer to [**time.Time**](time.Time.md) | time of last request relevant to the API health test. | ## Methods diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md index 8ba9fa10..2d10b9df 100644 --- a/docs/ApplicationCustomer.md +++ b/docs/ApplicationCustomer.md @@ -4,16 +4,17 @@ 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. 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. | **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. | +**TotalSales** | Pointer to **float32** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | **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. | +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | The 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. | +**Sandbox** | Pointer to **bool** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] **AdvocateIntegrationId** | Pointer to **string** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] ## Methods @@ -268,6 +269,31 @@ HasLastActivity returns a boolean if a field has been set. SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. +### GetSandbox + +`func (o *ApplicationCustomer) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *ApplicationCustomer) 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 *ApplicationCustomer) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *ApplicationCustomer) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetAdvocateIntegrationId `func (o *ApplicationCustomer) GetAdvocateIntegrationId() string` diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md index 0dde5f1c..e7acb140 100644 --- a/docs/ApplicationEvent.md +++ b/docs/ApplicationEvent.md @@ -4,14 +4,14 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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] **SessionId** | Pointer to **int32** | The globally unique Talon.One ID of the session that contains this event. | [optional] **Type** | Pointer to **string** | A string representing the event. Must not be a reserved event name. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Additional JSON serialized data associated with the event. | -**Effects** | Pointer to [**[][]interface{}**]([][]interface{}.md) | An array containing the effects that were applied as a result of this event. | +**Effects** | Pointer to [**[]Effect**](Effect.md) | An array containing the effects that were applied as a result of this event. | **RuleFailureReasons** | Pointer to [**[]RuleFailureReason**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional] ## Methods @@ -193,13 +193,13 @@ SetAttributes gets a reference to the given map[string]interface{} and assigns i ### GetEffects -`func (o *ApplicationEvent) GetEffects() [][]interface{}` +`func (o *ApplicationEvent) GetEffects() []Effect` GetEffects returns the Effects field if non-nil, zero value otherwise. ### GetEffectsOk -`func (o *ApplicationEvent) GetEffectsOk() ([][]interface{}, bool)` +`func (o *ApplicationEvent) 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. @@ -212,9 +212,9 @@ HasEffects returns a boolean if a field has been set. ### SetEffects -`func (o *ApplicationEvent) SetEffects(v [][]interface{})` +`func (o *ApplicationEvent) SetEffects(v []Effect)` -SetEffects gets a reference to the given [][]interface{} and assigns it to the Effects field. +SetEffects gets a reference to the given []Effect and assigns it to the Effects field. ### GetRuleFailureReasons diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index 76c89440..9a88ddef 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -4,15 +4,15 @@ 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. The exact moment this entity was created. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. The time 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 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** | 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** | 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](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | **CartItems** | Pointer to [**[]CartItem**](CartItem.md) | Serialized JSON representation. | **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. | diff --git a/docs/Attribute.md b/docs/Attribute.md index 2e5ffddc..ceca1f5c 100644 --- a/docs/Attribute.md +++ b/docs/Attribute.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | **EventType** | Pointer to **string** | | [optional] diff --git a/docs/Audience.md b/docs/Audience.md index 12aae661..358e3a64 100644 --- a/docs/Audience.md +++ b/docs/Audience.md @@ -5,14 +5,15 @@ 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. 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **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] +**LastUpdate** | Pointer to [**time.Time**](time.Time.md) | The last time that the audience memberships changed. | [optional] ## Methods @@ -241,6 +242,31 @@ HasCreatedIn3rdParty returns a boolean if a field has been set. SetCreatedIn3rdParty gets a reference to the given bool and assigns it to the CreatedIn3rdParty field. +### GetLastUpdate + +`func (o *Audience) GetLastUpdate() time.Time` + +GetLastUpdate returns the LastUpdate field if non-nil, zero value otherwise. + +### GetLastUpdateOk + +`func (o *Audience) GetLastUpdateOk() (time.Time, bool)` + +GetLastUpdateOk returns a tuple with the LastUpdate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLastUpdate + +`func (o *Audience) HasLastUpdate() bool` + +HasLastUpdate returns a boolean if a field has been set. + +### SetLastUpdate + +`func (o *Audience) SetLastUpdate(v time.Time)` + +SetLastUpdate gets a reference to the given time.Time and assigns it to the LastUpdate 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/AudienceCustomer.md b/docs/AudienceCustomer.md new file mode 100644 index 00000000..19f2ab03 --- /dev/null +++ b/docs/AudienceCustomer.md @@ -0,0 +1,351 @@ +# AudienceCustomer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. The time this entity was created. | +**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** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | +**LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | The 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. | +**Sandbox** | Pointer to **bool** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] +**ConnectedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the Applications that are connected to this customer profile. | [optional] +**ConnectedAudiences** | Pointer to **[]int32** | A list of the IDs of the audiences that are connected to this customer profile. | [optional] + +## Methods + +### GetId + +`func (o *AudienceCustomer) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AudienceCustomer) 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 *AudienceCustomer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *AudienceCustomer) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *AudienceCustomer) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AudienceCustomer) 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 *AudienceCustomer) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *AudienceCustomer) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetIntegrationId + +`func (o *AudienceCustomer) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *AudienceCustomer) 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 *AudienceCustomer) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *AudienceCustomer) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + +### GetAttributes + +`func (o *AudienceCustomer) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AudienceCustomer) 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 *AudienceCustomer) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *AudienceCustomer) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetAccountId + +`func (o *AudienceCustomer) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AudienceCustomer) 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 *AudienceCustomer) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *AudienceCustomer) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetClosedSessions + +`func (o *AudienceCustomer) GetClosedSessions() int32` + +GetClosedSessions returns the ClosedSessions field if non-nil, zero value otherwise. + +### GetClosedSessionsOk + +`func (o *AudienceCustomer) GetClosedSessionsOk() (int32, bool)` + +GetClosedSessionsOk returns a tuple with the ClosedSessions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasClosedSessions + +`func (o *AudienceCustomer) HasClosedSessions() bool` + +HasClosedSessions returns a boolean if a field has been set. + +### SetClosedSessions + +`func (o *AudienceCustomer) SetClosedSessions(v int32)` + +SetClosedSessions gets a reference to the given int32 and assigns it to the ClosedSessions field. + +### GetTotalSales + +`func (o *AudienceCustomer) GetTotalSales() float32` + +GetTotalSales returns the TotalSales field if non-nil, zero value otherwise. + +### GetTotalSalesOk + +`func (o *AudienceCustomer) GetTotalSalesOk() (float32, bool)` + +GetTotalSalesOk returns a tuple with the TotalSales field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalSales + +`func (o *AudienceCustomer) HasTotalSales() bool` + +HasTotalSales returns a boolean if a field has been set. + +### SetTotalSales + +`func (o *AudienceCustomer) SetTotalSales(v float32)` + +SetTotalSales gets a reference to the given float32 and assigns it to the TotalSales field. + +### GetLoyaltyMemberships + +`func (o *AudienceCustomer) GetLoyaltyMemberships() []LoyaltyMembership` + +GetLoyaltyMemberships returns the LoyaltyMemberships field if non-nil, zero value otherwise. + +### GetLoyaltyMembershipsOk + +`func (o *AudienceCustomer) GetLoyaltyMembershipsOk() ([]LoyaltyMembership, bool)` + +GetLoyaltyMembershipsOk returns a tuple with the LoyaltyMemberships field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyaltyMemberships + +`func (o *AudienceCustomer) HasLoyaltyMemberships() bool` + +HasLoyaltyMemberships returns a boolean if a field has been set. + +### SetLoyaltyMemberships + +`func (o *AudienceCustomer) SetLoyaltyMemberships(v []LoyaltyMembership)` + +SetLoyaltyMemberships gets a reference to the given []LoyaltyMembership and assigns it to the LoyaltyMemberships field. + +### GetAudienceMemberships + +`func (o *AudienceCustomer) GetAudienceMemberships() []AudienceMembership` + +GetAudienceMemberships returns the AudienceMemberships field if non-nil, zero value otherwise. + +### GetAudienceMembershipsOk + +`func (o *AudienceCustomer) GetAudienceMembershipsOk() ([]AudienceMembership, bool)` + +GetAudienceMembershipsOk returns a tuple with the AudienceMemberships field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudienceMemberships + +`func (o *AudienceCustomer) HasAudienceMemberships() bool` + +HasAudienceMemberships returns a boolean if a field has been set. + +### SetAudienceMemberships + +`func (o *AudienceCustomer) SetAudienceMemberships(v []AudienceMembership)` + +SetAudienceMemberships gets a reference to the given []AudienceMembership and assigns it to the AudienceMemberships field. + +### GetLastActivity + +`func (o *AudienceCustomer) GetLastActivity() time.Time` + +GetLastActivity returns the LastActivity field if non-nil, zero value otherwise. + +### GetLastActivityOk + +`func (o *AudienceCustomer) GetLastActivityOk() (time.Time, bool)` + +GetLastActivityOk returns a tuple with the LastActivity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLastActivity + +`func (o *AudienceCustomer) HasLastActivity() bool` + +HasLastActivity returns a boolean if a field has been set. + +### SetLastActivity + +`func (o *AudienceCustomer) SetLastActivity(v time.Time)` + +SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. + +### GetSandbox + +`func (o *AudienceCustomer) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *AudienceCustomer) 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 *AudienceCustomer) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *AudienceCustomer) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + +### GetConnectedApplicationsIds + +`func (o *AudienceCustomer) GetConnectedApplicationsIds() []int32` + +GetConnectedApplicationsIds returns the ConnectedApplicationsIds field if non-nil, zero value otherwise. + +### GetConnectedApplicationsIdsOk + +`func (o *AudienceCustomer) GetConnectedApplicationsIdsOk() ([]int32, bool)` + +GetConnectedApplicationsIdsOk returns a tuple with the ConnectedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasConnectedApplicationsIds + +`func (o *AudienceCustomer) HasConnectedApplicationsIds() bool` + +HasConnectedApplicationsIds returns a boolean if a field has been set. + +### SetConnectedApplicationsIds + +`func (o *AudienceCustomer) SetConnectedApplicationsIds(v []int32)` + +SetConnectedApplicationsIds gets a reference to the given []int32 and assigns it to the ConnectedApplicationsIds field. + +### GetConnectedAudiences + +`func (o *AudienceCustomer) GetConnectedAudiences() []int32` + +GetConnectedAudiences returns the ConnectedAudiences field if non-nil, zero value otherwise. + +### GetConnectedAudiencesOk + +`func (o *AudienceCustomer) GetConnectedAudiencesOk() ([]int32, bool)` + +GetConnectedAudiencesOk returns a tuple with the ConnectedAudiences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasConnectedAudiences + +`func (o *AudienceCustomer) HasConnectedAudiences() bool` + +HasConnectedAudiences returns a boolean if a field has been set. + +### SetConnectedAudiences + +`func (o *AudienceCustomer) SetConnectedAudiences(v []int32)` + +SetConnectedAudiences gets a reference to the given []int32 and assigns it to the ConnectedAudiences 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 832efbaf..0227a98e 100644 --- a/docs/BaseLoyaltyProgram.md +++ b/docs/BaseLoyaltyProgram.md @@ -7,10 +7,11 @@ Name | Type | Description | Notes **Title** | Pointer to **string** | The display title for the Loyalty Program. | [optional] **Description** | Pointer to **string** | Description of our Loyalty Program. | [optional] **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] +**DefaultValidity** | Pointer to **string** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [optional] +**DefaultPending** | Pointer to **string** | The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [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] +**Sandbox** | Pointer to **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional] ## Methods @@ -189,6 +190,31 @@ HasUsersPerCardLimit returns a boolean if a field has been set. SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +### GetSandbox + +`func (o *BaseLoyaltyProgram) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *BaseLoyaltyProgram) 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 *BaseLoyaltyProgram) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *BaseLoyaltyProgram) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox 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/BaseNotification.md b/docs/BaseNotification.md new file mode 100644 index 00000000..059ccb48 --- /dev/null +++ b/docs/BaseNotification.md @@ -0,0 +1,91 @@ +# BaseNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**map[string]interface{}**](.md) | | +**Webhook** | Pointer to [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | | +**Id** | Pointer to **int32** | Unique ID for this entity. | + +## Methods + +### GetPolicy + +`func (o *BaseNotification) GetPolicy() map[string]interface{}` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *BaseNotification) GetPolicyOk() (map[string]interface{}, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPolicy + +`func (o *BaseNotification) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### SetPolicy + +`func (o *BaseNotification) SetPolicy(v map[string]interface{})` + +SetPolicy gets a reference to the given map[string]interface{} and assigns it to the Policy field. + +### GetWebhook + +`func (o *BaseNotification) GetWebhook() BaseNotificationWebhook` + +GetWebhook returns the Webhook field if non-nil, zero value otherwise. + +### GetWebhookOk + +`func (o *BaseNotification) GetWebhookOk() (BaseNotificationWebhook, bool)` + +GetWebhookOk returns a tuple with the Webhook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasWebhook + +`func (o *BaseNotification) HasWebhook() bool` + +HasWebhook returns a boolean if a field has been set. + +### SetWebhook + +`func (o *BaseNotification) SetWebhook(v BaseNotificationWebhook)` + +SetWebhook gets a reference to the given BaseNotificationWebhook and assigns it to the Webhook field. + +### GetId + +`func (o *BaseNotification) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseNotification) 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 *BaseNotification) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *BaseNotification) 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/BaseNotificationEntity.md b/docs/BaseNotificationEntity.md new file mode 100644 index 00000000..d4b16839 --- /dev/null +++ b/docs/BaseNotificationEntity.md @@ -0,0 +1,39 @@ +# BaseNotificationEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**map[string]interface{}**](.md) | | + +## Methods + +### GetPolicy + +`func (o *BaseNotificationEntity) GetPolicy() map[string]interface{}` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *BaseNotificationEntity) GetPolicyOk() (map[string]interface{}, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPolicy + +`func (o *BaseNotificationEntity) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### SetPolicy + +`func (o *BaseNotificationEntity) SetPolicy(v map[string]interface{})` + +SetPolicy gets a reference to the given map[string]interface{} and assigns it to the Policy 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/BaseNotificationWebhook.md b/docs/BaseNotificationWebhook.md new file mode 100644 index 00000000..d3fbcbe6 --- /dev/null +++ b/docs/BaseNotificationWebhook.md @@ -0,0 +1,143 @@ +# BaseNotificationWebhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | +**Url** | Pointer to **string** | API URL for the given webhook-based notification. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for the given webhook-based notification. | + +## Methods + +### GetId + +`func (o *BaseNotificationWebhook) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseNotificationWebhook) 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 *BaseNotificationWebhook) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *BaseNotificationWebhook) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *BaseNotificationWebhook) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseNotificationWebhook) 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 *BaseNotificationWebhook) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *BaseNotificationWebhook) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetModified + +`func (o *BaseNotificationWebhook) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseNotificationWebhook) 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 *BaseNotificationWebhook) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *BaseNotificationWebhook) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetUrl + +`func (o *BaseNotificationWebhook) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *BaseNotificationWebhook) 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 *BaseNotificationWebhook) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### SetUrl + +`func (o *BaseNotificationWebhook) SetUrl(v string)` + +SetUrl gets a reference to the given string and assigns it to the Url field. + +### GetHeaders + +`func (o *BaseNotificationWebhook) GetHeaders() []string` + +GetHeaders returns the Headers field if non-nil, zero value otherwise. + +### GetHeadersOk + +`func (o *BaseNotificationWebhook) 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 *BaseNotificationWebhook) HasHeaders() bool` + +HasHeaders returns a boolean if a field has been set. + +### SetHeaders + +`func (o *BaseNotificationWebhook) 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/BaseNotifications.md b/docs/BaseNotifications.md new file mode 100644 index 00000000..03fb81bd --- /dev/null +++ b/docs/BaseNotifications.md @@ -0,0 +1,39 @@ +# BaseNotifications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | Pointer to [**[]BaseNotification**](BaseNotification.md) | List of notifications. | [optional] + +## Methods + +### GetData + +`func (o *BaseNotifications) GetData() []BaseNotification` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *BaseNotifications) GetDataOk() ([]BaseNotification, 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 *BaseNotifications) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *BaseNotifications) SetData(v []BaseNotification)` + +SetData gets a reference to the given []BaseNotification 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/Binding.md b/docs/Binding.md index 225b681f..d804887e 100644 --- a/docs/Binding.md +++ b/docs/Binding.md @@ -6,7 +6,7 @@ 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: - `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. | +**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 diff --git a/docs/Campaign.md b/docs/Campaign.md index 1653cb29..19fe5691 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -7,20 +7,20 @@ Name | Type | Description | Notes **Id** | Pointer to **int32** | Unique ID for this entity. | **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. | -**UserId** | Pointer to **int32** | The ID of the account that owns this entity. | +**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | **Name** | Pointer to **string** | A user-facing name for this campaign. | **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] **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](https://docs.talon.one/management-api/#operation/getRulesets) 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** | 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 [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] +**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] @@ -35,6 +35,7 @@ Name | Type | Description | Notes **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] +**ReservecouponEffectCount** | Pointer to **int32** | Total number of reserve coupon effects 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'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] @@ -818,6 +819,31 @@ HasCallApiEffectCount returns a boolean if a field has been set. SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. +### GetReservecouponEffectCount + +`func (o *Campaign) GetReservecouponEffectCount() int32` + +GetReservecouponEffectCount returns the ReservecouponEffectCount field if non-nil, zero value otherwise. + +### GetReservecouponEffectCountOk + +`func (o *Campaign) GetReservecouponEffectCountOk() (int32, bool)` + +GetReservecouponEffectCountOk returns a tuple with the ReservecouponEffectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservecouponEffectCount + +`func (o *Campaign) HasReservecouponEffectCount() bool` + +HasReservecouponEffectCount returns a boolean if a field has been set. + +### SetReservecouponEffectCount + +`func (o *Campaign) SetReservecouponEffectCount(v int32)` + +SetReservecouponEffectCount gets a reference to the given int32 and assigns it to the ReservecouponEffectCount field. + ### GetLastActivity `func (o *Campaign) GetLastActivity() time.Time` diff --git a/docs/CampaignCollection.md b/docs/CampaignCollection.md index c8d35918..a7ee30f7 100644 --- a/docs/CampaignCollection.md +++ b/docs/CampaignCollection.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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] diff --git a/docs/CampaignCollectionWithoutPayload.md b/docs/CampaignCollectionWithoutPayload.md index 1442072a..ab5a20db 100644 --- a/docs/CampaignCollectionWithoutPayload.md +++ b/docs/CampaignCollectionWithoutPayload.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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] diff --git a/docs/CampaignCreatedNotification.md b/docs/CampaignCreatedNotification.md index 9f945d5f..a2ddbc7a 100644 --- a/docs/CampaignCreatedNotification.md +++ b/docs/CampaignCreatedNotification.md @@ -5,6 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Campaign** | Pointer to [**Campaign**](Campaign.md) | | +**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] +**Priority** | Pointer to [**PriorityPosition**](PriorityPosition.md) | | ## Methods @@ -33,6 +35,56 @@ HasCampaign returns a boolean if a field has been set. SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. +### GetRuleset + +`func (o *CampaignCreatedNotification) GetRuleset() Ruleset` + +GetRuleset returns the Ruleset field if non-nil, zero value otherwise. + +### GetRulesetOk + +`func (o *CampaignCreatedNotification) 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 *CampaignCreatedNotification) HasRuleset() bool` + +HasRuleset returns a boolean if a field has been set. + +### SetRuleset + +`func (o *CampaignCreatedNotification) SetRuleset(v Ruleset)` + +SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. + +### GetPriority + +`func (o *CampaignCreatedNotification) GetPriority() PriorityPosition` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *CampaignCreatedNotification) GetPriorityOk() (PriorityPosition, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPriority + +`func (o *CampaignCreatedNotification) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### SetPriority + +`func (o *CampaignCreatedNotification) SetPriority(v PriorityPosition)` + +SetPriority gets a reference to the given PriorityPosition and assigns it to the Priority 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 index 36f0f6d3..d9201e0c 100644 --- a/docs/CampaignDeletedNotification.md +++ b/docs/CampaignDeletedNotification.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Campaign** | Pointer to [**Campaign**](Campaign.md) | | +**DeletedAt** | Pointer to [**time.Time**](time.Time.md) | Time when the campaign was deleted. | ## Methods @@ -33,6 +34,31 @@ HasCampaign returns a boolean if a field has been set. SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. +### GetDeletedAt + +`func (o *CampaignDeletedNotification) GetDeletedAt() time.Time` + +GetDeletedAt returns the DeletedAt field if non-nil, zero value otherwise. + +### GetDeletedAtOk + +`func (o *CampaignDeletedNotification) GetDeletedAtOk() (time.Time, bool)` + +GetDeletedAtOk returns a tuple with the DeletedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDeletedAt + +`func (o *CampaignDeletedNotification) HasDeletedAt() bool` + +HasDeletedAt returns a boolean if a field has been set. + +### SetDeletedAt + +`func (o *CampaignDeletedNotification) SetDeletedAt(v time.Time)` + +SetDeletedAt gets a reference to the given time.Time and assigns it to the DeletedAt 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 index ce40c987..3966c3e4 100644 --- a/docs/CampaignEditedNotification.md +++ b/docs/CampaignEditedNotification.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Campaign** | Pointer to [**Campaign**](Campaign.md) | | **OldCampaign** | Pointer to [**Campaign**](Campaign.md) | | +**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] ## Methods @@ -59,6 +60,31 @@ HasOldCampaign returns a boolean if a field has been set. SetOldCampaign gets a reference to the given Campaign and assigns it to the OldCampaign field. +### GetRuleset + +`func (o *CampaignEditedNotification) GetRuleset() Ruleset` + +GetRuleset returns the Ruleset field if non-nil, zero value otherwise. + +### GetRulesetOk + +`func (o *CampaignEditedNotification) 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 *CampaignEditedNotification) HasRuleset() bool` + +HasRuleset returns a boolean if a field has been set. + +### SetRuleset + +`func (o *CampaignEditedNotification) 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/CampaignGroup.md b/docs/CampaignGroup.md index 4855a5e9..0a3cb49b 100644 --- a/docs/CampaignGroup.md +++ b/docs/CampaignGroup.md @@ -4,9 +4,9 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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] diff --git a/docs/CampaignPrioritiesChangedNotification.md b/docs/CampaignPrioritiesChangedNotification.md index 471164c1..e9c3c9c5 100644 --- a/docs/CampaignPrioritiesChangedNotification.md +++ b/docs/CampaignPrioritiesChangedNotification.md @@ -4,46 +4,46 @@ 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'] | +**ApplicationId** | Pointer to **int32** | The ID of the Application whose campaigns' priorities changed. | +**OldPriorities** | Pointer to [**CampaignSet**](CampaignSet.md) | | [optional] +**Priorities** | Pointer to [**CampaignSet**](CampaignSet.md) | | ## Methods -### GetApplication +### GetApplicationId -`func (o *CampaignPrioritiesChangedNotification) GetApplication() Application` +`func (o *CampaignPrioritiesChangedNotification) GetApplicationId() int32` -GetApplication returns the Application field if non-nil, zero value otherwise. +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. -### GetApplicationOk +### GetApplicationIdOk -`func (o *CampaignPrioritiesChangedNotification) GetApplicationOk() (Application, bool)` +`func (o *CampaignPrioritiesChangedNotification) GetApplicationIdOk() (int32, bool)` -GetApplicationOk returns a tuple with the Application 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. -### HasApplication +### HasApplicationId -`func (o *CampaignPrioritiesChangedNotification) HasApplication() bool` +`func (o *CampaignPrioritiesChangedNotification) HasApplicationId() bool` -HasApplication returns a boolean if a field has been set. +HasApplicationId returns a boolean if a field has been set. -### SetApplication +### SetApplicationId -`func (o *CampaignPrioritiesChangedNotification) SetApplication(v Application)` +`func (o *CampaignPrioritiesChangedNotification) SetApplicationId(v int32)` -SetApplication gets a reference to the given Application and assigns it to the Application field. +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. ### GetOldPriorities -`func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() map[string][]int32` +`func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() CampaignSet` GetOldPriorities returns the OldPriorities field if non-nil, zero value otherwise. ### GetOldPrioritiesOk -`func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (map[string][]int32, bool)` +`func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (CampaignSet, 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. @@ -56,19 +56,19 @@ HasOldPriorities returns a boolean if a field has been set. ### SetOldPriorities -`func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v map[string][]int32)` +`func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v CampaignSet)` -SetOldPriorities gets a reference to the given map[string][]int32 and assigns it to the OldPriorities field. +SetOldPriorities gets a reference to the given CampaignSet and assigns it to the OldPriorities field. ### GetPriorities -`func (o *CampaignPrioritiesChangedNotification) GetPriorities() map[string][]int32` +`func (o *CampaignPrioritiesChangedNotification) GetPriorities() CampaignSet` GetPriorities returns the Priorities field if non-nil, zero value otherwise. ### GetPrioritiesOk -`func (o *CampaignPrioritiesChangedNotification) GetPrioritiesOk() (map[string][]int32, bool)` +`func (o *CampaignPrioritiesChangedNotification) GetPrioritiesOk() (CampaignSet, 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. @@ -81,9 +81,9 @@ HasPriorities returns a boolean if a field has been set. ### SetPriorities -`func (o *CampaignPrioritiesChangedNotification) SetPriorities(v map[string][]int32)` +`func (o *CampaignPrioritiesChangedNotification) SetPriorities(v CampaignSet)` -SetPriorities gets a reference to the given map[string][]int32 and assigns it to the Priorities field. +SetPriorities gets a reference to the given CampaignSet 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/CampaignRulesetChangedNotification.md b/docs/CampaignRulesetChangedNotification.md index 63fa4352..9b3732e9 100644 --- a/docs/CampaignRulesetChangedNotification.md +++ b/docs/CampaignRulesetChangedNotification.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Campaign** | Pointer to [**Campaign**](Campaign.md) | | **OldRuleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] -**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | +**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] ## Methods diff --git a/docs/CampaignSet.md b/docs/CampaignSet.md index 58940bcf..8f4f7766 100644 --- a/docs/CampaignSet.md +++ b/docs/CampaignSet.md @@ -4,11 +4,12 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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 [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | | +**UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign set, if available. | [optional] ## Methods @@ -137,6 +138,31 @@ HasSet returns a boolean if a field has been set. SetSet gets a reference to the given CampaignSetBranchNode and assigns it to the Set field. +### GetUpdatedBy + +`func (o *CampaignSet) GetUpdatedBy() string` + +GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. + +### GetUpdatedByOk + +`func (o *CampaignSet) GetUpdatedByOk() (string, bool)` + +GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUpdatedBy + +`func (o *CampaignSet) HasUpdatedBy() bool` + +HasUpdatedBy returns a boolean if a field has been set. + +### SetUpdatedBy + +`func (o *CampaignSet) SetUpdatedBy(v string)` + +SetUpdatedBy gets a reference to the given string and assigns it to the UpdatedBy 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/CampaignSetV2.md b/docs/CampaignSetV2.md index 59b1d607..a7b06f83 100644 --- a/docs/CampaignSetV2.md +++ b/docs/CampaignSetV2.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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) | | diff --git a/docs/CampaignStateChangedNotification.md b/docs/CampaignStateChangedNotification.md index d09dcb76..269419a7 100644 --- a/docs/CampaignStateChangedNotification.md +++ b/docs/CampaignStateChangedNotification.md @@ -7,6 +7,7 @@ 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'] | +**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] ## Methods @@ -85,6 +86,31 @@ HasNewState returns a boolean if a field has been set. SetNewState gets a reference to the given string and assigns it to the NewState field. +### GetRuleset + +`func (o *CampaignStateChangedNotification) GetRuleset() Ruleset` + +GetRuleset returns the Ruleset field if non-nil, zero value otherwise. + +### GetRulesetOk + +`func (o *CampaignStateChangedNotification) 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 *CampaignStateChangedNotification) HasRuleset() bool` + +HasRuleset returns a boolean if a field has been set. + +### SetRuleset + +`func (o *CampaignStateChangedNotification) 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/CampaignTemplate.md b/docs/CampaignTemplate.md index 81346035..d9606662 100644 --- a/docs/CampaignTemplate.md +++ b/docs/CampaignTemplate.md @@ -4,29 +4,29 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | **Name** | Pointer to **string** | The campaign template name. | **Description** | Pointer to **string** | Customer-facing text that explains the objective of the template. | **Instructions** | Pointer to **string** | Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. | -**CampaignAttributes** | Pointer to [**map[string]interface{}**](.md) | The Campaign Attributes that Campaigns created from this template will have by default. | [optional] -**CouponAttributes** | Pointer to [**map[string]interface{}**](.md) | The Campaign Attributes that Coupons created from this template will have by default. | [optional] -**State** | Pointer to **string** | Only Campaign Templates in 'available' state may be used to create Campaigns. | -**ActiveRulesetId** | Pointer to **int32** | The ID of the Ruleset this Campaign Template will use. | [optional] +**CampaignAttributes** | Pointer to [**map[string]interface{}**](.md) | The campaign attributes that campaigns created from this template will have by default. | [optional] +**CouponAttributes** | Pointer to [**map[string]interface{}**](.md) | The campaign attributes that coupons created from this template will have by default. | [optional] +**State** | Pointer to **string** | Only campaign templates in 'available' state may be used to create campaigns. | +**ActiveRulesetId** | Pointer to **int32** | The ID of the ruleset this campaign template will use. | [optional] **Tags** | Pointer to **[]string** | A list of tags for the campaign template. | [optional] **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] -**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. | +**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] +**TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] +**ApplicationsIds** | Pointer to **[]int32** | A list of 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] +**DefaultCampaignGroupId** | Pointer to **int32** | The default campaign group ID. | [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. | +**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. | ## Methods diff --git a/docs/CardLedgerTransactionLogEntry.md b/docs/CardLedgerTransactionLogEntry.md index 033e9524..72ff497b 100644 --- a/docs/CardLedgerTransactionLogEntry.md +++ b/docs/CardLedgerTransactionLogEntry.md @@ -6,13 +6,13 @@ 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. | +**CardIdentifier** | Pointer to **string** | The alphanumeric 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. | +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | [optional] +**Type** | Pointer to **string** | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. | **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. | +**StartDate** | Pointer to **string** | When points become active. Possible values: - `immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time. | **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. | diff --git a/docs/CardLedgerTransactionLogEntryIntegrationApi.md b/docs/CardLedgerTransactionLogEntryIntegrationApi.md index 19c93fbd..5efb2b00 100644 --- a/docs/CardLedgerTransactionLogEntryIntegrationApi.md +++ b/docs/CardLedgerTransactionLogEntryIntegrationApi.md @@ -6,11 +6,11 @@ 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. | +**CardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | [optional] +**Type** | Pointer to **string** | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. | **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. | +**StartDate** | Pointer to **string** | When points become active. Possible values: - `immediate`: Points are active immediately. - a timestamp value: Points become active at a given date and time. | **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. | diff --git a/docs/CartItem.md b/docs/CartItem.md index 5c2b4d69..2dbe6101 100644 --- a/docs/CartItem.md +++ b/docs/CartItem.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | Name of item. | +**Name** | Pointer to **string** | Name of item. | [optional] **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. | +**Quantity** | Pointer to **int32** | Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening), 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. | +**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. | [optional] **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] @@ -17,7 +17,7 @@ Name | Type | Description | Notes **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] +**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 diff --git a/docs/Catalog.md b/docs/Catalog.md index 8228b349..41b883bc 100644 --- a/docs/Catalog.md +++ b/docs/Catalog.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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] diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index 3c34dcd3..a2e1c683 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/CatalogsStrikethroughNotificationPolicy.md b/docs/CatalogsStrikethroughNotificationPolicy.md new file mode 100644 index 00000000..252be050 --- /dev/null +++ b/docs/CatalogsStrikethroughNotificationPolicy.md @@ -0,0 +1,39 @@ +# CatalogsStrikethroughNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Notification name. | + +## Methods + +### GetName + +`func (o *CatalogsStrikethroughNotificationPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CatalogsStrikethroughNotificationPolicy) 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 *CatalogsStrikethroughNotificationPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CatalogsStrikethroughNotificationPolicy) 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/Change.md b/docs/Change.md index fe1bf697..f70756fe 100644 --- a/docs/Change.md +++ b/docs/Change.md @@ -4,13 +4,14 @@ 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. | -**UserId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | **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] +**ManagementKeyId** | Pointer to **int32** | ID of management key used to perform changes. | [optional] ## Methods @@ -189,6 +190,31 @@ HasNew returns a boolean if a field has been set. SetNew gets a reference to the given map[string]interface{} and assigns it to the New field. +### GetManagementKeyId + +`func (o *Change) GetManagementKeyId() int32` + +GetManagementKeyId returns the ManagementKeyId field if non-nil, zero value otherwise. + +### GetManagementKeyIdOk + +`func (o *Change) GetManagementKeyIdOk() (int32, bool)` + +GetManagementKeyIdOk returns a tuple with the ManagementKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasManagementKeyId + +`func (o *Change) HasManagementKeyId() bool` + +HasManagementKeyId returns a boolean if a field has been set. + +### SetManagementKeyId + +`func (o *Change) SetManagementKeyId(v int32)` + +SetManagementKeyId gets a reference to the given int32 and assigns it to the ManagementKeyId 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/CodeGeneratorSettings.md b/docs/CodeGeneratorSettings.md index 7779e380..5700aa44 100644 --- a/docs/CodeGeneratorSettings.md +++ b/docs/CodeGeneratorSettings.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. | +**ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. | **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 1b639f4f..0c7e8996 100644 --- a/docs/Collection.md +++ b/docs/Collection.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/CollectionWithoutPayload.md b/docs/CollectionWithoutPayload.md index 0d54c733..412dd780 100644 --- a/docs/CollectionWithoutPayload.md +++ b/docs/CollectionWithoutPayload.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/Coupon.md b/docs/Coupon.md index 20c12b11..93ff6731 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -4,24 +4,27 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | +**UsageCounter** | Pointer to **int32** | The number of times the coupon has been successfully redeemed. | **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] +**ReservationCounter** | Pointer to **float32** | The number of times this coupon has been reserved. | [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** | 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] +**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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. | [optional] [default to true] **BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] +**IsReservationMandatory** | Pointer to **bool** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] ## Methods @@ -175,6 +178,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *Coupon) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *Coupon) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *Coupon) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *Coupon) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *Coupon) GetStartDate() time.Time` @@ -325,6 +353,31 @@ HasDiscountRemainder returns a boolean if a field has been set. SetDiscountRemainder gets a reference to the given float32 and assigns it to the DiscountRemainder field. +### GetReservationCounter + +`func (o *Coupon) GetReservationCounter() float32` + +GetReservationCounter returns the ReservationCounter field if non-nil, zero value otherwise. + +### GetReservationCounterOk + +`func (o *Coupon) GetReservationCounterOk() (float32, bool)` + +GetReservationCounterOk returns a tuple with the ReservationCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationCounter + +`func (o *Coupon) HasReservationCounter() bool` + +HasReservationCounter returns a boolean if a field has been set. + +### SetReservationCounter + +`func (o *Coupon) SetReservationCounter(v float32)` + +SetReservationCounter gets a reference to the given float32 and assigns it to the ReservationCounter field. + ### GetAttributes `func (o *Coupon) GetAttributes() map[string]interface{}` @@ -475,6 +528,31 @@ HasBatchId returns a boolean if a field has been set. SetBatchId gets a reference to the given string and assigns it to the BatchId field. +### GetIsReservationMandatory + +`func (o *Coupon) GetIsReservationMandatory() bool` + +GetIsReservationMandatory returns the IsReservationMandatory field if non-nil, zero value otherwise. + +### GetIsReservationMandatoryOk + +`func (o *Coupon) GetIsReservationMandatoryOk() (bool, bool)` + +GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsReservationMandatory + +`func (o *Coupon) HasIsReservationMandatory() bool` + +HasIsReservationMandatory returns a boolean if a field has been set. + +### SetIsReservationMandatory + +`func (o *Coupon) SetIsReservationMandatory(v bool)` + +SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory 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/CouponConstraints.md b/docs/CouponConstraints.md index 5143d14d..0b3c241f 100644 --- a/docs/CouponConstraints.md +++ b/docs/CouponConstraints.md @@ -5,9 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] ## Methods @@ -61,6 +62,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *CouponConstraints) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *CouponConstraints) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *CouponConstraints) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *CouponConstraints) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *CouponConstraints) GetStartDate() time.Time` diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md index 4abc0835..6ca9055a 100644 --- a/docs/CouponCreationJob.md +++ b/docs/CouponCreationJob.md @@ -4,16 +4,17 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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 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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | **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. | @@ -203,6 +204,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *CouponCreationJob) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *CouponCreationJob) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *CouponCreationJob) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *CouponCreationJob) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *CouponCreationJob) GetStartDate() time.Time` diff --git a/docs/CouponsNotificationPolicy.md b/docs/CouponsNotificationPolicy.md new file mode 100644 index 00000000..1c311828 --- /dev/null +++ b/docs/CouponsNotificationPolicy.md @@ -0,0 +1,65 @@ +# CouponsNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Notification name. | +**Scopes** | Pointer to **[]string** | | + +## Methods + +### GetName + +`func (o *CouponsNotificationPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CouponsNotificationPolicy) 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 *CouponsNotificationPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CouponsNotificationPolicy) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetScopes + +`func (o *CouponsNotificationPolicy) GetScopes() []string` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *CouponsNotificationPolicy) GetScopesOk() ([]string, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScopes + +`func (o *CouponsNotificationPolicy) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### SetScopes + +`func (o *CouponsNotificationPolicy) SetScopes(v []string)` + +SetScopes gets a reference to the given []string and assigns it to the Scopes 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/CreateManagementKey.md b/docs/CreateManagementKey.md index 0d9902cd..4408ea7f 100644 --- a/docs/CreateManagementKey.md +++ b/docs/CreateManagementKey.md @@ -7,6 +7,7 @@ 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 | +**AllowedApplicationIds** | Pointer to **[]int32** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. | [optional] ## Methods @@ -85,6 +86,31 @@ HasEndpoints returns a boolean if a field has been set. SetEndpoints gets a reference to the given []Endpoint and assigns it to the Endpoints field. +### GetAllowedApplicationIds + +`func (o *CreateManagementKey) GetAllowedApplicationIds() []int32` + +GetAllowedApplicationIds returns the AllowedApplicationIds field if non-nil, zero value otherwise. + +### GetAllowedApplicationIdsOk + +`func (o *CreateManagementKey) GetAllowedApplicationIdsOk() ([]int32, bool)` + +GetAllowedApplicationIdsOk returns a tuple with the AllowedApplicationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAllowedApplicationIds + +`func (o *CreateManagementKey) HasAllowedApplicationIds() bool` + +HasAllowedApplicationIds returns a boolean if a field has been set. + +### SetAllowedApplicationIds + +`func (o *CreateManagementKey) SetAllowedApplicationIds(v []int32)` + +SetAllowedApplicationIds gets a reference to the given []int32 and assigns it to the AllowedApplicationIds 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 22200185..9b792c30 100644 --- a/docs/CreateTemplateCampaign.md +++ b/docs/CreateTemplateCampaign.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **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] +**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 diff --git a/docs/CustomEffect.md b/docs/CustomEffect.md index 511a7aef..d35c43a2 100644 --- a/docs/CustomEffect.md +++ b/docs/CustomEffect.md @@ -4,11 +4,12 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | -**ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | +**ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. | +**IsPerItem** | Pointer to **bool** | Indicates if this effect is per item or not. | [optional] **Name** | Pointer to **string** | The name of this effect. | **Title** | Pointer to **string** | The title of this effect. | **Payload** | Pointer to **string** | The JSON payload of this effect. | @@ -145,6 +146,31 @@ HasApplicationIds returns a boolean if a field has been set. SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds field. +### GetIsPerItem + +`func (o *CustomEffect) GetIsPerItem() bool` + +GetIsPerItem returns the IsPerItem field if non-nil, zero value otherwise. + +### GetIsPerItemOk + +`func (o *CustomEffect) GetIsPerItemOk() (bool, bool)` + +GetIsPerItemOk returns a tuple with the IsPerItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsPerItem + +`func (o *CustomEffect) HasIsPerItem() bool` + +HasIsPerItem returns a boolean if a field has been set. + +### SetIsPerItem + +`func (o *CustomEffect) SetIsPerItem(v bool)` + +SetIsPerItem gets a reference to the given bool and assigns it to the IsPerItem field. + ### GetName `func (o *CustomEffect) GetName() string` diff --git a/docs/CustomEffectProps.md b/docs/CustomEffectProps.md index 47348d46..eb8d1d8d 100644 --- a/docs/CustomEffectProps.md +++ b/docs/CustomEffectProps.md @@ -6,6 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **EffectId** | Pointer to **int32** | The ID of the custom effect that was triggered. | **Name** | Pointer to **string** | The type of the custom effect. | +**CartItemPosition** | Pointer to **float32** | The index of the item in the cart item list to which the custom effect is applied. | [optional] +**CartItemSubPosition** | Pointer to **float32** | When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1. | [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 definition. | [optional] **Payload** | Pointer to [**map[string]interface{}**](.md) | The JSON payload of the custom effect. | ## Methods @@ -60,6 +64,106 @@ 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. +### GetCartItemPosition + +`func (o *CustomEffectProps) GetCartItemPosition() float32` + +GetCartItemPosition returns the CartItemPosition field if non-nil, zero value otherwise. + +### GetCartItemPositionOk + +`func (o *CustomEffectProps) 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 *CustomEffectProps) HasCartItemPosition() bool` + +HasCartItemPosition returns a boolean if a field has been set. + +### SetCartItemPosition + +`func (o *CustomEffectProps) SetCartItemPosition(v float32)` + +SetCartItemPosition gets a reference to the given float32 and assigns it to the CartItemPosition field. + +### GetCartItemSubPosition + +`func (o *CustomEffectProps) GetCartItemSubPosition() float32` + +GetCartItemSubPosition returns the CartItemSubPosition field if non-nil, zero value otherwise. + +### GetCartItemSubPositionOk + +`func (o *CustomEffectProps) 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 *CustomEffectProps) HasCartItemSubPosition() bool` + +HasCartItemSubPosition returns a boolean if a field has been set. + +### SetCartItemSubPosition + +`func (o *CustomEffectProps) SetCartItemSubPosition(v float32)` + +SetCartItemSubPosition gets a reference to the given float32 and assigns it to the CartItemSubPosition field. + +### GetBundleIndex + +`func (o *CustomEffectProps) GetBundleIndex() int32` + +GetBundleIndex returns the BundleIndex field if non-nil, zero value otherwise. + +### GetBundleIndexOk + +`func (o *CustomEffectProps) 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 *CustomEffectProps) HasBundleIndex() bool` + +HasBundleIndex returns a boolean if a field has been set. + +### SetBundleIndex + +`func (o *CustomEffectProps) SetBundleIndex(v int32)` + +SetBundleIndex gets a reference to the given int32 and assigns it to the BundleIndex field. + +### GetBundleName + +`func (o *CustomEffectProps) GetBundleName() string` + +GetBundleName returns the BundleName field if non-nil, zero value otherwise. + +### GetBundleNameOk + +`func (o *CustomEffectProps) 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 *CustomEffectProps) HasBundleName() bool` + +HasBundleName returns a boolean if a field has been set. + +### SetBundleName + +`func (o *CustomEffectProps) SetBundleName(v string)` + +SetBundleName gets a reference to the given string and assigns it to the BundleName field. + ### GetPayload `func (o *CustomEffectProps) GetPayload() map[string]interface{}` diff --git a/docs/CustomerActivityReport.md b/docs/CustomerActivityReport.md index 65719dc2..39aa65c0 100644 --- a/docs/CustomerActivityReport.md +++ b/docs/CustomerActivityReport.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | **LastActivity** | Pointer to [**time.Time**](time.Time.md) | The last activity of the customer. | [optional] diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md index e243c072..d8337df5 100644 --- a/docs/CustomerProfile.md +++ b/docs/CustomerProfile.md @@ -4,16 +4,17 @@ 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. The exact moment this entity was created. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. The time this entity was created. | **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. | +**TotalSales** | Pointer to **float32** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. | **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. | +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | The 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. | +**Sandbox** | Pointer to **bool** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] ## Methods @@ -267,6 +268,31 @@ HasLastActivity returns a boolean if a field has been set. SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. +### GetSandbox + +`func (o *CustomerProfile) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *CustomerProfile) 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 *CustomerProfile) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *CustomerProfile) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox 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/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md index df390cea..99ab2441 100644 --- a/docs/CustomerProfileIntegrationRequestV2.md +++ b/docs/CustomerProfileIntegrationRequestV2.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] **AudiencesChanges** | Pointer to [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [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] +**ResponseContent** | Pointer to **[]string** | Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer profile_ request instead of sending extra requests to other endpoints. | [optional] ## Methods @@ -35,6 +36,31 @@ 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. +### GetEvaluableCampaignIds + +`func (o *CustomerProfileIntegrationRequestV2) GetEvaluableCampaignIds() []int32` + +GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise. + +### GetEvaluableCampaignIdsOk + +`func (o *CustomerProfileIntegrationRequestV2) GetEvaluableCampaignIdsOk() ([]int32, bool)` + +GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluableCampaignIds + +`func (o *CustomerProfileIntegrationRequestV2) HasEvaluableCampaignIds() bool` + +HasEvaluableCampaignIds returns a boolean if a field has been set. + +### SetEvaluableCampaignIds + +`func (o *CustomerProfileIntegrationRequestV2) SetEvaluableCampaignIds(v []int32)` + +SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. + ### GetAudiencesChanges `func (o *CustomerProfileIntegrationRequestV2) GetAudiencesChanges() ProfileAudiencesChanges` diff --git a/docs/CustomerProfileUpdateV2Response.md b/docs/CustomerProfileUpdateV2Response.md new file mode 100644 index 00000000..3405e269 --- /dev/null +++ b/docs/CustomerProfileUpdateV2Response.md @@ -0,0 +1,39 @@ +# CustomerProfileUpdateV2Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerProfile** | Pointer to [**CustomerProfile**](CustomerProfile.md) | | + +## Methods + +### GetCustomerProfile + +`func (o *CustomerProfileUpdateV2Response) GetCustomerProfile() CustomerProfile` + +GetCustomerProfile returns the CustomerProfile field if non-nil, zero value otherwise. + +### GetCustomerProfileOk + +`func (o *CustomerProfileUpdateV2Response) GetCustomerProfileOk() (CustomerProfile, bool)` + +GetCustomerProfileOk returns a tuple with the CustomerProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerProfile + +`func (o *CustomerProfileUpdateV2Response) HasCustomerProfile() bool` + +HasCustomerProfile returns a boolean if a field has been set. + +### SetCustomerProfile + +`func (o *CustomerProfileUpdateV2Response) SetCustomerProfile(v CustomerProfile)` + +SetCustomerProfile gets a reference to the given CustomerProfile and assigns it to the CustomerProfile 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/CustomerSession.md b/docs/CustomerSession.md index 3e3134e5..80760185 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **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`. 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] +**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](https://docs.talon.one/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. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). | [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. | diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md index 38740078..b3752aa3 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -4,18 +4,19 @@ 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. The exact moment this entity was created. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. The time 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 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`. | +**EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [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). | [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. 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)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/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] +**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**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). | [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. | @@ -150,6 +151,31 @@ HasProfileId returns a boolean if a field has been set. SetProfileId gets a reference to the given string and assigns it to the ProfileId field. +### GetEvaluableCampaignIds + +`func (o *CustomerSessionV2) GetEvaluableCampaignIds() []int32` + +GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise. + +### GetEvaluableCampaignIdsOk + +`func (o *CustomerSessionV2) GetEvaluableCampaignIdsOk() ([]int32, bool)` + +GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluableCampaignIds + +`func (o *CustomerSessionV2) HasEvaluableCampaignIds() bool` + +HasEvaluableCampaignIds returns a boolean if a field has been set. + +### SetEvaluableCampaignIds + +`func (o *CustomerSessionV2) SetEvaluableCampaignIds(v []int32)` + +SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. + ### GetCouponCodes `func (o *CustomerSessionV2) GetCouponCodes() []string` diff --git a/docs/DeductLoyaltyPoints.md b/docs/DeductLoyaltyPoints.md new file mode 100644 index 00000000..346b8998 --- /dev/null +++ b/docs/DeductLoyaltyPoints.md @@ -0,0 +1,117 @@ +# DeductLoyaltyPoints + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Points** | Pointer to **float32** | Amount of loyalty points. | +**Name** | Pointer to **string** | Name / reason for the point deduction. | [optional] +**SubledgerId** | Pointer to **string** | ID of the subledger the points are deducted from. | [optional] +**ApplicationId** | Pointer to **int32** | ID of the Application that is connected to the loyalty program. | [optional] + +## Methods + +### GetPoints + +`func (o *DeductLoyaltyPoints) GetPoints() float32` + +GetPoints returns the Points field if non-nil, zero value otherwise. + +### GetPointsOk + +`func (o *DeductLoyaltyPoints) GetPointsOk() (float32, bool)` + +GetPointsOk returns a tuple with the Points field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoints + +`func (o *DeductLoyaltyPoints) HasPoints() bool` + +HasPoints returns a boolean if a field has been set. + +### SetPoints + +`func (o *DeductLoyaltyPoints) SetPoints(v float32)` + +SetPoints gets a reference to the given float32 and assigns it to the Points field. + +### GetName + +`func (o *DeductLoyaltyPoints) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *DeductLoyaltyPoints) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetSubledgerId + +`func (o *DeductLoyaltyPoints) GetSubledgerId() string` + +GetSubledgerId returns the SubledgerId field if non-nil, zero value otherwise. + +### GetSubledgerIdOk + +`func (o *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) HasSubledgerId() bool` + +HasSubledgerId returns a boolean if a field has been set. + +### SetSubledgerId + +`func (o *DeductLoyaltyPoints) SetSubledgerId(v string)` + +SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. + +### GetApplicationId + +`func (o *DeductLoyaltyPoints) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *DeductLoyaltyPoints) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId 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/DeductLoyaltyPointsEffectProps.md b/docs/DeductLoyaltyPointsEffectProps.md index e5e848b8..a9e47c46 100644 --- a/docs/DeductLoyaltyPointsEffectProps.md +++ b/docs/DeductLoyaltyPointsEffectProps.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **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] +**CardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] ## Methods diff --git a/docs/Effect.md b/docs/Effect.md index 55e432aa..2851d197 100644 --- a/docs/Effect.md +++ b/docs/Effect.md @@ -8,10 +8,10 @@ Name | Type | Description | Notes **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. | +**EffectType** | Pointer to **string** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | **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) | | +**Props** | Pointer to [**map[string]interface{}**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | ## Methods diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md index 034c8fcc..d4f7672f 100644 --- a/docs/EffectEntity.md +++ b/docs/EffectEntity.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **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. | +**EffectType** | Pointer to **string** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | **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] diff --git a/docs/Entity.md b/docs/Entity.md index 205169fe..c8138023 100644 --- a/docs/Entity.md +++ b/docs/Entity.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | ## Methods diff --git a/docs/Environment.md b/docs/Environment.md index 0ed60fb8..ba48ebb4 100644 --- a/docs/Environment.md +++ b/docs/Environment.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/EvaluableCampaignIds.md b/docs/EvaluableCampaignIds.md new file mode 100644 index 00000000..40b6157a --- /dev/null +++ b/docs/EvaluableCampaignIds.md @@ -0,0 +1,39 @@ +# EvaluableCampaignIds + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] + +## Methods + +### GetEvaluableCampaignIds + +`func (o *EvaluableCampaignIds) GetEvaluableCampaignIds() []int32` + +GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise. + +### GetEvaluableCampaignIdsOk + +`func (o *EvaluableCampaignIds) GetEvaluableCampaignIdsOk() ([]int32, bool)` + +GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluableCampaignIds + +`func (o *EvaluableCampaignIds) HasEvaluableCampaignIds() bool` + +HasEvaluableCampaignIds returns a boolean if a field has been set. + +### SetEvaluableCampaignIds + +`func (o *EvaluableCampaignIds) SetEvaluableCampaignIds(v []int32)` + +SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds 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/Event.md b/docs/Event.md index f2f914eb..3f0d32b0 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. 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **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 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** | 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](https://docs.talon.one/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 136f7a1f..5a137bbc 100644 --- a/docs/EventType.md +++ b/docs/EventType.md @@ -4,11 +4,11 @@ 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. | -**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. | [optional] +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Title** | Pointer to **string** | The human-friendly name for this event type. | +**Name** | Pointer to **string** | The integration 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** | A description of what the event represents. | [optional] ## Methods diff --git a/docs/EventV2.md b/docs/EventV2.md index bd5ef71e..0a86af74 100644 --- a/docs/EventV2.md +++ b/docs/EventV2.md @@ -5,8 +5,9 @@ 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] +**EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] +**Type** | Pointer to **string** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). | [optional] ## Methods @@ -35,6 +36,31 @@ HasProfileId returns a boolean if a field has been set. SetProfileId gets a reference to the given string and assigns it to the ProfileId field. +### GetEvaluableCampaignIds + +`func (o *EventV2) GetEvaluableCampaignIds() []int32` + +GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise. + +### GetEvaluableCampaignIdsOk + +`func (o *EventV2) GetEvaluableCampaignIdsOk() ([]int32, bool)` + +GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluableCampaignIds + +`func (o *EventV2) HasEvaluableCampaignIds() bool` + +HasEvaluableCampaignIds returns a boolean if a field has been set. + +### SetEvaluableCampaignIds + +`func (o *EventV2) SetEvaluableCampaignIds(v []int32)` + +SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. + ### GetType `func (o *EventV2) GetType() string` diff --git a/docs/ExpiringPointsNotificationPolicy.md b/docs/ExpiringPointsNotificationPolicy.md new file mode 100644 index 00000000..cb1440df --- /dev/null +++ b/docs/ExpiringPointsNotificationPolicy.md @@ -0,0 +1,65 @@ +# ExpiringPointsNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Notification name. | +**Triggers** | Pointer to [**[]ExpiringPointsNotificationTrigger**](ExpiringPointsNotificationTrigger.md) | | + +## Methods + +### GetName + +`func (o *ExpiringPointsNotificationPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExpiringPointsNotificationPolicy) 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 *ExpiringPointsNotificationPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ExpiringPointsNotificationPolicy) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetTriggers + +`func (o *ExpiringPointsNotificationPolicy) GetTriggers() []ExpiringPointsNotificationTrigger` + +GetTriggers returns the Triggers field if non-nil, zero value otherwise. + +### GetTriggersOk + +`func (o *ExpiringPointsNotificationPolicy) GetTriggersOk() ([]ExpiringPointsNotificationTrigger, bool)` + +GetTriggersOk returns a tuple with the Triggers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTriggers + +`func (o *ExpiringPointsNotificationPolicy) HasTriggers() bool` + +HasTriggers returns a boolean if a field has been set. + +### SetTriggers + +`func (o *ExpiringPointsNotificationPolicy) SetTriggers(v []ExpiringPointsNotificationTrigger)` + +SetTriggers gets a reference to the given []ExpiringPointsNotificationTrigger and assigns it to the Triggers 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/ExpiringPointsNotificationTrigger.md b/docs/ExpiringPointsNotificationTrigger.md new file mode 100644 index 00000000..9e7a26ac --- /dev/null +++ b/docs/ExpiringPointsNotificationTrigger.md @@ -0,0 +1,65 @@ +# ExpiringPointsNotificationTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | Pointer to **int32** | The amount of period. | +**Period** | Pointer to **string** | Notification period indicated by a letter; \"w\" means week, \"d\" means day. | + +## Methods + +### GetAmount + +`func (o *ExpiringPointsNotificationTrigger) GetAmount() int32` + +GetAmount returns the Amount field if non-nil, zero value otherwise. + +### GetAmountOk + +`func (o *ExpiringPointsNotificationTrigger) GetAmountOk() (int32, 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 *ExpiringPointsNotificationTrigger) HasAmount() bool` + +HasAmount returns a boolean if a field has been set. + +### SetAmount + +`func (o *ExpiringPointsNotificationTrigger) SetAmount(v int32)` + +SetAmount gets a reference to the given int32 and assigns it to the Amount field. + +### GetPeriod + +`func (o *ExpiringPointsNotificationTrigger) GetPeriod() string` + +GetPeriod returns the Period field if non-nil, zero value otherwise. + +### GetPeriodOk + +`func (o *ExpiringPointsNotificationTrigger) GetPeriodOk() (string, bool)` + +GetPeriodOk returns a tuple with the Period field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPeriod + +`func (o *ExpiringPointsNotificationTrigger) HasPeriod() bool` + +HasPeriod returns a boolean if a field has been set. + +### SetPeriod + +`func (o *ExpiringPointsNotificationTrigger) SetPeriod(v string)` + +SetPeriod gets a reference to the given string and assigns it to the Period 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 00bad52e..3a6553a8 100644 --- a/docs/Export.md +++ b/docs/Export.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**UserId** | Pointer to **int32** | The ID of the user associated with 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. | diff --git a/docs/FeatureFlag.md b/docs/FeatureFlag.md index 96515b2a..b077ae6a 100644 --- a/docs/FeatureFlag.md +++ b/docs/FeatureFlag.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] +**Name** | Pointer to **string** | The name of the feature flag. | +**Value** | Pointer to **string** | The value of the feature flag. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last created. | [optional] +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | [optional] ## Methods diff --git a/docs/FrontendState.md b/docs/FrontendState.md new file mode 100644 index 00000000..834b1bd3 --- /dev/null +++ b/docs/FrontendState.md @@ -0,0 +1,11 @@ +# FrontendState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + +[[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/Giveaway.md b/docs/Giveaway.md index aaa3a218..15b5e86f 100644 --- a/docs/Giveaway.md +++ b/docs/Giveaway.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the giveaway becomes valid. | [optional] @@ -13,6 +13,8 @@ Name | Type | Description | Notes **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this giveaway. | [optional] **Used** | Pointer to **bool** | Indicates whether this giveaway code was given before. | [optional] **ImportId** | Pointer to **int32** | The ID of the Import which created this giveaway. | [optional] +**ProfileIntegrationId** | Pointer to **string** | The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded. | [optional] +**ProfileId** | Pointer to **int32** | The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists. | [optional] ## Methods @@ -241,6 +243,56 @@ HasImportId returns a boolean if a field has been set. SetImportId gets a reference to the given int32 and assigns it to the ImportId field. +### GetProfileIntegrationId + +`func (o *Giveaway) GetProfileIntegrationId() string` + +GetProfileIntegrationId returns the ProfileIntegrationId field if non-nil, zero value otherwise. + +### GetProfileIntegrationIdOk + +`func (o *Giveaway) 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 *Giveaway) HasProfileIntegrationId() bool` + +HasProfileIntegrationId returns a boolean if a field has been set. + +### SetProfileIntegrationId + +`func (o *Giveaway) SetProfileIntegrationId(v string)` + +SetProfileIntegrationId gets a reference to the given string and assigns it to the ProfileIntegrationId field. + +### GetProfileId + +`func (o *Giveaway) GetProfileId() int32` + +GetProfileId returns the ProfileId field if non-nil, zero value otherwise. + +### GetProfileIdOk + +`func (o *Giveaway) 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 *Giveaway) HasProfileId() bool` + +HasProfileId returns a boolean if a field has been set. + +### SetProfileId + +`func (o *Giveaway) SetProfileId(v int32)` + +SetProfileId gets a reference to the given int32 and assigns it to the ProfileId 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/GiveawaysPool.md b/docs/GiveawaysPool.md index c0588991..f0d3db80 100644 --- a/docs/GiveawaysPool.md +++ b/docs/GiveawaysPool.md @@ -4,12 +4,13 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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] +**Sandbox** | Pointer to **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | **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] @@ -166,6 +167,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. +### GetSandbox + +`func (o *GiveawaysPool) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *GiveawaysPool) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetModified `func (o *GiveawaysPool) GetModified() time.Time` diff --git a/docs/Import.md b/docs/Import.md index a0ae9a34..6505de91 100644 --- a/docs/Import.md +++ b/docs/Import.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | **Entity** | Pointer to **string** | The name of the entity that was imported. | **Amount** | Pointer to **int32** | The number of values that were imported. | diff --git a/docs/InlineResponse2001.md b/docs/InlineResponse2001.md index 75819eca..afa0dd76 100644 --- a/docs/InlineResponse2001.md +++ b/docs/InlineResponse2001.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]LedgerTransactionLogEntryIntegrationApi**](LedgerTransactionLogEntryIntegrationAPI.md) | | +**Data** | Pointer to [**[]CardLedgerTransactionLogEntryIntegrationApi**](CardLedgerTransactionLogEntryIntegrationAPI.md) | | ## Methods @@ -36,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse2001) GetData() []LedgerTransactionLogEntryIntegrationApi` +`func (o *InlineResponse2001) GetData() []CardLedgerTransactionLogEntryIntegrationApi` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2001) GetDataOk() ([]LedgerTransactionLogEntryIntegrationApi, bool)` +`func (o *InlineResponse2001) GetDataOk() ([]CardLedgerTransactionLogEntryIntegrationApi, 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 *InlineResponse2001) SetData(v []LedgerTransactionLogEntryIntegrationApi)` +`func (o *InlineResponse2001) SetData(v []CardLedgerTransactionLogEntryIntegrationApi)` -SetData gets a reference to the given []LedgerTransactionLogEntryIntegrationApi and assigns it to the Data field. +SetData gets a reference to the given []CardLedgerTransactionLogEntryIntegrationApi 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/InlineResponse20010.md b/docs/InlineResponse20010.md index f718de4c..42f295f9 100644 --- a/docs/InlineResponse20010.md +++ b/docs/InlineResponse20010.md @@ -4,9 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | [optional] -**TotalResultSize** | Pointer to **int32** | | [optional] -**Data** | Pointer to [**[]CollectionWithoutPayload**](CollectionWithoutPayload.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]CampaignTemplate**](CampaignTemplate.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 *InlineResponse20010) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20010) 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 *InlineResponse20010) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20010) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetData -`func (o *InlineResponse20010) GetData() []CollectionWithoutPayload` +`func (o *InlineResponse20010) GetData() []CampaignTemplate` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20010) GetDataOk() ([]CollectionWithoutPayload, bool)` +`func (o *InlineResponse20010) GetDataOk() ([]CampaignTemplate, 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 *InlineResponse20010) SetData(v []CollectionWithoutPayload)` +`func (o *InlineResponse20010) SetData(v []CampaignTemplate)` -SetData gets a reference to the given []CollectionWithoutPayload and assigns it to the Data field. +SetData gets a reference to the given []CampaignTemplate 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 eea1069a..62255c23 100644 --- a/docs/InlineResponse20011.md +++ b/docs/InlineResponse20011.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]CollectionItem**](CollectionItem.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | | ## Methods -### 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() []CollectionItem` +`func (o *InlineResponse20011) GetData() []LoyaltyProgram` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20011) GetDataOk() ([]CollectionItem, bool)` +`func (o *InlineResponse20011) 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 *InlineResponse20011) SetData(v []CollectionItem)` +`func (o *InlineResponse20011) SetData(v []LoyaltyProgram)` -SetData gets a reference to the given []CollectionItem 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/InlineResponse20012.md b/docs/InlineResponse20012.md index bf69bd66..0391d5a9 100644 --- a/docs/InlineResponse20012.md +++ b/docs/InlineResponse20012.md @@ -4,9 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | [optional] -**TotalResultSize** | Pointer to **int32** | | [optional] -**Data** | Pointer to [**[]Collection**](Collection.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]LoyaltyProgramTransaction**](LoyaltyProgramTransaction.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 *InlineResponse20012) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20012) 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 *InlineResponse20012) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20012) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetData -`func (o *InlineResponse20012) GetData() []Collection` +`func (o *InlineResponse20012) GetData() []LoyaltyProgramTransaction` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20012) GetDataOk() ([]Collection, bool)` +`func (o *InlineResponse20012) GetDataOk() ([]LoyaltyProgramTransaction, 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 *InlineResponse20012) SetData(v []Collection)` +`func (o *InlineResponse20012) SetData(v []LoyaltyProgramTransaction)` -SetData gets a reference to the given []Collection and assigns it to the Data field. +SetData gets a reference to the given []LoyaltyProgramTransaction 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 cd06bc33..6fde520a 100644 --- a/docs/InlineResponse20013.md +++ b/docs/InlineResponse20013.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | +**Data** | Pointer to [**[]LoyaltyCard**](LoyaltyCard.md) | | ## Methods @@ -36,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20013) GetData() []AccessLogEntry` +`func (o *InlineResponse20013) GetData() []LoyaltyCard` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20013) GetDataOk() ([]AccessLogEntry, bool)` +`func (o *InlineResponse20013) GetDataOk() ([]LoyaltyCard, 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 []AccessLogEntry)` +`func (o *InlineResponse20013) SetData(v []LoyaltyCard)` -SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. +SetData gets a reference to the given []LoyaltyCard 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 00576953..e268d5da 100644 --- a/docs/InlineResponse20014.md +++ b/docs/InlineResponse20014.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | +**HasMore** | Pointer to **bool** | true means there is more data in the source collection to request.. | +**Data** | Pointer to [**[]CardLedgerTransactionLogEntry**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20014) GetTotalResultSize() int32` +`func (o *InlineResponse20014) 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 *InlineResponse20014) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20014) 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 *InlineResponse20014) HasTotalResultSize() bool` +`func (o *InlineResponse20014) 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 *InlineResponse20014) SetTotalResultSize(v int32)` +`func (o *InlineResponse20014) 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 *InlineResponse20014) GetData() []AccessLogEntry` +`func (o *InlineResponse20014) GetData() []CardLedgerTransactionLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20014) GetDataOk() ([]AccessLogEntry, bool)` +`func (o *InlineResponse20014) GetDataOk() ([]CardLedgerTransactionLogEntry, 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 []AccessLogEntry)` +`func (o *InlineResponse20014) SetData(v []CardLedgerTransactionLogEntry)` -SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. +SetData gets a reference to the given []CardLedgerTransactionLogEntry 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 ef9f18c1..3d70beb9 100644 --- a/docs/InlineResponse20015.md +++ b/docs/InlineResponse20015.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]CampaignAnalytics**](CampaignAnalytics.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]CollectionWithoutPayload**](CollectionWithoutPayload.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse20015) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20015) 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 *InlineResponse20015) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20015) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse20015) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20015) GetData() []CampaignAnalytics` +`func (o *InlineResponse20015) GetData() []CollectionWithoutPayload` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20015) GetDataOk() ([]CampaignAnalytics, bool)` +`func (o *InlineResponse20015) 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 *InlineResponse20015) SetData(v []CampaignAnalytics)` +`func (o *InlineResponse20015) SetData(v []CollectionWithoutPayload)` -SetData gets a reference to the given []CampaignAnalytics 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/InlineResponse20016.md b/docs/InlineResponse20016.md index c9291fda..aaa420d4 100644 --- a/docs/InlineResponse20016.md +++ b/docs/InlineResponse20016.md @@ -4,37 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | [optional] -**HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]CollectionItem**](CollectionItem.md) | | ## Methods -### GetTotalResultSize - -`func (o *InlineResponse20016) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20016) 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 *InlineResponse20016) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20016) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetHasMore `func (o *InlineResponse20016) GetHasMore() bool` @@ -62,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20016) GetData() []ApplicationCustomer` +`func (o *InlineResponse20016) GetData() []CollectionItem` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20016) GetDataOk() ([]ApplicationCustomer, bool)` +`func (o *InlineResponse20016) 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. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20016) SetData(v []ApplicationCustomer)` +`func (o *InlineResponse20016) SetData(v []CollectionItem)` -SetData gets a reference to the given []ApplicationCustomer 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/InlineResponse20017.md b/docs/InlineResponse20017.md index 349108c9..c4f11f2e 100644 --- a/docs/InlineResponse20017.md +++ b/docs/InlineResponse20017.md @@ -4,8 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]Collection**](Collection.md) | | ## Methods @@ -34,15 +35,40 @@ 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 *InlineResponse20017) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20017) 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 *InlineResponse20017) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20017) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + ### GetData -`func (o *InlineResponse20017) GetData() []ApplicationCustomer` +`func (o *InlineResponse20017) GetData() []Collection` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20017) GetDataOk() ([]ApplicationCustomer, bool)` +`func (o *InlineResponse20017) 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. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20017) SetData(v []ApplicationCustomer)` +`func (o *InlineResponse20017) 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/InlineResponse20018.md b/docs/InlineResponse20018.md index bcf1da72..762418a5 100644 --- a/docs/InlineResponse20018.md +++ b/docs/InlineResponse20018.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]CustomerProfile**](CustomerProfile.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 *InlineResponse20018) GetData() []CustomerProfile` +`func (o *InlineResponse20018) GetData() []AccessLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20018) GetDataOk() ([]CustomerProfile, bool)` +`func (o *InlineResponse20018) 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 *InlineResponse20018) SetData(v []CustomerProfile)` +`func (o *InlineResponse20018) 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/InlineResponse20019.md b/docs/InlineResponse20019.md index c84dce8b..5be27f92 100644 --- a/docs/InlineResponse20019.md +++ b/docs/InlineResponse20019.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 [**[]AccessLogEntry**](AccessLogEntry.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20019) GetHasMore() bool` +`func (o *InlineResponse20019) 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 *InlineResponse20019) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20019) 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 *InlineResponse20019) HasHasMore() bool` +`func (o *InlineResponse20019) 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 *InlineResponse20019) SetHasMore(v bool)` +`func (o *InlineResponse20019) 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 *InlineResponse20019) GetData() []CustomerActivityReport` +`func (o *InlineResponse20019) GetData() []AccessLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20019) GetDataOk() ([]CustomerActivityReport, bool)` +`func (o *InlineResponse20019) 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 *InlineResponse20019) SetData(v []CustomerActivityReport)` +`func (o *InlineResponse20019) SetData(v []AccessLogEntry)` -SetData gets a reference to the given []CustomerActivityReport 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/InlineResponse2002.md b/docs/InlineResponse2002.md index 306641b0..7f99a547 100644 --- a/docs/InlineResponse2002.md +++ b/docs/InlineResponse2002.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Application**](Application.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]LedgerTransactionLogEntryIntegrationApi**](LedgerTransactionLogEntryIntegrationAPI.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse2002) GetTotalResultSize() int32` +`func (o *InlineResponse2002) 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 *InlineResponse2002) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse2002) 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 *InlineResponse2002) HasTotalResultSize() bool` +`func (o *InlineResponse2002) 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 *InlineResponse2002) SetTotalResultSize(v int32)` +`func (o *InlineResponse2002) 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 *InlineResponse2002) GetData() []Application` +`func (o *InlineResponse2002) GetData() []LedgerTransactionLogEntryIntegrationApi` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2002) GetDataOk() ([]Application, bool)` +`func (o *InlineResponse2002) GetDataOk() ([]LedgerTransactionLogEntryIntegrationApi, 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 *InlineResponse2002) SetData(v []Application)` +`func (o *InlineResponse2002) SetData(v []LedgerTransactionLogEntryIntegrationApi)` -SetData gets a reference to the given []Application and assigns it to the Data field. +SetData gets a reference to the given []LedgerTransactionLogEntryIntegrationApi 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 fa4bf59b..563acfd1 100644 --- a/docs/InlineResponse20020.md +++ b/docs/InlineResponse20020.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]ApplicationSession**](ApplicationSession.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]CampaignAnalytics**](CampaignAnalytics.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20020) GetHasMore() bool` +`func (o *InlineResponse20020) 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 *InlineResponse20020) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20020) 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 *InlineResponse20020) HasHasMore() bool` +`func (o *InlineResponse20020) 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 *InlineResponse20020) SetHasMore(v bool)` +`func (o *InlineResponse20020) 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 *InlineResponse20020) GetData() []ApplicationSession` +`func (o *InlineResponse20020) GetData() []CampaignAnalytics` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20020) GetDataOk() ([]ApplicationSession, bool)` +`func (o *InlineResponse20020) 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 *InlineResponse20020) SetData(v []ApplicationSession)` +`func (o *InlineResponse20020) SetData(v []CampaignAnalytics)` -SetData gets a reference to the given []ApplicationSession 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/InlineResponse20021.md b/docs/InlineResponse20021.md index 04c658c8..b1fdc933 100644 --- a/docs/InlineResponse20021.md +++ b/docs/InlineResponse20021.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | +**TotalResultSize** | Pointer to **int32** | | [optional] +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | ## Methods +### GetTotalResultSize + +`func (o *InlineResponse20021) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20021) 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 *InlineResponse20021) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20021) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + ### GetHasMore `func (o *InlineResponse20021) GetHasMore() bool` @@ -36,13 +62,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20021) GetData() []ApplicationEvent` +`func (o *InlineResponse20021) GetData() []ApplicationCustomer` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20021) GetDataOk() ([]ApplicationEvent, bool)` +`func (o *InlineResponse20021) 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 *InlineResponse20021) SetData(v []ApplicationEvent)` +`func (o *InlineResponse20021) 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/InlineResponse20022.md b/docs/InlineResponse20022.md index 077bf238..b002f4dc 100644 --- a/docs/InlineResponse20022.md +++ b/docs/InlineResponse20022.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to **[]string** | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.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() []string` +`func (o *InlineResponse20022) GetData() []ApplicationCustomer` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20022) GetDataOk() ([]string, bool)` +`func (o *InlineResponse20022) 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 *InlineResponse20022) SetData(v []string)` +`func (o *InlineResponse20022) SetData(v []ApplicationCustomer)` -SetData gets a reference to the given []string 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/InlineResponse20023.md b/docs/InlineResponse20023.md index 69de82fa..6a1b468b 100644 --- a/docs/InlineResponse20023.md +++ b/docs/InlineResponse20023.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | [optional] **TotalResultSize** | Pointer to **int32** | | [optional] -**Data** | Pointer to [**[]Audience**](Audience.md) | | +**Data** | Pointer to [**[]CustomerProfile**](CustomerProfile.md) | | ## Methods @@ -62,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20023) GetData() []Audience` +`func (o *InlineResponse20023) GetData() []CustomerProfile` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20023) GetDataOk() ([]Audience, bool)` +`func (o *InlineResponse20023) 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. @@ -81,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20023) SetData(v []Audience)` +`func (o *InlineResponse20023) SetData(v []CustomerProfile)` -SetData gets a reference to the given []Audience 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/InlineResponse20024.md b/docs/InlineResponse20024.md index 8f9aa870..8a0de15d 100644 --- a/docs/InlineResponse20024.md +++ b/docs/InlineResponse20024.md @@ -5,8 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **HasMore** | Pointer to **bool** | | -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]ApplicationReferee**](ApplicationReferee.md) | | +**Data** | Pointer to [**[]CustomerProfile**](CustomerProfile.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 *InlineResponse20024) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20024) 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 *InlineResponse20024) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20024) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetData -`func (o *InlineResponse20024) GetData() []ApplicationReferee` +`func (o *InlineResponse20024) GetData() []CustomerProfile` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20024) GetDataOk() ([]ApplicationReferee, bool)` +`func (o *InlineResponse20024) 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. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20024) SetData(v []ApplicationReferee)` +`func (o *InlineResponse20024) SetData(v []CustomerProfile)` -SetData gets a reference to the given []ApplicationReferee 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/InlineResponse20025.md b/docs/InlineResponse20025.md index 108a3e49..f679baf2 100644 --- a/docs/InlineResponse20025.md +++ b/docs/InlineResponse20025.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 [**[]CustomerActivityReport**](CustomerActivityReport.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20025) GetTotalResultSize() int32` +`func (o *InlineResponse20025) 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 *InlineResponse20025) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20025) 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 *InlineResponse20025) HasTotalResultSize() bool` +`func (o *InlineResponse20025) 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 *InlineResponse20025) SetTotalResultSize(v int32)` +`func (o *InlineResponse20025) 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 *InlineResponse20025) GetData() []Attribute` +`func (o *InlineResponse20025) GetData() []CustomerActivityReport` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20025) GetDataOk() ([]Attribute, bool)` +`func (o *InlineResponse20025) 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. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20025) SetData(v []Attribute)` +`func (o *InlineResponse20025) SetData(v []CustomerActivityReport)` -SetData gets a reference to the given []Attribute 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/InlineResponse20026.md b/docs/InlineResponse20026.md index e7905ef4..c22af298 100644 --- a/docs/InlineResponse20026.md +++ b/docs/InlineResponse20026.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]ApplicationSession**](ApplicationSession.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20026) GetTotalResultSize() int32` +`func (o *InlineResponse20026) 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 *InlineResponse20026) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20026) 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 *InlineResponse20026) HasTotalResultSize() bool` +`func (o *InlineResponse20026) 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 *InlineResponse20026) SetTotalResultSize(v int32)` +`func (o *InlineResponse20026) 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 *InlineResponse20026) GetData() []AccountAdditionalCost` +`func (o *InlineResponse20026) GetData() []ApplicationSession` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20026) GetDataOk() ([]AccountAdditionalCost, bool)` +`func (o *InlineResponse20026) 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. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20026) SetData(v []AccountAdditionalCost)` +`func (o *InlineResponse20026) SetData(v []ApplicationSession)` -SetData gets a reference to the given []AccountAdditionalCost 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/InlineResponse20027.md b/docs/InlineResponse20027.md index ec582bdb..08e249e9 100644 --- a/docs/InlineResponse20027.md +++ b/docs/InlineResponse20027.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Webhook**](Webhook.md) | | +**HasMore** | Pointer to **bool** | | +**Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20027) GetTotalResultSize() int32` +`func (o *InlineResponse20027) 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 *InlineResponse20027) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20027) 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 *InlineResponse20027) HasTotalResultSize() bool` +`func (o *InlineResponse20027) 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 *InlineResponse20027) SetTotalResultSize(v int32)` +`func (o *InlineResponse20027) 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 *InlineResponse20027) GetData() []Webhook` +`func (o *InlineResponse20027) GetData() []ApplicationEvent` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20027) GetDataOk() ([]Webhook, bool)` +`func (o *InlineResponse20027) 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 *InlineResponse20027) SetData(v []Webhook)` +`func (o *InlineResponse20027) SetData(v []ApplicationEvent)` -SetData gets a reference to the given []Webhook 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/InlineResponse20028.md b/docs/InlineResponse20028.md index 9f1ae9a4..bda1ba93 100644 --- a/docs/InlineResponse20028.md +++ b/docs/InlineResponse20028.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]WebhookActivationLogEntry**](WebhookActivationLogEntry.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 *InlineResponse20028) GetData() []WebhookActivationLogEntry` +`func (o *InlineResponse20028) GetData() []string` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20028) GetDataOk() ([]WebhookActivationLogEntry, bool)` +`func (o *InlineResponse20028) 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 *InlineResponse20028) SetData(v []WebhookActivationLogEntry)` +`func (o *InlineResponse20028) SetData(v []string)` -SetData gets a reference to the given []WebhookActivationLogEntry 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/InlineResponse20029.md b/docs/InlineResponse20029.md index 26f4a7b7..0a4247aa 100644 --- a/docs/InlineResponse20029.md +++ b/docs/InlineResponse20029.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]WebhookLogEntry**](WebhookLogEntry.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]Audience**](Audience.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse20029) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20029) 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 *InlineResponse20029) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20029) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse20029) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20029) GetData() []WebhookLogEntry` +`func (o *InlineResponse20029) GetData() []Audience` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20029) GetDataOk() ([]WebhookLogEntry, bool)` +`func (o *InlineResponse20029) 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 *InlineResponse20029) SetData(v []WebhookLogEntry)` +`func (o *InlineResponse20029) SetData(v []Audience)` -SetData gets a reference to the given []WebhookLogEntry 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/InlineResponse2003.md b/docs/InlineResponse2003.md index e5d221a1..761a99b6 100644 --- a/docs/InlineResponse2003.md +++ b/docs/InlineResponse2003.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Campaign**](Campaign.md) | | +**Data** | Pointer to [**[]Application**](Application.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() []Campaign` +`func (o *InlineResponse2003) GetData() []Application` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2003) GetDataOk() ([]Campaign, bool)` +`func (o *InlineResponse2003) GetDataOk() ([]Application, 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 []Campaign)` +`func (o *InlineResponse2003) SetData(v []Application)` -SetData gets a reference to the given []Campaign and assigns it to the Data field. +SetData gets a reference to the given []Application 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 index 03528c45..fd063712 100644 --- a/docs/InlineResponse20030.md +++ b/docs/InlineResponse20030.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]EventType**](EventType.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]ApplicationReferee**](ApplicationReferee.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse20030) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20030) 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 *InlineResponse20030) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20030) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse20030) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20030) GetData() []EventType` +`func (o *InlineResponse20030) GetData() []ApplicationReferee` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20030) GetDataOk() ([]EventType, bool)` +`func (o *InlineResponse20030) 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 *InlineResponse20030) SetData(v []EventType)` +`func (o *InlineResponse20030) SetData(v []ApplicationReferee)` -SetData gets a reference to the given []EventType 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/InlineResponse20031.md b/docs/InlineResponse20031.md index 1002290c..55d2f6ea 100644 --- a/docs/InlineResponse20031.md +++ b/docs/InlineResponse20031.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]User**](User.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 *InlineResponse20031) GetData() []User` +`func (o *InlineResponse20031) GetData() []Attribute` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20031) GetDataOk() ([]User, bool)` +`func (o *InlineResponse20031) 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 *InlineResponse20031) SetData(v []User)` +`func (o *InlineResponse20031) SetData(v []Attribute)` -SetData gets a reference to the given []User 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/InlineResponse20032.md b/docs/InlineResponse20032.md index acf5c089..34e3e880 100644 --- a/docs/InlineResponse20032.md +++ b/docs/InlineResponse20032.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 [**[]AccountAdditionalCost**](AccountAdditionalCost.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 *InlineResponse20032) GetHasMore() bool` - -GetHasMore returns the HasMore field if non-nil, zero value otherwise. - -### GetHasMoreOk - -`func (o *InlineResponse20032) 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 *InlineResponse20032) HasHasMore() bool` - -HasHasMore returns a boolean if a field has been set. - -### SetHasMore - -`func (o *InlineResponse20032) SetHasMore(v bool)` - -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. - ### GetData -`func (o *InlineResponse20032) GetData() []Change` +`func (o *InlineResponse20032) GetData() []AccountAdditionalCost` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20032) GetDataOk() ([]Change, bool)` +`func (o *InlineResponse20032) 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. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20032) SetData(v []Change)` +`func (o *InlineResponse20032) SetData(v []AccountAdditionalCost)` -SetData gets a reference to the given []Change 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/InlineResponse20033.md b/docs/InlineResponse20033.md index b3552f67..e0c39c36 100644 --- a/docs/InlineResponse20033.md +++ b/docs/InlineResponse20033.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Export**](Export.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 *InlineResponse20033) GetData() []Export` +`func (o *InlineResponse20033) GetData() []Webhook` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20033) GetDataOk() ([]Export, bool)` +`func (o *InlineResponse20033) 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 *InlineResponse20033) SetData(v []Export)` +`func (o *InlineResponse20033) SetData(v []Webhook)` -SetData gets a reference to the given []Export 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/InlineResponse20034.md b/docs/InlineResponse20034.md index ea217194..97bb27df 100644 --- a/docs/InlineResponse20034.md +++ b/docs/InlineResponse20034.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Role**](Role.md) | | +**Data** | Pointer to [**[]WebhookActivationLogEntry**](WebhookActivationLogEntry.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20034) GetData() []Role` +`func (o *InlineResponse20034) GetData() []WebhookActivationLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20034) GetDataOk() ([]Role, bool)` +`func (o *InlineResponse20034) 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. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20034) SetData(v []Role)` +`func (o *InlineResponse20034) SetData(v []WebhookActivationLogEntry)` -SetData gets a reference to the given []Role 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/InlineResponse20035.md b/docs/InlineResponse20035.md new file mode 100644 index 00000000..d11e7773 --- /dev/null +++ b/docs/InlineResponse20035.md @@ -0,0 +1,65 @@ +# InlineResponse20035 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]WebhookLogEntry**](WebhookLogEntry.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20035) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20035) 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 *InlineResponse20035) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20035) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20035) GetData() []WebhookLogEntry` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20035) 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. + +### HasData + +`func (o *InlineResponse20035) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20035) SetData(v []WebhookLogEntry)` + +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/InlineResponse20036.md b/docs/InlineResponse20036.md new file mode 100644 index 00000000..51f327aa --- /dev/null +++ b/docs/InlineResponse20036.md @@ -0,0 +1,65 @@ +# InlineResponse20036 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]EventType**](EventType.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20036) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20036) 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 *InlineResponse20036) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20036) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20036) GetData() []EventType` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20036) 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. + +### HasData + +`func (o *InlineResponse20036) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20036) SetData(v []EventType)` + +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/InlineResponse20037.md b/docs/InlineResponse20037.md new file mode 100644 index 00000000..e0424fa4 --- /dev/null +++ b/docs/InlineResponse20037.md @@ -0,0 +1,65 @@ +# InlineResponse20037 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]User**](User.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20037) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20037) 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 *InlineResponse20037) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20037) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20037) GetData() []User` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20037) 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 *InlineResponse20037) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20037) 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/InlineResponse20038.md b/docs/InlineResponse20038.md new file mode 100644 index 00000000..7e335168 --- /dev/null +++ b/docs/InlineResponse20038.md @@ -0,0 +1,91 @@ +# InlineResponse20038 + +## 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 *InlineResponse20038) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20038) 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 *InlineResponse20038) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20038) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetHasMore + +`func (o *InlineResponse20038) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20038) 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 *InlineResponse20038) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20038) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + +### GetData + +`func (o *InlineResponse20038) GetData() []Change` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20038) 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 *InlineResponse20038) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20038) 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/InlineResponse20039.md b/docs/InlineResponse20039.md new file mode 100644 index 00000000..3ee71304 --- /dev/null +++ b/docs/InlineResponse20039.md @@ -0,0 +1,65 @@ +# InlineResponse20039 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]Export**](Export.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20039) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20039) 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 *InlineResponse20039) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20039) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20039) GetData() []Export` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20039) 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 *InlineResponse20039) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20039) 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/InlineResponse2004.md b/docs/InlineResponse2004.md index 3c270d7f..84e86b7d 100644 --- a/docs/InlineResponse2004.md +++ b/docs/InlineResponse2004.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]NotificationWebhook**](NotificationWebhook.md) | | +**Data** | Pointer to [**[]Campaign**](Campaign.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() []NotificationWebhook` +`func (o *InlineResponse2004) GetData() []Campaign` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2004) GetDataOk() ([]NotificationWebhook, bool)` +`func (o *InlineResponse2004) GetDataOk() ([]Campaign, 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 []NotificationWebhook)` +`func (o *InlineResponse2004) SetData(v []Campaign)` -SetData gets a reference to the given []NotificationWebhook and assigns it to the Data field. +SetData gets a reference to the given []Campaign 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/InlineResponse20040.md b/docs/InlineResponse20040.md new file mode 100644 index 00000000..3d2aa178 --- /dev/null +++ b/docs/InlineResponse20040.md @@ -0,0 +1,65 @@ +# InlineResponse20040 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]Role**](Role.md) | | + +## Methods + +### GetTotalResultSize + +`func (o *InlineResponse20040) GetTotalResultSize() int32` + +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. + +### GetTotalResultSizeOk + +`func (o *InlineResponse20040) 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 *InlineResponse20040) HasTotalResultSize() bool` + +HasTotalResultSize returns a boolean if a field has been set. + +### SetTotalResultSize + +`func (o *InlineResponse20040) SetTotalResultSize(v int32)` + +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. + +### GetData + +`func (o *InlineResponse20040) GetData() []Role` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *InlineResponse20040) 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 *InlineResponse20040) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *InlineResponse20040) 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/InlineResponse2005.md b/docs/InlineResponse2005.md index f34b03ba..53d2a5bb 100644 --- a/docs/InlineResponse2005.md +++ b/docs/InlineResponse2005.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 *InlineResponse2005) GetData() []Ruleset` +`func (o *InlineResponse2005) GetData() []NotificationWebhook` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2005) GetDataOk() ([]Ruleset, bool)` +`func (o *InlineResponse2005) 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 *InlineResponse2005) SetData(v []Ruleset)` +`func (o *InlineResponse2005) 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/InlineResponse2006.md b/docs/InlineResponse2006.md index f7a6374a..2902f43c 100644 --- a/docs/InlineResponse2006.md +++ b/docs/InlineResponse2006.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 *InlineResponse2006) GetData() []Coupon` +`func (o *InlineResponse2006) GetData() []Ruleset` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2006) GetDataOk() ([]Coupon, bool)` +`func (o *InlineResponse2006) 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 *InlineResponse2006) SetData(v []Coupon)` +`func (o *InlineResponse2006) 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/InlineResponse2007.md b/docs/InlineResponse2007.md index 628781d0..0a3f0bdd 100644 --- a/docs/InlineResponse2007.md +++ b/docs/InlineResponse2007.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 *InlineResponse2007) GetHasMore() bool` +`func (o *InlineResponse2007) 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 *InlineResponse2007) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse2007) 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 *InlineResponse2007) HasHasMore() bool` +`func (o *InlineResponse2007) 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 *InlineResponse2007) SetHasMore(v bool)` +`func (o *InlineResponse2007) 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/InlineResponse2008.md b/docs/InlineResponse2008.md index 938419e8..7f0d5458 100644 --- a/docs/InlineResponse2008.md +++ b/docs/InlineResponse2008.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 *InlineResponse2008) GetData() []Referral` +`func (o *InlineResponse2008) GetData() []Coupon` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2008) GetDataOk() ([]Referral, bool)` +`func (o *InlineResponse2008) 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 *InlineResponse2008) SetData(v []Referral)` +`func (o *InlineResponse2008) 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/InlineResponse2009.md b/docs/InlineResponse2009.md index 21041faf..1bd1b0f5 100644 --- a/docs/InlineResponse2009.md +++ b/docs/InlineResponse2009.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 *InlineResponse2009) GetTotalResultSize() int32` +`func (o *InlineResponse2009) 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 *InlineResponse2009) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse2009) 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 *InlineResponse2009) HasTotalResultSize() bool` +`func (o *InlineResponse2009) 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 *InlineResponse2009) SetTotalResultSize(v int32)` +`func (o *InlineResponse2009) 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 *InlineResponse2009) GetData() []LoyaltyProgram` +`func (o *InlineResponse2009) GetData() []Referral` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2009) GetDataOk() ([]LoyaltyProgram, bool)` +`func (o *InlineResponse2009) 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 *InlineResponse2009) SetData(v []LoyaltyProgram)` +`func (o *InlineResponse2009) 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/IntegrationApi.md b/docs/IntegrationApi.md index a2d0e681..345b2544 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -14,8 +14,13 @@ Method | HTTP request | Description [**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 +[**GetLoyaltyBalances**](IntegrationApi.md#GetLoyaltyBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points +[**GetLoyaltyCardBalances**](IntegrationApi.md#GetLoyaltyCardBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances +[**GetLoyaltyCardTransactions**](IntegrationApi.md#GetLoyaltyCardTransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions +[**GetLoyaltyProgramProfileTransactions**](IntegrationApi.md#GetLoyaltyProgramProfileTransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions [**GetReservedCustomers**](IntegrationApi.md#GetReservedCustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved +[**LinkLoyaltyCardToProfile**](IntegrationApi.md#LinkLoyaltyCardToProfile) | **Post** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card +[**ReopenCustomerSession**](IntegrationApi.md#ReopenCustomerSession) | **Put** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session [**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 @@ -48,7 +53,7 @@ Other parameters are passed through a pointer to a apiCreateAudienceV2Request st Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAudience**](NewAudience.md) | | + **body** | [**NewAudience**](NewAudience.md) | body | ### Return type @@ -92,7 +97,7 @@ Other parameters are passed through a pointer to a apiCreateCouponReservationReq Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CouponReservations**](CouponReservations.md) | | + **body** | [**CouponReservations**](CouponReservations.md) | body | ### Return type @@ -131,7 +136,7 @@ Other parameters are passed through a pointer to a apiCreateReferralRequest stru Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewReferral**](NewReferral.md) | | + **body** | [**NewReferral**](NewReferral.md) | body | ### Return type @@ -170,8 +175,8 @@ Other parameters are passed through a pointer to a apiCreateReferralsForMultiple Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.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** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md) | body | + **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 the updated customer profiles. | [default to yes] ### Return type @@ -222,7 +227,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[api_key_v1](../README.md#api_key_v1) ### HTTP request headers @@ -265,7 +270,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[api_key_v1](../README.md#api_key_v1) ### HTTP request headers @@ -301,7 +306,7 @@ Other parameters are passed through a pointer to a apiDeleteCouponReservationReq Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CouponReservations**](CouponReservations.md) | | + **body** | [**CouponReservations**](CouponReservations.md) | body | ### Return type @@ -335,7 +340,7 @@ Delete customer's personal data Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**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). | +**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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | ### Other Parameters @@ -366,7 +371,7 @@ Name | Type | Description | Notes ## GetCustomerInventory -> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).LoyaltyProjectionEndDate(loyaltyProjectionEndDate).Execute() +> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).Execute() List customer data @@ -378,7 +383,7 @@ List customer data Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**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). | +**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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | ### Other Parameters @@ -393,7 +398,6 @@ 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 @@ -427,7 +431,7 @@ Get customer session 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). | +**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | ### Other Parameters @@ -456,11 +460,11 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## GetLoyaltyTransactions +## GetLoyaltyBalances -> InlineResponse2001 GetLoyaltyTransactions(ctx, loyaltyProgramId, integrationId).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute() +> LoyaltyBalances GetLoyaltyBalances(ctx, loyaltyProgramId, integrationId).EndDate(endDate).Execute() -Get loyalty ledger transaction logs +Get customer's loyalty points @@ -470,21 +474,114 @@ Get loyalty ledger transaction logs 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). | +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | **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 +Other parameters are passed through a pointer to a apiGetLoyaltyBalancesRequest 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. | + **endDate** | **time.Time** | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | + +### Return type + +[**LoyaltyBalances**](LoyaltyBalances.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) + + +## GetLoyaltyCardBalances + +> LoyaltyBalances GetLoyaltyCardBalances(ctx, loyaltyProgramId, loyaltyCardId).EndDate(endDate).Execute() + +Get card's point balances + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyCardBalancesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **endDate** | **time.Time** | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | + +### Return type + +[**LoyaltyBalances**](LoyaltyBalances.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) + + +## GetLoyaltyCardTransactions + +> InlineResponse2001 GetLoyaltyCardTransactions(ctx, loyaltyProgramId, loyaltyCardId).SubledgerId(subledgerId).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute() + +List card's transactions + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyCardTransactionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **subledgerId** | **string** | The ID of the subledger by which we filter the data. | + **startDate** | **time.Time** | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **endDate** | **time.Time** | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | ### Return type @@ -505,6 +602,56 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## GetLoyaltyProgramProfileTransactions + +> InlineResponse2002 GetLoyaltyProgramProfileTransactions(ctx, loyaltyProgramId, integrationId).SubledgerId(subledgerId).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute() + +List customer's loyalty transactions + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**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 apiGetLoyaltyProgramProfileTransactionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **subledgerId** | **string** | The ID of the subledger by which we filter the data. | + **startDate** | **time.Time** | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **endDate** | **time.Time** | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **pageSize** | **int32** | The number of items in this response. | [default to 50] + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + +### Return type + +[**InlineResponse2002**](inline_response_200_2.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() @@ -548,6 +695,95 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## LinkLoyaltyCardToProfile + +> LoyaltyCard LinkLoyaltyCardToProfile(ctx, loyaltyProgramId, loyaltyCardId).Body(body).Execute() + +Link customer profile to card + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiLinkLoyaltyCardToProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **body** | [**LoyaltyCardRegistration**](LoyaltyCardRegistration.md) | body | + +### Return type + +[**LoyaltyCard**](LoyaltyCard.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) + + +## ReopenCustomerSession + +> ReopenSessionResponse ReopenCustomerSession(ctx, customerSessionId).Execute() + +Reopen 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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReopenCustomerSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReopenSessionResponse**](ReopenSessionResponse.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) + + ## ReturnCartItems > IntegrationStateV2 ReturnCartItems(ctx, customerSessionId).Body(body).Dry(dry).Execute() @@ -562,7 +798,7 @@ Return cart items 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). | +**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | ### Other Parameters @@ -572,8 +808,8 @@ Other parameters are passed through a pointer to a apiReturnCartItemsRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md) | | - **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | + **body** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md) | body | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type @@ -607,7 +843,7 @@ Sync cart item catalog Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**catalogId** | **int32** | | +**catalogId** | **int32** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. | ### Other Parameters @@ -617,7 +853,7 @@ Other parameters are passed through a pointer to a apiSyncCatalogRequest struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CatalogSyncRequest**](CatalogSyncRequest.md) | | + **body** | [**CatalogSyncRequest**](CatalogSyncRequest.md) | body | ### Return type @@ -625,7 +861,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[api_key_v1](../README.md#api_key_v1) ### HTTP request headers @@ -656,8 +892,8 @@ Other parameters are passed through a pointer to a apiTrackEventRequest struct v Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewEvent**](NewEvent.md) | | - **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | + **body** | [**NewEvent**](NewEvent.md) | body | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type @@ -696,9 +932,9 @@ Other parameters are passed through a pointer to a apiTrackEventV2Request struct 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`. | + **body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md) | body | + **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 the updated customer profiles. | [default to yes] + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type @@ -742,7 +978,7 @@ Other parameters are passed through a pointer to a apiUpdateAudienceCustomersAtt Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **map[string]interface{}** | | + **body** | **map[string]interface{}** | body | ### Return type @@ -786,7 +1022,7 @@ Other parameters are passed through a pointer to a apiUpdateAudienceV2Request st Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UpdateAudience**](UpdateAudience.md) | | + **body** | [**UpdateAudience**](UpdateAudience.md) | body | ### Return type @@ -825,7 +1061,7 @@ Other parameters are passed through a pointer to a apiUpdateCustomerProfileAudie Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md) | | + **body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md) | body | ### Return type @@ -869,9 +1105,9 @@ Other parameters are passed through a pointer to a apiUpdateCustomerProfileV2Req Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md) | | + **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md) | body | **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`. | + **dry** | **bool** | (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. | ### Return type @@ -910,8 +1146,8 @@ Other parameters are passed through a pointer to a apiUpdateCustomerProfilesV2Re Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.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** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md) | body | + **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 the updated customer profiles. | [default to yes] ### Return type @@ -945,7 +1181,7 @@ Update customer session 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). | +**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | ### Other Parameters @@ -955,8 +1191,8 @@ Other parameters are passed through a pointer to a apiUpdateCustomerSessionV2Req Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**IntegrationRequest**](IntegrationRequest.md) | | - **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | + **body** | [**IntegrationRequest**](IntegrationRequest.md) | body | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. | ### Return type diff --git a/docs/IntegrationCoupon.md b/docs/IntegrationCoupon.md new file mode 100644 index 00000000..a655ab4e --- /dev/null +++ b/docs/IntegrationCoupon.md @@ -0,0 +1,585 @@ +# IntegrationCoupon + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | +**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 total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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) | Expiration 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 the coupon has been successfully redeemed. | +**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] +**ReservationCounter** | Pointer to **float32** | The number of times this coupon has been reserved. | [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** | 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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. | [optional] [default to true] +**BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] +**IsReservationMandatory** | Pointer to **bool** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] +**ProfileRedemptionCount** | Pointer to **int32** | The number of times the coupon was redeemed by the profile. | + +## Methods + +### GetId + +`func (o *IntegrationCoupon) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *IntegrationCoupon) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *IntegrationCoupon) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *IntegrationCoupon) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCampaignId + +`func (o *IntegrationCoupon) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *IntegrationCoupon) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetValue + +`func (o *IntegrationCoupon) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IntegrationCoupon) GetValueOk() (string, 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 *IntegrationCoupon) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *IntegrationCoupon) SetValue(v string)` + +SetValue gets a reference to the given string and assigns it to the Value field. + +### GetUsageLimit + +`func (o *IntegrationCoupon) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *IntegrationCoupon) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + +### GetDiscountLimit + +`func (o *IntegrationCoupon) GetDiscountLimit() float32` + +GetDiscountLimit returns the DiscountLimit field if non-nil, zero value otherwise. + +### GetDiscountLimitOk + +`func (o *IntegrationCoupon) GetDiscountLimitOk() (float32, bool)` + +GetDiscountLimitOk returns a tuple with the DiscountLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscountLimit + +`func (o *IntegrationCoupon) HasDiscountLimit() bool` + +HasDiscountLimit returns a boolean if a field has been set. + +### SetDiscountLimit + +`func (o *IntegrationCoupon) SetDiscountLimit(v float32)` + +SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. + +### GetReservationLimit + +`func (o *IntegrationCoupon) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *IntegrationCoupon) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *IntegrationCoupon) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *IntegrationCoupon) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + +### GetStartDate + +`func (o *IntegrationCoupon) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *IntegrationCoupon) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *IntegrationCoupon) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *IntegrationCoupon) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetLimits + +`func (o *IntegrationCoupon) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *IntegrationCoupon) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + +### GetUsageCounter + +`func (o *IntegrationCoupon) GetUsageCounter() int32` + +GetUsageCounter returns the UsageCounter field if non-nil, zero value otherwise. + +### GetUsageCounterOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasUsageCounter() bool` + +HasUsageCounter returns a boolean if a field has been set. + +### SetUsageCounter + +`func (o *IntegrationCoupon) SetUsageCounter(v int32)` + +SetUsageCounter gets a reference to the given int32 and assigns it to the UsageCounter field. + +### GetDiscountCounter + +`func (o *IntegrationCoupon) GetDiscountCounter() float32` + +GetDiscountCounter returns the DiscountCounter field if non-nil, zero value otherwise. + +### GetDiscountCounterOk + +`func (o *IntegrationCoupon) GetDiscountCounterOk() (float32, bool)` + +GetDiscountCounterOk returns a tuple with the DiscountCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscountCounter + +`func (o *IntegrationCoupon) HasDiscountCounter() bool` + +HasDiscountCounter returns a boolean if a field has been set. + +### SetDiscountCounter + +`func (o *IntegrationCoupon) SetDiscountCounter(v float32)` + +SetDiscountCounter gets a reference to the given float32 and assigns it to the DiscountCounter field. + +### GetDiscountRemainder + +`func (o *IntegrationCoupon) GetDiscountRemainder() float32` + +GetDiscountRemainder returns the DiscountRemainder field if non-nil, zero value otherwise. + +### GetDiscountRemainderOk + +`func (o *IntegrationCoupon) GetDiscountRemainderOk() (float32, bool)` + +GetDiscountRemainderOk returns a tuple with the DiscountRemainder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscountRemainder + +`func (o *IntegrationCoupon) HasDiscountRemainder() bool` + +HasDiscountRemainder returns a boolean if a field has been set. + +### SetDiscountRemainder + +`func (o *IntegrationCoupon) SetDiscountRemainder(v float32)` + +SetDiscountRemainder gets a reference to the given float32 and assigns it to the DiscountRemainder field. + +### GetReservationCounter + +`func (o *IntegrationCoupon) GetReservationCounter() float32` + +GetReservationCounter returns the ReservationCounter field if non-nil, zero value otherwise. + +### GetReservationCounterOk + +`func (o *IntegrationCoupon) GetReservationCounterOk() (float32, bool)` + +GetReservationCounterOk returns a tuple with the ReservationCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationCounter + +`func (o *IntegrationCoupon) HasReservationCounter() bool` + +HasReservationCounter returns a boolean if a field has been set. + +### SetReservationCounter + +`func (o *IntegrationCoupon) SetReservationCounter(v float32)` + +SetReservationCounter gets a reference to the given float32 and assigns it to the ReservationCounter field. + +### GetAttributes + +`func (o *IntegrationCoupon) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *IntegrationCoupon) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetReferralId + +`func (o *IntegrationCoupon) GetReferralId() int32` + +GetReferralId returns the ReferralId field if non-nil, zero value otherwise. + +### GetReferralIdOk + +`func (o *IntegrationCoupon) GetReferralIdOk() (int32, bool)` + +GetReferralIdOk returns a tuple with the ReferralId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferralId + +`func (o *IntegrationCoupon) HasReferralId() bool` + +HasReferralId returns a boolean if a field has been set. + +### SetReferralId + +`func (o *IntegrationCoupon) SetReferralId(v int32)` + +SetReferralId gets a reference to the given int32 and assigns it to the ReferralId field. + +### GetRecipientIntegrationId + +`func (o *IntegrationCoupon) GetRecipientIntegrationId() string` + +GetRecipientIntegrationId returns the RecipientIntegrationId field if non-nil, zero value otherwise. + +### GetRecipientIntegrationIdOk + +`func (o *IntegrationCoupon) GetRecipientIntegrationIdOk() (string, bool)` + +GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRecipientIntegrationId + +`func (o *IntegrationCoupon) HasRecipientIntegrationId() bool` + +HasRecipientIntegrationId returns a boolean if a field has been set. + +### SetRecipientIntegrationId + +`func (o *IntegrationCoupon) SetRecipientIntegrationId(v string)` + +SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. + +### GetImportId + +`func (o *IntegrationCoupon) GetImportId() int32` + +GetImportId returns the ImportId field if non-nil, zero value otherwise. + +### GetImportIdOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasImportId() bool` + +HasImportId returns a boolean if a field has been set. + +### SetImportId + +`func (o *IntegrationCoupon) SetImportId(v int32)` + +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. + +### GetReservation + +`func (o *IntegrationCoupon) GetReservation() bool` + +GetReservation returns the Reservation field if non-nil, zero value otherwise. + +### GetReservationOk + +`func (o *IntegrationCoupon) GetReservationOk() (bool, bool)` + +GetReservationOk returns a tuple with the Reservation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservation + +`func (o *IntegrationCoupon) HasReservation() bool` + +HasReservation returns a boolean if a field has been set. + +### SetReservation + +`func (o *IntegrationCoupon) SetReservation(v bool)` + +SetReservation gets a reference to the given bool and assigns it to the Reservation field. + +### GetBatchId + +`func (o *IntegrationCoupon) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *IntegrationCoupon) 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 *IntegrationCoupon) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *IntegrationCoupon) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + +### GetIsReservationMandatory + +`func (o *IntegrationCoupon) GetIsReservationMandatory() bool` + +GetIsReservationMandatory returns the IsReservationMandatory field if non-nil, zero value otherwise. + +### GetIsReservationMandatoryOk + +`func (o *IntegrationCoupon) GetIsReservationMandatoryOk() (bool, bool)` + +GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsReservationMandatory + +`func (o *IntegrationCoupon) HasIsReservationMandatory() bool` + +HasIsReservationMandatory returns a boolean if a field has been set. + +### SetIsReservationMandatory + +`func (o *IntegrationCoupon) SetIsReservationMandatory(v bool)` + +SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. + +### GetProfileRedemptionCount + +`func (o *IntegrationCoupon) GetProfileRedemptionCount() int32` + +GetProfileRedemptionCount returns the ProfileRedemptionCount field if non-nil, zero value otherwise. + +### GetProfileRedemptionCountOk + +`func (o *IntegrationCoupon) GetProfileRedemptionCountOk() (int32, bool)` + +GetProfileRedemptionCountOk returns a tuple with the ProfileRedemptionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileRedemptionCount + +`func (o *IntegrationCoupon) HasProfileRedemptionCount() bool` + +HasProfileRedemptionCount returns a boolean if a field has been set. + +### SetProfileRedemptionCount + +`func (o *IntegrationCoupon) SetProfileRedemptionCount(v int32)` + +SetProfileRedemptionCount gets a reference to the given int32 and assigns it to the ProfileRedemptionCount 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 13deedcf..101a2eee 100644 --- a/docs/IntegrationEntity.md +++ b/docs/IntegrationEntity.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | ## Methods diff --git a/docs/IntegrationEventV2Request.md b/docs/IntegrationEventV2Request.md index ef8ae23c..dd94cfc0 100644 --- a/docs/IntegrationEventV2Request.md +++ b/docs/IntegrationEventV2Request.md @@ -5,8 +5,9 @@ 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] +**EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] +**Type** | Pointer to **string** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). | [optional] **ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the tracking custom event. | [optional] ## Methods @@ -36,6 +37,31 @@ HasProfileId returns a boolean if a field has been set. SetProfileId gets a reference to the given string and assigns it to the ProfileId field. +### GetEvaluableCampaignIds + +`func (o *IntegrationEventV2Request) GetEvaluableCampaignIds() []int32` + +GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise. + +### GetEvaluableCampaignIdsOk + +`func (o *IntegrationEventV2Request) GetEvaluableCampaignIdsOk() ([]int32, bool)` + +GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluableCampaignIds + +`func (o *IntegrationEventV2Request) HasEvaluableCampaignIds() bool` + +HasEvaluableCampaignIds returns a boolean if a field has been set. + +### SetEvaluableCampaignIds + +`func (o *IntegrationEventV2Request) SetEvaluableCampaignIds(v []int32)` + +SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. + ### GetType `func (o *IntegrationEventV2Request) GetType() string` diff --git a/docs/IntegrationRequest.md b/docs/IntegrationRequest.md index 16505674..8c3ddd05 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 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] +**ResponseContent** | Pointer to **[]string** | Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer session_ request instead of sending extra requests to other endpoints. | [optional] ## Methods diff --git a/docs/IntegrationStateV2.md b/docs/IntegrationStateV2.md index 8e9d756c..5de1147f 100644 --- a/docs/IntegrationStateV2.md +++ b/docs/IntegrationStateV2.md @@ -9,9 +9,9 @@ Name | Type | Description | Notes **Event** | Pointer to [**Event**](Event.md) | | [optional] **Loyalty** | Pointer to [**Loyalty**](Loyalty.md) | | [optional] **Referral** | Pointer to [**InventoryReferral**](InventoryReferral.md) | | [optional] -**Coupons** | Pointer to [**[]Coupon**](Coupon.md) | | [optional] +**Coupons** | Pointer to [**[]IntegrationCoupon**](IntegrationCoupon.md) | | [optional] **TriggeredCampaigns** | Pointer to [**[]Campaign**](Campaign.md) | | [optional] -**Effects** | Pointer to [**[]Effect**](Effect.md) | | +**Effects** | Pointer to [**[]Effect**](Effect.md) | The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | **RuleFailureReasons** | Pointer to [**[]RuleFailureReason**](RuleFailureReason.md) | | [optional] **CreatedCoupons** | Pointer to [**[]Coupon**](Coupon.md) | | **CreatedReferrals** | Pointer to [**[]Referral**](Referral.md) | | @@ -148,13 +148,13 @@ SetReferral gets a reference to the given InventoryReferral and assigns it to th ### GetCoupons -`func (o *IntegrationStateV2) GetCoupons() []Coupon` +`func (o *IntegrationStateV2) GetCoupons() []IntegrationCoupon` GetCoupons returns the Coupons field if non-nil, zero value otherwise. ### GetCouponsOk -`func (o *IntegrationStateV2) GetCouponsOk() ([]Coupon, bool)` +`func (o *IntegrationStateV2) GetCouponsOk() ([]IntegrationCoupon, bool)` GetCouponsOk returns a tuple with the Coupons field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -167,9 +167,9 @@ HasCoupons returns a boolean if a field has been set. ### SetCoupons -`func (o *IntegrationStateV2) SetCoupons(v []Coupon)` +`func (o *IntegrationStateV2) SetCoupons(v []IntegrationCoupon)` -SetCoupons gets a reference to the given []Coupon and assigns it to the Coupons field. +SetCoupons gets a reference to the given []IntegrationCoupon and assigns it to the Coupons field. ### GetTriggeredCampaigns diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md index ca327376..c1ba3546 100644 --- a/docs/InventoryCoupon.md +++ b/docs/InventoryCoupon.md @@ -4,24 +4,27 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | +**UsageCounter** | Pointer to **int32** | The number of times the coupon has been successfully redeemed. | **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] +**ReservationCounter** | Pointer to **float32** | The number of times this coupon has been reserved. | [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** | 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] +**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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. | [optional] [default to true] **BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] +**IsReservationMandatory** | Pointer to **bool** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] **ProfileRedemptionCount** | Pointer to **int32** | The number of times the coupon was redeemed by the profile. | **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. | @@ -177,6 +180,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *InventoryCoupon) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *InventoryCoupon) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *InventoryCoupon) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *InventoryCoupon) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *InventoryCoupon) GetStartDate() time.Time` @@ -327,6 +355,31 @@ HasDiscountRemainder returns a boolean if a field has been set. SetDiscountRemainder gets a reference to the given float32 and assigns it to the DiscountRemainder field. +### GetReservationCounter + +`func (o *InventoryCoupon) GetReservationCounter() float32` + +GetReservationCounter returns the ReservationCounter field if non-nil, zero value otherwise. + +### GetReservationCounterOk + +`func (o *InventoryCoupon) GetReservationCounterOk() (float32, bool)` + +GetReservationCounterOk returns a tuple with the ReservationCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationCounter + +`func (o *InventoryCoupon) HasReservationCounter() bool` + +HasReservationCounter returns a boolean if a field has been set. + +### SetReservationCounter + +`func (o *InventoryCoupon) SetReservationCounter(v float32)` + +SetReservationCounter gets a reference to the given float32 and assigns it to the ReservationCounter field. + ### GetAttributes `func (o *InventoryCoupon) GetAttributes() map[string]interface{}` @@ -477,6 +530,31 @@ HasBatchId returns a boolean if a field has been set. SetBatchId gets a reference to the given string and assigns it to the BatchId field. +### GetIsReservationMandatory + +`func (o *InventoryCoupon) GetIsReservationMandatory() bool` + +GetIsReservationMandatory returns the IsReservationMandatory field if non-nil, zero value otherwise. + +### GetIsReservationMandatoryOk + +`func (o *InventoryCoupon) GetIsReservationMandatoryOk() (bool, bool)` + +GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsReservationMandatory + +`func (o *InventoryCoupon) HasIsReservationMandatory() bool` + +HasIsReservationMandatory returns a boolean if a field has been set. + +### SetIsReservationMandatory + +`func (o *InventoryCoupon) SetIsReservationMandatory(v bool)` + +SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. + ### GetProfileRedemptionCount `func (o *InventoryCoupon) GetProfileRedemptionCount() int32` diff --git a/docs/InventoryReferral.md b/docs/InventoryReferral.md index 4c3e8d78..375c0a21 100644 --- a/docs/InventoryReferral.md +++ b/docs/InventoryReferral.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | diff --git a/docs/LedgerEntry.md b/docs/LedgerEntry.md index 9a2208f1..2c7c95fd 100644 --- a/docs/LedgerEntry.md +++ b/docs/LedgerEntry.md @@ -4,15 +4,15 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **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. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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 440d3834..115b77af 100644 --- a/docs/LedgerInfo.md +++ b/docs/LedgerInfo.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. | +**ExpiredBalance** | Pointer to **float32** | **DEPRECATED** Value is shown as 0. | +**SpentBalance** | Pointer to **float32** | **DEPRECATED** Value is shown as 0. | +**TentativeCurrentBalance** | Pointer to **float32** | Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied. | +**TentativePendingBalance** | Pointer to **float32** | Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied. | [optional] **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 @@ -140,6 +140,31 @@ HasTentativeCurrentBalance returns a boolean if a field has been set. SetTentativeCurrentBalance gets a reference to the given float32 and assigns it to the TentativeCurrentBalance field. +### GetTentativePendingBalance + +`func (o *LedgerInfo) GetTentativePendingBalance() float32` + +GetTentativePendingBalance returns the TentativePendingBalance field if non-nil, zero value otherwise. + +### GetTentativePendingBalanceOk + +`func (o *LedgerInfo) GetTentativePendingBalanceOk() (float32, bool)` + +GetTentativePendingBalanceOk returns a tuple with the TentativePendingBalance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTentativePendingBalance + +`func (o *LedgerInfo) HasTentativePendingBalance() bool` + +HasTentativePendingBalance returns a boolean if a field has been set. + +### SetTentativePendingBalance + +`func (o *LedgerInfo) SetTentativePendingBalance(v float32)` + +SetTentativePendingBalance gets a reference to the given float32 and assigns it to the TentativePendingBalance field. + ### GetCurrentTier `func (o *LedgerInfo) GetCurrentTier() Tier` @@ -190,31 +215,6 @@ 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 index d9b00482..7ad5335e 100644 --- a/docs/LedgerTransactionLogEntryIntegrationApi.md +++ b/docs/LedgerTransactionLogEntryIntegrationApi.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Created** | Pointer to [**time.Time**](time.Time.md) | Date and time the loyalty card transaction occurred. | +**Created** | Pointer to [**time.Time**](time.Time.md) | Date and time the loyalty 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. | +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | [optional] +**Type** | Pointer to **string** | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. | **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. | +**StartDate** | Pointer to **string** | When points become active. Possible values: - `immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time. | **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. | diff --git a/docs/LimitCounter.md b/docs/LimitCounter.md index dd3485e4..cc7c8020 100644 --- a/docs/LimitCounter.md +++ b/docs/LimitCounter.md @@ -11,11 +11,11 @@ Name | Type | Description | Notes **Action** | Pointer to **string** | The limitable action of the limit counter. | **ProfileId** | Pointer to **int32** | The profile ID for which this limit counter is used. | [optional] **ProfileIntegrationId** | Pointer to **string** | The profile integration ID for which this limit counter is used. | [optional] -**CouponId** | Pointer to **int32** | The coupon ID for which this limit counter is used. | [optional] +**CouponId** | Pointer to **int32** | The internal coupon ID for which this limit counter is used. | [optional] **CouponValue** | Pointer to **string** | The coupon value for which this limit counter is used. | [optional] **ReferralId** | Pointer to **int32** | The referral ID for which this limit counter is used. | [optional] **ReferralValue** | Pointer to **string** | The referral value for which this limit counter is used. | [optional] -**Identifier** | Pointer to **int32** | The arbitrary identifier for which this limit counter is used. | [optional] +**Identifier** | Pointer to **string** | The arbitrary identifier for which this limit counter is used. | [optional] **Period** | Pointer to **string** | The time period for which this limit counter is used. | [optional] **Limit** | Pointer to **float32** | The highest possible value for this limit counter. | **Counter** | Pointer to **float32** | The current value for this limit counter. | @@ -299,13 +299,13 @@ SetReferralValue gets a reference to the given string and assigns it to the Refe ### GetIdentifier -`func (o *LimitCounter) GetIdentifier() int32` +`func (o *LimitCounter) GetIdentifier() string` GetIdentifier returns the Identifier field if non-nil, zero value otherwise. ### GetIdentifierOk -`func (o *LimitCounter) GetIdentifierOk() (int32, bool)` +`func (o *LimitCounter) 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. @@ -318,9 +318,9 @@ HasIdentifier returns a boolean if a field has been set. ### SetIdentifier -`func (o *LimitCounter) SetIdentifier(v int32)` +`func (o *LimitCounter) SetIdentifier(v string)` -SetIdentifier gets a reference to the given int32 and assigns it to the Identifier field. +SetIdentifier gets a reference to the given string and assigns it to the Identifier field. ### GetPeriod diff --git a/docs/LoyaltyCard.md b/docs/LoyaltyCard.md index e492ffd1..3f63238e 100644 --- a/docs/LoyaltyCard.md +++ b/docs/LoyaltyCard.md @@ -4,16 +4,18 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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] +**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'inactive'] | +**Identifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | +**UsersPerCardLimit** | Pointer to **int32** | The max amount of customer profiles that can be linked to the card. 0 means unlimited. | +**Profiles** | Pointer to [**[]LoyaltyCardProfileRegistration**](LoyaltyCardProfileRegistration.md) | Integration IDs of the customers profiles linked to 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] +**OldCardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] +**NewCardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] ## Methods @@ -267,6 +269,56 @@ HasModified returns a boolean if a field has been set. SetModified gets a reference to the given time.Time and assigns it to the Modified field. +### GetOldCardIdentifier + +`func (o *LoyaltyCard) GetOldCardIdentifier() string` + +GetOldCardIdentifier returns the OldCardIdentifier field if non-nil, zero value otherwise. + +### GetOldCardIdentifierOk + +`func (o *LoyaltyCard) GetOldCardIdentifierOk() (string, bool)` + +GetOldCardIdentifierOk returns a tuple with the OldCardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOldCardIdentifier + +`func (o *LoyaltyCard) HasOldCardIdentifier() bool` + +HasOldCardIdentifier returns a boolean if a field has been set. + +### SetOldCardIdentifier + +`func (o *LoyaltyCard) SetOldCardIdentifier(v string)` + +SetOldCardIdentifier gets a reference to the given string and assigns it to the OldCardIdentifier field. + +### GetNewCardIdentifier + +`func (o *LoyaltyCard) GetNewCardIdentifier() string` + +GetNewCardIdentifier returns the NewCardIdentifier field if non-nil, zero value otherwise. + +### GetNewCardIdentifierOk + +`func (o *LoyaltyCard) GetNewCardIdentifierOk() (string, bool)` + +GetNewCardIdentifierOk returns a tuple with the NewCardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNewCardIdentifier + +`func (o *LoyaltyCard) HasNewCardIdentifier() bool` + +HasNewCardIdentifier returns a boolean if a field has been set. + +### SetNewCardIdentifier + +`func (o *LoyaltyCard) SetNewCardIdentifier(v string)` + +SetNewCardIdentifier gets a reference to the given string and assigns it to the NewCardIdentifier 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 index a8b33cb0..36b2cdb9 100644 --- a/docs/LoyaltyCardProfileRegistration.md +++ b/docs/LoyaltyCardProfileRegistration.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | Integration ID of the customer associated with the card. | +**IntegrationId** | Pointer to **string** | Integration ID of the customer profile linked to the card. | **Timestamp** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the registration to the card. | ## Methods diff --git a/docs/LoyaltyLedgerEntry.md b/docs/LoyaltyLedgerEntry.md index 30a8f0a3..e1558801 100644 --- a/docs/LoyaltyLedgerEntry.md +++ b/docs/LoyaltyLedgerEntry.md @@ -10,13 +10,14 @@ Name | Type | Description | Notes **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) | +**Type** | Pointer to **string** | The type of the ledger transaction. Possible values are: - `addition` - `subtraction` - `expire` - `expiring` (for expiring points ledgers) | **Amount** | Pointer to **float32** | | **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. | **UserID** | Pointer to **int32** | This is the ID of the user who created this entry, if the addition or subtraction was done manually. | [optional] +**Archived** | Pointer to **bool** | Indicates if the entry belongs to the archived session. | [optional] ## Methods @@ -345,6 +346,31 @@ HasUserID returns a boolean if a field has been set. SetUserID gets a reference to the given int32 and assigns it to the UserID field. +### GetArchived + +`func (o *LoyaltyLedgerEntry) GetArchived() bool` + +GetArchived returns the Archived field if non-nil, zero value otherwise. + +### GetArchivedOk + +`func (o *LoyaltyLedgerEntry) GetArchivedOk() (bool, bool)` + +GetArchivedOk returns a tuple with the Archived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasArchived + +`func (o *LoyaltyLedgerEntry) HasArchived() bool` + +HasArchived returns a boolean if a field has been set. + +### SetArchived + +`func (o *LoyaltyLedgerEntry) SetArchived(v bool)` + +SetArchived gets a reference to the given bool and assigns it to the Archived 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 deleted file mode 100644 index 3d93a6cc..00000000 --- a/docs/LoyaltyPoints.md +++ /dev/null @@ -1,143 +0,0 @@ -# LoyaltyPoints - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**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] - -## Methods - -### GetPoints - -`func (o *LoyaltyPoints) GetPoints() float32` - -GetPoints returns the Points field if non-nil, zero value otherwise. - -### GetPointsOk - -`func (o *LoyaltyPoints) GetPointsOk() (float32, bool)` - -GetPointsOk returns a tuple with the Points field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasPoints - -`func (o *LoyaltyPoints) HasPoints() bool` - -HasPoints returns a boolean if a field has been set. - -### SetPoints - -`func (o *LoyaltyPoints) SetPoints(v float32)` - -SetPoints gets a reference to the given float32 and assigns it to the Points field. - -### GetName - -`func (o *LoyaltyPoints) GetName() string` - -GetName returns the Name field if non-nil, zero value otherwise. - -### GetNameOk - -`func (o *LoyaltyPoints) 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 *LoyaltyPoints) HasName() bool` - -HasName returns a boolean if a field has been set. - -### SetName - -`func (o *LoyaltyPoints) SetName(v string)` - -SetName gets a reference to the given string and assigns it to the Name field. - -### GetValidityDuration - -`func (o *LoyaltyPoints) GetValidityDuration() string` - -GetValidityDuration returns the ValidityDuration field if non-nil, zero value otherwise. - -### GetValidityDurationOk - -`func (o *LoyaltyPoints) GetValidityDurationOk() (string, bool)` - -GetValidityDurationOk returns a tuple with the ValidityDuration field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasValidityDuration - -`func (o *LoyaltyPoints) HasValidityDuration() bool` - -HasValidityDuration returns a boolean if a field has been set. - -### SetValidityDuration - -`func (o *LoyaltyPoints) SetValidityDuration(v string)` - -SetValidityDuration gets a reference to the given string and assigns it to the ValidityDuration field. - -### GetPendingDuration - -`func (o *LoyaltyPoints) GetPendingDuration() string` - -GetPendingDuration returns the PendingDuration field if non-nil, zero value otherwise. - -### GetPendingDurationOk - -`func (o *LoyaltyPoints) GetPendingDurationOk() (string, bool)` - -GetPendingDurationOk returns a tuple with the PendingDuration field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasPendingDuration - -`func (o *LoyaltyPoints) HasPendingDuration() bool` - -HasPendingDuration returns a boolean if a field has been set. - -### SetPendingDuration - -`func (o *LoyaltyPoints) SetPendingDuration(v string)` - -SetPendingDuration gets a reference to the given string and assigns it to the PendingDuration field. - -### GetSubLedgerID - -`func (o *LoyaltyPoints) GetSubLedgerID() string` - -GetSubLedgerID returns the SubLedgerID field if non-nil, zero value otherwise. - -### GetSubLedgerIDOk - -`func (o *LoyaltyPoints) 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 *LoyaltyPoints) HasSubLedgerID() bool` - -HasSubLedgerID returns a boolean if a field has been set. - -### SetSubLedgerID - -`func (o *LoyaltyPoints) SetSubLedgerID(v string)` - -SetSubLedgerID gets a reference to the given string and assigns it to the SubLedgerID 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/LoyaltyProgram.md b/docs/LoyaltyProgram.md index ec9fd5e1..878c1f7e 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -4,15 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. | +**Id** | Pointer to **int32** | The ID of loyalty program. Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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'. | +**DefaultValidity** | Pointer to **string** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | +**DefaultPending** | Pointer to **string** | The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | **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] +**Sandbox** | Pointer to **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | **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] @@ -246,6 +247,31 @@ HasUsersPerCardLimit returns a boolean if a field has been set. SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +### GetSandbox + +`func (o *LoyaltyProgram) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *LoyaltyProgram) 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 *LoyaltyProgram) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *LoyaltyProgram) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetAccountID `func (o *LoyaltyProgram) GetAccountID() int32` diff --git a/docs/LoyaltyProgramBalance.md b/docs/LoyaltyProgramBalance.md index 7596e2ea..c8afac89 100644 --- a/docs/LoyaltyProgramBalance.md +++ b/docs/LoyaltyProgramBalance.md @@ -6,9 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. | +**ExpiredBalance** | Pointer to **float32** | **DEPRECATED** Value is shown as 0. | +**SpentBalance** | Pointer to **float32** | **DEPRECATED** Value is shown as 0. | +**TentativeCurrentBalance** | Pointer to **float32** | Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied. | +**TentativePendingBalance** | Pointer to **float32** | Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied. | [optional] ## Methods @@ -137,6 +138,31 @@ HasTentativeCurrentBalance returns a boolean if a field has been set. SetTentativeCurrentBalance gets a reference to the given float32 and assigns it to the TentativeCurrentBalance field. +### GetTentativePendingBalance + +`func (o *LoyaltyProgramBalance) GetTentativePendingBalance() float32` + +GetTentativePendingBalance returns the TentativePendingBalance field if non-nil, zero value otherwise. + +### GetTentativePendingBalanceOk + +`func (o *LoyaltyProgramBalance) GetTentativePendingBalanceOk() (float32, bool)` + +GetTentativePendingBalanceOk returns a tuple with the TentativePendingBalance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTentativePendingBalance + +`func (o *LoyaltyProgramBalance) HasTentativePendingBalance() bool` + +HasTentativePendingBalance returns a boolean if a field has been set. + +### SetTentativePendingBalance + +`func (o *LoyaltyProgramBalance) SetTentativePendingBalance(v float32)` + +SetTentativePendingBalance gets a reference to the given float32 and assigns it to the TentativePendingBalance 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/LoyaltyProgramTransaction.md b/docs/LoyaltyProgramTransaction.md new file mode 100644 index 00000000..e2069d34 --- /dev/null +++ b/docs/LoyaltyProgramTransaction.md @@ -0,0 +1,455 @@ +# LoyaltyProgramTransaction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | ID of the loyalty ledger transaction. | +**ProgramId** | Pointer to **int32** | ID of the loyalty program. | +**Created** | Pointer to [**time.Time**](time.Time.md) | Date and time the loyalty transaction occurred. | +**Type** | Pointer to **string** | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. | +**Amount** | Pointer to **float32** | Amount of loyalty points added or deducted in the transaction. | +**Name** | Pointer to **string** | Name or reason for the loyalty ledger transaction. | +**StartDate** | Pointer to **string** | When points become active. Possible values: - `immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time. | +**ExpiryDate** | Pointer to **string** | When points expire. Possible values: - `unlimited`: Points have no expiration date. - a timestamp value: Points expire at a given date and time. | +**CustomerProfileId** | Pointer to **string** | Customer profile integration ID used in the loyalty program. | [optional] +**CardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] +**SubledgerId** | Pointer to **string** | ID of the subledger. | +**CustomerSessionId** | Pointer to **string** | ID of the customer session where the transaction occurred. | [optional] +**ImportId** | Pointer to **int32** | ID of the import where the transaction occurred. | [optional] +**UserId** | Pointer to **int32** | ID of the user who manually added or deducted points. Applies only for manual transactions. | [optional] +**UserEmail** | Pointer to **string** | The email of the user who manually added or deducted points. Applies only for manual transactions. | [optional] +**RulesetId** | Pointer to **int32** | ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional] +**RuleName** | Pointer to **string** | Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional] + +## Methods + +### GetId + +`func (o *LoyaltyProgramTransaction) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *LoyaltyProgramTransaction) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetProgramId + +`func (o *LoyaltyProgramTransaction) GetProgramId() int32` + +GetProgramId returns the ProgramId field if non-nil, zero value otherwise. + +### GetProgramIdOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasProgramId() bool` + +HasProgramId returns a boolean if a field has been set. + +### SetProgramId + +`func (o *LoyaltyProgramTransaction) SetProgramId(v int32)` + +SetProgramId gets a reference to the given int32 and assigns it to the ProgramId field. + +### GetCreated + +`func (o *LoyaltyProgramTransaction) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *LoyaltyProgramTransaction) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetType + +`func (o *LoyaltyProgramTransaction) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *LoyaltyProgramTransaction) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetAmount + +`func (o *LoyaltyProgramTransaction) GetAmount() float32` + +GetAmount returns the Amount field if non-nil, zero value otherwise. + +### GetAmountOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasAmount() bool` + +HasAmount returns a boolean if a field has been set. + +### SetAmount + +`func (o *LoyaltyProgramTransaction) SetAmount(v float32)` + +SetAmount gets a reference to the given float32 and assigns it to the Amount field. + +### GetName + +`func (o *LoyaltyProgramTransaction) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *LoyaltyProgramTransaction) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetStartDate + +`func (o *LoyaltyProgramTransaction) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *LoyaltyProgramTransaction) SetStartDate(v string)` + +SetStartDate gets a reference to the given string and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *LoyaltyProgramTransaction) GetExpiryDate() string` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *LoyaltyProgramTransaction) SetExpiryDate(v string)` + +SetExpiryDate gets a reference to the given string and assigns it to the ExpiryDate field. + +### GetCustomerProfileId + +`func (o *LoyaltyProgramTransaction) GetCustomerProfileId() string` + +GetCustomerProfileId returns the CustomerProfileId field if non-nil, zero value otherwise. + +### GetCustomerProfileIdOk + +`func (o *LoyaltyProgramTransaction) GetCustomerProfileIdOk() (string, bool)` + +GetCustomerProfileIdOk returns a tuple with the CustomerProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerProfileId + +`func (o *LoyaltyProgramTransaction) HasCustomerProfileId() bool` + +HasCustomerProfileId returns a boolean if a field has been set. + +### SetCustomerProfileId + +`func (o *LoyaltyProgramTransaction) SetCustomerProfileId(v string)` + +SetCustomerProfileId gets a reference to the given string and assigns it to the CustomerProfileId field. + +### GetCardIdentifier + +`func (o *LoyaltyProgramTransaction) GetCardIdentifier() string` + +GetCardIdentifier returns the CardIdentifier field if non-nil, zero value otherwise. + +### GetCardIdentifierOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasCardIdentifier() bool` + +HasCardIdentifier returns a boolean if a field has been set. + +### SetCardIdentifier + +`func (o *LoyaltyProgramTransaction) SetCardIdentifier(v string)` + +SetCardIdentifier gets a reference to the given string and assigns it to the CardIdentifier field. + +### GetSubledgerId + +`func (o *LoyaltyProgramTransaction) GetSubledgerId() string` + +GetSubledgerId returns the SubledgerId field if non-nil, zero value otherwise. + +### GetSubledgerIdOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasSubledgerId() bool` + +HasSubledgerId returns a boolean if a field has been set. + +### SetSubledgerId + +`func (o *LoyaltyProgramTransaction) SetSubledgerId(v string)` + +SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. + +### GetCustomerSessionId + +`func (o *LoyaltyProgramTransaction) GetCustomerSessionId() string` + +GetCustomerSessionId returns the CustomerSessionId field if non-nil, zero value otherwise. + +### GetCustomerSessionIdOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasCustomerSessionId() bool` + +HasCustomerSessionId returns a boolean if a field has been set. + +### SetCustomerSessionId + +`func (o *LoyaltyProgramTransaction) SetCustomerSessionId(v string)` + +SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. + +### GetImportId + +`func (o *LoyaltyProgramTransaction) GetImportId() int32` + +GetImportId returns the ImportId field if non-nil, zero value otherwise. + +### GetImportIdOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasImportId() bool` + +HasImportId returns a boolean if a field has been set. + +### SetImportId + +`func (o *LoyaltyProgramTransaction) SetImportId(v int32)` + +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. + +### GetUserId + +`func (o *LoyaltyProgramTransaction) GetUserId() int32` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *LoyaltyProgramTransaction) GetUserIdOk() (int32, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUserId + +`func (o *LoyaltyProgramTransaction) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### SetUserId + +`func (o *LoyaltyProgramTransaction) SetUserId(v int32)` + +SetUserId gets a reference to the given int32 and assigns it to the UserId field. + +### GetUserEmail + +`func (o *LoyaltyProgramTransaction) GetUserEmail() string` + +GetUserEmail returns the UserEmail field if non-nil, zero value otherwise. + +### GetUserEmailOk + +`func (o *LoyaltyProgramTransaction) GetUserEmailOk() (string, bool)` + +GetUserEmailOk returns a tuple with the UserEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUserEmail + +`func (o *LoyaltyProgramTransaction) HasUserEmail() bool` + +HasUserEmail returns a boolean if a field has been set. + +### SetUserEmail + +`func (o *LoyaltyProgramTransaction) SetUserEmail(v string)` + +SetUserEmail gets a reference to the given string and assigns it to the UserEmail field. + +### GetRulesetId + +`func (o *LoyaltyProgramTransaction) GetRulesetId() int32` + +GetRulesetId returns the RulesetId field if non-nil, zero value otherwise. + +### GetRulesetIdOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasRulesetId() bool` + +HasRulesetId returns a boolean if a field has been set. + +### SetRulesetId + +`func (o *LoyaltyProgramTransaction) SetRulesetId(v int32)` + +SetRulesetId gets a reference to the given int32 and assigns it to the RulesetId field. + +### GetRuleName + +`func (o *LoyaltyProgramTransaction) GetRuleName() string` + +GetRuleName returns the RuleName field if non-nil, zero value otherwise. + +### GetRuleNameOk + +`func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasRuleName() bool` + +HasRuleName returns a boolean if a field has been set. + +### SetRuleName + +`func (o *LoyaltyProgramTransaction) 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/LoyaltyProjection.md b/docs/LoyaltyProjection.md deleted file mode 100644 index 517ccc69..00000000 --- a/docs/LoyaltyProjection.md +++ /dev/null @@ -1,91 +0,0 @@ -# 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 deleted file mode 100644 index deed9075..00000000 --- a/docs/LoyaltyProjectionData.md +++ /dev/null @@ -1,117 +0,0 @@ -# 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/LoyaltyTier.md b/docs/LoyaltyTier.md index e57ba9a3..30a29890 100644 --- a/docs/LoyaltyTier.md +++ b/docs/LoyaltyTier.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index 7ed5e86a..bede5fb8 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -4,8 +4,9 @@ All URIs are relative to *https://yourbaseurl.talon.one* Method | HTTP request | Description ------------- | ------------- | ------------- -[**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 +[**AddLoyaltyCardPoints**](ManagementApi.md#AddLoyaltyCardPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card +[**AddLoyaltyPoints**](ManagementApi.md#AddLoyaltyPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile +[**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 @@ -14,15 +15,17 @@ Method | HTTP request | Description [**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 +[**CreateNotificationWebhook**](ManagementApi.md#CreateNotificationWebhook) | **Post** /v1/applications/{applicationId}/notification_webhooks | Create notification about campaign-related changes [**CreatePasswordRecoveryEmail**](ManagementApi.md#CreatePasswordRecoveryEmail) | **Post** /v1/password_recovery_emails | Request a password reset [**CreateSession**](ManagementApi.md#CreateSession) | **Post** /v1/sessions | Create session +[**DeductLoyaltyCardPoints**](ManagementApi.md#DeductLoyaltyCardPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card [**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 +[**DeleteLoyaltyCard**](ManagementApi.md#DeleteLoyaltyCard) | **Delete** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card +[**DeleteNotificationWebhook**](ManagementApi.md#DeleteNotificationWebhook) | **Delete** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification about campaign-related changes [**DeleteReferral**](ManagementApi.md#DeleteReferral) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral [**DestroySession**](ManagementApi.md#DestroySession) | **Delete** /v1/sessions | Destroy session [**ExportAccountCollectionItems**](ManagementApi.md#ExportAccountCollectionItems) | **Get** /v1/collections/{collectionId}/export | Export account-level collection's items @@ -30,8 +33,11 @@ Method | HTTP request | Description [**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 +[**ExportLoyaltyBalance**](ManagementApi.md#ExportLoyaltyBalance) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV +[**ExportLoyaltyBalances**](ManagementApi.md#ExportLoyaltyBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances +[**ExportLoyaltyCardBalances**](ManagementApi.md#ExportLoyaltyCardBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs +[**ExportLoyaltyCardLedger**](ManagementApi.md#ExportLoyaltyCardLedger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log +[**ExportLoyaltyLedger**](ManagementApi.md#ExportLoyaltyLedger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs [**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 @@ -41,8 +47,8 @@ Method | HTTP request | Description [**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 -[**GetApplicationApiHealth**](ManagementApi.md#GetApplicationApiHealth) | **Get** /v1/applications/{applicationId}/health_report | Get report of health of application API +[**GetApplication**](ManagementApi.md#GetApplication) | **Get** /v1/applications/{applicationId} | Get Application +[**GetApplicationApiHealth**](ManagementApi.md#GetApplicationApiHealth) | **Get** /v1/applications/{applicationId}/health_report | Get Application health [**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 [**GetApplicationCustomers**](ManagementApi.md#GetApplicationCustomers) | **Get** /v1/applications/{applicationId}/customers | List application's customers @@ -51,13 +57,14 @@ 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 +[**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 +[**GetCampaignTemplates**](ManagementApi.md#GetCampaignTemplates) | **Get** /v1/campaign_templates | List campaign templates [**GetCampaigns**](ManagementApi.md#GetCampaigns) | **Get** /v1/applications/{applicationId}/campaigns | List campaigns [**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 @@ -71,12 +78,16 @@ Method | HTTP request | Description [**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/{loyaltyProgramId}/profile/{integrationId} | Get the Loyalty Ledger for this integrationID +[**GetLoyaltyCard**](ManagementApi.md#GetLoyaltyCard) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card +[**GetLoyaltyCardTransactionLogs**](ManagementApi.md#GetLoyaltyCardTransactionLogs) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions +[**GetLoyaltyCards**](ManagementApi.md#GetLoyaltyCards) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards +[**GetLoyaltyPoints**](ManagementApi.md#GetLoyaltyPoints) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger [**GetLoyaltyProgram**](ManagementApi.md#GetLoyaltyProgram) | **Get** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program +[**GetLoyaltyProgramTransactions**](ManagementApi.md#GetLoyaltyProgramTransactions) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions [**GetLoyaltyPrograms**](ManagementApi.md#GetLoyaltyPrograms) | **Get** /v1/loyalty_programs | List loyalty programs -[**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 +[**GetLoyaltyStatistics**](ManagementApi.md#GetLoyaltyStatistics) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics +[**GetNotificationWebhook**](ManagementApi.md#GetNotificationWebhook) | **Get** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Get notification about campaign-related changes +[**GetNotificationWebhooks**](ManagementApi.md#GetNotificationWebhooks) | **Get** /v1/applications/{applicationId}/notification_webhooks | List notifications about campaign-related changes [**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 @@ -91,16 +102,20 @@ Method | HTTP request | Description [**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 +[**ImportLoyaltyCards**](ManagementApi.md#ImportLoyaltyCards) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards [**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 [**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 +[**PostAddedDeductedPointsNotification**](ManagementApi.md#PostAddedDeductedPointsNotification) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points +[**PostCatalogsStrikethroughNotification**](ManagementApi.md#PostCatalogsStrikethroughNotification) | **Post** /v1/catalogs/{applicationId}/notifications/strikethrough | Create strikethrough notification +[**RemoveLoyaltyPoints**](ManagementApi.md#RemoveLoyaltyPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile [**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 (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) +[**TransferLoyaltyCard**](ManagementApi.md#TransferLoyaltyCard) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data [**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 @@ -108,16 +123,63 @@ Method | HTTP request | Description [**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 coupons -[**UpdateNotificationWebhook**](ManagementApi.md#UpdateNotificationWebhook) | **Put** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification webhook +[**UpdateLoyaltyCard**](ManagementApi.md#UpdateLoyaltyCard) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status +[**UpdateNotificationWebhook**](ManagementApi.md#UpdateNotificationWebhook) | **Put** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification about campaign-related changes [**UpdateReferral**](ManagementApi.md#UpdateReferral) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral +## AddLoyaltyCardPoints + +> AddLoyaltyCardPoints(ctx, loyaltyProgramId, loyaltyCardId).Body(body).Execute() + +Add points to card + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddLoyaltyCardPointsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **body** | [**AddLoyaltyPoints**](AddLoyaltyPoints.md) | body | + +### Return type + + (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [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) + + ## AddLoyaltyPoints > AddLoyaltyPoints(ctx, loyaltyProgramId, integrationId).Body(body).Execute() -Add points in loyalty program for given customer +Add points to customer profile @@ -139,7 +201,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LoyaltyPoints**](LoyaltyPoints.md) | | + **body** | [**AddLoyaltyPoints**](AddLoyaltyPoints.md) | body | ### Return type @@ -147,7 +209,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -161,9 +223,9 @@ Name | Type | Description | Notes ## CopyCampaignToApplications -> InlineResponse2003 CopyCampaignToApplications(ctx, applicationId, campaignId).Body(body).Execute() +> InlineResponse2004 CopyCampaignToApplications(ctx, applicationId, campaignId).Body(body).Execute() -Copy the campaign into the specified application +Copy the campaign into the specified Application @@ -185,15 +247,15 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CampaignCopy**](CampaignCopy.md) | | + **body** | [**CampaignCopy**](CampaignCopy.md) | body | ### Return type -[**InlineResponse2003**](inline_response_200_3.md) +[**InlineResponse2004**](inline_response_200_4.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -224,7 +286,7 @@ Other parameters are passed through a pointer to a apiCreateAccountCollectionReq Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewCollection**](NewCollection.md) | | + **body** | [**NewCollection**](NewCollection.md) | body | ### Return type @@ -232,7 +294,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -263,7 +325,7 @@ Other parameters are passed through a pointer to a apiCreateAdditionalCostReques Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAdditionalCost**](NewAdditionalCost.md) | | + **body** | [**NewAdditionalCost**](NewAdditionalCost.md) | body | ### Return type @@ -271,7 +333,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -302,7 +364,7 @@ Other parameters are passed through a pointer to a apiCreateAttributeRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAttribute**](NewAttribute.md) | | + **body** | [**NewAttribute**](NewAttribute.md) | body | ### Return type @@ -310,7 +372,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -346,7 +408,7 @@ Other parameters are passed through a pointer to a apiCreateCampaignFromTemplate Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CreateTemplateCampaign**](CreateTemplateCampaign.md) | | + **body** | [**CreateTemplateCampaign**](CreateTemplateCampaign.md) | body | ### Return type @@ -354,7 +416,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -392,7 +454,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewCampaignCollection**](NewCampaignCollection.md) | | + **body** | [**NewCampaignCollection**](NewCampaignCollection.md) | body | ### Return type @@ -400,7 +462,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -414,7 +476,7 @@ Name | Type | Description | Notes ## CreateCoupons -> InlineResponse2006 CreateCoupons(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() +> InlineResponse2007 CreateCoupons(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() Create coupons @@ -438,16 +500,16 @@ 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** | [**NewCoupons**](NewCoupons.md) | body | + **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 the updated customer profiles. | [default to yes] ### Return type -[**InlineResponse2006**](inline_response_200_6.md) +[**InlineResponse2007**](inline_response_200_7.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -485,7 +547,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewCouponCreationJob**](NewCouponCreationJob.md) | | + **body** | [**NewCouponCreationJob**](NewCouponCreationJob.md) | body | ### Return type @@ -493,7 +555,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -507,7 +569,7 @@ Name | Type | Description | Notes ## CreateCouponsForMultipleRecipients -> InlineResponse2006 CreateCouponsForMultipleRecipients(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() +> InlineResponse2007 CreateCouponsForMultipleRecipients(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() Create coupons for multiple recipients @@ -531,16 +593,16 @@ 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** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md) | body | + **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 the updated customer profiles. | [default to yes] ### Return type -[**InlineResponse2006**](inline_response_200_6.md) +[**InlineResponse2007**](inline_response_200_7.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -556,7 +618,7 @@ Name | Type | Description | Notes > NotificationWebhook CreateNotificationWebhook(ctx, applicationId).Body(body).Execute() -Create notification webhook +Create notification about campaign-related changes @@ -576,7 +638,7 @@ Other parameters are passed through a pointer to a apiCreateNotificationWebhookR Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | | + **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | body | ### Return type @@ -584,7 +646,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -615,7 +677,7 @@ Other parameters are passed through a pointer to a apiCreatePasswordRecoveryEmai Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewPasswordEmail**](NewPasswordEmail.md) | | + **body** | [**NewPasswordEmail**](NewPasswordEmail.md) | body | ### Return type @@ -623,7 +685,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -654,7 +716,7 @@ Other parameters are passed through a pointer to a apiCreateSessionRequest struc Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LoginParams**](LoginParams.md) | | + **body** | [**LoginParams**](LoginParams.md) | body | ### Return type @@ -662,7 +724,53 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [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) + + +## DeductLoyaltyCardPoints + +> DeductLoyaltyCardPoints(ctx, loyaltyProgramId, loyaltyCardId).Body(body).Execute() + +Deduct points from card + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeductLoyaltyCardPointsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md) | body | + +### Return type + + (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -688,7 +796,7 @@ Delete account-level collection 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -705,7 +813,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -750,7 +858,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -778,7 +886,7 @@ 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -797,7 +905,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -825,7 +933,7 @@ 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. | -**couponId** | **string** | The ID of the coupon code to update | +**couponId** | **string** | The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. | ### Other Parameters @@ -844,7 +952,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -889,10 +997,10 @@ Name | Type | Description | Notes **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. | + **valid** | **string** | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration 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. | + **referralId** | **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming 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] @@ -902,7 +1010,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -914,11 +1022,56 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## DeleteLoyaltyCard + +> DeleteLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId).Execute() + +Delete loyalty card + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLoyaltyCardRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [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) + + ## DeleteNotificationWebhook > DeleteNotificationWebhook(ctx, applicationId, notificationWebhookId).Execute() -Delete notification webhook +Delete notification about campaign-related changes @@ -929,7 +1082,7 @@ 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** | | +**notificationWebhookId** | **int32** | The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. | ### Other Parameters @@ -947,7 +1100,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -975,7 +1128,7 @@ 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. | -**referralId** | **string** | The ID of the referral code to delete | +**referralId** | **string** | The ID of the referral code. | ### Other Parameters @@ -994,7 +1147,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1029,7 +1182,7 @@ Other parameters are passed through a pointer to a apiDestroySessionRequest stru ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1055,7 +1208,7 @@ Export account-level collection's items 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -1072,7 +1225,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1100,7 +1253,7 @@ 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -1119,7 +1272,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1156,13 +1309,13 @@ 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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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. | + **referralId** | **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming 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] @@ -1175,7 +1328,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1223,7 +1376,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1270,7 +1423,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1284,9 +1437,9 @@ Name | Type | Description | Notes ## ExportLoyaltyBalance -> string ExportLoyaltyBalance(ctx, loyaltyProgramId).Execute() +> string ExportLoyaltyBalance(ctx, loyaltyProgramId).EndDate(endDate).Execute() -Export customer loyalty balance to a CSV file +Export customer loyalty balance to CSV @@ -1303,17 +1456,154 @@ Name | Type | Description | Notes Other parameters are passed through a pointer to a apiExportLoyaltyBalanceRequest struct via the builder pattern +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **endDate** | **time.Time** | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | + +### Return type + +**string** + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## ExportLoyaltyBalances + +> string ExportLoyaltyBalances(ctx, loyaltyProgramId).EndDate(endDate).Execute() + +Export customer loyalty balances + + + +### 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 apiExportLoyaltyBalancesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **endDate** | **time.Time** | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | + +### Return type + +**string** + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## ExportLoyaltyCardBalances + +> string ExportLoyaltyCardBalances(ctx, loyaltyProgramId).EndDate(endDate).Execute() + +Export all card transaction logs + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportLoyaltyCardBalancesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **endDate** | **time.Time** | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | + +### Return type + +**string** + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## ExportLoyaltyCardLedger + +> string ExportLoyaltyCardLedger(ctx, loyaltyProgramId, loyaltyCardId).RangeStart(rangeStart).RangeEnd(rangeEnd).DateFormat(dateFormat).Execute() + +Export card's ledger log + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportLoyaltyCardLedgerRequest struct via the builder pattern + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **rangeStart** | **time.Time** | Only return results from after this timestamp. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This 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) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1329,7 +1619,7 @@ Name | Type | Description | Notes > string ExportLoyaltyLedger(ctx, loyaltyProgramId, integrationId).RangeStart(rangeStart).RangeEnd(rangeEnd).DateFormat(dateFormat).Execute() -Export a customer's loyalty ledger log +Export customer's transaction logs @@ -1349,8 +1639,8 @@ Other parameters are passed through a pointer to a apiExportLoyaltyLedgerRequest 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. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This must be an RFC3339 timestamp string. | **dateFormat** | **string** | Determines the format of dates in the export document. | @@ -1361,7 +1651,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1400,7 +1690,7 @@ 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. | + **valid** | **string** | - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration 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. | @@ -1411,7 +1701,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1425,7 +1715,7 @@ Name | Type | Description | Notes ## GetAccessLogsWithoutTotalCount -> InlineResponse20013 GetAccessLogsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20018 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 @@ -1447,22 +1737,22 @@ Other parameters are passed through a pointer to a apiGetAccessLogsWithoutTotalC 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. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse20013**](inline_response_200_13.md) +[**InlineResponse20018**](inline_response_200_18.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1488,7 +1778,7 @@ Get account details 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. | +**accountId** | **int32** | The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. | ### Other Parameters @@ -1505,7 +1795,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1531,7 +1821,7 @@ Get account analytics 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. | +**accountId** | **int32** | The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property. | ### Other Parameters @@ -1548,7 +1838,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1574,7 +1864,7 @@ Get account-level collection 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -1591,7 +1881,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1617,7 +1907,7 @@ Get additional cost Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**additionalCostId** | **int32** | | +**additionalCostId** | **int32** | The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. | ### Other Parameters @@ -1634,7 +1924,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1648,7 +1938,7 @@ Name | Type | Description | Notes ## GetAdditionalCosts -> InlineResponse20026 GetAdditionalCosts(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20032 GetAdditionalCosts(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List additional costs @@ -1665,17 +1955,17 @@ Other parameters are passed through a pointer to a apiGetAdditionalCostsRequest 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse20026**](inline_response_200_26.md) +[**InlineResponse20032**](inline_response_200_32.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1689,7 +1979,7 @@ Name | Type | Description | Notes ## GetAllAccessLogs -> InlineResponse20014 GetAllAccessLogs(ctx).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20019 GetAllAccessLogs(ctx).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List access logs @@ -1706,22 +1996,22 @@ Other parameters are passed through a pointer to a apiGetAllAccessLogsRequest st 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. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse20014**](inline_response_200_14.md) +[**InlineResponse20019**](inline_response_200_19.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1735,7 +2025,7 @@ Name | Type | Description | Notes ## GetAllRoles -> InlineResponse20034 GetAllRoles(ctx).Execute() +> InlineResponse20040 GetAllRoles(ctx).Execute() List roles @@ -1752,11 +2042,11 @@ Other parameters are passed through a pointer to a apiGetAllRolesRequest struct ### Return type -[**InlineResponse20034**](inline_response_200_34.md) +[**InlineResponse20040**](inline_response_200_40.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1772,7 +2062,7 @@ Other parameters are passed through a pointer to a apiGetAllRolesRequest struct > Application GetApplication(ctx, applicationId).Execute() -Get application +Get Application @@ -1799,7 +2089,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1815,7 +2105,7 @@ Name | Type | Description | Notes > ApplicationApiHealth GetApplicationApiHealth(ctx, applicationId).Execute() -Get report of health of application API +Get Application health @@ -1842,7 +2132,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1869,7 +2159,7 @@ 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. | -**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. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | ### Other Parameters @@ -1887,7 +2177,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1901,7 +2191,7 @@ Name | Type | Description | Notes ## GetApplicationCustomerFriends -> InlineResponse20024 GetApplicationCustomerFriends(ctx, applicationId, integrationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20030 GetApplicationCustomerFriends(ctx, applicationId, integrationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() List friends referred by customer profile @@ -1925,18 +2215,18 @@ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 -[**InlineResponse20024**](inline_response_200_24.md) +[**InlineResponse20030**](inline_response_200_30.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1950,7 +2240,7 @@ Name | Type | Description | Notes ## GetApplicationCustomers -> InlineResponse20016 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20021 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() List application's customers @@ -1973,17 +2263,17 @@ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | **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 -[**InlineResponse20016**](inline_response_200_16.md) +[**InlineResponse20021**](inline_response_200_21.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -1997,7 +2287,7 @@ Name | Type | Description | Notes ## GetApplicationCustomersByAttributes -> InlineResponse20017 GetApplicationCustomersByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20022 GetApplicationCustomersByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() List application customers matching the given attributes @@ -2019,18 +2309,18 @@ Other parameters are passed through a pointer to a apiGetApplicationCustomersByA 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. | + **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md) | body | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | **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 -[**InlineResponse20017**](inline_response_200_17.md) +[**InlineResponse20022**](inline_response_200_22.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2044,7 +2334,7 @@ Name | Type | Description | Notes ## GetApplicationEventTypes -> InlineResponse20022 GetApplicationEventTypes(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20028 GetApplicationEventTypes(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List Applications event types @@ -2066,17 +2356,17 @@ Other parameters are passed through a pointer to a apiGetApplicationEventTypesRe 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse20022**](inline_response_200_22.md) +[**InlineResponse20028**](inline_response_200_28.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2090,7 +2380,7 @@ Name | Type | Description | Notes ## GetApplicationEventsWithoutTotalCount -> InlineResponse20021 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() +> InlineResponse20027 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() List Applications events @@ -2112,9 +2402,9 @@ Other parameters are passed through a pointer to a apiGetApplicationEventsWithou 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | @@ -2129,11 +2419,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20021**](inline_response_200_21.md) +[**InlineResponse20027**](inline_response_200_27.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2160,7 +2450,7 @@ 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. | -**sessionId** | **int32** | The **internal** ID of the session. You can get the ID with the [List Application sessions endpoint](/#tag/Customer-data/operation/getApplicationSession). | +**sessionId** | **int32** | The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint. | ### Other Parameters @@ -2178,7 +2468,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2192,7 +2482,7 @@ Name | Type | Description | Notes ## GetApplicationSessions -> InlineResponse20020 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Coupon(coupon).Referral(referral).IntegrationId(integrationId).Execute() +> InlineResponse20026 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Coupon(coupon).Referral(referral).IntegrationId(integrationId).Execute() List Application sessions @@ -2214,9 +2504,9 @@ Other parameters are passed through a pointer to a apiGetApplicationSessionsRequ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | @@ -2227,11 +2517,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20020**](inline_response_200_20.md) +[**InlineResponse20026**](inline_response_200_26.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2245,9 +2535,9 @@ Name | Type | Description | Notes ## GetApplications -> InlineResponse2002 GetApplications(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse2003 GetApplications(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() -List applications +List Applications @@ -2262,17 +2552,17 @@ Other parameters are passed through a pointer to a apiGetApplicationsRequest str 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse2002**](inline_response_200_2.md) +[**InlineResponse2003**](inline_response_200_3.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2298,7 +2588,7 @@ Get custom attribute Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**attributeId** | **int32** | | +**attributeId** | **int32** | The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. | ### Other Parameters @@ -2315,7 +2605,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2329,7 +2619,7 @@ Name | Type | Description | Notes ## GetAttributes -> InlineResponse20025 GetAttributes(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Entity(entity).Execute() +> InlineResponse20031 GetAttributes(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Entity(entity).Execute() List custom attributes @@ -2346,18 +2636,18 @@ Other parameters are passed through a pointer to a apiGetAttributesRequest struc 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **entity** | **string** | Returned attributes will be filtered by supplied entity. | ### Return type -[**InlineResponse20025**](inline_response_200_25.md) +[**InlineResponse20031**](inline_response_200_31.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2371,7 +2661,7 @@ Name | Type | Description | Notes ## GetAudiences -> InlineResponse20023 GetAudiences(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20029 GetAudiences(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() List audiences @@ -2388,18 +2678,18 @@ Other parameters are passed through a pointer to a apiGetAudiencesRequest struct 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 -[**InlineResponse20023**](inline_response_200_23.md) +[**InlineResponse20029**](inline_response_200_29.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2444,7 +2734,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2458,7 +2748,7 @@ Name | Type | Description | Notes ## GetCampaignAnalytics -> InlineResponse20015 GetCampaignAnalytics(ctx, applicationId, campaignId).RangeStart(rangeStart).RangeEnd(rangeEnd).Granularity(granularity).Execute() +> InlineResponse20020 GetCampaignAnalytics(ctx, applicationId, campaignId).RangeStart(rangeStart).RangeEnd(rangeEnd).Granularity(granularity).Execute() Get analytics of campaigns @@ -2482,17 +2772,17 @@ 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. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This must be an RFC3339 timestamp string. | **granularity** | **string** | The time interval between the results in the returned time-series. | ### Return type -[**InlineResponse20015**](inline_response_200_15.md) +[**InlineResponse20020**](inline_response_200_20.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2506,7 +2796,7 @@ Name | Type | Description | Notes ## GetCampaignByAttributes -> InlineResponse2003 GetCampaignByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Execute() +> InlineResponse2004 GetCampaignByAttributes(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Execute() List campaigns that match the given attributes @@ -2528,19 +2818,19 @@ Other parameters are passed through a pointer to a apiGetCampaignByAttributesReq 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. | + **body** | [**CampaignSearch**](CampaignSearch.md) | body | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 -[**InlineResponse2003**](inline_response_200_3.md) +[**InlineResponse2004**](inline_response_200_4.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2552,9 +2842,54 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## GetCampaignTemplates + +> InlineResponse20010 GetCampaignTemplates(ctx).PageSize(pageSize).Skip(skip).Sort(sort).State(state).Name(name).Tags(tags).UserId(userId).Execute() + +List campaign templates + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplatesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | **int32** | The number of items in this response. | [default to 1000] + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | + **state** | **string** | Filter results by the state of the campaign template. | + **name** | **string** | Filter results performing case-insensitive matching against the name of the campaign template. | + **tags** | **string** | Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values. | + **userId** | **int32** | Filter results by user ID. | + +### Return type + +[**InlineResponse20010**](inline_response_200_10.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + ## GetCampaigns -> InlineResponse2003 GetCampaigns(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Name(name).Tags(tags).CreatedBefore(createdBefore).CreatedAfter(createdAfter).CampaignGroupId(campaignGroupId).TemplateId(templateId).Execute() +> InlineResponse2004 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 campaigns @@ -2576,9 +2911,9 @@ Other parameters are passed through a pointer to a apiGetCampaignsRequest struct 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 | @@ -2589,11 +2924,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2003**](inline_response_200_3.md) +[**InlineResponse2004**](inline_response_200_4.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2607,7 +2942,7 @@ Name | Type | Description | Notes ## GetChanges -> InlineResponse20032 GetChanges(ctx).PageSize(pageSize).Skip(skip).Sort(sort).ApplicationId(applicationId).EntityPath(entityPath).UserId(userId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).WithTotalResultSize(withTotalResultSize).IncludeOld(includeOld).Execute() +> InlineResponse20038 GetChanges(ctx).PageSize(pageSize).Skip(skip).Sort(sort).ApplicationId(applicationId).EntityPath(entityPath).UserId(userId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).WithTotalResultSize(withTotalResultSize).ManagementKeyId(managementKeyId).IncludeOld(includeOld).Execute() Get audit logs for an account @@ -2624,24 +2959,25 @@ Other parameters are passed through a pointer to a apiGetChangesRequest struct v 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | + **userId** | **int32** | Filter results by 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. | + **managementKeyId** | **int32** | Filter results that match the given management key ID. | **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 -[**InlineResponse20032**](inline_response_200_32.md) +[**InlineResponse20038**](inline_response_200_38.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2669,7 +3005,7 @@ 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -2688,7 +3024,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2702,7 +3038,7 @@ Name | Type | Description | Notes ## GetCollectionItems -> InlineResponse20011 GetCollectionItems(ctx, collectionId).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20016 GetCollectionItems(ctx, collectionId).PageSize(pageSize).Skip(skip).Execute() Get collection items @@ -2714,7 +3050,7 @@ Get collection items 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -2724,16 +3060,16 @@ Other parameters are passed through a pointer to a apiGetCollectionItemsRequest 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | ### Return type -[**InlineResponse20011**](inline_response_200_11.md) +[**InlineResponse20016**](inline_response_200_16.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2747,7 +3083,7 @@ Name | Type | Description | Notes ## GetCouponsWithoutTotalCount -> InlineResponse2007 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() +> InlineResponse2008 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 coupons @@ -2771,26 +3107,26 @@ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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. | + **referralId** | **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming 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 -[**InlineResponse2007**](inline_response_200_7.md) +[**InlineResponse2008**](inline_response_200_8.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2817,7 +3153,7 @@ 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. | -**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. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | ### Other Parameters @@ -2826,11 +3162,11 @@ Other parameters are passed through a pointer to a apiGetCustomerActivityReportR 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. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | ### Return type @@ -2839,7 +3175,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2853,7 +3189,7 @@ Name | Type | Description | Notes ## GetCustomerActivityReportsWithoutTotalCount -> InlineResponse20019 GetCustomerActivityReportsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() +> InlineResponse20025 GetCustomerActivityReportsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() Get Activity Reports for Application Customers @@ -2874,12 +3210,12 @@ Other parameters are passed through a pointer to a apiGetCustomerActivityReports 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. This must be an RFC3339 timestamp string. | + **rangeEnd** | **time.Time** | Only return results from before this timestamp. This 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 | @@ -2887,11 +3223,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20019**](inline_response_200_19.md) +[**InlineResponse20025**](inline_response_200_25.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2918,7 +3254,7 @@ 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. | -**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. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | ### Other Parameters @@ -2929,9 +3265,9 @@ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type @@ -2939,7 +3275,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2965,7 +3301,7 @@ Get customer profile Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**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. | +**customerId** | **int32** | The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | ### Other Parameters @@ -2982,7 +3318,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -2996,7 +3332,7 @@ Name | Type | Description | Notes ## GetCustomerProfiles -> InlineResponse20018 GetCustomerProfiles(ctx).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20024 GetCustomerProfiles(ctx).PageSize(pageSize).Skip(skip).Sandbox(sandbox).Execute() List customer profiles @@ -3013,16 +3349,17 @@ Other parameters are passed through a pointer to a apiGetCustomerProfilesRequest 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sandbox** | **bool** | Indicates whether you are pointing to a sandbox or Live customer. | [default to false] ### Return type -[**InlineResponse20018**](inline_response_200_18.md) +[**InlineResponse20024**](inline_response_200_24.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3036,7 +3373,7 @@ Name | Type | Description | Notes ## GetCustomersByAttributes -> InlineResponse20018 GetCustomersByAttributes(ctx).Body(body).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20023 GetCustomersByAttributes(ctx).Body(body).PageSize(pageSize).Skip(skip).Sandbox(sandbox).Execute() List customer profiles matching the given attributes @@ -3053,17 +3390,18 @@ Other parameters are passed through a pointer to a apiGetCustomersByAttributesRe 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. | + **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md) | body | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sandbox** | **bool** | Indicates whether you are pointing to a sandbox or Live customer. | [default to false] ### Return type -[**InlineResponse20018**](inline_response_200_18.md) +[**InlineResponse20023**](inline_response_200_23.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3077,7 +3415,7 @@ Name | Type | Description | Notes ## GetEventTypes -> InlineResponse20030 GetEventTypes(ctx).Name(name).IncludeOldVersions(includeOldVersions).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20036 GetEventTypes(ctx).Name(name).IncludeOldVersions(includeOldVersions).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List event types @@ -3096,17 +3434,17 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse20030**](inline_response_200_30.md) +[**InlineResponse20036**](inline_response_200_36.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3120,7 +3458,7 @@ Name | Type | Description | Notes ## GetExports -> InlineResponse20033 GetExports(ctx).PageSize(pageSize).Skip(skip).ApplicationId(applicationId).CampaignId(campaignId).Entity(entity).Execute() +> InlineResponse20039 GetExports(ctx).PageSize(pageSize).Skip(skip).ApplicationId(applicationId).CampaignId(campaignId).Entity(entity).Execute() Get exports @@ -3137,7 +3475,7 @@ Other parameters are passed through a pointer to a apiGetExportsRequest struct v 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | @@ -3145,11 +3483,154 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20033**](inline_response_200_33.md) +[**InlineResponse20039**](inline_response_200_39.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## GetLoyaltyCard + +> LoyaltyCard GetLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId).Execute() + +Get loyalty card + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyCardRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LoyaltyCard**](LoyaltyCard.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [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) + + +## GetLoyaltyCardTransactionLogs + +> InlineResponse20014 GetLoyaltyCardTransactionLogs(ctx, loyaltyProgramId, loyaltyCardId).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).SubledgerId(subledgerId).Execute() + +List card's transactions + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyCardTransactionLogsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **startDate** | **time.Time** | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **endDate** | **time.Time** | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **subledgerId** | **string** | The ID of the subledger by which we filter the data. | + +### Return type + +[**InlineResponse20014**](inline_response_200_14.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## GetLoyaltyCards + +> InlineResponse20013 GetLoyaltyCards(ctx, loyaltyProgramId).PageSize(pageSize).Skip(skip).Sort(sort).Identifier(identifier).ProfileId(profileId).Execute() + +List loyalty cards + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyCardsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **pageSize** | **int32** | The number of items in this response. | [default to 1000] + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | + **identifier** | **string** | Optional query parameter to search cards by identifier. | + **profileId** | **int32** | Filter by the profile ID. | + +### Return type + +[**InlineResponse20013**](inline_response_200_13.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3165,7 +3646,7 @@ Name | Type | Description | Notes > LoyaltyLedger GetLoyaltyPoints(ctx, loyaltyProgramId, integrationId).Execute() -Get the Loyalty Ledger for this integrationID +Get customer's full loyalty ledger @@ -3194,7 +3675,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3220,7 +3701,7 @@ Get loyalty program 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). | +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | ### Other Parameters @@ -3237,7 +3718,56 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [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) + + +## GetLoyaltyProgramTransactions + +> InlineResponse20012 GetLoyaltyProgramTransactions(ctx, loyaltyProgramId).LoyaltyTransactionType(loyaltyTransactionType).SubledgerId(subledgerId).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute() + +List loyalty program transactions + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyProgramTransactionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **loyaltyTransactionType** | **string** | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | + **subledgerId** | **string** | The ID of the subledger by which we filter the data. | + **startDate** | **time.Time** | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **endDate** | **time.Time** | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | + **pageSize** | **int32** | The number of items in this response. | [default to 50] + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + +### Return type + +[**InlineResponse20012**](inline_response_200_12.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3251,7 +3781,7 @@ Name | Type | Description | Notes ## GetLoyaltyPrograms -> InlineResponse2009 GetLoyaltyPrograms(ctx).Execute() +> InlineResponse20011 GetLoyaltyPrograms(ctx).Execute() List loyalty programs @@ -3268,11 +3798,11 @@ Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest ### Return type -[**InlineResponse2009**](inline_response_200_9.md) +[**InlineResponse20011**](inline_response_200_11.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3288,7 +3818,7 @@ Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest > LoyaltyStatistics GetLoyaltyStatistics(ctx, loyaltyProgramId).Execute() -Get loyalty program statistics by loyalty program ID +Get loyalty program statistics @@ -3298,7 +3828,7 @@ Get loyalty program statistics by loyalty program ID 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). | +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | ### Other Parameters @@ -3315,7 +3845,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3331,7 +3861,7 @@ Name | Type | Description | Notes > NotificationWebhook GetNotificationWebhook(ctx, applicationId, notificationWebhookId).Execute() -Get notification webhook +Get notification about campaign-related changes @@ -3342,7 +3872,7 @@ 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** | | +**notificationWebhookId** | **int32** | The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. | ### Other Parameters @@ -3360,7 +3890,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3374,9 +3904,9 @@ Name | Type | Description | Notes ## GetNotificationWebhooks -> InlineResponse2004 GetNotificationWebhooks(ctx, applicationId).Execute() +> InlineResponse2005 GetNotificationWebhooks(ctx, applicationId).Execute() -List notification webhooks +List notifications about campaign-related changes @@ -3399,11 +3929,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2004**](inline_response_200_4.md) +[**InlineResponse2005**](inline_response_200_5.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3417,7 +3947,7 @@ Name | Type | Description | Notes ## GetReferralsWithoutTotalCount -> InlineResponse2008 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() +> InlineResponse2009 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() List referrals @@ -3441,23 +3971,23 @@ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future. | **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 -[**InlineResponse2008**](inline_response_200_8.md) +[**InlineResponse2009**](inline_response_200_9.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3500,7 +4030,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3528,7 +4058,7 @@ 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. | -**rulesetId** | **int32** | | +**rulesetId** | **int32** | The ID of the ruleset. | ### Other Parameters @@ -3547,7 +4077,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3561,7 +4091,7 @@ Name | Type | Description | Notes ## GetRulesets -> InlineResponse2005 GetRulesets(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse2006 GetRulesets(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List campaign rulesets @@ -3585,17 +4115,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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse2005**](inline_response_200_5.md) +[**InlineResponse2006**](inline_response_200_6.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3638,7 +4168,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3652,7 +4182,7 @@ Name | Type | Description | Notes ## GetUsers -> InlineResponse20031 GetUsers(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20037 GetUsers(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List users in account @@ -3669,17 +4199,17 @@ Other parameters are passed through a pointer to a apiGetUsersRequest struct via 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | ### Return type -[**InlineResponse20031**](inline_response_200_31.md) +[**InlineResponse20037**](inline_response_200_37.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3705,7 +4235,7 @@ Get webhook Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**webhookId** | **int32** | | +**webhookId** | **int32** | The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**. | ### Other Parameters @@ -3722,7 +4252,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3736,7 +4266,7 @@ Name | Type | Description | Notes ## GetWebhookActivationLogs -> InlineResponse20028 GetWebhookActivationLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).IntegrationRequestUuid(integrationRequestUuid).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> InlineResponse20034 GetWebhookActivationLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).IntegrationRequestUuid(integrationRequestUuid).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() List webhook activation log entries @@ -3753,9 +4283,9 @@ Other parameters are passed through a pointer to a apiGetWebhookActivationLogsRe 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **integrationRequestUuid** | **string** | Filter results by integration request UUID. | **webhookId** | **float32** | Filter results by Webhook. | **applicationId** | **float32** | Filter results by Application ID. | @@ -3765,11 +4295,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20028**](inline_response_200_28.md) +[**InlineResponse20034**](inline_response_200_34.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3783,7 +4313,7 @@ Name | Type | Description | Notes ## GetWebhookLogs -> InlineResponse20029 GetWebhookLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Status(status).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).RequestUuid(requestUuid).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> InlineResponse20035 GetWebhookLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Status(status).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).RequestUuid(requestUuid).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() List webhook log entries @@ -3800,9 +4330,9 @@ Other parameters are passed through a pointer to a apiGetWebhookLogsRequest stru 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **status** | **string** | Filter results by HTTP status codes. | **webhookId** | **float32** | Filter results by Webhook. | **applicationId** | **float32** | Filter results by Application ID. | @@ -3813,11 +4343,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20029**](inline_response_200_29.md) +[**InlineResponse20035**](inline_response_200_35.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3831,7 +4361,7 @@ Name | Type | Description | Notes ## GetWebhooks -> InlineResponse20027 GetWebhooks(ctx).ApplicationIds(applicationIds).Sort(sort).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20033 GetWebhooks(ctx).ApplicationIds(applicationIds).Sort(sort).PageSize(pageSize).Skip(skip).Execute() List webhooks @@ -3848,18 +4378,18 @@ Other parameters are passed through a pointer to a apiGetWebhooksRequest struct 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. | + **applicationIds** | **string** | Filter by one or more application IDs separated by a comma. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **skip** | **int32** | Skips the given number of items when paging through large result sets. | ### Return type -[**InlineResponse20027**](inline_response_200_27.md) +[**InlineResponse20033**](inline_response_200_33.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3885,7 +4415,7 @@ Import data in existing account-level collection 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -3903,7 +4433,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3929,7 +4459,7 @@ Import allowed values for attribute Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**attributeId** | **int32** | | +**attributeId** | **int32** | The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. | ### Other Parameters @@ -3947,7 +4477,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -3975,7 +4505,7 @@ 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -3995,7 +4525,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4041,7 +4571,51 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **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) + + +## ImportLoyaltyCards + +> Import ImportLoyaltyCards(ctx, loyaltyProgramId).UpFile(upFile).Execute() + +Import loyalty cards + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportLoyaltyCardsRequest 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 + +[**Import**](Import.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4067,7 +4641,7 @@ Import loyalty points 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). | +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | ### Other Parameters @@ -4085,7 +4659,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4111,7 +4685,7 @@ Import giveaway codes into a giveaway pool Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**poolId** | **int32** | | +**poolId** | **int32** | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. | ### Other Parameters @@ -4129,7 +4703,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4175,7 +4749,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4189,7 +4763,7 @@ Name | Type | Description | Notes ## ListAccountCollections -> InlineResponse20010 ListAccountCollections(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() +> InlineResponse20015 ListAccountCollections(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() List collections in account @@ -4206,19 +4780,19 @@ Other parameters are passed through a pointer to a apiListAccountCollectionsRequ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 -[**InlineResponse20010**](inline_response_200_10.md) +[**InlineResponse20015**](inline_response_200_15.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4232,7 +4806,7 @@ Name | Type | Description | Notes ## ListCollections -> InlineResponse20012 ListCollections(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() +> InlineResponse20017 ListCollections(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() List collections @@ -4256,19 +4830,19 @@ 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 -[**InlineResponse20012**](inline_response_200_12.md) +[**InlineResponse20017**](inline_response_200_17.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4282,7 +4856,7 @@ Name | Type | Description | Notes ## ListCollectionsInApplication -> InlineResponse20012 ListCollectionsInApplication(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() +> InlineResponse20017 ListCollectionsInApplication(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Name(name).Execute() List collections in application @@ -4304,19 +4878,19 @@ Other parameters are passed through a pointer to a apiListCollectionsInApplicati 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. | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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 -[**InlineResponse20012**](inline_response_200_12.md) +[**InlineResponse20017**](inline_response_200_17.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4328,11 +4902,99 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## PostAddedDeductedPointsNotification + +> BaseNotification PostAddedDeductedPointsNotification(ctx, loyaltyProgramId).Body(body).Execute() + +Create notification about added or deducted loyalty points + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPostAddedDeductedPointsNotificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**NewBaseNotification**](NewBaseNotification.md) | body | + +### Return type + +[**BaseNotification**](BaseNotification.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## PostCatalogsStrikethroughNotification + +> BaseNotification PostCatalogsStrikethroughNotification(ctx, applicationId).Body(body).Execute() + +Create strikethrough notification + + + +### 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 apiPostCatalogsStrikethroughNotificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**NewBaseNotification**](NewBaseNotification.md) | body | + +### Return type + +[**BaseNotification**](BaseNotification.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + ## RemoveLoyaltyPoints > RemoveLoyaltyPoints(ctx, loyaltyProgramId, integrationId).Body(body).Execute() -Deduct points in loyalty program for given customer +Deduct points from customer profile @@ -4354,7 +5016,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**LoyaltyPoints**](LoyaltyPoints.md) | | + **body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md) | body | ### Return type @@ -4362,7 +5024,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4393,7 +5055,7 @@ Other parameters are passed through a pointer to a apiResetPasswordRequest struc Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewPassword**](NewPassword.md) | | + **body** | [**NewPassword**](NewPassword.md) | body | ### Return type @@ -4401,7 +5063,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4415,7 +5077,7 @@ Name | Type | Description | Notes ## SearchCouponsAdvancedApplicationWideWithoutTotalCount -> InlineResponse2007 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() +> InlineResponse2008 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 (without total count) @@ -4437,16 +5099,16 @@ Other parameters are passed through a pointer to a apiSearchCouponsAdvancedAppli Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **map[string]interface{}** | | - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **body** | **map[string]interface{}** | body | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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. | + **referralId** | **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming 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] @@ -4454,11 +5116,11 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2007**](inline_response_200_7.md) +[**InlineResponse2008**](inline_response_200_8.md) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4472,7 +5134,7 @@ Name | Type | Description | Notes ## SearchCouponsAdvancedWithoutTotalCount -> InlineResponse2007 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() +> InlineResponse2008 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 in campaign (without total count) @@ -4496,27 +5158,73 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **map[string]interface{}** | | - **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **body** | **map[string]interface{}** | body | + **pageSize** | **int32** | The number of items in this response. | [default to 1000] **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. | + **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **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. | + **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration 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. | + **referralId** | **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming 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 -[**InlineResponse2007**](inline_response_200_7.md) +[**InlineResponse2008**](inline_response_200_8.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + +## TransferLoyaltyCard + +> TransferLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId).Body(body).Execute() + +Transfer card data + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTransferLoyaltyCardRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **body** | [**TransferLoyaltyCard**](TransferLoyaltyCard.md) | body | + +### Return type + + (empty response body) ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4542,7 +5250,7 @@ Update account-level collection 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -4552,7 +5260,7 @@ Other parameters are passed through a pointer to a apiUpdateAccountCollectionReq Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UpdateCollection**](UpdateCollection.md) | | + **body** | [**UpdateCollection**](UpdateCollection.md) | body | ### Return type @@ -4560,7 +5268,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4586,7 +5294,7 @@ Update additional cost Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**additionalCostId** | **int32** | | +**additionalCostId** | **int32** | The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**. | ### Other Parameters @@ -4596,7 +5304,7 @@ Other parameters are passed through a pointer to a apiUpdateAdditionalCostReques Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAdditionalCost**](NewAdditionalCost.md) | | + **body** | [**NewAdditionalCost**](NewAdditionalCost.md) | body | ### Return type @@ -4604,7 +5312,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4630,7 +5338,7 @@ Update custom attribute Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**attributeId** | **int32** | | +**attributeId** | **int32** | The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. | ### Other Parameters @@ -4640,7 +5348,7 @@ Other parameters are passed through a pointer to a apiUpdateAttributeRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewAttribute**](NewAttribute.md) | | + **body** | [**NewAttribute**](NewAttribute.md) | body | ### Return type @@ -4648,7 +5356,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4686,7 +5394,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UpdateCampaign**](UpdateCampaign.md) | | + **body** | [**UpdateCampaign**](UpdateCampaign.md) | body | ### Return type @@ -4694,7 +5402,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4722,7 +5430,7 @@ 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). | +**collectionId** | **int32** | The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint. | ### Other Parameters @@ -4734,7 +5442,7 @@ Name | Type | Description | Notes - **body** | [**UpdateCampaignCollection**](UpdateCampaignCollection.md) | | + **body** | [**UpdateCampaignCollection**](UpdateCampaignCollection.md) | body | ### Return type @@ -4742,7 +5450,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4770,7 +5478,7 @@ 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. | -**couponId** | **string** | The ID of the coupon code to update | +**couponId** | **string** | The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response. | ### Other Parameters @@ -4782,7 +5490,7 @@ Name | Type | Description | Notes - **body** | [**UpdateCoupon**](UpdateCoupon.md) | | + **body** | [**UpdateCoupon**](UpdateCoupon.md) | body | ### Return type @@ -4790,7 +5498,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4828,7 +5536,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UpdateCouponBatch**](UpdateCouponBatch.md) | | + **body** | [**UpdateCouponBatch**](UpdateCouponBatch.md) | body | ### Return type @@ -4836,7 +5544,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4848,11 +5556,57 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## UpdateLoyaltyCard + +> LoyaltyCard UpdateLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId).Body(body).Execute() + +Update loyalty card status + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +**loyaltyCardId** | **string** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLoyaltyCardRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **body** | [**UpdateLoyaltyCard**](UpdateLoyaltyCard.md) | body | + +### Return type + +[**LoyaltyCard**](LoyaltyCard.md) + +### Authorization + +[management_key](../README.md#management_key), [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) + + ## UpdateNotificationWebhook > NotificationWebhook UpdateNotificationWebhook(ctx, applicationId, notificationWebhookId).Body(body).Execute() -Update notification webhook +Update notification about campaign-related changes @@ -4863,7 +5617,7 @@ 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** | | +**notificationWebhookId** | **int32** | The ID of the webhook. Get it with the appropriate _List notifications_ endpoint. | ### Other Parameters @@ -4874,7 +5628,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | | + **body** | [**NewNotificationWebhook**](NewNotificationWebhook.md) | body | ### Return type @@ -4882,7 +5636,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers @@ -4910,7 +5664,7 @@ 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. | -**referralId** | **string** | The ID of the referral code to delete | +**referralId** | **string** | The ID of the referral code. | ### Other Parameters @@ -4922,7 +5676,7 @@ Name | Type | Description | Notes - **body** | [**UpdateReferral**](UpdateReferral.md) | | + **body** | [**UpdateReferral**](UpdateReferral.md) | body | ### Return type @@ -4930,7 +5684,7 @@ Name | Type | Description | Notes ### Authorization -[manager_auth](../README.md#manager_auth) +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) ### HTTP request headers diff --git a/docs/ManagementKey.md b/docs/ManagementKey.md index e91f5e17..c88220c7 100644 --- a/docs/ManagementKey.md +++ b/docs/ManagementKey.md @@ -7,6 +7,7 @@ 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 | +**AllowedApplicationIds** | Pointer to **[]int32** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. | [optional] **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. | @@ -89,6 +90,31 @@ HasEndpoints returns a boolean if a field has been set. SetEndpoints gets a reference to the given []Endpoint and assigns it to the Endpoints field. +### GetAllowedApplicationIds + +`func (o *ManagementKey) GetAllowedApplicationIds() []int32` + +GetAllowedApplicationIds returns the AllowedApplicationIds field if non-nil, zero value otherwise. + +### GetAllowedApplicationIdsOk + +`func (o *ManagementKey) GetAllowedApplicationIdsOk() ([]int32, bool)` + +GetAllowedApplicationIdsOk returns a tuple with the AllowedApplicationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAllowedApplicationIds + +`func (o *ManagementKey) HasAllowedApplicationIds() bool` + +HasAllowedApplicationIds returns a boolean if a field has been set. + +### SetAllowedApplicationIds + +`func (o *ManagementKey) SetAllowedApplicationIds(v []int32)` + +SetAllowedApplicationIds gets a reference to the given []int32 and assigns it to the AllowedApplicationIds field. + ### GetId `func (o *ManagementKey) GetId() int32` diff --git a/docs/MultiApplicationEntity.md b/docs/MultiApplicationEntity.md index bac44847..089c2bcf 100644 --- a/docs/MultiApplicationEntity.md +++ b/docs/MultiApplicationEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | +**ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. | ## Methods diff --git a/docs/MultipleAudiencesItem.md b/docs/MultipleAudiencesItem.md index b0e82173..c2b80bea 100644 --- a/docs/MultipleAudiencesItem.md +++ b/docs/MultipleAudiencesItem.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/MultipleCustomerProfileIntegrationRequestItem.md b/docs/MultipleCustomerProfileIntegrationRequestItem.md index 98949f60..9b48cf3b 100644 --- a/docs/MultipleCustomerProfileIntegrationRequestItem.md +++ b/docs/MultipleCustomerProfileIntegrationRequestItem.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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). | +**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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2). | ## Methods diff --git a/docs/MultipleCustomerProfileIntegrationResponseV2.md b/docs/MultipleCustomerProfileIntegrationResponseV2.md index 2b3f8e15..dbd9579d 100644 --- a/docs/MultipleCustomerProfileIntegrationResponseV2.md +++ b/docs/MultipleCustomerProfileIntegrationResponseV2.md @@ -4,19 +4,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationStates** | Pointer to [**[]IntegrationStateV2**](IntegrationStateV2.md) | | [optional] +**IntegrationStates** | Pointer to [**[]CustomerProfileUpdateV2Response**](CustomerProfileUpdateV2Response.md) | | [optional] ## Methods ### GetIntegrationStates -`func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() []IntegrationStateV2` +`func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() []CustomerProfileUpdateV2Response` GetIntegrationStates returns the IntegrationStates field if non-nil, zero value otherwise. ### GetIntegrationStatesOk -`func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStatesOk() ([]IntegrationStateV2, bool)` +`func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStatesOk() ([]CustomerProfileUpdateV2Response, bool)` GetIntegrationStatesOk returns a tuple with the IntegrationStates field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -29,9 +29,9 @@ HasIntegrationStates returns a boolean if a field has been set. ### SetIntegrationStates -`func (o *MultipleCustomerProfileIntegrationResponseV2) SetIntegrationStates(v []IntegrationStateV2)` +`func (o *MultipleCustomerProfileIntegrationResponseV2) SetIntegrationStates(v []CustomerProfileUpdateV2Response)` -SetIntegrationStates gets a reference to the given []IntegrationStateV2 and assigns it to the IntegrationStates field. +SetIntegrationStates gets a reference to the given []CustomerProfileUpdateV2Response and assigns it to the IntegrationStates 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/MutableEntity.md b/docs/MutableEntity.md index aeb8f7d3..d36c7c94 100644 --- a/docs/MutableEntity.md +++ b/docs/MutableEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | ## Methods diff --git a/docs/NewAdditionalCost.md b/docs/NewAdditionalCost.md index c3edbae2..e3693d4a 100644 --- a/docs/NewAdditionalCost.md +++ b/docs/NewAdditionalCost.md @@ -4,11 +4,11 @@ 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. | +**Name** | Pointer to **string** | The internal name used in API requests. | **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] -**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] +**Type** | Pointer to **string** | The type of additional cost. Possible value: - `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 diff --git a/docs/NewApplication.md b/docs/NewApplication.md index e307ce80..ebe07f46 100644 --- a/docs/NewApplication.md +++ b/docs/NewApplication.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **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] +**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#flattening). | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [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] diff --git a/docs/NewAudience.md b/docs/NewAudience.md index 2b930658..322886f0 100644 --- a/docs/NewAudience.md +++ b/docs/NewAudience.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **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] +**LastUpdate** | Pointer to [**time.Time**](time.Time.md) | The last time that the audience memberships changed. | [optional] ## Methods @@ -163,6 +164,31 @@ HasCreatedIn3rdParty returns a boolean if a field has been set. SetCreatedIn3rdParty gets a reference to the given bool and assigns it to the CreatedIn3rdParty field. +### GetLastUpdate + +`func (o *NewAudience) GetLastUpdate() time.Time` + +GetLastUpdate returns the LastUpdate field if non-nil, zero value otherwise. + +### GetLastUpdateOk + +`func (o *NewAudience) GetLastUpdateOk() (time.Time, bool)` + +GetLastUpdateOk returns a tuple with the LastUpdate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLastUpdate + +`func (o *NewAudience) HasLastUpdate() bool` + +HasLastUpdate returns a boolean if a field has been set. + +### SetLastUpdate + +`func (o *NewAudience) SetLastUpdate(v time.Time)` + +SetLastUpdate gets a reference to the given time.Time and assigns it to the LastUpdate 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/NewBaseNotification.md b/docs/NewBaseNotification.md new file mode 100644 index 00000000..5b455423 --- /dev/null +++ b/docs/NewBaseNotification.md @@ -0,0 +1,65 @@ +# NewBaseNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**map[string]interface{}**](.md) | | +**Webhook** | Pointer to [**NewNotificationWebhook**](NewNotificationWebhook.md) | | + +## Methods + +### GetPolicy + +`func (o *NewBaseNotification) GetPolicy() map[string]interface{}` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *NewBaseNotification) GetPolicyOk() (map[string]interface{}, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPolicy + +`func (o *NewBaseNotification) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### SetPolicy + +`func (o *NewBaseNotification) SetPolicy(v map[string]interface{})` + +SetPolicy gets a reference to the given map[string]interface{} and assigns it to the Policy field. + +### GetWebhook + +`func (o *NewBaseNotification) GetWebhook() NewNotificationWebhook` + +GetWebhook returns the Webhook field if non-nil, zero value otherwise. + +### GetWebhookOk + +`func (o *NewBaseNotification) GetWebhookOk() (NewNotificationWebhook, bool)` + +GetWebhookOk returns a tuple with the Webhook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasWebhook + +`func (o *NewBaseNotification) HasWebhook() bool` + +HasWebhook returns a boolean if a field has been set. + +### SetWebhook + +`func (o *NewBaseNotification) SetWebhook(v NewNotificationWebhook)` + +SetWebhook gets a reference to the given NewNotificationWebhook and assigns it to the Webhook 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 69c4d480..030b6766 100644 --- a/docs/NewCampaign.md +++ b/docs/NewCampaign.md @@ -10,13 +10,13 @@ Name | Type | Description | Notes **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] **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](https://docs.talon.one/management-api/#operation/getRulesets) 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** | 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 [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] +**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/NewCampaignTemplate.md b/docs/NewCampaignTemplate.md index 2b708146..7463e0f7 100644 --- a/docs/NewCampaignTemplate.md +++ b/docs/NewCampaignTemplate.md @@ -7,17 +7,17 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | The campaign template name. | **Description** | Pointer to **string** | Customer-facing text that explains the objective of the template. | **Instructions** | Pointer to **string** | Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. | -**CampaignAttributes** | Pointer to [**map[string]interface{}**](.md) | The Campaign Attributes that Campaigns created from this template will have by default. | [optional] -**CouponAttributes** | Pointer to [**map[string]interface{}**](.md) | The Campaign Attributes that Coupons created from this template will have by default. | [optional] +**CampaignAttributes** | Pointer to [**map[string]interface{}**](.md) | The campaign attributes that campaigns created from this template will have by default. | [optional] +**CouponAttributes** | Pointer to [**map[string]interface{}**](.md) | The campaign attributes that coupons created from this template will have by default. | [optional] **State** | Pointer to **string** | Only Campaign Templates in 'available' state may be used to create Campaigns. | **Tags** | Pointer to **[]string** | A list of tags for the campaign template. | [optional] **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] -**TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | Template parameters are fields which can be used to replace values in a rule. | [optional] +**TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | 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] +**DefaultCampaignGroupId** | Pointer to **int32** | The default campaign group ID. | [optional] ## Methods diff --git a/docs/NewCouponCreationJob.md b/docs/NewCouponCreationJob.md index d6c9e89b..ab83abe2 100644 --- a/docs/NewCouponCreationJob.md +++ b/docs/NewCouponCreationJob.md @@ -5,10 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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. | +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons. | @@ -64,6 +65,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *NewCouponCreationJob) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *NewCouponCreationJob) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *NewCouponCreationJob) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *NewCouponCreationJob) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *NewCouponCreationJob) GetStartDate() time.Time` diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md index a08401fe..d2ae5289 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -5,16 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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** | **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] +**UniquePrefix** | Pointer to **string** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint. | [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] +**IsReservationMandatory** | Pointer to **bool** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] ## Methods @@ -68,6 +70,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *NewCoupons) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *NewCoupons) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *NewCoupons) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *NewCoupons) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *NewCoupons) GetStartDate() time.Time` @@ -293,6 +320,31 @@ HasCouponPattern returns a boolean if a field has been set. SetCouponPattern gets a reference to the given string and assigns it to the CouponPattern field. +### GetIsReservationMandatory + +`func (o *NewCoupons) GetIsReservationMandatory() bool` + +GetIsReservationMandatory returns the IsReservationMandatory field if non-nil, zero value otherwise. + +### GetIsReservationMandatoryOk + +`func (o *NewCoupons) GetIsReservationMandatoryOk() (bool, bool)` + +GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsReservationMandatory + +`func (o *NewCoupons) HasIsReservationMandatory() bool` + +HasIsReservationMandatory returns a boolean if a field has been set. + +### SetIsReservationMandatory + +`func (o *NewCoupons) SetIsReservationMandatory(v bool)` + +SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory 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/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md index 07a992ab..c344435e 100644 --- a/docs/NewCouponsForMultipleRecipients.md +++ b/docs/NewCouponsForMultipleRecipients.md @@ -5,9 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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** | 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] @@ -65,6 +66,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *NewCouponsForMultipleRecipients) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *NewCouponsForMultipleRecipients) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *NewCouponsForMultipleRecipients) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *NewCouponsForMultipleRecipients) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *NewCouponsForMultipleRecipients) GetStartDate() time.Time` diff --git a/docs/NewCustomEffect.md b/docs/NewCustomEffect.md index 42529b52..72db29c5 100644 --- a/docs/NewCustomEffect.md +++ b/docs/NewCustomEffect.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | +**ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. | +**IsPerItem** | Pointer to **bool** | Indicates if this effect is per item or not. | [optional] **Name** | Pointer to **string** | The name of this effect. | **Title** | Pointer to **string** | The title of this effect. | **Payload** | Pointer to **string** | The JSON payload of this effect. | @@ -39,6 +40,31 @@ HasApplicationIds returns a boolean if a field has been set. SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds field. +### GetIsPerItem + +`func (o *NewCustomEffect) GetIsPerItem() bool` + +GetIsPerItem returns the IsPerItem field if non-nil, zero value otherwise. + +### GetIsPerItemOk + +`func (o *NewCustomEffect) GetIsPerItemOk() (bool, bool)` + +GetIsPerItemOk returns a tuple with the IsPerItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsPerItem + +`func (o *NewCustomEffect) HasIsPerItem() bool` + +HasIsPerItem returns a boolean if a field has been set. + +### SetIsPerItem + +`func (o *NewCustomEffect) SetIsPerItem(v bool)` + +SetIsPerItem gets a reference to the given bool and assigns it to the IsPerItem field. + ### GetName `func (o *NewCustomEffect) GetName() string` diff --git a/docs/NewCustomerSession.md b/docs/NewCustomerSession.md index 6fe3cb4f..00be09de 100644 --- a/docs/NewCustomerSession.md +++ b/docs/NewCustomerSession.md @@ -7,9 +7,9 @@ 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] **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`. 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] +**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](https://docs.talon.one/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. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). | [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 78e791ba..10b0ebe3 100644 --- a/docs/NewCustomerSessionV2.md +++ b/docs/NewCustomerSessionV2.md @@ -5,13 +5,14 @@ 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] +**EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [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] +**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)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/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] +**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**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). | [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 @@ -41,6 +42,31 @@ HasProfileId returns a boolean if a field has been set. SetProfileId gets a reference to the given string and assigns it to the ProfileId field. +### GetEvaluableCampaignIds + +`func (o *NewCustomerSessionV2) GetEvaluableCampaignIds() []int32` + +GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise. + +### GetEvaluableCampaignIdsOk + +`func (o *NewCustomerSessionV2) GetEvaluableCampaignIdsOk() ([]int32, bool)` + +GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluableCampaignIds + +`func (o *NewCustomerSessionV2) HasEvaluableCampaignIds() bool` + +HasEvaluableCampaignIds returns a boolean if a field has been set. + +### SetEvaluableCampaignIds + +`func (o *NewCustomerSessionV2) SetEvaluableCampaignIds(v []int32)` + +SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. + ### GetCouponCodes `func (o *NewCustomerSessionV2) GetCouponCodes() []string` diff --git a/docs/NewEventType.md b/docs/NewEventType.md index 8eddb1b7..ccac0c9d 100644 --- a/docs/NewEventType.md +++ b/docs/NewEventType.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. | [optional] +**Title** | Pointer to **string** | The human-friendly name for this event type. | +**Name** | Pointer to **string** | The integration 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** | A description of what the event represents. | [optional] ## Methods diff --git a/docs/NewGiveawaysPool.md b/docs/NewGiveawaysPool.md index 9d15d190..20c1ea42 100644 --- a/docs/NewGiveawaysPool.md +++ b/docs/NewGiveawaysPool.md @@ -7,6 +7,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] +**Sandbox** | Pointer to **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | ## Methods @@ -85,6 +86,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. +### GetSandbox + +`func (o *NewGiveawaysPool) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *NewGiveawaysPool) 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 *NewGiveawaysPool) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *NewGiveawaysPool) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox 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 9376329b..7708dd2a 100644 --- a/docs/NewInvitation.md +++ b/docs/NewInvitation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | Name of the user being invited. | [optional] **Email** | Pointer to **string** | | -**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}` | +**Acl** | Pointer to **string** | The `Access Control List` json defining the role of the user. This represents the 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 5d1242b6..79ac1691 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -7,10 +7,11 @@ Name | Type | Description | Notes **Title** | Pointer to **string** | The display title for the Loyalty Program. | **Description** | Pointer to **string** | Description of our Loyalty Program. | [optional] **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'. | +**DefaultValidity** | Pointer to **string** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | +**DefaultPending** | Pointer to **string** | The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | **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] +**Sandbox** | Pointer to **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | **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] **Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | @@ -193,6 +194,31 @@ HasUsersPerCardLimit returns a boolean if a field has been set. SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +### GetSandbox + +`func (o *NewLoyaltyProgram) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *NewLoyaltyProgram) 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 *NewLoyaltyProgram) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *NewLoyaltyProgram) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetName `func (o *NewLoyaltyProgram) GetName() string` diff --git a/docs/NewManagementKey.md b/docs/NewManagementKey.md index 479a8425..56f0fd06 100644 --- a/docs/NewManagementKey.md +++ b/docs/NewManagementKey.md @@ -7,6 +7,7 @@ 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 | +**AllowedApplicationIds** | Pointer to **[]int32** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. | [optional] **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. | @@ -90,6 +91,31 @@ HasEndpoints returns a boolean if a field has been set. SetEndpoints gets a reference to the given []Endpoint and assigns it to the Endpoints field. +### GetAllowedApplicationIds + +`func (o *NewManagementKey) GetAllowedApplicationIds() []int32` + +GetAllowedApplicationIds returns the AllowedApplicationIds field if non-nil, zero value otherwise. + +### GetAllowedApplicationIdsOk + +`func (o *NewManagementKey) GetAllowedApplicationIdsOk() ([]int32, bool)` + +GetAllowedApplicationIdsOk returns a tuple with the AllowedApplicationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAllowedApplicationIds + +`func (o *NewManagementKey) HasAllowedApplicationIds() bool` + +HasAllowedApplicationIds returns a boolean if a field has been set. + +### SetAllowedApplicationIds + +`func (o *NewManagementKey) SetAllowedApplicationIds(v []int32)` + +SetAllowedApplicationIds gets a reference to the given []int32 and assigns it to the AllowedApplicationIds field. + ### GetId `func (o *NewManagementKey) GetId() int32` diff --git a/docs/NewNotificationWebhook.md b/docs/NewNotificationWebhook.md index 43d9c935..b2f1e913 100644 --- a/docs/NewNotificationWebhook.md +++ b/docs/NewNotificationWebhook.md @@ -4,8 +4,8 @@ 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. | +**Url** | Pointer to **string** | API URL for the given webhook-based notification. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for the given webhook-based notification. | ## Methods diff --git a/docs/NewOutgoingIntegrationWebhook.md b/docs/NewOutgoingIntegrationWebhook.md new file mode 100644 index 00000000..97353926 --- /dev/null +++ b/docs/NewOutgoingIntegrationWebhook.md @@ -0,0 +1,65 @@ +# NewOutgoingIntegrationWebhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Title** | Pointer to **string** | Webhook title. | +**ApplicationIds** | Pointer to **[]int32** | IDs of the Applications to which a webhook must be linked. | + +## Methods + +### GetTitle + +`func (o *NewOutgoingIntegrationWebhook) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *NewOutgoingIntegrationWebhook) GetTitleOk() (string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTitle + +`func (o *NewOutgoingIntegrationWebhook) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *NewOutgoingIntegrationWebhook) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetApplicationIds + +`func (o *NewOutgoingIntegrationWebhook) GetApplicationIds() []int32` + +GetApplicationIds returns the ApplicationIds field if non-nil, zero value otherwise. + +### GetApplicationIdsOk + +`func (o *NewOutgoingIntegrationWebhook) 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 *NewOutgoingIntegrationWebhook) HasApplicationIds() bool` + +HasApplicationIds returns a boolean if a field has been set. + +### SetApplicationIds + +`func (o *NewOutgoingIntegrationWebhook) SetApplicationIds(v []int32)` + +SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds 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/NewPicklist.md b/docs/NewPicklist.md new file mode 100644 index 00000000..43649ca9 --- /dev/null +++ b/docs/NewPicklist.md @@ -0,0 +1,65 @@ +# NewPicklist + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. | +**Values** | Pointer to **[]string** | The list of allowed values provided by this picklist. | + +## Methods + +### GetType + +`func (o *NewPicklist) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NewPicklist) 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 *NewPicklist) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *NewPicklist) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetValues + +`func (o *NewPicklist) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *NewPicklist) GetValuesOk() ([]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValues + +`func (o *NewPicklist) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValues + +`func (o *NewPicklist) SetValues(v []string)` + +SetValues gets a reference to the given []string and assigns it to the Values 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 a8c4f614..ee820b55 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -5,7 +5,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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | [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. | diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md index c5c97cc4..f1df9cae 100644 --- a/docs/NewReferralsForMultipleAdvocates.md +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -5,11 +5,11 @@ 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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** | 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] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this referral code. | [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] diff --git a/docs/NewRole.md b/docs/NewRole.md index 5e980f65..029bb98a 100644 --- a/docs/NewRole.md +++ b/docs/NewRole.md @@ -6,7 +6,7 @@ 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. | +**Acl** | Pointer to **string** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | **Members** | Pointer to **[]int32** | An array of user identifiers. | ## Methods diff --git a/docs/NewRuleset.md b/docs/NewRuleset.md index 8134cb16..a3c87626 100644 --- a/docs/NewRuleset.md +++ b/docs/NewRuleset.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Rules** | Pointer to [**[]Rule**](Rule.md) | Set of rules to apply. | +**StrikethroughRules** | Pointer to [**[]Rule**](Rule.md) | Set of rules to apply for strikethrough. | [optional] **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** | 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] @@ -36,6 +37,31 @@ HasRules returns a boolean if a field has been set. SetRules gets a reference to the given []Rule and assigns it to the Rules field. +### GetStrikethroughRules + +`func (o *NewRuleset) GetStrikethroughRules() []Rule` + +GetStrikethroughRules returns the StrikethroughRules field if non-nil, zero value otherwise. + +### GetStrikethroughRulesOk + +`func (o *NewRuleset) GetStrikethroughRulesOk() ([]Rule, bool)` + +GetStrikethroughRulesOk returns a tuple with the StrikethroughRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStrikethroughRules + +`func (o *NewRuleset) HasStrikethroughRules() bool` + +HasStrikethroughRules returns a boolean if a field has been set. + +### SetStrikethroughRules + +`func (o *NewRuleset) SetStrikethroughRules(v []Rule)` + +SetStrikethroughRules gets a reference to the given []Rule and assigns it to the StrikethroughRules field. + ### GetBindings `func (o *NewRuleset) GetBindings() []Binding` diff --git a/docs/NewTemplateDef.md b/docs/NewTemplateDef.md index 5f6634bf..7fd425e9 100644 --- a/docs/NewTemplateDef.md +++ b/docs/NewTemplateDef.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A short description of the template that will be shown in the rule editor. | [optional] **Help** | Pointer to **string** | Extended help text for the template. | [optional] **Category** | Pointer to **string** | Used for grouping templates in the rule editor sidebar. | -**Expr** | Pointer to [**[]map[string]interface{}**](map[string]interface{}.md) | A Talang expression that contains variable bindings referring to args. | +**Expr** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that contains variable bindings referring to args. | **Args** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | An array of argument definitions. | **Expose** | Pointer to **bool** | A flag to control exposure in Rule Builder. | [optional] [default to false] @@ -116,13 +116,13 @@ SetCategory gets a reference to the given string and assigns it to the Category ### GetExpr -`func (o *NewTemplateDef) GetExpr() []map[string]interface{}` +`func (o *NewTemplateDef) GetExpr() []interface{}` GetExpr returns the Expr field if non-nil, zero value otherwise. ### GetExprOk -`func (o *NewTemplateDef) GetExprOk() ([]map[string]interface{}, bool)` +`func (o *NewTemplateDef) GetExprOk() ([]interface{}, bool)` GetExprOk returns a tuple with the Expr field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -135,9 +135,9 @@ HasExpr returns a boolean if a field has been set. ### SetExpr -`func (o *NewTemplateDef) SetExpr(v []map[string]interface{})` +`func (o *NewTemplateDef) SetExpr(v []interface{})` -SetExpr gets a reference to the given []map[string]interface{} and assigns it to the Expr field. +SetExpr gets a reference to the given []interface{} and assigns it to the Expr field. ### GetArgs diff --git a/docs/NewWebhook.md b/docs/NewWebhook.md index f2b363e3..430c76b1 100644 --- a/docs/NewWebhook.md +++ b/docs/NewWebhook.md @@ -4,14 +4,14 @@ 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. | +**ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. | +**Title** | Pointer to **string** | Name or 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. | +**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. | +**Enabled** | Pointer to **bool** | Enables or disables webhook from showing in the Rule Builder. | ## Methods diff --git a/docs/NotificationWebhook.md b/docs/NotificationWebhook.md index 631aadf9..7d4f13a3 100644 --- a/docs/NotificationWebhook.md +++ b/docs/NotificationWebhook.md @@ -4,12 +4,12 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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. | +**Url** | Pointer to **string** | API URL for the given webhook-based notification. | +**Headers** | Pointer to **[]string** | List of API HTTP headers for the given webhook-based notification. | ## Methods diff --git a/docs/OutgoingIntegrationBrazePolicy.md b/docs/OutgoingIntegrationBrazePolicy.md new file mode 100644 index 00000000..5390498a --- /dev/null +++ b/docs/OutgoingIntegrationBrazePolicy.md @@ -0,0 +1,65 @@ +# OutgoingIntegrationBrazePolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BaseUrl** | Pointer to **string** | The base URL of your Braze deployment. | +**ApiKey** | Pointer to **string** | The API key of your Braze deployment. | + +## Methods + +### GetBaseUrl + +`func (o *OutgoingIntegrationBrazePolicy) GetBaseUrl() string` + +GetBaseUrl returns the BaseUrl field if non-nil, zero value otherwise. + +### GetBaseUrlOk + +`func (o *OutgoingIntegrationBrazePolicy) GetBaseUrlOk() (string, bool)` + +GetBaseUrlOk returns a tuple with the BaseUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBaseUrl + +`func (o *OutgoingIntegrationBrazePolicy) HasBaseUrl() bool` + +HasBaseUrl returns a boolean if a field has been set. + +### SetBaseUrl + +`func (o *OutgoingIntegrationBrazePolicy) SetBaseUrl(v string)` + +SetBaseUrl gets a reference to the given string and assigns it to the BaseUrl field. + +### GetApiKey + +`func (o *OutgoingIntegrationBrazePolicy) GetApiKey() string` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *OutgoingIntegrationBrazePolicy) GetApiKeyOk() (string, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApiKey + +`func (o *OutgoingIntegrationBrazePolicy) HasApiKey() bool` + +HasApiKey returns a boolean if a field has been set. + +### SetApiKey + +`func (o *OutgoingIntegrationBrazePolicy) SetApiKey(v string)` + +SetApiKey gets a reference to the given string and assigns it to the ApiKey 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/OutgoingIntegrationConfiguration.md b/docs/OutgoingIntegrationConfiguration.md new file mode 100644 index 00000000..09e8ea95 --- /dev/null +++ b/docs/OutgoingIntegrationConfiguration.md @@ -0,0 +1,117 @@ +# OutgoingIntegrationConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. | +**AccountId** | Pointer to **int32** | The ID of the account to which this configuration belongs. | +**TypeId** | Pointer to **int32** | The outgoing integration type ID. | +**Policy** | Pointer to [**map[string]interface{}**](.md) | | + +## Methods + +### GetId + +`func (o *OutgoingIntegrationConfiguration) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutgoingIntegrationConfiguration) 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 *OutgoingIntegrationConfiguration) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *OutgoingIntegrationConfiguration) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetAccountId + +`func (o *OutgoingIntegrationConfiguration) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *OutgoingIntegrationConfiguration) 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 *OutgoingIntegrationConfiguration) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *OutgoingIntegrationConfiguration) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetTypeId + +`func (o *OutgoingIntegrationConfiguration) GetTypeId() int32` + +GetTypeId returns the TypeId field if non-nil, zero value otherwise. + +### GetTypeIdOk + +`func (o *OutgoingIntegrationConfiguration) GetTypeIdOk() (int32, bool)` + +GetTypeIdOk returns a tuple with the TypeId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTypeId + +`func (o *OutgoingIntegrationConfiguration) HasTypeId() bool` + +HasTypeId returns a boolean if a field has been set. + +### SetTypeId + +`func (o *OutgoingIntegrationConfiguration) SetTypeId(v int32)` + +SetTypeId gets a reference to the given int32 and assigns it to the TypeId field. + +### GetPolicy + +`func (o *OutgoingIntegrationConfiguration) GetPolicy() map[string]interface{}` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *OutgoingIntegrationConfiguration) GetPolicyOk() (map[string]interface{}, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPolicy + +`func (o *OutgoingIntegrationConfiguration) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### SetPolicy + +`func (o *OutgoingIntegrationConfiguration) SetPolicy(v map[string]interface{})` + +SetPolicy gets a reference to the given map[string]interface{} and assigns it to the Policy 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/OutgoingIntegrationType.md b/docs/OutgoingIntegrationType.md new file mode 100644 index 00000000..70e2eef3 --- /dev/null +++ b/docs/OutgoingIntegrationType.md @@ -0,0 +1,143 @@ +# OutgoingIntegrationType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. | +**Name** | Pointer to **string** | Name of the outgoing integration. | +**Description** | Pointer to **string** | Description of the outgoing integration. | [optional] +**Category** | Pointer to **string** | Category of the outgoing integration. | [optional] +**DocumentationLink** | Pointer to **string** | Http link to the outgoing integration's documentation. | [optional] + +## Methods + +### GetId + +`func (o *OutgoingIntegrationType) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutgoingIntegrationType) 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 *OutgoingIntegrationType) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *OutgoingIntegrationType) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetName + +`func (o *OutgoingIntegrationType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OutgoingIntegrationType) 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 *OutgoingIntegrationType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *OutgoingIntegrationType) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *OutgoingIntegrationType) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutgoingIntegrationType) 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 *OutgoingIntegrationType) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *OutgoingIntegrationType) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetCategory + +`func (o *OutgoingIntegrationType) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *OutgoingIntegrationType) GetCategoryOk() (string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCategory + +`func (o *OutgoingIntegrationType) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategory + +`func (o *OutgoingIntegrationType) SetCategory(v string)` + +SetCategory gets a reference to the given string and assigns it to the Category field. + +### GetDocumentationLink + +`func (o *OutgoingIntegrationType) GetDocumentationLink() string` + +GetDocumentationLink returns the DocumentationLink field if non-nil, zero value otherwise. + +### GetDocumentationLinkOk + +`func (o *OutgoingIntegrationType) GetDocumentationLinkOk() (string, bool)` + +GetDocumentationLinkOk returns a tuple with the DocumentationLink field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDocumentationLink + +`func (o *OutgoingIntegrationType) HasDocumentationLink() bool` + +HasDocumentationLink returns a boolean if a field has been set. + +### SetDocumentationLink + +`func (o *OutgoingIntegrationType) SetDocumentationLink(v string)` + +SetDocumentationLink gets a reference to the given string and assigns it to the DocumentationLink 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/OutgoingIntegrationTypes.md b/docs/OutgoingIntegrationTypes.md new file mode 100644 index 00000000..f60ae40d --- /dev/null +++ b/docs/OutgoingIntegrationTypes.md @@ -0,0 +1,39 @@ +# OutgoingIntegrationTypes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | Pointer to [**[]OutgoingIntegrationType**](OutgoingIntegrationType.md) | List of outgoing integrations. | [optional] + +## Methods + +### GetData + +`func (o *OutgoingIntegrationTypes) GetData() []OutgoingIntegrationType` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *OutgoingIntegrationTypes) GetDataOk() ([]OutgoingIntegrationType, 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 *OutgoingIntegrationTypes) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *OutgoingIntegrationTypes) SetData(v []OutgoingIntegrationType)` + +SetData gets a reference to the given []OutgoingIntegrationType 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/OutgoingIntegrationWebhookTemplate.md b/docs/OutgoingIntegrationWebhookTemplate.md new file mode 100644 index 00000000..0ccbab97 --- /dev/null +++ b/docs/OutgoingIntegrationWebhookTemplate.md @@ -0,0 +1,169 @@ +# OutgoingIntegrationWebhookTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique Id for this entity. | +**IntegrationType** | Pointer to **int32** | Unique Id of outgoing integration type. | +**Title** | Pointer to **string** | Title of the webhook template. | +**Description** | Pointer to **string** | General description for the specific outgoing integration webhook template. | +**Payload** | Pointer to **string** | API payload (supports templating using parameters) for this webhook template. | +**Method** | Pointer to **string** | API method for this webhook. | + +## Methods + +### GetId + +`func (o *OutgoingIntegrationWebhookTemplate) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutgoingIntegrationWebhookTemplate) 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 *OutgoingIntegrationWebhookTemplate) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *OutgoingIntegrationWebhookTemplate) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetIntegrationType + +`func (o *OutgoingIntegrationWebhookTemplate) GetIntegrationType() int32` + +GetIntegrationType returns the IntegrationType field if non-nil, zero value otherwise. + +### GetIntegrationTypeOk + +`func (o *OutgoingIntegrationWebhookTemplate) GetIntegrationTypeOk() (int32, bool)` + +GetIntegrationTypeOk returns a tuple with the IntegrationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationType + +`func (o *OutgoingIntegrationWebhookTemplate) HasIntegrationType() bool` + +HasIntegrationType returns a boolean if a field has been set. + +### SetIntegrationType + +`func (o *OutgoingIntegrationWebhookTemplate) SetIntegrationType(v int32)` + +SetIntegrationType gets a reference to the given int32 and assigns it to the IntegrationType field. + +### GetTitle + +`func (o *OutgoingIntegrationWebhookTemplate) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *OutgoingIntegrationWebhookTemplate) GetTitleOk() (string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTitle + +`func (o *OutgoingIntegrationWebhookTemplate) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *OutgoingIntegrationWebhookTemplate) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetDescription + +`func (o *OutgoingIntegrationWebhookTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutgoingIntegrationWebhookTemplate) 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 *OutgoingIntegrationWebhookTemplate) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *OutgoingIntegrationWebhookTemplate) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetPayload + +`func (o *OutgoingIntegrationWebhookTemplate) GetPayload() string` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *OutgoingIntegrationWebhookTemplate) 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 *OutgoingIntegrationWebhookTemplate) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *OutgoingIntegrationWebhookTemplate) SetPayload(v string)` + +SetPayload gets a reference to the given string and assigns it to the Payload field. + +### GetMethod + +`func (o *OutgoingIntegrationWebhookTemplate) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *OutgoingIntegrationWebhookTemplate) GetMethodOk() (string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMethod + +`func (o *OutgoingIntegrationWebhookTemplate) HasMethod() bool` + +HasMethod returns a boolean if a field has been set. + +### SetMethod + +`func (o *OutgoingIntegrationWebhookTemplate) SetMethod(v string)` + +SetMethod gets a reference to the given string and assigns it to the Method 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/OutgoingIntegrationWebhookTemplates.md b/docs/OutgoingIntegrationWebhookTemplates.md new file mode 100644 index 00000000..98df01d9 --- /dev/null +++ b/docs/OutgoingIntegrationWebhookTemplates.md @@ -0,0 +1,39 @@ +# OutgoingIntegrationWebhookTemplates + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | Pointer to [**[]OutgoingIntegrationWebhookTemplate**](OutgoingIntegrationWebhookTemplate.md) | The list of webhook templates for a given outgoing integration type. | [optional] + +## Methods + +### GetData + +`func (o *OutgoingIntegrationWebhookTemplates) GetData() []OutgoingIntegrationWebhookTemplate` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *OutgoingIntegrationWebhookTemplates) GetDataOk() ([]OutgoingIntegrationWebhookTemplate, 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 *OutgoingIntegrationWebhookTemplates) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *OutgoingIntegrationWebhookTemplates) SetData(v []OutgoingIntegrationWebhookTemplate)` + +SetData gets a reference to the given []OutgoingIntegrationWebhookTemplate 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/Picklist.md b/docs/Picklist.md new file mode 100644 index 00000000..0d780fae --- /dev/null +++ b/docs/Picklist.md @@ -0,0 +1,221 @@ +# Picklist + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Type** | Pointer to **string** | The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. | +**Values** | Pointer to **[]string** | The list of allowed values provided by this picklist. | +**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. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | [optional] +**Imported** | Pointer to **bool** | Imported flag shows that a picklist is imported by a CSV file or not | [optional] + +## Methods + +### GetId + +`func (o *Picklist) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Picklist) 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 *Picklist) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Picklist) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *Picklist) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Picklist) 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 *Picklist) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *Picklist) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetType + +`func (o *Picklist) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Picklist) 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 *Picklist) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *Picklist) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetValues + +`func (o *Picklist) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Picklist) GetValuesOk() ([]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValues + +`func (o *Picklist) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValues + +`func (o *Picklist) SetValues(v []string)` + +SetValues gets a reference to the given []string and assigns it to the Values field. + +### GetModifiedBy + +`func (o *Picklist) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *Picklist) 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 *Picklist) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *Picklist) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *Picklist) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *Picklist) 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 *Picklist) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *Picklist) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetAccountId + +`func (o *Picklist) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Picklist) 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 *Picklist) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *Picklist) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetImported + +`func (o *Picklist) GetImported() bool` + +GetImported returns the Imported field if non-nil, zero value otherwise. + +### GetImportedOk + +`func (o *Picklist) GetImportedOk() (bool, bool)` + +GetImportedOk returns a tuple with the Imported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasImported + +`func (o *Picklist) HasImported() bool` + +HasImported returns a boolean if a field has been set. + +### SetImported + +`func (o *Picklist) SetImported(v bool)` + +SetImported gets a reference to the given bool and assigns it to the Imported 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/PriorityPosition.md b/docs/PriorityPosition.md new file mode 100644 index 00000000..b49b925c --- /dev/null +++ b/docs/PriorityPosition.md @@ -0,0 +1,65 @@ +# PriorityPosition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Set** | Pointer to **string** | The name of the priority set where the campaign is located. | [default to SET_UNIVERSAL] +**Position** | Pointer to **int32** | The position of the campaign in the priority order starting from 1. | + +## Methods + +### GetSet + +`func (o *PriorityPosition) GetSet() string` + +GetSet returns the Set field if non-nil, zero value otherwise. + +### GetSetOk + +`func (o *PriorityPosition) GetSetOk() (string, 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 *PriorityPosition) HasSet() bool` + +HasSet returns a boolean if a field has been set. + +### SetSet + +`func (o *PriorityPosition) SetSet(v string)` + +SetSet gets a reference to the given string and assigns it to the Set field. + +### GetPosition + +`func (o *PriorityPosition) GetPosition() int32` + +GetPosition returns the Position field if non-nil, zero value otherwise. + +### GetPositionOk + +`func (o *PriorityPosition) 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 *PriorityPosition) HasPosition() bool` + +HasPosition returns a boolean if a field has been set. + +### SetPosition + +`func (o *PriorityPosition) SetPosition(v int32)` + +SetPosition gets a reference to the given int32 and assigns it to the Position 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/Referral.md b/docs/Referral.md index 540b0e03..7ef38ec5 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -4,10 +4,10 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | diff --git a/docs/ReferralConstraints.md b/docs/ReferralConstraints.md index 801bba9c..5ead3273 100644 --- a/docs/ReferralConstraints.md +++ b/docs/ReferralConstraints.md @@ -5,7 +5,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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | [optional] ## Methods diff --git a/docs/ReopenSessionResponse.md b/docs/ReopenSessionResponse.md new file mode 100644 index 00000000..30d2752c --- /dev/null +++ b/docs/ReopenSessionResponse.md @@ -0,0 +1,39 @@ +# ReopenSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Effects** | Pointer to [**[]Effect**](Effect.md) | The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | + +## Methods + +### GetEffects + +`func (o *ReopenSessionResponse) GetEffects() []Effect` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *ReopenSessionResponse) 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 *ReopenSessionResponse) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + +### SetEffects + +`func (o *ReopenSessionResponse) 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/ReserveCouponEffectProps.md b/docs/ReserveCouponEffectProps.md new file mode 100644 index 00000000..588df1bb --- /dev/null +++ b/docs/ReserveCouponEffectProps.md @@ -0,0 +1,91 @@ +# ReserveCouponEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CouponValue** | Pointer to **string** | The value of the coupon currently on scope. | +**ProfileIntegrationId** | Pointer to **string** | The ID of this customer profile in the third-party integration. | +**IsNewReservation** | Pointer to **bool** | Indicates whether this is a new coupon reservation or not. | + +## Methods + +### GetCouponValue + +`func (o *ReserveCouponEffectProps) GetCouponValue() string` + +GetCouponValue returns the CouponValue field if non-nil, zero value otherwise. + +### GetCouponValueOk + +`func (o *ReserveCouponEffectProps) GetCouponValueOk() (string, bool)` + +GetCouponValueOk returns a tuple with the CouponValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCouponValue + +`func (o *ReserveCouponEffectProps) HasCouponValue() bool` + +HasCouponValue returns a boolean if a field has been set. + +### SetCouponValue + +`func (o *ReserveCouponEffectProps) SetCouponValue(v string)` + +SetCouponValue gets a reference to the given string and assigns it to the CouponValue field. + +### GetProfileIntegrationId + +`func (o *ReserveCouponEffectProps) GetProfileIntegrationId() string` + +GetProfileIntegrationId returns the ProfileIntegrationId field if non-nil, zero value otherwise. + +### GetProfileIntegrationIdOk + +`func (o *ReserveCouponEffectProps) 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 *ReserveCouponEffectProps) HasProfileIntegrationId() bool` + +HasProfileIntegrationId returns a boolean if a field has been set. + +### SetProfileIntegrationId + +`func (o *ReserveCouponEffectProps) SetProfileIntegrationId(v string)` + +SetProfileIntegrationId gets a reference to the given string and assigns it to the ProfileIntegrationId field. + +### GetIsNewReservation + +`func (o *ReserveCouponEffectProps) GetIsNewReservation() bool` + +GetIsNewReservation returns the IsNewReservation field if non-nil, zero value otherwise. + +### GetIsNewReservationOk + +`func (o *ReserveCouponEffectProps) GetIsNewReservationOk() (bool, bool)` + +GetIsNewReservationOk returns a tuple with the IsNewReservation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsNewReservation + +`func (o *ReserveCouponEffectProps) HasIsNewReservation() bool` + +HasIsNewReservation returns a boolean if a field has been set. + +### SetIsNewReservation + +`func (o *ReserveCouponEffectProps) SetIsNewReservation(v bool)` + +SetIsNewReservation gets a reference to the given bool and assigns it to the IsNewReservation 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 index fae44612..0cb75393 100644 --- a/docs/Return.md +++ b/docs/Return.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | diff --git a/docs/ReturnIntegrationRequest.md b/docs/ReturnIntegrationRequest.md index dc434c0e..723ed5a9 100644 --- a/docs/ReturnIntegrationRequest.md +++ b/docs/ReturnIntegrationRequest.md @@ -5,7 +5,7 @@ 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] +**ResponseContent** | Pointer to **[]string** | Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer session_ request instead of sending extra requests to other endpoints. | [optional] ## Methods diff --git a/docs/ReturnedCartItem.md b/docs/ReturnedCartItem.md index 5923b33f..71275d13 100644 --- a/docs/ReturnedCartItem.md +++ b/docs/ReturnedCartItem.md @@ -5,7 +5,7 @@ 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] +**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#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. | [optional] ## Methods diff --git a/docs/Role.md b/docs/Role.md index 896e64e1..3b39e51c 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. 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this role was created for. | [optional] +**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. | +**Acl** | Pointer to [**map[string]interface{}**](.md) | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | ## Methods diff --git a/docs/RoleV2.md b/docs/RoleV2.md new file mode 100644 index 00000000..9dee08ce --- /dev/null +++ b/docs/RoleV2.md @@ -0,0 +1,143 @@ +# RoleV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the role. | [optional] +**Description** | Pointer to **string** | Description of the role. | [optional] +**IsAdmin** | Pointer to **bool** | Indicates whether the role grants admin permissions. | [optional] +**Permissions** | Pointer to [**RoleV2Permissions**](RoleV2Permissions.md) | | [optional] +**Members** | Pointer to **[]int32** | An array of user identifiers. | [optional] + +## Methods + +### GetName + +`func (o *RoleV2) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleV2) 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 *RoleV2) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *RoleV2) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *RoleV2) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleV2) 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 *RoleV2) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *RoleV2) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetIsAdmin + +`func (o *RoleV2) GetIsAdmin() bool` + +GetIsAdmin returns the IsAdmin field if non-nil, zero value otherwise. + +### GetIsAdminOk + +`func (o *RoleV2) GetIsAdminOk() (bool, bool)` + +GetIsAdminOk returns a tuple with the IsAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsAdmin + +`func (o *RoleV2) HasIsAdmin() bool` + +HasIsAdmin returns a boolean if a field has been set. + +### SetIsAdmin + +`func (o *RoleV2) SetIsAdmin(v bool)` + +SetIsAdmin gets a reference to the given bool and assigns it to the IsAdmin field. + +### GetPermissions + +`func (o *RoleV2) GetPermissions() RoleV2Permissions` + +GetPermissions returns the Permissions field if non-nil, zero value otherwise. + +### GetPermissionsOk + +`func (o *RoleV2) GetPermissionsOk() (RoleV2Permissions, bool)` + +GetPermissionsOk returns a tuple with the Permissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPermissions + +`func (o *RoleV2) HasPermissions() bool` + +HasPermissions returns a boolean if a field has been set. + +### SetPermissions + +`func (o *RoleV2) SetPermissions(v RoleV2Permissions)` + +SetPermissions gets a reference to the given RoleV2Permissions and assigns it to the Permissions field. + +### GetMembers + +`func (o *RoleV2) GetMembers() []int32` + +GetMembers returns the Members field if non-nil, zero value otherwise. + +### GetMembersOk + +`func (o *RoleV2) GetMembersOk() ([]int32, bool)` + +GetMembersOk returns a tuple with the Members field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMembers + +`func (o *RoleV2) HasMembers() bool` + +HasMembers returns a boolean if a field has been set. + +### SetMembers + +`func (o *RoleV2) SetMembers(v []int32)` + +SetMembers gets a reference to the given []int32 and assigns it to the Members 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/RoleV2ApplicationDetails.md b/docs/RoleV2ApplicationDetails.md new file mode 100644 index 00000000..ecabef19 --- /dev/null +++ b/docs/RoleV2ApplicationDetails.md @@ -0,0 +1,91 @@ +# RoleV2ApplicationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | Pointer to **string** | Name of the Application-level permission set. | [optional] +**Campaign** | Pointer to **string** | Name of the campaign-level permission set. | [optional] +**DraftCampaign** | Pointer to **string** | Name of the draft campaign-level permission set. | [optional] + +## Methods + +### GetApplication + +`func (o *RoleV2ApplicationDetails) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *RoleV2ApplicationDetails) GetApplicationOk() (string, 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 *RoleV2ApplicationDetails) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### SetApplication + +`func (o *RoleV2ApplicationDetails) SetApplication(v string)` + +SetApplication gets a reference to the given string and assigns it to the Application field. + +### GetCampaign + +`func (o *RoleV2ApplicationDetails) GetCampaign() string` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *RoleV2ApplicationDetails) GetCampaignOk() (string, 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 *RoleV2ApplicationDetails) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *RoleV2ApplicationDetails) SetCampaign(v string)` + +SetCampaign gets a reference to the given string and assigns it to the Campaign field. + +### GetDraftCampaign + +`func (o *RoleV2ApplicationDetails) GetDraftCampaign() string` + +GetDraftCampaign returns the DraftCampaign field if non-nil, zero value otherwise. + +### GetDraftCampaignOk + +`func (o *RoleV2ApplicationDetails) GetDraftCampaignOk() (string, bool)` + +GetDraftCampaignOk returns a tuple with the DraftCampaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDraftCampaign + +`func (o *RoleV2ApplicationDetails) HasDraftCampaign() bool` + +HasDraftCampaign returns a boolean if a field has been set. + +### SetDraftCampaign + +`func (o *RoleV2ApplicationDetails) SetDraftCampaign(v string)` + +SetDraftCampaign gets a reference to the given string and assigns it to the DraftCampaign 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/RoleV2PermissionSet.md b/docs/RoleV2PermissionSet.md new file mode 100644 index 00000000..dbc7c90a --- /dev/null +++ b/docs/RoleV2PermissionSet.md @@ -0,0 +1,65 @@ +# RoleV2PermissionSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the permission set. | +**OperationIds** | Pointer to **[]string** | | + +## Methods + +### GetName + +`func (o *RoleV2PermissionSet) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleV2PermissionSet) 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 *RoleV2PermissionSet) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *RoleV2PermissionSet) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetOperationIds + +`func (o *RoleV2PermissionSet) GetOperationIds() []string` + +GetOperationIds returns the OperationIds field if non-nil, zero value otherwise. + +### GetOperationIdsOk + +`func (o *RoleV2PermissionSet) GetOperationIdsOk() ([]string, bool)` + +GetOperationIdsOk returns a tuple with the OperationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOperationIds + +`func (o *RoleV2PermissionSet) HasOperationIds() bool` + +HasOperationIds returns a boolean if a field has been set. + +### SetOperationIds + +`func (o *RoleV2PermissionSet) SetOperationIds(v []string)` + +SetOperationIds gets a reference to the given []string and assigns it to the OperationIds 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/RoleV2Permissions.md b/docs/RoleV2Permissions.md new file mode 100644 index 00000000..4d47f5c8 --- /dev/null +++ b/docs/RoleV2Permissions.md @@ -0,0 +1,65 @@ +# RoleV2Permissions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PermissionSets** | Pointer to [**[]RoleV2PermissionSet**](RoleV2PermissionSet.md) | List of grouped operation IDs to use as a reference in the roles section. Each group of operation IDs has a name. | [optional] +**Roles** | Pointer to [**RoleV2PermissionsRoles**](RoleV2Permissions_roles.md) | | [optional] + +## Methods + +### GetPermissionSets + +`func (o *RoleV2Permissions) GetPermissionSets() []RoleV2PermissionSet` + +GetPermissionSets returns the PermissionSets field if non-nil, zero value otherwise. + +### GetPermissionSetsOk + +`func (o *RoleV2Permissions) GetPermissionSetsOk() ([]RoleV2PermissionSet, bool)` + +GetPermissionSetsOk returns a tuple with the PermissionSets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPermissionSets + +`func (o *RoleV2Permissions) HasPermissionSets() bool` + +HasPermissionSets returns a boolean if a field has been set. + +### SetPermissionSets + +`func (o *RoleV2Permissions) SetPermissionSets(v []RoleV2PermissionSet)` + +SetPermissionSets gets a reference to the given []RoleV2PermissionSet and assigns it to the PermissionSets field. + +### GetRoles + +`func (o *RoleV2Permissions) GetRoles() RoleV2PermissionsRoles` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *RoleV2Permissions) GetRolesOk() (RoleV2PermissionsRoles, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRoles + +`func (o *RoleV2Permissions) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### SetRoles + +`func (o *RoleV2Permissions) SetRoles(v RoleV2PermissionsRoles)` + +SetRoles gets a reference to the given RoleV2PermissionsRoles and assigns it to the Roles 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/RoleV2PermissionsRoles.md b/docs/RoleV2PermissionsRoles.md new file mode 100644 index 00000000..112f0a8f --- /dev/null +++ b/docs/RoleV2PermissionsRoles.md @@ -0,0 +1,91 @@ +# RoleV2PermissionsRoles + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Applications** | Pointer to [**map[string]RoleV2ApplicationDetails**](RoleV2ApplicationDetails.md) | | [optional] +**LoyaltyPrograms** | Pointer to **map[string]string** | | [optional] +**CampaignAccessGroups** | Pointer to **map[string]string** | | [optional] + +## Methods + +### GetApplications + +`func (o *RoleV2PermissionsRoles) GetApplications() map[string]RoleV2ApplicationDetails` + +GetApplications returns the Applications field if non-nil, zero value otherwise. + +### GetApplicationsOk + +`func (o *RoleV2PermissionsRoles) GetApplicationsOk() (map[string]RoleV2ApplicationDetails, bool)` + +GetApplicationsOk returns a tuple with the Applications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplications + +`func (o *RoleV2PermissionsRoles) HasApplications() bool` + +HasApplications returns a boolean if a field has been set. + +### SetApplications + +`func (o *RoleV2PermissionsRoles) SetApplications(v map[string]RoleV2ApplicationDetails)` + +SetApplications gets a reference to the given map[string]RoleV2ApplicationDetails and assigns it to the Applications field. + +### GetLoyaltyPrograms + +`func (o *RoleV2PermissionsRoles) GetLoyaltyPrograms() map[string]string` + +GetLoyaltyPrograms returns the LoyaltyPrograms field if non-nil, zero value otherwise. + +### GetLoyaltyProgramsOk + +`func (o *RoleV2PermissionsRoles) GetLoyaltyProgramsOk() (map[string]string, bool)` + +GetLoyaltyProgramsOk returns a tuple with the LoyaltyPrograms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyaltyPrograms + +`func (o *RoleV2PermissionsRoles) HasLoyaltyPrograms() bool` + +HasLoyaltyPrograms returns a boolean if a field has been set. + +### SetLoyaltyPrograms + +`func (o *RoleV2PermissionsRoles) SetLoyaltyPrograms(v map[string]string)` + +SetLoyaltyPrograms gets a reference to the given map[string]string and assigns it to the LoyaltyPrograms field. + +### GetCampaignAccessGroups + +`func (o *RoleV2PermissionsRoles) GetCampaignAccessGroups() map[string]string` + +GetCampaignAccessGroups returns the CampaignAccessGroups field if non-nil, zero value otherwise. + +### GetCampaignAccessGroupsOk + +`func (o *RoleV2PermissionsRoles) GetCampaignAccessGroupsOk() (map[string]string, bool)` + +GetCampaignAccessGroupsOk returns a tuple with the CampaignAccessGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignAccessGroups + +`func (o *RoleV2PermissionsRoles) HasCampaignAccessGroups() bool` + +HasCampaignAccessGroups returns a boolean if a field has been set. + +### SetCampaignAccessGroups + +`func (o *RoleV2PermissionsRoles) SetCampaignAccessGroups(v map[string]string)` + +SetCampaignAccessGroups gets a reference to the given map[string]string and assigns it to the CampaignAccessGroups 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/RollbackAddedLoyaltyPointsEffectProps.md b/docs/RollbackAddedLoyaltyPointsEffectProps.md index 1e9feec8..ca0a680b 100644 --- a/docs/RollbackAddedLoyaltyPointsEffectProps.md +++ b/docs/RollbackAddedLoyaltyPointsEffectProps.md @@ -10,8 +10,8 @@ Name | Type | Description | Notes **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] +**CartItemSubPosition** | Pointer to **float32** | The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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 alphanumeric identifier of the loyalty card. | [optional] ## Methods diff --git a/docs/RollbackDeductedLoyaltyPointsEffectProps.md b/docs/RollbackDeductedLoyaltyPointsEffectProps.md index 86fec337..3b556ad1 100644 --- a/docs/RollbackDeductedLoyaltyPointsEffectProps.md +++ b/docs/RollbackDeductedLoyaltyPointsEffectProps.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **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] +**CardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] ## Methods diff --git a/docs/Rule.md b/docs/Rule.md index f7ce47a7..95a057ad 100644 --- a/docs/Rule.md +++ b/docs/Rule.md @@ -4,14 +4,67 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | A unique identifier for the rule. | [optional] +**ParentId** | Pointer to **string** | The ID of the rule that was copied to create this rule. | [optional] **Title** | Pointer to **string** | A short description of the rule. | **Description** | Pointer to **string** | A longer, more detailed description of the rule. | [optional] **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. | [optional] **Condition** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that will be evaluated in the context of the given event. | + **Effects** | Pointer to [**[][]interface{}**]([][]interface{}].md) | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | ## Methods +### GetId + +`func (o *Rule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Rule) GetIdOk() (string, 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 *Rule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Rule) SetId(v string)` + +SetId gets a reference to the given string and assigns it to the Id field. + +### GetParentId + +`func (o *Rule) GetParentId() string` + +GetParentId returns the ParentId field if non-nil, zero value otherwise. + +### GetParentIdOk + +`func (o *Rule) GetParentIdOk() (string, bool)` + +GetParentIdOk returns a tuple with the ParentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasParentId + +`func (o *Rule) HasParentId() bool` + +HasParentId returns a boolean if a field has been set. + +### SetParentId + +`func (o *Rule) SetParentId(v string)` + +SetParentId gets a reference to the given string and assigns it to the ParentId field. + ### GetTitle `func (o *Rule) GetTitle() string` diff --git a/docs/Ruleset.md b/docs/Ruleset.md index 6cde4ca3..3030a58b 100644 --- a/docs/Ruleset.md +++ b/docs/Ruleset.md @@ -4,10 +4,11 @@ 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. | -**UserId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | **Rules** | Pointer to [**[]Rule**](Rule.md) | Set of rules to apply. | +**StrikethroughRules** | Pointer to [**[]Rule**](Rule.md) | Set of rules to apply for strikethrough. | [optional] **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** | 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] @@ -117,6 +118,31 @@ HasRules returns a boolean if a field has been set. SetRules gets a reference to the given []Rule and assigns it to the Rules field. +### GetStrikethroughRules + +`func (o *Ruleset) GetStrikethroughRules() []Rule` + +GetStrikethroughRules returns the StrikethroughRules field if non-nil, zero value otherwise. + +### GetStrikethroughRulesOk + +`func (o *Ruleset) GetStrikethroughRulesOk() ([]Rule, bool)` + +GetStrikethroughRulesOk returns a tuple with the StrikethroughRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStrikethroughRules + +`func (o *Ruleset) HasStrikethroughRules() bool` + +HasStrikethroughRules returns a boolean if a field has been set. + +### SetStrikethroughRules + +`func (o *Ruleset) SetStrikethroughRules(v []Rule)` + +SetStrikethroughRules gets a reference to the given []Rule and assigns it to the StrikethroughRules field. + ### GetBindings `func (o *Ruleset) GetBindings() []Binding` diff --git a/docs/SamlConnection.md b/docs/SamlConnection.md index 7371892e..3d4b99af 100644 --- a/docs/SamlConnection.md +++ b/docs/SamlConnection.md @@ -13,8 +13,8 @@ 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. 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | ## Methods diff --git a/docs/SetDiscountEffectProps.md b/docs/SetDiscountEffectProps.md index 8ec89105..d3bd7ef5 100644 --- a/docs/SetDiscountEffectProps.md +++ b/docs/SetDiscountEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this discount. | +**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] diff --git a/docs/SetDiscountPerAdditionalCostEffectProps.md b/docs/SetDiscountPerAdditionalCostEffectProps.md index d0d15a01..ab07cbc8 100644 --- a/docs/SetDiscountPerAdditionalCostEffectProps.md +++ b/docs/SetDiscountPerAdditionalCostEffectProps.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this 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. | diff --git a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md index b87939ea..0527885f 100644 --- a/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +++ b/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | The name/description of this discount. | +**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] +**SubPosition** | Pointer to **float32** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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] diff --git a/docs/SetDiscountPerItemEffectProps.md b/docs/SetDiscountPerItemEffectProps.md index 25e576e3..1d1a7c4c 100644 --- a/docs/SetDiscountPerItemEffectProps.md +++ b/docs/SetDiscountPerItemEffectProps.md @@ -7,13 +7,13 @@ Name | Type | Description | Notes **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] +**SubPosition** | Pointer to **float32** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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] +**BundleName** | Pointer to **string** | The name of the bundle definition. | [optional] ## Methods diff --git a/docs/StrikethroughChangedItem.md b/docs/StrikethroughChangedItem.md new file mode 100644 index 00000000..50ed3d89 --- /dev/null +++ b/docs/StrikethroughChangedItem.md @@ -0,0 +1,195 @@ +# StrikethroughChangedItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | The ID of the event that triggered the strikethrough labeling. | +**CatalogId** | Pointer to **int32** | The ID of the catalog that the changed item belongs to. | +**Sku** | Pointer to **string** | The unique SKU of the changed item. | +**Version** | Pointer to **int32** | The version of the changed item. | +**Price** | Pointer to **float32** | The price of the changed item. | +**EvaluatedAt** | Pointer to [**time.Time**](time.Time.md) | The evaluation time of the changed item. | +**Effects** | Pointer to [**[]StrikethroughEffect**](StrikethroughEffect.md) | | [optional] + +## Methods + +### GetId + +`func (o *StrikethroughChangedItem) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *StrikethroughChangedItem) 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 *StrikethroughChangedItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *StrikethroughChangedItem) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCatalogId + +`func (o *StrikethroughChangedItem) GetCatalogId() int32` + +GetCatalogId returns the CatalogId field if non-nil, zero value otherwise. + +### GetCatalogIdOk + +`func (o *StrikethroughChangedItem) 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 *StrikethroughChangedItem) HasCatalogId() bool` + +HasCatalogId returns a boolean if a field has been set. + +### SetCatalogId + +`func (o *StrikethroughChangedItem) SetCatalogId(v int32)` + +SetCatalogId gets a reference to the given int32 and assigns it to the CatalogId field. + +### GetSku + +`func (o *StrikethroughChangedItem) GetSku() string` + +GetSku returns the Sku field if non-nil, zero value otherwise. + +### GetSkuOk + +`func (o *StrikethroughChangedItem) 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 *StrikethroughChangedItem) HasSku() bool` + +HasSku returns a boolean if a field has been set. + +### SetSku + +`func (o *StrikethroughChangedItem) SetSku(v string)` + +SetSku gets a reference to the given string and assigns it to the Sku field. + +### GetVersion + +`func (o *StrikethroughChangedItem) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *StrikethroughChangedItem) 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 *StrikethroughChangedItem) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *StrikethroughChangedItem) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetPrice + +`func (o *StrikethroughChangedItem) GetPrice() float32` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *StrikethroughChangedItem) 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 *StrikethroughChangedItem) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + +### SetPrice + +`func (o *StrikethroughChangedItem) SetPrice(v float32)` + +SetPrice gets a reference to the given float32 and assigns it to the Price field. + +### GetEvaluatedAt + +`func (o *StrikethroughChangedItem) GetEvaluatedAt() time.Time` + +GetEvaluatedAt returns the EvaluatedAt field if non-nil, zero value otherwise. + +### GetEvaluatedAtOk + +`func (o *StrikethroughChangedItem) GetEvaluatedAtOk() (time.Time, bool)` + +GetEvaluatedAtOk returns a tuple with the EvaluatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluatedAt + +`func (o *StrikethroughChangedItem) HasEvaluatedAt() bool` + +HasEvaluatedAt returns a boolean if a field has been set. + +### SetEvaluatedAt + +`func (o *StrikethroughChangedItem) SetEvaluatedAt(v time.Time)` + +SetEvaluatedAt gets a reference to the given time.Time and assigns it to the EvaluatedAt field. + +### GetEffects + +`func (o *StrikethroughChangedItem) GetEffects() []StrikethroughEffect` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *StrikethroughChangedItem) GetEffectsOk() ([]StrikethroughEffect, 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 *StrikethroughChangedItem) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + +### SetEffects + +`func (o *StrikethroughChangedItem) SetEffects(v []StrikethroughEffect)` + +SetEffects gets a reference to the given []StrikethroughEffect 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/StrikethroughCustomEffectPerItemProps.md b/docs/StrikethroughCustomEffectPerItemProps.md new file mode 100644 index 00000000..e9363aa1 --- /dev/null +++ b/docs/StrikethroughCustomEffectPerItemProps.md @@ -0,0 +1,91 @@ +# StrikethroughCustomEffectPerItemProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EffectId** | Pointer to **int32** | ID of the effect. | +**Name** | Pointer to **string** | The type of the custom effect. | +**Payload** | Pointer to [**map[string]interface{}**](.md) | The JSON payload of the custom effect. | + +## Methods + +### GetEffectId + +`func (o *StrikethroughCustomEffectPerItemProps) GetEffectId() int32` + +GetEffectId returns the EffectId field if non-nil, zero value otherwise. + +### GetEffectIdOk + +`func (o *StrikethroughCustomEffectPerItemProps) GetEffectIdOk() (int32, bool)` + +GetEffectIdOk returns a tuple with the EffectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEffectId + +`func (o *StrikethroughCustomEffectPerItemProps) HasEffectId() bool` + +HasEffectId returns a boolean if a field has been set. + +### SetEffectId + +`func (o *StrikethroughCustomEffectPerItemProps) SetEffectId(v int32)` + +SetEffectId gets a reference to the given int32 and assigns it to the EffectId field. + +### GetName + +`func (o *StrikethroughCustomEffectPerItemProps) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *StrikethroughCustomEffectPerItemProps) 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 *StrikethroughCustomEffectPerItemProps) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *StrikethroughCustomEffectPerItemProps) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetPayload + +`func (o *StrikethroughCustomEffectPerItemProps) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *StrikethroughCustomEffectPerItemProps) 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 *StrikethroughCustomEffectPerItemProps) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *StrikethroughCustomEffectPerItemProps) 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/StrikethroughEffect.md b/docs/StrikethroughEffect.md new file mode 100644 index 00000000..4c4dfaad --- /dev/null +++ b/docs/StrikethroughEffect.md @@ -0,0 +1,169 @@ +# StrikethroughEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignId** | Pointer to **int32** | The ID of the campaign that effect belongs to. | +**RulesetId** | Pointer to **int32** | The ID of the ruleset containing the rule that triggered this effect. | +**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. | +**Type** | Pointer to **string** | The type of this effect. | +**Props** | Pointer to [**map[string]interface{}**](.md) | | + +## Methods + +### GetCampaignId + +`func (o *StrikethroughEffect) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *StrikethroughEffect) 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 *StrikethroughEffect) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *StrikethroughEffect) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetRulesetId + +`func (o *StrikethroughEffect) GetRulesetId() int32` + +GetRulesetId returns the RulesetId field if non-nil, zero value otherwise. + +### GetRulesetIdOk + +`func (o *StrikethroughEffect) 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 *StrikethroughEffect) HasRulesetId() bool` + +HasRulesetId returns a boolean if a field has been set. + +### SetRulesetId + +`func (o *StrikethroughEffect) SetRulesetId(v int32)` + +SetRulesetId gets a reference to the given int32 and assigns it to the RulesetId field. + +### GetRuleIndex + +`func (o *StrikethroughEffect) GetRuleIndex() int32` + +GetRuleIndex returns the RuleIndex field if non-nil, zero value otherwise. + +### GetRuleIndexOk + +`func (o *StrikethroughEffect) GetRuleIndexOk() (int32, bool)` + +GetRuleIndexOk returns a tuple with the RuleIndex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRuleIndex + +`func (o *StrikethroughEffect) HasRuleIndex() bool` + +HasRuleIndex returns a boolean if a field has been set. + +### SetRuleIndex + +`func (o *StrikethroughEffect) SetRuleIndex(v int32)` + +SetRuleIndex gets a reference to the given int32 and assigns it to the RuleIndex field. + +### GetRuleName + +`func (o *StrikethroughEffect) GetRuleName() string` + +GetRuleName returns the RuleName field if non-nil, zero value otherwise. + +### GetRuleNameOk + +`func (o *StrikethroughEffect) 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 *StrikethroughEffect) HasRuleName() bool` + +HasRuleName returns a boolean if a field has been set. + +### SetRuleName + +`func (o *StrikethroughEffect) SetRuleName(v string)` + +SetRuleName gets a reference to the given string and assigns it to the RuleName field. + +### GetType + +`func (o *StrikethroughEffect) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *StrikethroughEffect) 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 *StrikethroughEffect) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *StrikethroughEffect) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetProps + +`func (o *StrikethroughEffect) GetProps() map[string]interface{}` + +GetProps returns the Props field if non-nil, zero value otherwise. + +### GetPropsOk + +`func (o *StrikethroughEffect) GetPropsOk() (map[string]interface{}, bool)` + +GetPropsOk returns a tuple with the Props field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProps + +`func (o *StrikethroughEffect) HasProps() bool` + +HasProps returns a boolean if a field has been set. + +### SetProps + +`func (o *StrikethroughEffect) SetProps(v map[string]interface{})` + +SetProps gets a reference to the given map[string]interface{} and assigns it to the Props 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/StrikethroughLabelingNotification.md b/docs/StrikethroughLabelingNotification.md new file mode 100644 index 00000000..730b525d --- /dev/null +++ b/docs/StrikethroughLabelingNotification.md @@ -0,0 +1,143 @@ +# StrikethroughLabelingNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **int32** | The ID of the application that catalog items labels belongs to. | +**CurrentBatch** | Pointer to **int32** | The batch number of the notification. Notifications might be sent in different batches. | +**TotalBatches** | Pointer to **int32** | The total number of batches for the notification. | +**Trigger** | Pointer to [**StrikethroughTrigger**](StrikethroughTrigger.md) | | +**ChangedItems** | Pointer to [**[]StrikethroughChangedItem**](StrikethroughChangedItem.md) | | + +## Methods + +### GetApplicationId + +`func (o *StrikethroughLabelingNotification) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *StrikethroughLabelingNotification) 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 *StrikethroughLabelingNotification) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *StrikethroughLabelingNotification) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetCurrentBatch + +`func (o *StrikethroughLabelingNotification) GetCurrentBatch() int32` + +GetCurrentBatch returns the CurrentBatch field if non-nil, zero value otherwise. + +### GetCurrentBatchOk + +`func (o *StrikethroughLabelingNotification) GetCurrentBatchOk() (int32, bool)` + +GetCurrentBatchOk returns a tuple with the CurrentBatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentBatch + +`func (o *StrikethroughLabelingNotification) HasCurrentBatch() bool` + +HasCurrentBatch returns a boolean if a field has been set. + +### SetCurrentBatch + +`func (o *StrikethroughLabelingNotification) SetCurrentBatch(v int32)` + +SetCurrentBatch gets a reference to the given int32 and assigns it to the CurrentBatch field. + +### GetTotalBatches + +`func (o *StrikethroughLabelingNotification) GetTotalBatches() int32` + +GetTotalBatches returns the TotalBatches field if non-nil, zero value otherwise. + +### GetTotalBatchesOk + +`func (o *StrikethroughLabelingNotification) GetTotalBatchesOk() (int32, bool)` + +GetTotalBatchesOk returns a tuple with the TotalBatches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalBatches + +`func (o *StrikethroughLabelingNotification) HasTotalBatches() bool` + +HasTotalBatches returns a boolean if a field has been set. + +### SetTotalBatches + +`func (o *StrikethroughLabelingNotification) SetTotalBatches(v int32)` + +SetTotalBatches gets a reference to the given int32 and assigns it to the TotalBatches field. + +### GetTrigger + +`func (o *StrikethroughLabelingNotification) GetTrigger() StrikethroughTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *StrikethroughLabelingNotification) GetTriggerOk() (StrikethroughTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTrigger + +`func (o *StrikethroughLabelingNotification) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + +### SetTrigger + +`func (o *StrikethroughLabelingNotification) SetTrigger(v StrikethroughTrigger)` + +SetTrigger gets a reference to the given StrikethroughTrigger and assigns it to the Trigger field. + +### GetChangedItems + +`func (o *StrikethroughLabelingNotification) GetChangedItems() []StrikethroughChangedItem` + +GetChangedItems returns the ChangedItems field if non-nil, zero value otherwise. + +### GetChangedItemsOk + +`func (o *StrikethroughLabelingNotification) GetChangedItemsOk() ([]StrikethroughChangedItem, bool)` + +GetChangedItemsOk returns a tuple with the ChangedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasChangedItems + +`func (o *StrikethroughLabelingNotification) HasChangedItems() bool` + +HasChangedItems returns a boolean if a field has been set. + +### SetChangedItems + +`func (o *StrikethroughLabelingNotification) SetChangedItems(v []StrikethroughChangedItem)` + +SetChangedItems gets a reference to the given []StrikethroughChangedItem and assigns it to the ChangedItems 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/StrikethroughSetDiscountPerItemEffectProps.md b/docs/StrikethroughSetDiscountPerItemEffectProps.md new file mode 100644 index 00000000..3db009a8 --- /dev/null +++ b/docs/StrikethroughSetDiscountPerItemEffectProps.md @@ -0,0 +1,65 @@ +# StrikethroughSetDiscountPerItemEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | effect name. | +**Value** | Pointer to [**map[string]interface{}**](.md) | discount value. | + +## Methods + +### GetName + +`func (o *StrikethroughSetDiscountPerItemEffectProps) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *StrikethroughSetDiscountPerItemEffectProps) 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 *StrikethroughSetDiscountPerItemEffectProps) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *StrikethroughSetDiscountPerItemEffectProps) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetValue + +`func (o *StrikethroughSetDiscountPerItemEffectProps) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *StrikethroughSetDiscountPerItemEffectProps) 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 *StrikethroughSetDiscountPerItemEffectProps) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *StrikethroughSetDiscountPerItemEffectProps) 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/StrikethroughTrigger.md b/docs/StrikethroughTrigger.md new file mode 100644 index 00000000..5f61f56b --- /dev/null +++ b/docs/StrikethroughTrigger.md @@ -0,0 +1,143 @@ +# StrikethroughTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | The ID of the event that triggered the strikethrough labeling. | +**Type** | Pointer to **string** | The type of event that triggered the strikethrough labeling. | +**TriggeredAt** | Pointer to [**time.Time**](time.Time.md) | The creation time of the event that triggered the strikethrough labeling. | +**TotalAffectedItems** | Pointer to **int32** | The total number of items affected by the event that triggered the strikethrough labeling. | +**Payload** | Pointer to [**map[string]interface{}**](.md) | The arbitrary properties associated with this trigger type. | + +## Methods + +### GetId + +`func (o *StrikethroughTrigger) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *StrikethroughTrigger) 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 *StrikethroughTrigger) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *StrikethroughTrigger) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetType + +`func (o *StrikethroughTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *StrikethroughTrigger) 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 *StrikethroughTrigger) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *StrikethroughTrigger) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetTriggeredAt + +`func (o *StrikethroughTrigger) GetTriggeredAt() time.Time` + +GetTriggeredAt returns the TriggeredAt field if non-nil, zero value otherwise. + +### GetTriggeredAtOk + +`func (o *StrikethroughTrigger) GetTriggeredAtOk() (time.Time, bool)` + +GetTriggeredAtOk returns a tuple with the TriggeredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTriggeredAt + +`func (o *StrikethroughTrigger) HasTriggeredAt() bool` + +HasTriggeredAt returns a boolean if a field has been set. + +### SetTriggeredAt + +`func (o *StrikethroughTrigger) SetTriggeredAt(v time.Time)` + +SetTriggeredAt gets a reference to the given time.Time and assigns it to the TriggeredAt field. + +### GetTotalAffectedItems + +`func (o *StrikethroughTrigger) GetTotalAffectedItems() int32` + +GetTotalAffectedItems returns the TotalAffectedItems field if non-nil, zero value otherwise. + +### GetTotalAffectedItemsOk + +`func (o *StrikethroughTrigger) GetTotalAffectedItemsOk() (int32, bool)` + +GetTotalAffectedItemsOk returns a tuple with the TotalAffectedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalAffectedItems + +`func (o *StrikethroughTrigger) HasTotalAffectedItems() bool` + +HasTotalAffectedItems returns a boolean if a field has been set. + +### SetTotalAffectedItems + +`func (o *StrikethroughTrigger) SetTotalAffectedItems(v int32)` + +SetTotalAffectedItems gets a reference to the given int32 and assigns it to the TotalAffectedItems field. + +### GetPayload + +`func (o *StrikethroughTrigger) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *StrikethroughTrigger) 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 *StrikethroughTrigger) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *StrikethroughTrigger) 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/TalangAttribute.md b/docs/TalangAttribute.md new file mode 100644 index 00000000..44a0ea6b --- /dev/null +++ b/docs/TalangAttribute.md @@ -0,0 +1,247 @@ +# TalangAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entity** | Pointer to **string** | The name of the entity of the attribute. | [optional] +**Name** | Pointer to **string** | 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. | +**Title** | Pointer to **string** | The name of the attribute that is displayed to the user in the Campaign Manager. | [optional] +**Type** | Pointer to **string** | The talang type of the attribute. | +**Description** | Pointer to **string** | A description of the attribute. | [optional] +**Visible** | Pointer to **bool** | Indicates whether the attribute is visible in the UI or not. | [default to true] +**Kind** | Pointer to **string** | Indicate the kind of the attribute. | +**CampaignsCount** | Pointer to **int32** | The number of campaigns that refer to the attribute. | +**ExampleValue** | Pointer to **[]string** | Examples of values that can be assigned to the attribute. | [optional] + +## Methods + +### GetEntity + +`func (o *TalangAttribute) GetEntity() string` + +GetEntity returns the Entity field if non-nil, zero value otherwise. + +### GetEntityOk + +`func (o *TalangAttribute) GetEntityOk() (string, bool)` + +GetEntityOk returns a tuple with the Entity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEntity + +`func (o *TalangAttribute) HasEntity() bool` + +HasEntity returns a boolean if a field has been set. + +### SetEntity + +`func (o *TalangAttribute) SetEntity(v string)` + +SetEntity gets a reference to the given string and assigns it to the Entity field. + +### GetName + +`func (o *TalangAttribute) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TalangAttribute) 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 *TalangAttribute) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *TalangAttribute) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetTitle + +`func (o *TalangAttribute) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *TalangAttribute) GetTitleOk() (string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTitle + +`func (o *TalangAttribute) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *TalangAttribute) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetType + +`func (o *TalangAttribute) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TalangAttribute) 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 *TalangAttribute) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *TalangAttribute) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetDescription + +`func (o *TalangAttribute) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TalangAttribute) 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 *TalangAttribute) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *TalangAttribute) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetVisible + +`func (o *TalangAttribute) GetVisible() bool` + +GetVisible returns the Visible field if non-nil, zero value otherwise. + +### GetVisibleOk + +`func (o *TalangAttribute) GetVisibleOk() (bool, bool)` + +GetVisibleOk returns a tuple with the Visible field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVisible + +`func (o *TalangAttribute) HasVisible() bool` + +HasVisible returns a boolean if a field has been set. + +### SetVisible + +`func (o *TalangAttribute) SetVisible(v bool)` + +SetVisible gets a reference to the given bool and assigns it to the Visible field. + +### GetKind + +`func (o *TalangAttribute) GetKind() string` + +GetKind returns the Kind field if non-nil, zero value otherwise. + +### GetKindOk + +`func (o *TalangAttribute) GetKindOk() (string, bool)` + +GetKindOk returns a tuple with the Kind field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasKind + +`func (o *TalangAttribute) HasKind() bool` + +HasKind returns a boolean if a field has been set. + +### SetKind + +`func (o *TalangAttribute) SetKind(v string)` + +SetKind gets a reference to the given string and assigns it to the Kind field. + +### GetCampaignsCount + +`func (o *TalangAttribute) GetCampaignsCount() int32` + +GetCampaignsCount returns the CampaignsCount field if non-nil, zero value otherwise. + +### GetCampaignsCountOk + +`func (o *TalangAttribute) GetCampaignsCountOk() (int32, bool)` + +GetCampaignsCountOk returns a tuple with the CampaignsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignsCount + +`func (o *TalangAttribute) HasCampaignsCount() bool` + +HasCampaignsCount returns a boolean if a field has been set. + +### SetCampaignsCount + +`func (o *TalangAttribute) SetCampaignsCount(v int32)` + +SetCampaignsCount gets a reference to the given int32 and assigns it to the CampaignsCount field. + +### GetExampleValue + +`func (o *TalangAttribute) GetExampleValue() []string` + +GetExampleValue returns the ExampleValue field if non-nil, zero value otherwise. + +### GetExampleValueOk + +`func (o *TalangAttribute) GetExampleValueOk() ([]string, bool)` + +GetExampleValueOk returns a tuple with the ExampleValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExampleValue + +`func (o *TalangAttribute) HasExampleValue() bool` + +HasExampleValue returns a boolean if a field has been set. + +### SetExampleValue + +`func (o *TalangAttribute) SetExampleValue(v []string)` + +SetExampleValue gets a reference to the given []string and assigns it to the ExampleValue 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/TalangAttributeVisibility.md b/docs/TalangAttributeVisibility.md new file mode 100644 index 00000000..109fde53 --- /dev/null +++ b/docs/TalangAttributeVisibility.md @@ -0,0 +1,65 @@ +# TalangAttributeVisibility + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Invisible** | Pointer to **[]string** | List of attribute names to hide in the UI. | [optional] +**Visible** | Pointer to **[]string** | List of attribute names to show in the UI. | [optional] + +## Methods + +### GetInvisible + +`func (o *TalangAttributeVisibility) GetInvisible() []string` + +GetInvisible returns the Invisible field if non-nil, zero value otherwise. + +### GetInvisibleOk + +`func (o *TalangAttributeVisibility) GetInvisibleOk() ([]string, bool)` + +GetInvisibleOk returns a tuple with the Invisible field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasInvisible + +`func (o *TalangAttributeVisibility) HasInvisible() bool` + +HasInvisible returns a boolean if a field has been set. + +### SetInvisible + +`func (o *TalangAttributeVisibility) SetInvisible(v []string)` + +SetInvisible gets a reference to the given []string and assigns it to the Invisible field. + +### GetVisible + +`func (o *TalangAttributeVisibility) GetVisible() []string` + +GetVisible returns the Visible field if non-nil, zero value otherwise. + +### GetVisibleOk + +`func (o *TalangAttributeVisibility) GetVisibleOk() ([]string, bool)` + +GetVisibleOk returns a tuple with the Visible field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVisible + +`func (o *TalangAttributeVisibility) HasVisible() bool` + +HasVisible returns a boolean if a field has been set. + +### SetVisible + +`func (o *TalangAttributeVisibility) SetVisible(v []string)` + +SetVisible gets a reference to the given []string and assigns it to the Visible 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/TemplateArgDef.md b/docs/TemplateArgDef.md index 5be63c04..606507b2 100644 --- a/docs/TemplateArgDef.md +++ b/docs/TemplateArgDef.md @@ -8,6 +8,8 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | **Title** | Pointer to **string** | A campaigner friendly name for the argument, this will be shown in the rule editor. | **Ui** | Pointer to [**map[string]interface{}**](.md) | Arbitrary metadata that may be used to render an input for this argument. | +**PicklistID** | Pointer to **int32** | ID of the picklist linked to a template. | [optional] +**RestrictedByPicklist** | Pointer to **bool** | Whether or not this attribute's value is restricted by picklist (`picklist` property) | [optional] ## Methods @@ -111,6 +113,56 @@ HasUi returns a boolean if a field has been set. SetUi gets a reference to the given map[string]interface{} and assigns it to the Ui field. +### GetPicklistID + +`func (o *TemplateArgDef) GetPicklistID() int32` + +GetPicklistID returns the PicklistID field if non-nil, zero value otherwise. + +### GetPicklistIDOk + +`func (o *TemplateArgDef) GetPicklistIDOk() (int32, bool)` + +GetPicklistIDOk returns a tuple with the PicklistID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPicklistID + +`func (o *TemplateArgDef) HasPicklistID() bool` + +HasPicklistID returns a boolean if a field has been set. + +### SetPicklistID + +`func (o *TemplateArgDef) SetPicklistID(v int32)` + +SetPicklistID gets a reference to the given int32 and assigns it to the PicklistID field. + +### GetRestrictedByPicklist + +`func (o *TemplateArgDef) GetRestrictedByPicklist() bool` + +GetRestrictedByPicklist returns the RestrictedByPicklist field if non-nil, zero value otherwise. + +### GetRestrictedByPicklistOk + +`func (o *TemplateArgDef) GetRestrictedByPicklistOk() (bool, bool)` + +GetRestrictedByPicklistOk returns a tuple with the RestrictedByPicklist field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRestrictedByPicklist + +`func (o *TemplateArgDef) HasRestrictedByPicklist() bool` + +HasRestrictedByPicklist returns a boolean if a field has been set. + +### SetRestrictedByPicklist + +`func (o *TemplateArgDef) SetRestrictedByPicklist(v bool)` + +SetRestrictedByPicklist gets a reference to the given bool and assigns it to the RestrictedByPicklist 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/TemplateDef.md b/docs/TemplateDef.md index a70452ae..b8504154 100644 --- a/docs/TemplateDef.md +++ b/docs/TemplateDef.md @@ -4,8 +4,8 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time 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. | **Description** | Pointer to **string** | A short description of the template that will be shown in the rule editor. | diff --git a/docs/TransferLoyaltyCard.md b/docs/TransferLoyaltyCard.md new file mode 100644 index 00000000..964edab6 --- /dev/null +++ b/docs/TransferLoyaltyCard.md @@ -0,0 +1,39 @@ +# TransferLoyaltyCard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewCardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | + +## Methods + +### GetNewCardIdentifier + +`func (o *TransferLoyaltyCard) GetNewCardIdentifier() string` + +GetNewCardIdentifier returns the NewCardIdentifier field if non-nil, zero value otherwise. + +### GetNewCardIdentifierOk + +`func (o *TransferLoyaltyCard) GetNewCardIdentifierOk() (string, bool)` + +GetNewCardIdentifierOk returns a tuple with the NewCardIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNewCardIdentifier + +`func (o *TransferLoyaltyCard) HasNewCardIdentifier() bool` + +HasNewCardIdentifier returns a boolean if a field has been set. + +### SetNewCardIdentifier + +`func (o *TransferLoyaltyCard) SetNewCardIdentifier(v string)` + +SetNewCardIdentifier gets a reference to the given string and assigns it to the NewCardIdentifier 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/UpdateApplication.md b/docs/UpdateApplication.md index 6d54a7be..24e6c410 100644 --- a/docs/UpdateApplication.md +++ b/docs/UpdateApplication.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **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] +**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#flattening). | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [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] diff --git a/docs/UpdateCampaignTemplate.md b/docs/UpdateCampaignTemplate.md index c45042a9..55d5a41a 100644 --- a/docs/UpdateCampaignTemplate.md +++ b/docs/UpdateCampaignTemplate.md @@ -7,19 +7,19 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | The campaign template name. | **Description** | Pointer to **string** | Customer-facing text that explains the objective of the template. | **Instructions** | Pointer to **string** | Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. | -**CampaignAttributes** | Pointer to [**map[string]interface{}**](.md) | The Campaign Attributes that Campaigns created from this template will have by default. | [optional] -**CouponAttributes** | Pointer to [**map[string]interface{}**](.md) | The Campaign Attributes that Coupons created from this template will have by default. | [optional] -**State** | Pointer to **string** | Only Campaign Templates in 'available' state may be used to create Campaigns. | -**ActiveRulesetId** | Pointer to **int32** | The ID of the Ruleset this Campaign Template will use. | [optional] +**CampaignAttributes** | Pointer to [**map[string]interface{}**](.md) | The campaign attributes that campaigns created from this template will have by default. | [optional] +**CouponAttributes** | Pointer to [**map[string]interface{}**](.md) | The campaign attributes that coupons created from this template will have by default. | [optional] +**State** | Pointer to **string** | Only campaign templates in 'available' state may be used to create campaigns. | +**ActiveRulesetId** | Pointer to **int32** | The ID of the ruleset this campaign template will use. | [optional] **Tags** | Pointer to **[]string** | A list of tags for the campaign template. | [optional] **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] -**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. | +**Limits** | Pointer to [**[]TemplateLimitConfig**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] +**TemplateParams** | Pointer to [**[]CampaignTemplateParams**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] +**ApplicationsIds** | Pointer to **[]int32** | A list of 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] +**DefaultCampaignGroupId** | Pointer to **int32** | The default campaign group ID. | [optional] ## Methods diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index aec3aba7..963a72d6 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -5,12 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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] **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] +**IsReservationMandatory** | Pointer to **bool** | Whether the reservation effect actually created a new reservation. | [optional] [default to true] ## Methods @@ -64,6 +66,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *UpdateCoupon) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *UpdateCoupon) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *UpdateCoupon) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *UpdateCoupon) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *UpdateCoupon) GetStartDate() time.Time` @@ -189,6 +216,31 @@ 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. +### GetIsReservationMandatory + +`func (o *UpdateCoupon) GetIsReservationMandatory() bool` + +GetIsReservationMandatory returns the IsReservationMandatory field if non-nil, zero value otherwise. + +### GetIsReservationMandatoryOk + +`func (o *UpdateCoupon) GetIsReservationMandatoryOk() (bool, bool)` + +GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsReservationMandatory + +`func (o *UpdateCoupon) HasIsReservationMandatory() bool` + +HasIsReservationMandatory returns a boolean if a field has been set. + +### SetIsReservationMandatory + +`func (o *UpdateCoupon) SetIsReservationMandatory(v bool)` + +SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory 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/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index 88a064de..257bb346 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -5,9 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] +**ReservationLimit** | Pointer to **int32** | The number of reservations that can be made 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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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. | [optional] @@ -63,6 +64,31 @@ HasDiscountLimit returns a boolean if a field has been set. SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +### GetReservationLimit + +`func (o *UpdateCouponBatch) GetReservationLimit() int32` + +GetReservationLimit returns the ReservationLimit field if non-nil, zero value otherwise. + +### GetReservationLimitOk + +`func (o *UpdateCouponBatch) GetReservationLimitOk() (int32, bool)` + +GetReservationLimitOk returns a tuple with the ReservationLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservationLimit + +`func (o *UpdateCouponBatch) HasReservationLimit() bool` + +HasReservationLimit returns a boolean if a field has been set. + +### SetReservationLimit + +`func (o *UpdateCouponBatch) SetReservationLimit(v int32)` + +SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. + ### GetStartDate `func (o *UpdateCouponBatch) GetStartDate() time.Time` diff --git a/docs/UpdateCustomEffect.md b/docs/UpdateCustomEffect.md index 5472782f..2b46ddd3 100644 --- a/docs/UpdateCustomEffect.md +++ b/docs/UpdateCustomEffect.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApplicationIds** | Pointer to **[]int32** | The IDs of the applications that are related to this entity. | +**ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. | +**IsPerItem** | Pointer to **bool** | Indicates if this effect is per item or not. | [optional] **Name** | Pointer to **string** | The name of this effect. | **Title** | Pointer to **string** | The title of this effect. | **Payload** | Pointer to **string** | The JSON payload of this effect. | @@ -39,6 +40,31 @@ HasApplicationIds returns a boolean if a field has been set. SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds field. +### GetIsPerItem + +`func (o *UpdateCustomEffect) GetIsPerItem() bool` + +GetIsPerItem returns the IsPerItem field if non-nil, zero value otherwise. + +### GetIsPerItemOk + +`func (o *UpdateCustomEffect) GetIsPerItemOk() (bool, bool)` + +GetIsPerItemOk returns a tuple with the IsPerItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIsPerItem + +`func (o *UpdateCustomEffect) HasIsPerItem() bool` + +HasIsPerItem returns a boolean if a field has been set. + +### SetIsPerItem + +`func (o *UpdateCustomEffect) SetIsPerItem(v bool)` + +SetIsPerItem gets a reference to the given bool and assigns it to the IsPerItem field. + ### GetName `func (o *UpdateCustomEffect) GetName() string` diff --git a/docs/UpdateLoyaltyCard.md b/docs/UpdateLoyaltyCard.md index 6a557acb..06d4b000 100644 --- a/docs/UpdateLoyaltyCard.md +++ b/docs/UpdateLoyaltyCard.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'disabled'] | +**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'inactive'] | ## Methods diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index 6a9ef6c1..1e8e7f03 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -7,10 +7,11 @@ Name | Type | Description | Notes **Title** | Pointer to **string** | The display title for the Loyalty Program. | [optional] **Description** | Pointer to **string** | Description of our Loyalty Program. | [optional] **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] +**DefaultValidity** | Pointer to **string** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [optional] +**DefaultPending** | Pointer to **string** | The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [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] +**Sandbox** | Pointer to **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional] **Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] ## Methods @@ -190,6 +191,31 @@ HasUsersPerCardLimit returns a boolean if a field has been set. SetUsersPerCardLimit gets a reference to the given int32 and assigns it to the UsersPerCardLimit field. +### GetSandbox + +`func (o *UpdateLoyaltyProgram) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *UpdateLoyaltyProgram) 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 *UpdateLoyaltyProgram) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *UpdateLoyaltyProgram) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetTiers `func (o *UpdateLoyaltyProgram) GetTiers() []NewLoyaltyTier` diff --git a/docs/UpdatePicklist.md b/docs/UpdatePicklist.md new file mode 100644 index 00000000..4689155c --- /dev/null +++ b/docs/UpdatePicklist.md @@ -0,0 +1,65 @@ +# UpdatePicklist + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. | +**Values** | Pointer to **[]string** | The list of allowed values provided by this picklist. | + +## Methods + +### GetType + +`func (o *UpdatePicklist) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UpdatePicklist) 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 *UpdatePicklist) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *UpdatePicklist) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetValues + +`func (o *UpdatePicklist) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *UpdatePicklist) GetValuesOk() ([]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValues + +`func (o *UpdatePicklist) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValues + +`func (o *UpdatePicklist) SetValues(v []string)` + +SetValues gets a reference to the given []string and assigns it to the Values 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 eea50498..316d8bf3 100644 --- a/docs/UpdateReferral.md +++ b/docs/UpdateReferral.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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] diff --git a/docs/UpdateReferralBatch.md b/docs/UpdateReferralBatch.md index 08536243..b54193c6 100644 --- a/docs/UpdateReferralBatch.md +++ b/docs/UpdateReferralBatch.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **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] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration 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] ## Methods diff --git a/docs/UpdateRole.md b/docs/UpdateRole.md index 8b7bd8c7..69c02100 100644 --- a/docs/UpdateRole.md +++ b/docs/UpdateRole.md @@ -6,7 +6,7 @@ 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] +**Acl** | Pointer to **string** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | [optional] **Members** | Pointer to **[]int32** | An array of user identifiers. | [optional] ## Methods diff --git a/docs/UpdateUser.md b/docs/UpdateUser.md index d57e3944..ac2c987c 100644 --- a/docs/UpdateUser.md +++ b/docs/UpdateUser.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The user name. | [optional] -**Policy** | Pointer to **string** | ACL Json. | [optional] +**Policy** | Pointer to **string** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | [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** | List of roles to assign to the user. | [optional] **ApplicationNotificationSubscriptions** | Pointer to [**map[string]interface{}**](.md) | | [optional] diff --git a/docs/User.md b/docs/User.md index 1da4bdeb..e687ffbb 100644 --- a/docs/User.md +++ b/docs/User.md @@ -4,9 +4,9 @@ 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | **Email** | Pointer to **string** | The email address associated with your account. | **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | **InviteToken** | Pointer to **string** | Invite token, empty if the user as already accepted their invite. | diff --git a/docs/UserEntity.md b/docs/UserEntity.md index 5c063fae..36528c26 100644 --- a/docs/UserEntity.md +++ b/docs/UserEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UserId** | Pointer to **int32** | The ID of the account that owns this entity. | +**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | ## Methods diff --git a/docs/Webhook.md b/docs/Webhook.md index 2fba63c4..8f7d190e 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. 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. | +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The time 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** | Name or 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. | +**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. | +**Enabled** | Pointer to **bool** | Enables or disables webhook from showing in the Rule Builder. | ## Methods diff --git a/go.mod b/go.mod index 37a5ebe3..56e7e49c 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/talon-one/talon_go/v2 +module github.com/talon-one/talon_go/v3 go 1.13 diff --git a/Migration-v2.md b/migrations/Migration-v2.md similarity index 100% rename from Migration-v2.md rename to migrations/Migration-v2.md diff --git a/migrations/Migration-v3.md b/migrations/Migration-v3.md new file mode 100644 index 00000000..e75023eb --- /dev/null +++ b/migrations/Migration-v3.md @@ -0,0 +1,159 @@ +# Migration from older versions to v3.0.0 + +## Background and a short introduction to Cart Item Catalogs + +Since July last year we are developing the [Cart Item Catalogs][1] feature and incorporating it into our platform and the Integration API. + +Part of the Cart Item Catalogs feature core offerings is the ability to pre-sync a _catalog of items_ to Talon.One's platform and rely on them when sending integration requests to update Customer Sessions. + +To support this flexibility, the formerly required `Name` and `Price` fields of the [CartItem][2] model are now flagged as optional. \ +In the SDK, the meaning of this was changing the struct field types to pointers to a string and a float32 for the `Name` and `Price` fields respectively: + +```diff +type CartItem struct { + // Name of item. +- Name string `json:"name"` ++ Name *string `json:"name,omitempty"` + + // ... +- // Price of item +- Price float32 `json:"price"` ++ // 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,omitempty"` +} +``` + +## Required code changes + +The main change upgrading to the SDK's new version ([v3.0.0][3]) is to update the references to the `Name` and `Price` of the `CartItem` model, upon initialization and accessing them. + +### `CartItem` struct initialization + +For example, let's assume we have an instruction in our code to initialize a list of cart items with their properties, and assign it to a customer session model. + +For prior versions of the SDKs that looks like: +```go +newCustomerSession.SetCartItems([]talon.CartItem{ + { + Name: "Pad Thai - Veggie", + Sku: "pad-332", + Quantity: 1, + Price: 5.5, + Category: talon.PtrString("Noodles"), + }, + { + Name: "Chang", + Sku: "chang-br-42", + Quantity: 1, + Price: 2.3, + Category: talon.PtrString("Beverages"), + }, +}) +``` + +However, from version 3.0.0 on, that will look like: +```go +newCustomerSession.SetCartItems([]talon.CartItem{ + { + Name: talon.PtrString("Pad Thai - Veggie"), + Sku: "pad-332", + Quantity: 1, + Price: talon.PtrFloat32(5.5), + Category: talon.PtrString("Noodles"), + }, + { + Name: talon.PtrString("Chang"), + Sku: "chang-br-42", + Quantity: 1, + Price: talon.PtrFloat32(2.3), + Category: talon.PtrString("Beverages"), + }, +}) +``` + +Note the usage of the wrapping of the `Name` and `Price` fields' values with the provided [util functions][4] for pointer wrapping: +```diff +- Name: "Pad Thai - Veggie", ++ Name: talon.PtrString("Pad Thai - Veggie"), + +- Price: 5.5, ++ Price: talon.PtrFloat32(5.5), +``` + +If the item you are sending as part of the customer session update is part of a Cart Item Catalog, you can simply omit the `Name` field, `Price` field or both. These will be propagated automatically by the pre-synced Cart Item Catalog the item belongs to by the platform. + +For items that are part of a Cart Item Catalog, sending a value in one or both of the fields **will override the values that were pre-synced as part of the Cart Item Catalog**. + +For the above example, let's assume the _"Chang"_ beer item is part of a catalog already presence and synced to Talon.One, the code could be simplified to: +```go +newCustomerSession.SetCartItems([]talon.CartItem{ + { + Name: talon.PtrString("Pad Thai - Veggie"), + Sku: "pad-332", + Quantity: 1, + Price: talon.PtrFloat32(5.5), + Category: talon.PtrString("Noodles"), + }, + { + Sku: "chang-br-42", + Quantity: 1, + Category: talon.PtrString("Beverages"), + }, +}) +``` + +### Accessing returned `CartItem` fields + +When your code needs to use the returned values for these fields of the `CartItem` model, you would need to update these references to also dereference the pointer to the value that is now returned from our APIs. + +For example, if our code is accessing the name and price of a cart item upon a successful request to the `UpdateCustomerSession` endpoint (don't forget to request the `"customerSession"` as part of the [`ResponseContent` field][5]), then we'd need to update these references. + +For prior versions of the SDKs that looks like: +```go +integrationState, _, err := api. + UpdateCustomerSessionV2(context, "my_customer_session_id"). + Body(integrationRequest). + Execute() + +var firstCartItemName string +var secondCartItemPrice float32 + +firstCartItemName = integrationState.GetCustomerSession().CartItems[0].Name +secondCartItemPrice = integrationState.GetCustomerSession().CartItems[1].Price +``` + +However, from version 3.0.0 on, that will look like: +```go +integrationState, _, err := api. + UpdateCustomerSessionV2(context, "my_customer_session_id"). + Body(integrationRequest). + Execute() + +var firstCartItemName string +var secondCartItemPrice float32 + +firstCartItemName = integrationState.GetCustomerSession().CartItems[0].GetName() +secondCartItemPrice = integrationState.GetCustomerSession().CartItems[1].GetPrice() +``` + +If we used the Getter functions already, our code won't require any changes. However, accessing the fields directly will impose the below changes: +```diff +integrationState, _, err := api. + UpdateCustomerSessionV2(context, "my_customer_session_id"). + Body(integrationRequest). + Execute() + +var firstCartItemName string +var secondCartItemPrice float32 + +- firstCartItemName = integrationState.GetCustomerSession().CartItems[0].Name ++ firstCartItemName = integrationState.GetCustomerSession().CartItems[0].GetName() +- secondCartItemPrice = integrationState.GetCustomerSession().CartItems[1].Price ++ secondCartItemPrice = integrationState.GetCustomerSession().CartItems[1].GetPrice() +``` + +[1]: https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs "Cart Item Catalog" +[2]: ../model_cart_item.go "CartItem Model" +[3]: https://github.com/talon-one/talon_go/releases/tag/v3.0.0 "v3.0.0" +[4]: ../utils.go "util functions" +[5]: https://github.com/talon-one/talon_go/blob/master/model_integration_request.go#L20-L21 "IntegrationRequest's response content" diff --git a/model_accept_coupon_effect_props.go b/model_accept_coupon_effect_props.go index 3e3d73d1..d76cb2ff 100644 --- a/model_accept_coupon_effect_props.go +++ b/model_accept_coupon_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_accept_referral_effect_props.go b/model_accept_referral_effect_props.go index 4ca677be..a05fae04 100644 --- a/model_accept_referral_effect_props.go +++ b/model_accept_referral_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_access_log_entry.go b/model_access_log_entry.go index edc43ea8..efb37224 100644 --- a/model_access_log_entry.go +++ b/model_access_log_entry.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_account.go b/model_account.go index 067014f5..c1e9d7af 100644 --- a/model_account.go +++ b/model_account.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,11 +17,11 @@ import ( // Account type Account 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified time.Time `json:"modified"` CompanyName string `json:"companyName"` // Subdomain Name for yourcompany.talon.one. diff --git a/model_account_additional_cost.go b/model_account_additional_cost.go index b61a9b5d..7e632e31 100644 --- a/model_account_additional_cost.go +++ b/model_account_additional_cost.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // AccountAdditionalCost type AccountAdditionalCost 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // 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. + // The internal name used in API requests. Name string `json:"name"` // 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. Title string `json:"title"` @@ -31,7 +31,7 @@ type AccountAdditionalCost struct { Description string `json:"description"` // 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. + // The type of additional cost. Possible value: - `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"` } diff --git a/model_account_analytics.go b/model_account_analytics.go index 7f0c420b..811783bb 100644 --- a/model_account_analytics.go +++ b/model_account_analytics.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_account_dashboard_statistic.go b/model_account_dashboard_statistic.go new file mode 100644 index 00000000..907c855d --- /dev/null +++ b/model_account_dashboard_statistic.go @@ -0,0 +1,233 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AccountDashboardStatistic struct for AccountDashboardStatistic +type AccountDashboardStatistic struct { + // Aggregated statistic for account revenue. + Revenue *[]AccountDashboardStatisticRevenue `json:"revenue,omitempty"` + // Aggregated statistic for account discount. + Discounts *[]AccountDashboardStatisticDiscount `json:"discounts,omitempty"` + // Aggregated statistic for account loyalty points. + LoyaltyPoints *[]AccountDashboardStatisticLoyaltyPoints `json:"loyaltyPoints,omitempty"` + // Aggregated statistic for account referrals. + Referrals *[]AccountDashboardStatisticReferrals `json:"referrals,omitempty"` + // Aggregated statistic for the number of account API calls. + ApiCalls *[]AccountDashboardStatisticApiCalls `json:"apiCalls,omitempty"` + Campaigns AccountDashboardStatisticCampaigns `json:"campaigns"` +} + +// GetRevenue returns the Revenue field value if set, zero value otherwise. +func (o *AccountDashboardStatistic) GetRevenue() []AccountDashboardStatisticRevenue { + if o == nil || o.Revenue == nil { + var ret []AccountDashboardStatisticRevenue + return ret + } + return *o.Revenue +} + +// GetRevenueOk returns a tuple with the Revenue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AccountDashboardStatistic) GetRevenueOk() ([]AccountDashboardStatisticRevenue, bool) { + if o == nil || o.Revenue == nil { + var ret []AccountDashboardStatisticRevenue + return ret, false + } + return *o.Revenue, true +} + +// HasRevenue returns a boolean if a field has been set. +func (o *AccountDashboardStatistic) HasRevenue() bool { + if o != nil && o.Revenue != nil { + return true + } + + return false +} + +// SetRevenue gets a reference to the given []AccountDashboardStatisticRevenue and assigns it to the Revenue field. +func (o *AccountDashboardStatistic) SetRevenue(v []AccountDashboardStatisticRevenue) { + o.Revenue = &v +} + +// GetDiscounts returns the Discounts field value if set, zero value otherwise. +func (o *AccountDashboardStatistic) GetDiscounts() []AccountDashboardStatisticDiscount { + if o == nil || o.Discounts == nil { + var ret []AccountDashboardStatisticDiscount + return ret + } + return *o.Discounts +} + +// GetDiscountsOk returns a tuple with the Discounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AccountDashboardStatistic) GetDiscountsOk() ([]AccountDashboardStatisticDiscount, bool) { + if o == nil || o.Discounts == nil { + var ret []AccountDashboardStatisticDiscount + return ret, false + } + return *o.Discounts, true +} + +// HasDiscounts returns a boolean if a field has been set. +func (o *AccountDashboardStatistic) HasDiscounts() bool { + if o != nil && o.Discounts != nil { + return true + } + + return false +} + +// SetDiscounts gets a reference to the given []AccountDashboardStatisticDiscount and assigns it to the Discounts field. +func (o *AccountDashboardStatistic) SetDiscounts(v []AccountDashboardStatisticDiscount) { + o.Discounts = &v +} + +// GetLoyaltyPoints returns the LoyaltyPoints field value if set, zero value otherwise. +func (o *AccountDashboardStatistic) GetLoyaltyPoints() []AccountDashboardStatisticLoyaltyPoints { + if o == nil || o.LoyaltyPoints == nil { + var ret []AccountDashboardStatisticLoyaltyPoints + return ret + } + return *o.LoyaltyPoints +} + +// GetLoyaltyPointsOk returns a tuple with the LoyaltyPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AccountDashboardStatistic) GetLoyaltyPointsOk() ([]AccountDashboardStatisticLoyaltyPoints, bool) { + if o == nil || o.LoyaltyPoints == nil { + var ret []AccountDashboardStatisticLoyaltyPoints + return ret, false + } + return *o.LoyaltyPoints, true +} + +// HasLoyaltyPoints returns a boolean if a field has been set. +func (o *AccountDashboardStatistic) HasLoyaltyPoints() bool { + if o != nil && o.LoyaltyPoints != nil { + return true + } + + return false +} + +// SetLoyaltyPoints gets a reference to the given []AccountDashboardStatisticLoyaltyPoints and assigns it to the LoyaltyPoints field. +func (o *AccountDashboardStatistic) SetLoyaltyPoints(v []AccountDashboardStatisticLoyaltyPoints) { + o.LoyaltyPoints = &v +} + +// GetReferrals returns the Referrals field value if set, zero value otherwise. +func (o *AccountDashboardStatistic) GetReferrals() []AccountDashboardStatisticReferrals { + if o == nil || o.Referrals == nil { + var ret []AccountDashboardStatisticReferrals + return ret + } + return *o.Referrals +} + +// 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 *AccountDashboardStatistic) GetReferralsOk() ([]AccountDashboardStatisticReferrals, bool) { + if o == nil || o.Referrals == nil { + var ret []AccountDashboardStatisticReferrals + return ret, false + } + return *o.Referrals, true +} + +// HasReferrals returns a boolean if a field has been set. +func (o *AccountDashboardStatistic) HasReferrals() bool { + if o != nil && o.Referrals != nil { + return true + } + + return false +} + +// SetReferrals gets a reference to the given []AccountDashboardStatisticReferrals and assigns it to the Referrals field. +func (o *AccountDashboardStatistic) SetReferrals(v []AccountDashboardStatisticReferrals) { + o.Referrals = &v +} + +// GetApiCalls returns the ApiCalls field value if set, zero value otherwise. +func (o *AccountDashboardStatistic) GetApiCalls() []AccountDashboardStatisticApiCalls { + if o == nil || o.ApiCalls == nil { + var ret []AccountDashboardStatisticApiCalls + return ret + } + return *o.ApiCalls +} + +// GetApiCallsOk returns a tuple with the ApiCalls field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AccountDashboardStatistic) GetApiCallsOk() ([]AccountDashboardStatisticApiCalls, bool) { + if o == nil || o.ApiCalls == nil { + var ret []AccountDashboardStatisticApiCalls + return ret, false + } + return *o.ApiCalls, true +} + +// HasApiCalls returns a boolean if a field has been set. +func (o *AccountDashboardStatistic) HasApiCalls() bool { + if o != nil && o.ApiCalls != nil { + return true + } + + return false +} + +// SetApiCalls gets a reference to the given []AccountDashboardStatisticApiCalls and assigns it to the ApiCalls field. +func (o *AccountDashboardStatistic) SetApiCalls(v []AccountDashboardStatisticApiCalls) { + o.ApiCalls = &v +} + +// GetCampaigns returns the Campaigns field value +func (o *AccountDashboardStatistic) GetCampaigns() AccountDashboardStatisticCampaigns { + if o == nil { + var ret AccountDashboardStatisticCampaigns + return ret + } + + return o.Campaigns +} + +// SetCampaigns sets field value +func (o *AccountDashboardStatistic) SetCampaigns(v AccountDashboardStatisticCampaigns) { + o.Campaigns = v +} + +type NullableAccountDashboardStatistic struct { + Value AccountDashboardStatistic + ExplicitNull bool +} + +func (v NullableAccountDashboardStatistic) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatistic) 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_account_dashboard_statistic_api_calls.go b/model_account_dashboard_statistic_api_calls.go new file mode 100644 index 00000000..cbbd19ae --- /dev/null +++ b/model_account_dashboard_statistic_api_calls.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AccountDashboardStatisticApiCalls struct for AccountDashboardStatisticApiCalls +type AccountDashboardStatisticApiCalls struct { + // Total number of API calls received. + Total float32 `json:"total"` + // Values aggregated for the specified date. + Datetime time.Time `json:"datetime"` +} + +// GetTotal returns the Total field value +func (o *AccountDashboardStatisticApiCalls) GetTotal() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Total +} + +// SetTotal sets field value +func (o *AccountDashboardStatisticApiCalls) SetTotal(v float32) { + o.Total = v +} + +// GetDatetime returns the Datetime field value +func (o *AccountDashboardStatisticApiCalls) GetDatetime() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Datetime +} + +// SetDatetime sets field value +func (o *AccountDashboardStatisticApiCalls) SetDatetime(v time.Time) { + o.Datetime = v +} + +type NullableAccountDashboardStatisticApiCalls struct { + Value AccountDashboardStatisticApiCalls + ExplicitNull bool +} + +func (v NullableAccountDashboardStatisticApiCalls) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatisticApiCalls) 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_account_dashboard_statistic_campaigns.go b/model_account_dashboard_statistic_campaigns.go new file mode 100644 index 00000000..ebe7fefb --- /dev/null +++ b/model_account_dashboard_statistic_campaigns.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AccountDashboardStatisticCampaigns struct for AccountDashboardStatisticCampaigns +type AccountDashboardStatisticCampaigns struct { + // Number of campaigns that are active and live (across all Applications). + Live int32 `json:"live"` + // Campaigns with a schedule ending in 7 days or with only 10% of budget left. + EndingSoon int32 `json:"endingSoon"` +} + +// GetLive returns the Live field value +func (o *AccountDashboardStatisticCampaigns) GetLive() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Live +} + +// SetLive sets field value +func (o *AccountDashboardStatisticCampaigns) SetLive(v int32) { + o.Live = v +} + +// GetEndingSoon returns the EndingSoon field value +func (o *AccountDashboardStatisticCampaigns) GetEndingSoon() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.EndingSoon +} + +// SetEndingSoon sets field value +func (o *AccountDashboardStatisticCampaigns) SetEndingSoon(v int32) { + o.EndingSoon = v +} + +type NullableAccountDashboardStatisticCampaigns struct { + Value AccountDashboardStatisticCampaigns + ExplicitNull bool +} + +func (v NullableAccountDashboardStatisticCampaigns) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatisticCampaigns) 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_account_dashboard_statistic_discount.go b/model_account_dashboard_statistic_discount.go new file mode 100644 index 00000000..6e94f1a0 --- /dev/null +++ b/model_account_dashboard_statistic_discount.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AccountDashboardStatisticDiscount struct for AccountDashboardStatisticDiscount +type AccountDashboardStatisticDiscount struct { + // Total discount value redeemed by users. + Total float32 `json:"total"` + // Average discount percentage. + Average float32 `json:"average"` + // Values aggregated for the specified date. + Datetime time.Time `json:"datetime"` +} + +// GetTotal returns the Total field value +func (o *AccountDashboardStatisticDiscount) GetTotal() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Total +} + +// SetTotal sets field value +func (o *AccountDashboardStatisticDiscount) SetTotal(v float32) { + o.Total = v +} + +// GetAverage returns the Average field value +func (o *AccountDashboardStatisticDiscount) GetAverage() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Average +} + +// SetAverage sets field value +func (o *AccountDashboardStatisticDiscount) SetAverage(v float32) { + o.Average = v +} + +// GetDatetime returns the Datetime field value +func (o *AccountDashboardStatisticDiscount) GetDatetime() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Datetime +} + +// SetDatetime sets field value +func (o *AccountDashboardStatisticDiscount) SetDatetime(v time.Time) { + o.Datetime = v +} + +type NullableAccountDashboardStatisticDiscount struct { + Value AccountDashboardStatisticDiscount + ExplicitNull bool +} + +func (v NullableAccountDashboardStatisticDiscount) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatisticDiscount) 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_account_dashboard_statistic_loyalty_points.go b/model_account_dashboard_statistic_loyalty_points.go new file mode 100644 index 00000000..62726907 --- /dev/null +++ b/model_account_dashboard_statistic_loyalty_points.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AccountDashboardStatisticLoyaltyPoints struct for AccountDashboardStatisticLoyaltyPoints +type AccountDashboardStatisticLoyaltyPoints struct { + // Total loyalty points earned by users. + Total float32 `json:"total"` + // Values aggregated for the specified date. + Datetime time.Time `json:"datetime"` +} + +// GetTotal returns the Total field value +func (o *AccountDashboardStatisticLoyaltyPoints) GetTotal() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Total +} + +// SetTotal sets field value +func (o *AccountDashboardStatisticLoyaltyPoints) SetTotal(v float32) { + o.Total = v +} + +// GetDatetime returns the Datetime field value +func (o *AccountDashboardStatisticLoyaltyPoints) GetDatetime() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Datetime +} + +// SetDatetime sets field value +func (o *AccountDashboardStatisticLoyaltyPoints) SetDatetime(v time.Time) { + o.Datetime = v +} + +type NullableAccountDashboardStatisticLoyaltyPoints struct { + Value AccountDashboardStatisticLoyaltyPoints + ExplicitNull bool +} + +func (v NullableAccountDashboardStatisticLoyaltyPoints) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatisticLoyaltyPoints) 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_account_dashboard_statistic_referrals.go b/model_account_dashboard_statistic_referrals.go new file mode 100644 index 00000000..d1a2f600 --- /dev/null +++ b/model_account_dashboard_statistic_referrals.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AccountDashboardStatisticReferrals struct for AccountDashboardStatisticReferrals +type AccountDashboardStatisticReferrals struct { + // Total number of referrals initiated by users. + Total float32 `json:"total"` + // Values aggregated for the specified date. + Datetime time.Time `json:"datetime"` +} + +// GetTotal returns the Total field value +func (o *AccountDashboardStatisticReferrals) GetTotal() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Total +} + +// SetTotal sets field value +func (o *AccountDashboardStatisticReferrals) SetTotal(v float32) { + o.Total = v +} + +// GetDatetime returns the Datetime field value +func (o *AccountDashboardStatisticReferrals) GetDatetime() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Datetime +} + +// SetDatetime sets field value +func (o *AccountDashboardStatisticReferrals) SetDatetime(v time.Time) { + o.Datetime = v +} + +type NullableAccountDashboardStatisticReferrals struct { + Value AccountDashboardStatisticReferrals + ExplicitNull bool +} + +func (v NullableAccountDashboardStatisticReferrals) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatisticReferrals) 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_account_dashboard_statistic_revenue.go b/model_account_dashboard_statistic_revenue.go new file mode 100644 index 00000000..7c0f9037 --- /dev/null +++ b/model_account_dashboard_statistic_revenue.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AccountDashboardStatisticRevenue struct for AccountDashboardStatisticRevenue +type AccountDashboardStatisticRevenue struct { + // All revenue that went through the client's shop (including purchases that didn’t trigger an effect). + Total float32 `json:"total"` + // The revenue that was created by a purchase that triggered an effect (excluding web hooks, notifications). + Influenced float32 `json:"influenced"` + // Values aggregated for the specified date. + Datetime time.Time `json:"datetime"` +} + +// GetTotal returns the Total field value +func (o *AccountDashboardStatisticRevenue) GetTotal() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Total +} + +// SetTotal sets field value +func (o *AccountDashboardStatisticRevenue) SetTotal(v float32) { + o.Total = v +} + +// GetInfluenced returns the Influenced field value +func (o *AccountDashboardStatisticRevenue) GetInfluenced() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Influenced +} + +// SetInfluenced sets field value +func (o *AccountDashboardStatisticRevenue) SetInfluenced(v float32) { + o.Influenced = v +} + +// GetDatetime returns the Datetime field value +func (o *AccountDashboardStatisticRevenue) GetDatetime() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Datetime +} + +// SetDatetime sets field value +func (o *AccountDashboardStatisticRevenue) SetDatetime(v time.Time) { + o.Datetime = v +} + +type NullableAccountDashboardStatisticRevenue struct { + Value AccountDashboardStatisticRevenue + ExplicitNull bool +} + +func (v NullableAccountDashboardStatisticRevenue) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAccountDashboardStatisticRevenue) 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_account_entity.go b/model_account_entity.go index a8730b1c..1601f1ac 100644 --- a/model_account_entity.go +++ b/model_account_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_account_limits.go b/model_account_limits.go index 163a2d06..56f8875d 100644 --- a/model_account_limits.go +++ b/model_account_limits.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_add_free_item_effect_props.go b/model_add_free_item_effect_props.go index 45aae92b..bb609470 100644 --- a/model_add_free_item_effect_props.go +++ b/model_add_free_item_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,7 +18,7 @@ import ( type AddFreeItemEffectProps struct { // 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 index 871232fa..41cf44c1 100644 --- a/model_add_item_catalog_action.go +++ b/model_add_item_catalog_action.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_add_loyalty_points.go b/model_add_loyalty_points.go new file mode 100644 index 00000000..cd455c2a --- /dev/null +++ b/model_add_loyalty_points.go @@ -0,0 +1,305 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AddLoyaltyPoints Points to add. +type AddLoyaltyPoints struct { + // Amount of loyalty points. + Points float32 `json:"points"` + // Name / reason for the point addition. + Name *string `json:"name,omitempty"` + // The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. If passed, `validUntil` should be omitted. + ValidityDuration *string `json:"validityDuration,omitempty"` + // Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. + ValidUntil *time.Time `json:"validUntil,omitempty"` + // The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks and months. Signifies the end of the day, week, or month. + PendingDuration *string `json:"pendingDuration,omitempty"` + // Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. + PendingUntil *time.Time `json:"pendingUntil,omitempty"` + // ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. + SubledgerId *string `json:"subledgerId,omitempty"` + // ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. + ApplicationId *int32 `json:"applicationId,omitempty"` +} + +// GetPoints returns the Points field value +func (o *AddLoyaltyPoints) GetPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Points +} + +// SetPoints sets field value +func (o *AddLoyaltyPoints) SetPoints(v float32) { + o.Points = v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) 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 *AddLoyaltyPoints) 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 *AddLoyaltyPoints) 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 *AddLoyaltyPoints) SetName(v string) { + o.Name = &v +} + +// GetValidityDuration returns the ValidityDuration field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) GetValidityDuration() string { + if o == nil || o.ValidityDuration == nil { + var ret string + return ret + } + return *o.ValidityDuration +} + +// GetValidityDurationOk returns a tuple with the ValidityDuration field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPoints) GetValidityDurationOk() (string, bool) { + if o == nil || o.ValidityDuration == nil { + var ret string + return ret, false + } + return *o.ValidityDuration, true +} + +// HasValidityDuration returns a boolean if a field has been set. +func (o *AddLoyaltyPoints) HasValidityDuration() bool { + if o != nil && o.ValidityDuration != nil { + return true + } + + return false +} + +// SetValidityDuration gets a reference to the given string and assigns it to the ValidityDuration field. +func (o *AddLoyaltyPoints) SetValidityDuration(v string) { + o.ValidityDuration = &v +} + +// GetValidUntil returns the ValidUntil field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) GetValidUntil() time.Time { + if o == nil || o.ValidUntil == nil { + var ret time.Time + return ret + } + return *o.ValidUntil +} + +// GetValidUntilOk returns a tuple with the ValidUntil field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPoints) GetValidUntilOk() (time.Time, bool) { + if o == nil || o.ValidUntil == nil { + var ret time.Time + return ret, false + } + return *o.ValidUntil, true +} + +// HasValidUntil returns a boolean if a field has been set. +func (o *AddLoyaltyPoints) HasValidUntil() bool { + if o != nil && o.ValidUntil != nil { + return true + } + + return false +} + +// SetValidUntil gets a reference to the given time.Time and assigns it to the ValidUntil field. +func (o *AddLoyaltyPoints) SetValidUntil(v time.Time) { + o.ValidUntil = &v +} + +// GetPendingDuration returns the PendingDuration field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) GetPendingDuration() string { + if o == nil || o.PendingDuration == nil { + var ret string + return ret + } + return *o.PendingDuration +} + +// GetPendingDurationOk returns a tuple with the PendingDuration field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPoints) GetPendingDurationOk() (string, bool) { + if o == nil || o.PendingDuration == nil { + var ret string + return ret, false + } + return *o.PendingDuration, true +} + +// HasPendingDuration returns a boolean if a field has been set. +func (o *AddLoyaltyPoints) HasPendingDuration() bool { + if o != nil && o.PendingDuration != nil { + return true + } + + return false +} + +// SetPendingDuration gets a reference to the given string and assigns it to the PendingDuration field. +func (o *AddLoyaltyPoints) SetPendingDuration(v string) { + o.PendingDuration = &v +} + +// GetPendingUntil returns the PendingUntil field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) GetPendingUntil() time.Time { + if o == nil || o.PendingUntil == nil { + var ret time.Time + return ret + } + return *o.PendingUntil +} + +// GetPendingUntilOk returns a tuple with the PendingUntil field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPoints) GetPendingUntilOk() (time.Time, bool) { + if o == nil || o.PendingUntil == nil { + var ret time.Time + return ret, false + } + return *o.PendingUntil, true +} + +// HasPendingUntil returns a boolean if a field has been set. +func (o *AddLoyaltyPoints) HasPendingUntil() bool { + if o != nil && o.PendingUntil != nil { + return true + } + + return false +} + +// SetPendingUntil gets a reference to the given time.Time and assigns it to the PendingUntil field. +func (o *AddLoyaltyPoints) SetPendingUntil(v time.Time) { + o.PendingUntil = &v +} + +// GetSubledgerId returns the SubledgerId field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) GetSubledgerId() string { + if o == nil || o.SubledgerId == nil { + var ret string + return ret + } + return *o.SubledgerId +} + +// GetSubledgerIdOk returns a tuple with the SubledgerId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPoints) GetSubledgerIdOk() (string, bool) { + if o == nil || o.SubledgerId == nil { + var ret string + return ret, false + } + return *o.SubledgerId, true +} + +// HasSubledgerId returns a boolean if a field has been set. +func (o *AddLoyaltyPoints) HasSubledgerId() bool { + if o != nil && o.SubledgerId != nil { + return true + } + + return false +} + +// SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. +func (o *AddLoyaltyPoints) SetSubledgerId(v string) { + o.SubledgerId = &v +} + +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *AddLoyaltyPoints) 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 *AddLoyaltyPoints) 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 *AddLoyaltyPoints) 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 *AddLoyaltyPoints) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +type NullableAddLoyaltyPoints struct { + Value AddLoyaltyPoints + ExplicitNull bool +} + +func (v NullableAddLoyaltyPoints) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAddLoyaltyPoints) 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 ccfbf726..25bc4567 100644 --- a/model_add_loyalty_points_effect_props.go +++ b/model_add_loyalty_points_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,7 +17,7 @@ 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 reason of the point addition. + // The name / description of this loyalty point addition. Name string `json:"name"` // The ID of the loyalty program where these points were added. ProgramId int32 `json:"programId"` @@ -39,8 +39,12 @@ type AddLoyaltyPointsEffectProps struct { 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. + // The alphanumeric identifier of the loyalty card. CardIdentifier *string `json:"cardIdentifier,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 definition. + BundleName *string `json:"bundleName,omitempty"` } // GetName returns the Name field value @@ -331,6 +335,72 @@ func (o *AddLoyaltyPointsEffectProps) SetCardIdentifier(v string) { o.CardIdentifier = &v } +// GetBundleIndex returns the BundleIndex field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) SetBundleIndex(v int32) { + o.BundleIndex = &v +} + +// GetBundleName returns the BundleName field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) 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 *AddLoyaltyPointsEffectProps) SetBundleName(v string) { + o.BundleName = &v +} + type NullableAddLoyaltyPointsEffectProps struct { Value AddLoyaltyPointsEffectProps ExplicitNull bool diff --git a/model_added_deducted_points_notification_policy.go b/model_added_deducted_points_notification_policy.go new file mode 100644 index 00000000..d4d5837e --- /dev/null +++ b/model_added_deducted_points_notification_policy.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AddedDeductedPointsNotificationPolicy struct for AddedDeductedPointsNotificationPolicy +type AddedDeductedPointsNotificationPolicy struct { + // Notification name. + Name string `json:"name"` + Scopes []string `json:"scopes"` +} + +// GetName returns the Name field value +func (o *AddedDeductedPointsNotificationPolicy) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *AddedDeductedPointsNotificationPolicy) SetName(v string) { + o.Name = v +} + +// GetScopes returns the Scopes field value +func (o *AddedDeductedPointsNotificationPolicy) GetScopes() []string { + if o == nil { + var ret []string + return ret + } + + return o.Scopes +} + +// SetScopes sets field value +func (o *AddedDeductedPointsNotificationPolicy) SetScopes(v []string) { + o.Scopes = v +} + +type NullableAddedDeductedPointsNotificationPolicy struct { + Value AddedDeductedPointsNotificationPolicy + ExplicitNull bool +} + +func (v NullableAddedDeductedPointsNotificationPolicy) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAddedDeductedPointsNotificationPolicy) 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_additional_cost.go b/model_additional_cost.go index 23c9f6c3..9cde5cb7 100644 --- a/model_additional_cost.go +++ b/model_additional_cost.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_api_error.go b/model_api_error.go index 7026e122..70346919 100644 --- a/model_api_error.go +++ b/model_api_error.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application.go b/model_application.go index 28d5f390..6960f60d 100644 --- a/model_application.go +++ b/model_application.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,11 +17,11 @@ import ( // Application type Application 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified time.Time `json:"modified"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` @@ -47,7 +47,7 @@ type Application struct { DefaultDiscountScope *string `json:"defaultDiscountScope,omitempty"` // 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. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). + // 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#flattening). EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` // Indicates if this is a live or sandbox Application. diff --git a/model_application_api_health.go b/model_application_api_health.go index b9d55bd1..abce9f8b 100644 --- a/model_application_api_health.go +++ b/model_application_api_health.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,7 +17,7 @@ import ( // 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. Possible values are: - `OK`: The Application has received only successful API requests in the last 5 minutes. - `WARNING`: The Application received at least one failed request in the last 50 minutes. - `ERROR`: More than 50% of received requests failed. - `CRITICAL`: All received requests failed. - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests. Summary string `json:"summary"` // 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 4dd2dd17..37e116b5 100644 --- a/model_application_api_key.go +++ b/model_application_api_key.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application_campaign_stats.go b/model_application_campaign_stats.go index 7487e2f9..466bd4d0 100644 --- a/model_application_campaign_stats.go +++ b/model_application_campaign_stats.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application_customer.go b/model_application_customer.go index 73a4e0bd..1cea6e04 100644 --- a/model_application_customer.go +++ b/model_application_customer.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // ApplicationCustomer type ApplicationCustomer 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. 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. + // Internal ID of this entity. Internal ID of this entity. 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. + // The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. Created time.Time `json:"created"` // The integration ID set by your integration layer. The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` @@ -29,14 +29,16 @@ type ApplicationCustomer struct { 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. + // The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. TotalSales float32 `json:"totalSales"` // **DEPRECATED** A list of loyalty programs joined by the customer. LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` - // A list of audiences the customer belongs to. + // The audiences the customer belongs to. AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` - // 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. + // 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"` + // Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). + Sandbox *bool `json:"sandbox,omitempty"` // The Integration ID of the Customer Profile that referred this Customer in the Application. AdvocateIntegrationId *string `json:"advocateIntegrationId,omitempty"` } @@ -227,6 +229,39 @@ func (o *ApplicationCustomer) SetLastActivity(v time.Time) { o.LastActivity = v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *ApplicationCustomer) 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 *ApplicationCustomer) 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 *ApplicationCustomer) 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 *ApplicationCustomer) SetSandbox(v bool) { + o.Sandbox = &v +} + // GetAdvocateIntegrationId returns the AdvocateIntegrationId field value if set, zero value otherwise. func (o *ApplicationCustomer) GetAdvocateIntegrationId() string { if o == nil || o.AdvocateIntegrationId == nil { diff --git a/model_application_customer_entity.go b/model_application_customer_entity.go index b70bf802..49303838 100644 --- a/model_application_customer_entity.go +++ b/model_application_customer_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application_entity.go b/model_application_entity.go index 434ddff5..5a2121b3 100644 --- a/model_application_entity.go +++ b/model_application_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application_event.go b/model_application_event.go index 9f231f60..a7fc4147 100644 --- a/model_application_event.go +++ b/model_application_event.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // ApplicationEvent type ApplicationEvent 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` @@ -32,7 +32,7 @@ type ApplicationEvent struct { // Additional JSON serialized data associated with the event. Attributes map[string]interface{} `json:"attributes"` // An array containing the effects that were applied as a result of this event. - Effects [][]interface{} `json:"effects"` + Effects []Effect `json:"effects"` // An array containing the rule failure reasons which happened during this event. RuleFailureReasons *[]RuleFailureReason `json:"ruleFailureReasons,omitempty"` } @@ -179,9 +179,9 @@ func (o *ApplicationEvent) SetAttributes(v map[string]interface{}) { } // GetEffects returns the Effects field value -func (o *ApplicationEvent) GetEffects() [][]interface{} { +func (o *ApplicationEvent) GetEffects() []Effect { if o == nil { - var ret [][]interface{} + var ret []Effect return ret } @@ -189,7 +189,7 @@ func (o *ApplicationEvent) GetEffects() [][]interface{} { } // SetEffects sets field value -func (o *ApplicationEvent) SetEffects(v [][]interface{}) { +func (o *ApplicationEvent) SetEffects(v []Effect) { o.Effects = v } diff --git a/model_application_notification.go b/model_application_notification.go index fb8a6efd..71451f7f 100644 --- a/model_application_notification.go +++ b/model_application_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application_referee.go b/model_application_referee.go index b2676af3..73349a74 100644 --- a/model_application_referee.go +++ b/model_application_referee.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_application_session.go b/model_application_session.go index 732d7dac..2b473164 100644 --- a/model_application_session.go +++ b/model_application_session.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // ApplicationSession type ApplicationSession 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. The exact moment this entity was created. + // The time this entity was created. The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` @@ -33,7 +33,7 @@ type ApplicationSession struct { 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`. 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). + // 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](https://docs.talon.one/docs/dev/concepts/entities#customer-session). State string `json:"state"` // Serialized JSON representation. CartItems []CartItem `json:"cartItems"` diff --git a/model_application_session_entity.go b/model_application_session_entity.go index 6c54acd7..900e0cf2 100644 --- a/model_application_session_entity.go +++ b/model_application_session_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_async_coupon_creation_response.go b/model_async_coupon_creation_response.go index 6861329a..3b4f5caa 100644 --- a/model_async_coupon_creation_response.go +++ b/model_async_coupon_creation_response.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_attribute.go b/model_attribute.go index f9647de3..2512a3b7 100644 --- a/model_attribute.go +++ b/model_attribute.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // Attribute type Attribute 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` diff --git a/model_attributes_mandatory.go b/model_attributes_mandatory.go index 796ef840..311e2f55 100644 --- a/model_attributes_mandatory.go +++ b/model_attributes_mandatory.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_attributes_settings.go b/model_attributes_settings.go index 2bc834ee..32355e1d 100644 --- a/model_attributes_settings.go +++ b/model_attributes_settings.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_audience.go b/model_audience.go index 7347ad7b..38e71948 100644 --- a/model_audience.go +++ b/model_audience.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,9 +19,9 @@ import ( type Audience struct { // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The human-friendly display name for this audience. Name string `json:"name"` @@ -35,6 +35,8 @@ type Audience struct { IntegrationId *string `json:"integrationId,omitempty"` // Determines if this audience is a 3rd party audience or not. CreatedIn3rdParty *bool `json:"createdIn3rdParty,omitempty"` + // The last time that the audience memberships changed. + LastUpdate *time.Time `json:"lastUpdate,omitempty"` } // GetAccountId returns the AccountId field value @@ -262,6 +264,39 @@ func (o *Audience) SetCreatedIn3rdParty(v bool) { o.CreatedIn3rdParty = &v } +// GetLastUpdate returns the LastUpdate field value if set, zero value otherwise. +func (o *Audience) GetLastUpdate() time.Time { + if o == nil || o.LastUpdate == nil { + var ret time.Time + return ret + } + return *o.LastUpdate +} + +// GetLastUpdateOk returns a tuple with the LastUpdate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Audience) GetLastUpdateOk() (time.Time, bool) { + if o == nil || o.LastUpdate == nil { + var ret time.Time + return ret, false + } + return *o.LastUpdate, true +} + +// HasLastUpdate returns a boolean if a field has been set. +func (o *Audience) HasLastUpdate() bool { + if o != nil && o.LastUpdate != nil { + return true + } + + return false +} + +// SetLastUpdate gets a reference to the given time.Time and assigns it to the LastUpdate field. +func (o *Audience) SetLastUpdate(v time.Time) { + o.LastUpdate = &v +} + type NullableAudience struct { Value Audience ExplicitNull bool diff --git a/model_audience_analytics.go b/model_audience_analytics.go index 4994a4e8..8893c111 100644 --- a/model_audience_analytics.go +++ b/model_audience_analytics.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_audience_customer.go b/model_audience_customer.go new file mode 100644 index 00000000..df175b1e --- /dev/null +++ b/model_audience_customer.go @@ -0,0 +1,354 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// AudienceCustomer +type AudienceCustomer struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. The time this entity was created. + Created time.Time `json:"created"` + // The integration ID set by your integration layer. + IntegrationId string `json:"integrationId"` + // 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"` + // The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. + TotalSales float32 `json:"totalSales"` + // **DEPRECATED** A list of loyalty programs joined by the customer. + LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` + // The audiences the customer belongs to. + AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` + // 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"` + // Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). + Sandbox *bool `json:"sandbox,omitempty"` + // A list of the IDs of the Applications that are connected to this customer profile. + ConnectedApplicationsIds *[]int32 `json:"connectedApplicationsIds,omitempty"` + // A list of the IDs of the audiences that are connected to this customer profile. + ConnectedAudiences *[]int32 `json:"connectedAudiences,omitempty"` +} + +// GetId returns the Id field value +func (o *AudienceCustomer) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *AudienceCustomer) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *AudienceCustomer) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *AudienceCustomer) SetCreated(v time.Time) { + o.Created = v +} + +// GetIntegrationId returns the IntegrationId field value +func (o *AudienceCustomer) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *AudienceCustomer) SetIntegrationId(v string) { + o.IntegrationId = v +} + +// GetAttributes returns the Attributes field value +func (o *AudienceCustomer) GetAttributes() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Attributes +} + +// SetAttributes sets field value +func (o *AudienceCustomer) SetAttributes(v map[string]interface{}) { + o.Attributes = v +} + +// GetAccountId returns the AccountId field value +func (o *AudienceCustomer) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *AudienceCustomer) SetAccountId(v int32) { + o.AccountId = v +} + +// GetClosedSessions returns the ClosedSessions field value +func (o *AudienceCustomer) GetClosedSessions() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ClosedSessions +} + +// SetClosedSessions sets field value +func (o *AudienceCustomer) SetClosedSessions(v int32) { + o.ClosedSessions = v +} + +// GetTotalSales returns the TotalSales field value +func (o *AudienceCustomer) GetTotalSales() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalSales +} + +// SetTotalSales sets field value +func (o *AudienceCustomer) SetTotalSales(v float32) { + o.TotalSales = v +} + +// GetLoyaltyMemberships returns the LoyaltyMemberships field value if set, zero value otherwise. +func (o *AudienceCustomer) GetLoyaltyMemberships() []LoyaltyMembership { + if o == nil || o.LoyaltyMemberships == nil { + var ret []LoyaltyMembership + return ret + } + return *o.LoyaltyMemberships +} + +// GetLoyaltyMembershipsOk returns a tuple with the LoyaltyMemberships field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceCustomer) GetLoyaltyMembershipsOk() ([]LoyaltyMembership, bool) { + if o == nil || o.LoyaltyMemberships == nil { + var ret []LoyaltyMembership + return ret, false + } + return *o.LoyaltyMemberships, true +} + +// HasLoyaltyMemberships returns a boolean if a field has been set. +func (o *AudienceCustomer) HasLoyaltyMemberships() bool { + if o != nil && o.LoyaltyMemberships != nil { + return true + } + + return false +} + +// SetLoyaltyMemberships gets a reference to the given []LoyaltyMembership and assigns it to the LoyaltyMemberships field. +func (o *AudienceCustomer) SetLoyaltyMemberships(v []LoyaltyMembership) { + o.LoyaltyMemberships = &v +} + +// GetAudienceMemberships returns the AudienceMemberships field value if set, zero value otherwise. +func (o *AudienceCustomer) GetAudienceMemberships() []AudienceMembership { + if o == nil || o.AudienceMemberships == nil { + var ret []AudienceMembership + return ret + } + return *o.AudienceMemberships +} + +// GetAudienceMembershipsOk returns a tuple with the AudienceMemberships field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceCustomer) GetAudienceMembershipsOk() ([]AudienceMembership, bool) { + if o == nil || o.AudienceMemberships == nil { + var ret []AudienceMembership + return ret, false + } + return *o.AudienceMemberships, true +} + +// HasAudienceMemberships returns a boolean if a field has been set. +func (o *AudienceCustomer) HasAudienceMemberships() bool { + if o != nil && o.AudienceMemberships != nil { + return true + } + + return false +} + +// SetAudienceMemberships gets a reference to the given []AudienceMembership and assigns it to the AudienceMemberships field. +func (o *AudienceCustomer) SetAudienceMemberships(v []AudienceMembership) { + o.AudienceMemberships = &v +} + +// GetLastActivity returns the LastActivity field value +func (o *AudienceCustomer) GetLastActivity() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.LastActivity +} + +// SetLastActivity sets field value +func (o *AudienceCustomer) SetLastActivity(v time.Time) { + o.LastActivity = v +} + +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *AudienceCustomer) 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 *AudienceCustomer) 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 *AudienceCustomer) 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 *AudienceCustomer) SetSandbox(v bool) { + o.Sandbox = &v +} + +// GetConnectedApplicationsIds returns the ConnectedApplicationsIds field value if set, zero value otherwise. +func (o *AudienceCustomer) GetConnectedApplicationsIds() []int32 { + if o == nil || o.ConnectedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.ConnectedApplicationsIds +} + +// GetConnectedApplicationsIdsOk returns a tuple with the ConnectedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceCustomer) GetConnectedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.ConnectedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.ConnectedApplicationsIds, true +} + +// HasConnectedApplicationsIds returns a boolean if a field has been set. +func (o *AudienceCustomer) HasConnectedApplicationsIds() bool { + if o != nil && o.ConnectedApplicationsIds != nil { + return true + } + + return false +} + +// SetConnectedApplicationsIds gets a reference to the given []int32 and assigns it to the ConnectedApplicationsIds field. +func (o *AudienceCustomer) SetConnectedApplicationsIds(v []int32) { + o.ConnectedApplicationsIds = &v +} + +// GetConnectedAudiences returns the ConnectedAudiences field value if set, zero value otherwise. +func (o *AudienceCustomer) GetConnectedAudiences() []int32 { + if o == nil || o.ConnectedAudiences == nil { + var ret []int32 + return ret + } + return *o.ConnectedAudiences +} + +// GetConnectedAudiencesOk returns a tuple with the ConnectedAudiences field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AudienceCustomer) GetConnectedAudiencesOk() ([]int32, bool) { + if o == nil || o.ConnectedAudiences == nil { + var ret []int32 + return ret, false + } + return *o.ConnectedAudiences, true +} + +// HasConnectedAudiences returns a boolean if a field has been set. +func (o *AudienceCustomer) HasConnectedAudiences() bool { + if o != nil && o.ConnectedAudiences != nil { + return true + } + + return false +} + +// SetConnectedAudiences gets a reference to the given []int32 and assigns it to the ConnectedAudiences field. +func (o *AudienceCustomer) SetConnectedAudiences(v []int32) { + o.ConnectedAudiences = &v +} + +type NullableAudienceCustomer struct { + Value AudienceCustomer + ExplicitNull bool +} + +func (v NullableAudienceCustomer) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAudienceCustomer) 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 index 0638c1b8..1a9ef91d 100644 --- a/model_audience_integration_id.go +++ b/model_audience_integration_id.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_audience_membership.go b/model_audience_membership.go index d67282fe..ecae861a 100644 --- a/model_audience_membership.go +++ b/model_audience_membership.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 0dc3400c..516484c3 100644 --- a/model_award_giveaway_effect_props.go +++ b/model_award_giveaway_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_base_loyalty_program.go b/model_base_loyalty_program.go index dcd64f6b..82f2bee6 100644 --- a/model_base_loyalty_program.go +++ b/model_base_loyalty_program.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,14 +22,16 @@ type BaseLoyaltyProgram struct { Description *string `json:"description,omitempty"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications *[]int32 `json:"subscribedApplications,omitempty"` - // 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'. + // The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. 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'. + // The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. DefaultPending *string `json:"defaultPending,omitempty"` // Indicates if this program supports subledgers inside the program. AllowSubledger *bool `json:"allowSubledger,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"` + // Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. + Sandbox *bool `json:"sandbox,omitempty"` } // GetTitle returns the Title field value if set, zero value otherwise. @@ -263,6 +265,39 @@ func (o *BaseLoyaltyProgram) SetUsersPerCardLimit(v int32) { o.UsersPerCardLimit = &v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *BaseLoyaltyProgram) 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 *BaseLoyaltyProgram) 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 *BaseLoyaltyProgram) 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 *BaseLoyaltyProgram) SetSandbox(v bool) { + o.Sandbox = &v +} + type NullableBaseLoyaltyProgram struct { Value BaseLoyaltyProgram ExplicitNull bool diff --git a/model_base_notification.go b/model_base_notification.go new file mode 100644 index 00000000..bd24e439 --- /dev/null +++ b/model_base_notification.go @@ -0,0 +1,91 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// BaseNotification +type BaseNotification struct { + Policy map[string]interface{} `json:"policy"` + Webhook BaseNotificationWebhook `json:"webhook"` + // Unique ID for this entity. + Id int32 `json:"id"` +} + +// GetPolicy returns the Policy field value +func (o *BaseNotification) GetPolicy() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Policy +} + +// SetPolicy sets field value +func (o *BaseNotification) SetPolicy(v map[string]interface{}) { + o.Policy = v +} + +// GetWebhook returns the Webhook field value +func (o *BaseNotification) GetWebhook() BaseNotificationWebhook { + if o == nil { + var ret BaseNotificationWebhook + return ret + } + + return o.Webhook +} + +// SetWebhook sets field value +func (o *BaseNotification) SetWebhook(v BaseNotificationWebhook) { + o.Webhook = v +} + +// GetId returns the Id field value +func (o *BaseNotification) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *BaseNotification) SetId(v int32) { + o.Id = v +} + +type NullableBaseNotification struct { + Value BaseNotification + ExplicitNull bool +} + +func (v NullableBaseNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableBaseNotification) 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_base_notification_entity.go b/model_base_notification_entity.go new file mode 100644 index 00000000..1d7007c2 --- /dev/null +++ b/model_base_notification_entity.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// BaseNotificationEntity struct for BaseNotificationEntity +type BaseNotificationEntity struct { + Policy map[string]interface{} `json:"policy"` +} + +// GetPolicy returns the Policy field value +func (o *BaseNotificationEntity) GetPolicy() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Policy +} + +// SetPolicy sets field value +func (o *BaseNotificationEntity) SetPolicy(v map[string]interface{}) { + o.Policy = v +} + +type NullableBaseNotificationEntity struct { + Value BaseNotificationEntity + ExplicitNull bool +} + +func (v NullableBaseNotificationEntity) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableBaseNotificationEntity) 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_base_notification_webhook.go b/model_base_notification_webhook.go new file mode 100644 index 00000000..2fa3ff54 --- /dev/null +++ b/model_base_notification_webhook.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// BaseNotificationWebhook +type BaseNotificationWebhook struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. + Created time.Time `json:"created"` + // The time this entity was last modified. + Modified time.Time `json:"modified"` + // API URL for the given webhook-based notification. + Url string `json:"url"` + // List of API HTTP headers for the given webhook-based notification. + Headers []string `json:"headers"` +} + +// GetId returns the Id field value +func (o *BaseNotificationWebhook) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *BaseNotificationWebhook) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *BaseNotificationWebhook) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *BaseNotificationWebhook) SetCreated(v time.Time) { + o.Created = v +} + +// GetModified returns the Modified field value +func (o *BaseNotificationWebhook) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *BaseNotificationWebhook) SetModified(v time.Time) { + o.Modified = v +} + +// GetUrl returns the Url field value +func (o *BaseNotificationWebhook) GetUrl() string { + if o == nil { + var ret string + return ret + } + + return o.Url +} + +// SetUrl sets field value +func (o *BaseNotificationWebhook) SetUrl(v string) { + o.Url = v +} + +// GetHeaders returns the Headers field value +func (o *BaseNotificationWebhook) GetHeaders() []string { + if o == nil { + var ret []string + return ret + } + + return o.Headers +} + +// SetHeaders sets field value +func (o *BaseNotificationWebhook) SetHeaders(v []string) { + o.Headers = v +} + +type NullableBaseNotificationWebhook struct { + Value BaseNotificationWebhook + ExplicitNull bool +} + +func (v NullableBaseNotificationWebhook) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableBaseNotificationWebhook) 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_base_notifications.go b/model_base_notifications.go new file mode 100644 index 00000000..cd22706f --- /dev/null +++ b/model_base_notifications.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// BaseNotifications struct for BaseNotifications +type BaseNotifications struct { + // List of notifications. + Data *[]BaseNotification `json:"data,omitempty"` +} + +// GetData returns the Data field value if set, zero value otherwise. +func (o *BaseNotifications) GetData() []BaseNotification { + if o == nil || o.Data == nil { + var ret []BaseNotification + 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 *BaseNotifications) GetDataOk() ([]BaseNotification, bool) { + if o == nil || o.Data == nil { + var ret []BaseNotification + return ret, false + } + return *o.Data, true +} + +// HasData returns a boolean if a field has been set. +func (o *BaseNotifications) HasData() bool { + if o != nil && o.Data != nil { + return true + } + + return false +} + +// SetData gets a reference to the given []BaseNotification and assigns it to the Data field. +func (o *BaseNotifications) SetData(v []BaseNotification) { + o.Data = &v +} + +type NullableBaseNotifications struct { + Value BaseNotifications + ExplicitNull bool +} + +func (v NullableBaseNotifications) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableBaseNotifications) 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_base_saml_connection.go b/model_base_saml_connection.go index 3e49714c..d4c30408 100644 --- a/model_base_saml_connection.go +++ b/model_base_saml_connection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_binding.go b/model_binding.go index 0a66e725..2449ece1 100644 --- a/model_binding.go +++ b/model_binding.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_bulk_application_notification.go b/model_bulk_application_notification.go index b5ed8526..9f1ab7e6 100644 --- a/model_bulk_application_notification.go +++ b/model_bulk_application_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_bulk_campaign_notification.go b/model_bulk_campaign_notification.go index 8ba020e7..0ce3e882 100644 --- a/model_bulk_campaign_notification.go +++ b/model_bulk_campaign_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign.go b/model_campaign.go index d5b38d5f..247a4a1a 100644 --- a/model_campaign.go +++ b/model_campaign.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,7 +23,7 @@ type Campaign struct { 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. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` // A user-facing name for this campaign. Name string `json:"name"` @@ -37,7 +37,7 @@ type Campaign struct { 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](https://docs.talon.one/management-api/#operation/getRulesets) 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"` @@ -45,9 +45,9 @@ type Campaign struct { Features []string `json:"features"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) 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](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + // 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"` @@ -77,6 +77,8 @@ type Campaign struct { RedeemedLoyaltyPointsEffectCount *int32 `json:"redeemedLoyaltyPointsEffectCount,omitempty"` // Total number of webhook triggered by rules in this campaign. CallApiEffectCount *int32 `json:"callApiEffectCount,omitempty"` + // Total number of reserve coupon effects triggered by rules in this campaign. + ReservecouponEffectCount *int32 `json:"reservecouponEffectCount,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's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. @@ -932,6 +934,39 @@ func (o *Campaign) SetCallApiEffectCount(v int32) { o.CallApiEffectCount = &v } +// GetReservecouponEffectCount returns the ReservecouponEffectCount field value if set, zero value otherwise. +func (o *Campaign) GetReservecouponEffectCount() int32 { + if o == nil || o.ReservecouponEffectCount == nil { + var ret int32 + return ret + } + return *o.ReservecouponEffectCount +} + +// GetReservecouponEffectCountOk returns a tuple with the ReservecouponEffectCount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetReservecouponEffectCountOk() (int32, bool) { + if o == nil || o.ReservecouponEffectCount == nil { + var ret int32 + return ret, false + } + return *o.ReservecouponEffectCount, true +} + +// HasReservecouponEffectCount returns a boolean if a field has been set. +func (o *Campaign) HasReservecouponEffectCount() bool { + if o != nil && o.ReservecouponEffectCount != nil { + return true + } + + return false +} + +// SetReservecouponEffectCount gets a reference to the given int32 and assigns it to the ReservecouponEffectCount field. +func (o *Campaign) SetReservecouponEffectCount(v int32) { + o.ReservecouponEffectCount = &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 index aff58ce9..c039b952 100644 --- a/model_campaign_activation_request.go +++ b/model_campaign_activation_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_analytics.go b/model_campaign_analytics.go index 348ee80b..66ee03be 100644 --- a/model_campaign_analytics.go +++ b/model_campaign_analytics.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_collection.go b/model_campaign_collection.go index dd9cdc12..5e0fb299 100644 --- a/model_campaign_collection.go +++ b/model_campaign_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // The time this entity was last modified. Modified time.Time `json:"modified"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` diff --git a/model_campaign_collection_without_payload.go b/model_campaign_collection_without_payload.go index d8ae2de8..35ef09e4 100644 --- a/model_campaign_collection_without_payload.go +++ b/model_campaign_collection_without_payload.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // The time this entity was last modified. Modified time.Time `json:"modified"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` diff --git a/model_campaign_copy.go b/model_campaign_copy.go index 2a7363dd..ad0a7e54 100644 --- a/model_campaign_copy.go +++ b/model_campaign_copy.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_created_notification.go b/model_campaign_created_notification.go index 04d52d69..c83f7d24 100644 --- a/model_campaign_created_notification.go +++ b/model_campaign_created_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,9 @@ import ( // CampaignCreatedNotification A notification regarding a campaign that was created. type CampaignCreatedNotification struct { - Campaign Campaign `json:"campaign"` + Campaign Campaign `json:"campaign"` + Ruleset *Ruleset `json:"ruleset,omitempty"` + Priority PriorityPosition `json:"priority"` } // GetCampaign returns the Campaign field value @@ -34,6 +36,54 @@ func (o *CampaignCreatedNotification) SetCampaign(v Campaign) { o.Campaign = v } +// GetRuleset returns the Ruleset field value if set, zero value otherwise. +func (o *CampaignCreatedNotification) GetRuleset() Ruleset { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret + } + return *o.Ruleset +} + +// GetRulesetOk returns a tuple with the Ruleset field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCreatedNotification) GetRulesetOk() (Ruleset, bool) { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret, false + } + return *o.Ruleset, true +} + +// HasRuleset returns a boolean if a field has been set. +func (o *CampaignCreatedNotification) HasRuleset() bool { + if o != nil && o.Ruleset != nil { + return true + } + + return false +} + +// SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. +func (o *CampaignCreatedNotification) SetRuleset(v Ruleset) { + o.Ruleset = &v +} + +// GetPriority returns the Priority field value +func (o *CampaignCreatedNotification) GetPriority() PriorityPosition { + if o == nil { + var ret PriorityPosition + return ret + } + + return o.Priority +} + +// SetPriority sets field value +func (o *CampaignCreatedNotification) SetPriority(v PriorityPosition) { + o.Priority = v +} + type NullableCampaignCreatedNotification struct { Value CampaignCreatedNotification ExplicitNull bool diff --git a/model_campaign_deleted_notification.go b/model_campaign_deleted_notification.go index dfb2123f..03a46e82 100644 --- a/model_campaign_deleted_notification.go +++ b/model_campaign_deleted_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,11 +12,14 @@ package talon import ( "bytes" "encoding/json" + "time" ) // CampaignDeletedNotification A notification regarding a campaign that was deleted. type CampaignDeletedNotification struct { Campaign Campaign `json:"campaign"` + // Time when the campaign was deleted. + DeletedAt time.Time `json:"deletedAt"` } // GetCampaign returns the Campaign field value @@ -34,6 +37,21 @@ func (o *CampaignDeletedNotification) SetCampaign(v Campaign) { o.Campaign = v } +// GetDeletedAt returns the DeletedAt field value +func (o *CampaignDeletedNotification) GetDeletedAt() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.DeletedAt +} + +// SetDeletedAt sets field value +func (o *CampaignDeletedNotification) SetDeletedAt(v time.Time) { + o.DeletedAt = v +} + type NullableCampaignDeletedNotification struct { Value CampaignDeletedNotification ExplicitNull bool diff --git a/model_campaign_edited_notification.go b/model_campaign_edited_notification.go index a8ccef3b..da2433ac 100644 --- a/model_campaign_edited_notification.go +++ b/model_campaign_edited_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,6 +18,7 @@ import ( type CampaignEditedNotification struct { Campaign Campaign `json:"campaign"` OldCampaign Campaign `json:"oldCampaign"` + Ruleset *Ruleset `json:"ruleset,omitempty"` } // GetCampaign returns the Campaign field value @@ -50,6 +51,39 @@ func (o *CampaignEditedNotification) SetOldCampaign(v Campaign) { o.OldCampaign = v } +// GetRuleset returns the Ruleset field value if set, zero value otherwise. +func (o *CampaignEditedNotification) GetRuleset() Ruleset { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret + } + return *o.Ruleset +} + +// GetRulesetOk returns a tuple with the Ruleset field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignEditedNotification) GetRulesetOk() (Ruleset, bool) { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret, false + } + return *o.Ruleset, true +} + +// HasRuleset returns a boolean if a field has been set. +func (o *CampaignEditedNotification) HasRuleset() bool { + if o != nil && o.Ruleset != nil { + return true + } + + return false +} + +// SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. +func (o *CampaignEditedNotification) SetRuleset(v Ruleset) { + o.Ruleset = &v +} + type NullableCampaignEditedNotification struct { Value CampaignEditedNotification ExplicitNull bool diff --git a/model_campaign_entity.go b/model_campaign_entity.go index 2f55d43c..45f15c5c 100644 --- a/model_campaign_entity.go +++ b/model_campaign_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_group.go b/model_campaign_group.go index 13d179b1..7aa8ee56 100644 --- a/model_campaign_group.go +++ b/model_campaign_group.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,11 +17,11 @@ import ( // CampaignGroup type CampaignGroup 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified time.Time `json:"modified"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` diff --git a/model_campaign_group_entity.go b/model_campaign_group_entity.go index 0a4d8870..05f05b4a 100644 --- a/model_campaign_group_entity.go +++ b/model_campaign_group_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_notification.go b/model_campaign_notification.go index 4af418b0..e2f06adc 100644 --- a/model_campaign_notification.go +++ b/model_campaign_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_priorities_changed_notification.go b/model_campaign_priorities_changed_notification.go index f24566a0..bb1a90ac 100644 --- a/model_campaign_priorities_changed_notification.go +++ b/model_campaign_priorities_changed_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,32 +16,31 @@ import ( // 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"` + // The ID of the Application whose campaigns' priorities changed. + ApplicationId int32 `json:"applicationId"` + OldPriorities *CampaignSet `json:"oldPriorities,omitempty"` + Priorities CampaignSet `json:"priorities"` } -// GetApplication returns the Application field value -func (o *CampaignPrioritiesChangedNotification) GetApplication() Application { +// GetApplicationId returns the ApplicationId field value +func (o *CampaignPrioritiesChangedNotification) GetApplicationId() int32 { if o == nil { - var ret Application + var ret int32 return ret } - return o.Application + return o.ApplicationId } -// SetApplication sets field value -func (o *CampaignPrioritiesChangedNotification) SetApplication(v Application) { - o.Application = v +// SetApplicationId sets field value +func (o *CampaignPrioritiesChangedNotification) SetApplicationId(v int32) { + o.ApplicationId = v } // GetOldPriorities returns the OldPriorities field value if set, zero value otherwise. -func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() map[string][]int32 { +func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() CampaignSet { if o == nil || o.OldPriorities == nil { - var ret map[string][]int32 + var ret CampaignSet return ret } return *o.OldPriorities @@ -49,9 +48,9 @@ func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() map[string][] // 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) { +func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (CampaignSet, bool) { if o == nil || o.OldPriorities == nil { - var ret map[string][]int32 + var ret CampaignSet return ret, false } return *o.OldPriorities, true @@ -66,15 +65,15 @@ func (o *CampaignPrioritiesChangedNotification) HasOldPriorities() bool { 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) { +// SetOldPriorities gets a reference to the given CampaignSet and assigns it to the OldPriorities field. +func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v CampaignSet) { o.OldPriorities = &v } // GetPriorities returns the Priorities field value -func (o *CampaignPrioritiesChangedNotification) GetPriorities() map[string][]int32 { +func (o *CampaignPrioritiesChangedNotification) GetPriorities() CampaignSet { if o == nil { - var ret map[string][]int32 + var ret CampaignSet return ret } @@ -82,7 +81,7 @@ func (o *CampaignPrioritiesChangedNotification) GetPriorities() map[string][]int } // SetPriorities sets field value -func (o *CampaignPrioritiesChangedNotification) SetPriorities(v map[string][]int32) { +func (o *CampaignPrioritiesChangedNotification) SetPriorities(v CampaignSet) { o.Priorities = v } diff --git a/model_campaign_priorities_v2.go b/model_campaign_priorities_v2.go index 4d352f0d..0c747b5f 100644 --- a/model_campaign_priorities_v2.go +++ b/model_campaign_priorities_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_ruleset_changed_notification.go b/model_campaign_ruleset_changed_notification.go index 4f061709..26c50c6d 100644 --- a/model_campaign_ruleset_changed_notification.go +++ b/model_campaign_ruleset_changed_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,7 +18,7 @@ import ( type CampaignRulesetChangedNotification struct { Campaign Campaign `json:"campaign"` OldRuleset *Ruleset `json:"oldRuleset,omitempty"` - Ruleset Ruleset `json:"ruleset"` + Ruleset *Ruleset `json:"ruleset,omitempty"` } // GetCampaign returns the Campaign field value @@ -69,19 +69,37 @@ func (o *CampaignRulesetChangedNotification) SetOldRuleset(v Ruleset) { o.OldRuleset = &v } -// GetRuleset returns the Ruleset field value +// GetRuleset returns the Ruleset field value if set, zero value otherwise. func (o *CampaignRulesetChangedNotification) GetRuleset() Ruleset { - if o == nil { + if o == nil || o.Ruleset == nil { var ret Ruleset return ret } + return *o.Ruleset +} + +// GetRulesetOk returns a tuple with the Ruleset field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignRulesetChangedNotification) GetRulesetOk() (Ruleset, bool) { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret, false + } + return *o.Ruleset, true +} + +// HasRuleset returns a boolean if a field has been set. +func (o *CampaignRulesetChangedNotification) HasRuleset() bool { + if o != nil && o.Ruleset != nil { + return true + } - return o.Ruleset + return false } -// SetRuleset sets field value +// SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. func (o *CampaignRulesetChangedNotification) SetRuleset(v Ruleset) { - o.Ruleset = v + o.Ruleset = &v } type NullableCampaignRulesetChangedNotification struct { diff --git a/model_campaign_search.go b/model_campaign_search.go index 2d866760..3429f9ac 100644 --- a/model_campaign_search.go +++ b/model_campaign_search.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_set.go b/model_campaign_set.go index b7edab9f..e7da75df 100644 --- a/model_campaign_set.go +++ b/model_campaign_set.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,15 +17,17 @@ import ( // CampaignSet type CampaignSet 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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 CampaignSetBranchNode `json:"set"` + // Name of the user who last updated this campaign set, if available. + UpdatedBy *string `json:"updatedBy,omitempty"` } // GetId returns the Id field value @@ -103,6 +105,39 @@ func (o *CampaignSet) SetSet(v CampaignSetBranchNode) { o.Set = v } +// GetUpdatedBy returns the UpdatedBy field value if set, zero value otherwise. +func (o *CampaignSet) GetUpdatedBy() string { + if o == nil || o.UpdatedBy == nil { + var ret string + return ret + } + return *o.UpdatedBy +} + +// GetUpdatedByOk returns a tuple with the UpdatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignSet) GetUpdatedByOk() (string, bool) { + if o == nil || o.UpdatedBy == nil { + var ret string + return ret, false + } + return *o.UpdatedBy, true +} + +// HasUpdatedBy returns a boolean if a field has been set. +func (o *CampaignSet) HasUpdatedBy() bool { + if o != nil && o.UpdatedBy != nil { + return true + } + + return false +} + +// SetUpdatedBy gets a reference to the given string and assigns it to the UpdatedBy field. +func (o *CampaignSet) SetUpdatedBy(v string) { + o.UpdatedBy = &v +} + type NullableCampaignSet struct { Value CampaignSet ExplicitNull bool diff --git a/model_campaign_set_branch_node.go b/model_campaign_set_branch_node.go index d699bcd4..632c5c58 100644 --- a/model_campaign_set_branch_node.go +++ b/model_campaign_set_branch_node.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_set_i_ds.go b/model_campaign_set_i_ds.go index 6902128f..7caf7337 100644 --- a/model_campaign_set_i_ds.go +++ b/model_campaign_set_i_ds.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_set_leaf_node.go b/model_campaign_set_leaf_node.go index ae03bffb..53b95a59 100644 --- a/model_campaign_set_leaf_node.go +++ b/model_campaign_set_leaf_node.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_set_node.go b/model_campaign_set_node.go index 71347c70..2290b08a 100644 --- a/model_campaign_set_node.go +++ b/model_campaign_set_node.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_set_v2.go b/model_campaign_set_v2.go index fc1144cf..3dd9e681 100644 --- a/model_campaign_set_v2.go +++ b/model_campaign_set_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` diff --git a/model_campaign_state_changed_notification.go b/model_campaign_state_changed_notification.go index e764c6ea..f5d60aae 100644 --- a/model_campaign_state_changed_notification.go +++ b/model_campaign_state_changed_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -20,7 +20,8 @@ type CampaignStateChangedNotification struct { // 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"` + NewState string `json:"newState"` + Ruleset *Ruleset `json:"ruleset,omitempty"` } // GetCampaign returns the Campaign field value @@ -68,6 +69,39 @@ func (o *CampaignStateChangedNotification) SetNewState(v string) { o.NewState = v } +// GetRuleset returns the Ruleset field value if set, zero value otherwise. +func (o *CampaignStateChangedNotification) GetRuleset() Ruleset { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret + } + return *o.Ruleset +} + +// GetRulesetOk returns a tuple with the Ruleset field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignStateChangedNotification) GetRulesetOk() (Ruleset, bool) { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret, false + } + return *o.Ruleset, true +} + +// HasRuleset returns a boolean if a field has been set. +func (o *CampaignStateChangedNotification) HasRuleset() bool { + if o != nil && o.Ruleset != nil { + return true + } + + return false +} + +// SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. +func (o *CampaignStateChangedNotification) SetRuleset(v Ruleset) { + o.Ruleset = &v +} + type NullableCampaignStateChangedNotification struct { Value CampaignStateChangedNotification ExplicitNull bool diff --git a/model_campaign_template.go b/model_campaign_template.go index 426081ab..9642b1de 100644 --- a/model_campaign_template.go +++ b/model_campaign_template.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // CampaignTemplate type CampaignTemplate 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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 account that owns this entity. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` // The campaign template name. Name string `json:"name"` @@ -31,13 +31,13 @@ type CampaignTemplate struct { Description string `json:"description"` // Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. Instructions string `json:"instructions"` - // The Campaign Attributes that Campaigns created from this template will have by default. + // The campaign attributes that campaigns created from this template will have by default. CampaignAttributes *map[string]interface{} `json:"campaignAttributes,omitempty"` - // The Campaign Attributes that Coupons created from this template will have by default. + // The campaign attributes that coupons created from this template will have by default. CouponAttributes *map[string]interface{} `json:"couponAttributes,omitempty"` - // Only Campaign Templates in 'available' state may be used to create Campaigns. + // Only campaign templates in 'available' state may be used to create campaigns. State string `json:"state"` - // The ID of the Ruleset this Campaign Template will use. + // The ID of the ruleset this campaign template will use. ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` // A list of tags for the campaign template. Tags *[]string `json:"tags,omitempty"` @@ -45,21 +45,21 @@ 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 operate for this campaign template. Limits *[]TemplateLimitConfig `json:"limits,omitempty"` - // Template parameters are fields which can be used to replace values in a rule. + // 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 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. + // The default campaign group ID. 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. + // Name of the user who last updated this campaign template, if available. UpdatedBy *string `json:"updatedBy,omitempty"` - // The IDs of the applications that are related to this entity. + // The IDs of the Applications that are related to this entity. ValidApplicationIds []int32 `json:"validApplicationIds"` } diff --git a/model_campaign_template_collection.go b/model_campaign_template_collection.go index 7eceee97..cce30772 100644 --- a/model_campaign_template_collection.go +++ b/model_campaign_template_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_campaign_template_params.go b/model_campaign_template_params.go index d596c0c9..7c796355 100644 --- a/model_campaign_template_params.go +++ b/model_campaign_template_params.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_card_ledger_transaction_log_entry.go b/model_card_ledger_transaction_log_entry.go index a1a39672..5abb91c1 100644 --- a/model_card_ledger_transaction_log_entry.go +++ b/model_card_ledger_transaction_log_entry.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -21,19 +21,19 @@ type CardLedgerTransactionLogEntry struct { Created time.Time `json:"created"` // ID of the loyalty program. ProgramId int32 `json:"programId"` - // Identifier of the loyalty card. + // The alphanumeric 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. + CustomerSessionId *string `json:"customerSessionId,omitempty"` + // Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. 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. + // When points become active. Possible values: - `immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time. 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"` @@ -156,19 +156,37 @@ func (o *CardLedgerTransactionLogEntry) SetSessionId(v int32) { o.SessionId = &v } -// GetCustomerSessionId returns the CustomerSessionId field value +// GetCustomerSessionId returns the CustomerSessionId field value if set, zero value otherwise. func (o *CardLedgerTransactionLogEntry) GetCustomerSessionId() string { - if o == nil { + if o == nil || o.CustomerSessionId == nil { var ret string return ret } + return *o.CustomerSessionId +} + +// GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CardLedgerTransactionLogEntry) GetCustomerSessionIdOk() (string, bool) { + if o == nil || o.CustomerSessionId == nil { + var ret string + return ret, false + } + return *o.CustomerSessionId, true +} + +// HasCustomerSessionId returns a boolean if a field has been set. +func (o *CardLedgerTransactionLogEntry) HasCustomerSessionId() bool { + if o != nil && o.CustomerSessionId != nil { + return true + } - return o.CustomerSessionId + return false } -// SetCustomerSessionId sets field value +// SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. func (o *CardLedgerTransactionLogEntry) SetCustomerSessionId(v string) { - o.CustomerSessionId = v + o.CustomerSessionId = &v } // GetType returns the Type field value diff --git a/model_card_ledger_transaction_log_entry_integration_api.go b/model_card_ledger_transaction_log_entry_integration_api.go index 8f908e77..12bea9d2 100644 --- a/model_card_ledger_transaction_log_entry_integration_api.go +++ b/model_card_ledger_transaction_log_entry_integration_api.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -21,15 +21,15 @@ type CardLedgerTransactionLogEntryIntegrationApi struct { Created time.Time `json:"created"` // ID of the loyalty program. ProgramId int32 `json:"programId"` - // Identifier of the loyalty card. + // The alphanumeric 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. + CustomerSessionId *string `json:"customerSessionId,omitempty"` + // Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. 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. + // When points become active. Possible values: - `immediate`: Points are active immediately. - a timestamp value: Points become active at a given date and time. 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"` @@ -90,19 +90,37 @@ func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCardIdentifier(v string o.CardIdentifier = v } -// GetCustomerSessionId returns the CustomerSessionId field value +// GetCustomerSessionId returns the CustomerSessionId field value if set, zero value otherwise. func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCustomerSessionId() string { - if o == nil { + if o == nil || o.CustomerSessionId == nil { var ret string return ret } + return *o.CustomerSessionId +} + +// GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CardLedgerTransactionLogEntryIntegrationApi) GetCustomerSessionIdOk() (string, bool) { + if o == nil || o.CustomerSessionId == nil { + var ret string + return ret, false + } + return *o.CustomerSessionId, true +} + +// HasCustomerSessionId returns a boolean if a field has been set. +func (o *CardLedgerTransactionLogEntryIntegrationApi) HasCustomerSessionId() bool { + if o != nil && o.CustomerSessionId != nil { + return true + } - return o.CustomerSessionId + return false } -// SetCustomerSessionId sets field value +// SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. func (o *CardLedgerTransactionLogEntryIntegrationApi) SetCustomerSessionId(v string) { - o.CustomerSessionId = v + o.CustomerSessionId = &v } // GetType returns the Type field value diff --git a/model_cart_item.go b/model_cart_item.go index b11942cb..891840e2 100644 --- a/model_cart_item.go +++ b/model_cart_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,17 +17,17 @@ import ( // CartItem struct for CartItem type CartItem struct { // Name of item. - Name string `json:"name"` + Name *string `json:"name,omitempty"` // Stock keeping unit of item. Sku string `json:"sku"` - // 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 of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening), 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"` // 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"` + // 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,omitempty"` // Type, group or model of the item. Category *string `json:"category,omitempty"` // Weight of item in grams. @@ -42,25 +42,43 @@ type CartItem struct { Position *float32 `json:"position,omitempty"` // 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/). + // 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 +// GetName returns the Name field value if set, zero value otherwise. func (o *CartItem) GetName() string { - if o == nil { + 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 *CartItem) 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 *CartItem) HasName() bool { + if o != nil && o.Name != nil { + return true + } - return o.Name + return false } -// SetName sets field value +// SetName gets a reference to the given string and assigns it to the Name field. func (o *CartItem) SetName(v string) { - o.Name = v + o.Name = &v } // GetSku returns the Sku field value @@ -159,19 +177,37 @@ func (o *CartItem) SetRemainingQuantity(v int32) { o.RemainingQuantity = &v } -// GetPrice returns the Price field value +// GetPrice returns the Price field value if set, zero value otherwise. func (o *CartItem) GetPrice() float32 { - if o == nil { + 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 *CartItem) 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 *CartItem) HasPrice() bool { + if o != nil && o.Price != nil { + return true + } - return o.Price + return false } -// SetPrice sets field value +// SetPrice gets a reference to the given float32 and assigns it to the Price field. func (o *CartItem) SetPrice(v float32) { - o.Price = v + o.Price = &v } // GetCategory returns the Category field value if set, zero value otherwise. diff --git a/model_catalog.go b/model_catalog.go index 74844ddb..4eaaf590 100644 --- a/model_catalog.go +++ b/model_catalog.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // The time this entity was last modified. Modified time.Time `json:"modified"` // The cart item catalog name. Name string `json:"name"` diff --git a/model_catalog_action.go b/model_catalog_action.go index e84b2a7f..bcc8afc9 100644 --- a/model_catalog_action.go +++ b/model_catalog_action.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_catalog_action_filter.go b/model_catalog_action_filter.go index 48c8303c..6067f85b 100644 --- a/model_catalog_action_filter.go +++ b/model_catalog_action_filter.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_catalog_item.go b/model_catalog_item.go index 238799e6..6cf3e113 100644 --- a/model_catalog_item.go +++ b/model_catalog_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The stock keeping unit of the item. Sku string `json:"sku"` diff --git a/model_catalog_sync_request.go b/model_catalog_sync_request.go index b8261c77..262646e2 100644 --- a/model_catalog_sync_request.go +++ b/model_catalog_sync_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_catalogs_strikethrough_notification_policy.go b/model_catalogs_strikethrough_notification_policy.go new file mode 100644 index 00000000..0a3ae7ef --- /dev/null +++ b/model_catalogs_strikethrough_notification_policy.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CatalogsStrikethroughNotificationPolicy struct for CatalogsStrikethroughNotificationPolicy +type CatalogsStrikethroughNotificationPolicy struct { + // Notification name. + Name string `json:"name"` +} + +// GetName returns the Name field value +func (o *CatalogsStrikethroughNotificationPolicy) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CatalogsStrikethroughNotificationPolicy) SetName(v string) { + o.Name = v +} + +type NullableCatalogsStrikethroughNotificationPolicy struct { + Value CatalogsStrikethroughNotificationPolicy + ExplicitNull bool +} + +func (v NullableCatalogsStrikethroughNotificationPolicy) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCatalogsStrikethroughNotificationPolicy) 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 0fe341c5..0cfaa8d7 100644 --- a/model_change.go +++ b/model_change.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,11 +17,11 @@ import ( // Change type Change 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The ID of the account that owns this entity. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` // ID of application associated with change. ApplicationId *int32 `json:"applicationId,omitempty"` @@ -31,6 +31,8 @@ type Change struct { Old *map[string]interface{} `json:"old,omitempty"` // Resource after the change occurred. New *map[string]interface{} `json:"new,omitempty"` + // ID of management key used to perform changes. + ManagementKeyId *int32 `json:"managementKeyId,omitempty"` } // GetId returns the Id field value @@ -192,6 +194,39 @@ func (o *Change) SetNew(v map[string]interface{}) { o.New = &v } +// GetManagementKeyId returns the ManagementKeyId field value if set, zero value otherwise. +func (o *Change) GetManagementKeyId() int32 { + if o == nil || o.ManagementKeyId == nil { + var ret int32 + return ret + } + return *o.ManagementKeyId +} + +// GetManagementKeyIdOk returns a tuple with the ManagementKeyId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Change) GetManagementKeyIdOk() (int32, bool) { + if o == nil || o.ManagementKeyId == nil { + var ret int32 + return ret, false + } + return *o.ManagementKeyId, true +} + +// HasManagementKeyId returns a boolean if a field has been set. +func (o *Change) HasManagementKeyId() bool { + if o != nil && o.ManagementKeyId != nil { + return true + } + + return false +} + +// SetManagementKeyId gets a reference to the given int32 and assigns it to the ManagementKeyId field. +func (o *Change) SetManagementKeyId(v int32) { + o.ManagementKeyId = &v +} + type NullableChange struct { Value Change ExplicitNull bool diff --git a/model_change_profile_password.go b/model_change_profile_password.go index 72403741..16a0dfa8 100644 --- a/model_change_profile_password.go +++ b/model_change_profile_password.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_code_generator_settings.go b/model_code_generator_settings.go index 3758de7c..b0e070c8 100644 --- a/model_code_generator_settings.go +++ b/model_code_generator_settings.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ import ( // CodeGeneratorSettings struct for CodeGeneratorSettings type CodeGeneratorSettings struct { - // List of characters used to generate the random parts of a code. Defaults to a list equivalent to the `[A-Z, 0-9]` regexp. + // List of characters used to generate the random parts of a code. ValidCharacters []string `json:"validCharacters"` // 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 c255ee3f..5bae2b34 100644 --- a/model_collection.go +++ b/model_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // Collection type Collection 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // The time this entity was last modified. Modified time.Time `json:"modified"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` diff --git a/model_collection_item.go b/model_collection_item.go index 4e6cd6c5..9ba975ed 100644 --- a/model_collection_item.go +++ b/model_collection_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_collection_without_payload.go b/model_collection_without_payload.go index f30b2a8e..3346c813 100644 --- a/model_collection_without_payload.go +++ b/model_collection_without_payload.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // The time this entity was last modified. Modified time.Time `json:"modified"` // A short description of the purpose of this collection. Description *string `json:"description,omitempty"` diff --git a/model_coupon.go b/model_coupon.go index 3a046897..fb036d7a 100644 --- a/model_coupon.go +++ b/model_coupon.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // Coupon type Coupon 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the campaign that owns this entity. CampaignId int32 `json:"campaignId"` @@ -27,20 +27,24 @@ type Coupon struct { Value string `json:"value"` // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration 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. + // The number of times the coupon has been successfully redeemed. 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"` + // The number of times this coupon has been reserved. + ReservationCounter *float32 `json:"reservationCounter,omitempty"` // 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. @@ -49,10 +53,12 @@ type Coupon struct { RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` // The ID of the Import which created this coupon. ImportId *int32 `json:"importId,omitempty"` - // 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). + // 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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. Reservation *bool `json:"reservation,omitempty"` // The id of the batch the coupon belongs to. BatchId *string `json:"batchId,omitempty"` + // Whether the reservation effect actually created a new reservation. + IsReservationMandatory *bool `json:"isReservationMandatory,omitempty"` } // GetId returns the Id field value @@ -163,6 +169,39 @@ func (o *Coupon) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *Coupon) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Coupon) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *Coupon) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *Coupon) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *Coupon) GetStartDate() time.Time { if o == nil || o.StartDate == nil { @@ -343,6 +382,39 @@ func (o *Coupon) SetDiscountRemainder(v float32) { o.DiscountRemainder = &v } +// GetReservationCounter returns the ReservationCounter field value if set, zero value otherwise. +func (o *Coupon) GetReservationCounter() float32 { + if o == nil || o.ReservationCounter == nil { + var ret float32 + return ret + } + return *o.ReservationCounter +} + +// GetReservationCounterOk returns a tuple with the ReservationCounter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Coupon) GetReservationCounterOk() (float32, bool) { + if o == nil || o.ReservationCounter == nil { + var ret float32 + return ret, false + } + return *o.ReservationCounter, true +} + +// HasReservationCounter returns a boolean if a field has been set. +func (o *Coupon) HasReservationCounter() bool { + if o != nil && o.ReservationCounter != nil { + return true + } + + return false +} + +// SetReservationCounter gets a reference to the given float32 and assigns it to the ReservationCounter field. +func (o *Coupon) SetReservationCounter(v float32) { + o.ReservationCounter = &v +} + // GetAttributes returns the Attributes field value if set, zero value otherwise. func (o *Coupon) GetAttributes() map[string]interface{} { if o == nil || o.Attributes == nil { @@ -541,6 +613,39 @@ func (o *Coupon) SetBatchId(v string) { o.BatchId = &v } +// GetIsReservationMandatory returns the IsReservationMandatory field value if set, zero value otherwise. +func (o *Coupon) GetIsReservationMandatory() bool { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret + } + return *o.IsReservationMandatory +} + +// GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Coupon) GetIsReservationMandatoryOk() (bool, bool) { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret, false + } + return *o.IsReservationMandatory, true +} + +// HasIsReservationMandatory returns a boolean if a field has been set. +func (o *Coupon) HasIsReservationMandatory() bool { + if o != nil && o.IsReservationMandatory != nil { + return true + } + + return false +} + +// SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. +func (o *Coupon) SetIsReservationMandatory(v bool) { + o.IsReservationMandatory = &v +} + type NullableCoupon struct { Value Coupon ExplicitNull bool diff --git a/model_coupon_constraints.go b/model_coupon_constraints.go index 1c9755f2..615846d1 100644 --- a/model_coupon_constraints.go +++ b/model_coupon_constraints.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,11 +19,13 @@ import ( type CouponConstraints struct { // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` } @@ -93,6 +95,39 @@ func (o *CouponConstraints) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *CouponConstraints) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponConstraints) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *CouponConstraints) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *CouponConstraints) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *CouponConstraints) GetStartDate() time.Time { if o == nil || o.StartDate == nil { diff --git a/model_coupon_created_effect_props.go b/model_coupon_created_effect_props.go index d5269dbe..55e84128 100644 --- a/model_coupon_created_effect_props.go +++ b/model_coupon_created_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_coupon_creation_job.go b/model_coupon_creation_job.go index 7c702fd1..fa9b4e17 100644 --- a/model_coupon_creation_job.go +++ b/model_coupon_creation_job.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // CouponCreationJob type CouponCreationJob 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the campaign that owns this entity. CampaignId int32 `json:"campaignId"` @@ -29,13 +29,15 @@ type CouponCreationJob struct { AccountId int32 `json:"accountId"` // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. + // The number of new coupon codes to generate for the campaign. NumberOfCoupons int32 `json:"numberOfCoupons"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` // Arbitrary properties associated with coupons. @@ -183,6 +185,39 @@ func (o *CouponCreationJob) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *CouponCreationJob) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponCreationJob) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *CouponCreationJob) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *CouponCreationJob) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *CouponCreationJob) GetStartDate() time.Time { if o == nil || o.StartDate == nil { diff --git a/model_coupon_limit_configs.go b/model_coupon_limit_configs.go index 3bbaf08e..ad5e4259 100644 --- a/model_coupon_limit_configs.go +++ b/model_coupon_limit_configs.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_coupon_rejection_reason.go b/model_coupon_rejection_reason.go index 40f5f582..7e754370 100644 --- a/model_coupon_rejection_reason.go +++ b/model_coupon_rejection_reason.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_coupon_reservations.go b/model_coupon_reservations.go index 6afaac5c..52fc472d 100644 --- a/model_coupon_reservations.go +++ b/model_coupon_reservations.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_coupon_search.go b/model_coupon_search.go index 331f52fa..f2881aa9 100644 --- a/model_coupon_search.go +++ b/model_coupon_search.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_coupon_value.go b/model_coupon_value.go index 073ff252..10c2916a 100644 --- a/model_coupon_value.go +++ b/model_coupon_value.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_coupons_notification_policy.go b/model_coupons_notification_policy.go new file mode 100644 index 00000000..dcb2a09c --- /dev/null +++ b/model_coupons_notification_policy.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CouponsNotificationPolicy struct for CouponsNotificationPolicy +type CouponsNotificationPolicy struct { + // Notification name. + Name string `json:"name"` + Scopes []string `json:"scopes"` +} + +// GetName returns the Name field value +func (o *CouponsNotificationPolicy) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CouponsNotificationPolicy) SetName(v string) { + o.Name = v +} + +// GetScopes returns the Scopes field value +func (o *CouponsNotificationPolicy) GetScopes() []string { + if o == nil { + var ret []string + return ret + } + + return o.Scopes +} + +// SetScopes sets field value +func (o *CouponsNotificationPolicy) SetScopes(v []string) { + o.Scopes = v +} + +type NullableCouponsNotificationPolicy struct { + Value CouponsNotificationPolicy + ExplicitNull bool +} + +func (v NullableCouponsNotificationPolicy) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCouponsNotificationPolicy) 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_application_api_key.go b/model_create_application_api_key.go index acc202ee..5680f089 100644 --- a/model_create_application_api_key.go +++ b/model_create_application_api_key.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_create_management_key.go b/model_create_management_key.go index 88d6d8ae..7912dd6a 100644 --- a/model_create_management_key.go +++ b/model_create_management_key.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,6 +23,8 @@ type CreateManagementKey struct { ExpiryDate time.Time `json:"expiryDate"` // The list of endpoints that can be accessed with the key Endpoints []Endpoint `json:"endpoints"` + // A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. + AllowedApplicationIds *[]int32 `json:"allowedApplicationIds,omitempty"` } // GetName returns the Name field value @@ -70,6 +72,39 @@ func (o *CreateManagementKey) SetEndpoints(v []Endpoint) { o.Endpoints = v } +// GetAllowedApplicationIds returns the AllowedApplicationIds field value if set, zero value otherwise. +func (o *CreateManagementKey) GetAllowedApplicationIds() []int32 { + if o == nil || o.AllowedApplicationIds == nil { + var ret []int32 + return ret + } + return *o.AllowedApplicationIds +} + +// GetAllowedApplicationIdsOk returns a tuple with the AllowedApplicationIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CreateManagementKey) GetAllowedApplicationIdsOk() ([]int32, bool) { + if o == nil || o.AllowedApplicationIds == nil { + var ret []int32 + return ret, false + } + return *o.AllowedApplicationIds, true +} + +// HasAllowedApplicationIds returns a boolean if a field has been set. +func (o *CreateManagementKey) HasAllowedApplicationIds() bool { + if o != nil && o.AllowedApplicationIds != nil { + return true + } + + return false +} + +// SetAllowedApplicationIds gets a reference to the given []int32 and assigns it to the AllowedApplicationIds field. +func (o *CreateManagementKey) SetAllowedApplicationIds(v []int32) { + o.AllowedApplicationIds = &v +} + type NullableCreateManagementKey struct { Value CreateManagementKey ExplicitNull bool diff --git a/model_create_template_campaign.go b/model_create_template_campaign.go index a10724c2..59d3ff4b 100644 --- a/model_create_template_campaign.go +++ b/model_create_template_campaign.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -28,7 +28,7 @@ type CreateTemplateCampaign struct { 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. + // 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"` diff --git a/model_create_template_campaign_response.go b/model_create_template_campaign_response.go index 3261797a..63918036 100644 --- a/model_create_template_campaign_response.go +++ b/model_create_template_campaign_response.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_custom_effect.go b/model_custom_effect.go index 969423f7..4c762a6b 100644 --- a/model_custom_effect.go +++ b/model_custom_effect.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,16 +17,18 @@ import ( // CustomEffect type CustomEffect 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // The time this entity was last modified. 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"` + // Indicates if this effect is per item or not. + IsPerItem *bool `json:"isPerItem,omitempty"` // The name of this effect. Name string `json:"name"` // The title of this effect. @@ -120,6 +122,39 @@ func (o *CustomEffect) SetApplicationIds(v []int32) { o.ApplicationIds = v } +// GetIsPerItem returns the IsPerItem field value if set, zero value otherwise. +func (o *CustomEffect) GetIsPerItem() bool { + if o == nil || o.IsPerItem == nil { + var ret bool + return ret + } + return *o.IsPerItem +} + +// GetIsPerItemOk returns a tuple with the IsPerItem field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomEffect) GetIsPerItemOk() (bool, bool) { + if o == nil || o.IsPerItem == nil { + var ret bool + return ret, false + } + return *o.IsPerItem, true +} + +// HasIsPerItem returns a boolean if a field has been set. +func (o *CustomEffect) HasIsPerItem() bool { + if o != nil && o.IsPerItem != nil { + return true + } + + return false +} + +// SetIsPerItem gets a reference to the given bool and assigns it to the IsPerItem field. +func (o *CustomEffect) SetIsPerItem(v bool) { + o.IsPerItem = &v +} + // GetName returns the Name field value func (o *CustomEffect) GetName() string { if o == nil { diff --git a/model_custom_effect_props.go b/model_custom_effect_props.go index d55bca5e..18155c6d 100644 --- a/model_custom_effect_props.go +++ b/model_custom_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -20,6 +20,14 @@ type CustomEffectProps struct { EffectId int32 `json:"effectId"` // The type of the custom effect. Name string `json:"name"` + // The index of the item in the cart item list to which the custom effect is applied. + CartItemPosition *float32 `json:"cartItemPosition,omitempty"` + // When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1. + CartItemSubPosition *float32 `json:"cartItemSubPosition,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 definition. + BundleName *string `json:"bundleName,omitempty"` // The JSON payload of the custom effect. Payload map[string]interface{} `json:"payload"` } @@ -54,6 +62,138 @@ func (o *CustomEffectProps) SetName(v string) { o.Name = v } +// GetCartItemPosition returns the CartItemPosition field value if set, zero value otherwise. +func (o *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) SetCartItemPosition(v float32) { + o.CartItemPosition = &v +} + +// GetCartItemSubPosition returns the CartItemSubPosition field value if set, zero value otherwise. +func (o *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) SetCartItemSubPosition(v float32) { + o.CartItemSubPosition = &v +} + +// GetBundleIndex returns the BundleIndex field value if set, zero value otherwise. +func (o *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) SetBundleIndex(v int32) { + o.BundleIndex = &v +} + +// GetBundleName returns the BundleName field value if set, zero value otherwise. +func (o *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) 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 *CustomEffectProps) SetBundleName(v string) { + o.BundleName = &v +} + // GetPayload returns the Payload field value func (o *CustomEffectProps) GetPayload() map[string]interface{} { if o == nil { diff --git a/model_customer_activity_report.go b/model_customer_activity_report.go index 0ea4b3c8..8e783b26 100644 --- a/model_customer_activity_report.go +++ b/model_customer_activity_report.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ import ( type CustomerActivityReport struct { // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The name for this customer profile. Name string `json:"name"` diff --git a/model_customer_analytics.go b/model_customer_analytics.go index fc847aa4..cf1ad782 100644 --- a/model_customer_analytics.go +++ b/model_customer_analytics.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_customer_inventory.go b/model_customer_inventory.go index f87867a3..f6992164 100644 --- a/model_customer_inventory.go +++ b/model_customer_inventory.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_customer_profile.go b/model_customer_profile.go index 9149c007..5e71ea18 100644 --- a/model_customer_profile.go +++ b/model_customer_profile.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // CustomerProfile type CustomerProfile 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. The exact moment this entity was created. + // The time this entity was created. The time this entity was created. Created time.Time `json:"created"` // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` @@ -29,14 +29,16 @@ type CustomerProfile struct { 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. + // The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. TotalSales float32 `json:"totalSales"` // **DEPRECATED** A list of loyalty programs joined by the customer. LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` - // A list of audiences the customer belongs to. + // The audiences the customer belongs to. AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` - // 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. + // 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"` + // Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). + Sandbox *bool `json:"sandbox,omitempty"` } // GetId returns the Id field value @@ -225,6 +227,39 @@ func (o *CustomerProfile) SetLastActivity(v time.Time) { o.LastActivity = v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *CustomerProfile) 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 *CustomerProfile) 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 *CustomerProfile) 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 *CustomerProfile) SetSandbox(v bool) { + o.Sandbox = &v +} + type NullableCustomerProfile struct { Value CustomerProfile ExplicitNull bool diff --git a/model_customer_profile_audience_request.go b/model_customer_profile_audience_request.go index f081b6bf..919221d2 100644 --- a/model_customer_profile_audience_request.go +++ b/model_customer_profile_audience_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 3a1f3772..5ea2233f 100644 --- a/model_customer_profile_audience_request_item.go +++ b/model_customer_profile_audience_request_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_customer_profile_integration_request_v2.go b/model_customer_profile_integration_request_v2.go index 30c2ad9f..0eb70e6c 100644 --- a/model_customer_profile_integration_request_v2.go +++ b/model_customer_profile_integration_request_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,11 @@ import ( // CustomerProfileIntegrationRequestV2 type CustomerProfileIntegrationRequestV2 struct { // Arbitrary properties associated with this item. - Attributes *map[string]interface{} `json:"attributes,omitempty"` - AudiencesChanges *ProfileAudiencesChanges `json:"audiencesChanges,omitempty"` - // 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`. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` + AudiencesChanges *ProfileAudiencesChanges `json:"audiencesChanges,omitempty"` + // Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer profile_ request instead of sending extra requests to other endpoints. ResponseContent *[]string `json:"responseContent,omitempty"` } @@ -56,6 +58,39 @@ func (o *CustomerProfileIntegrationRequestV2) SetAttributes(v map[string]interfa o.Attributes = &v } +// GetEvaluableCampaignIds returns the EvaluableCampaignIds field value if set, zero value otherwise. +func (o *CustomerProfileIntegrationRequestV2) GetEvaluableCampaignIds() []int32 { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret + } + return *o.EvaluableCampaignIds +} + +// GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerProfileIntegrationRequestV2) GetEvaluableCampaignIdsOk() ([]int32, bool) { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.EvaluableCampaignIds, true +} + +// HasEvaluableCampaignIds returns a boolean if a field has been set. +func (o *CustomerProfileIntegrationRequestV2) HasEvaluableCampaignIds() bool { + if o != nil && o.EvaluableCampaignIds != nil { + return true + } + + return false +} + +// SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. +func (o *CustomerProfileIntegrationRequestV2) SetEvaluableCampaignIds(v []int32) { + o.EvaluableCampaignIds = &v +} + // GetAudiencesChanges returns the AudiencesChanges field value if set, zero value otherwise. func (o *CustomerProfileIntegrationRequestV2) GetAudiencesChanges() ProfileAudiencesChanges { if o == nil || o.AudiencesChanges == nil { diff --git a/model_customer_profile_search_query.go b/model_customer_profile_search_query.go index 176c6800..9085e104 100644 --- a/model_customer_profile_search_query.go +++ b/model_customer_profile_search_query.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_customer_profile_update_v2_response.go b/model_customer_profile_update_v2_response.go new file mode 100644 index 00000000..4109d134 --- /dev/null +++ b/model_customer_profile_update_v2_response.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CustomerProfileUpdateV2Response Contains the updated customer profiles entities. This is the response type returned by the V2 PUT customer_profiles endpoint +type CustomerProfileUpdateV2Response struct { + CustomerProfile CustomerProfile `json:"customerProfile"` +} + +// GetCustomerProfile returns the CustomerProfile field value +func (o *CustomerProfileUpdateV2Response) GetCustomerProfile() CustomerProfile { + if o == nil { + var ret CustomerProfile + return ret + } + + return o.CustomerProfile +} + +// SetCustomerProfile sets field value +func (o *CustomerProfileUpdateV2Response) SetCustomerProfile(v CustomerProfile) { + o.CustomerProfile = v +} + +type NullableCustomerProfileUpdateV2Response struct { + Value CustomerProfileUpdateV2Response + ExplicitNull bool +} + +func (v NullableCustomerProfileUpdateV2Response) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCustomerProfileUpdateV2Response) 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_customer_session.go b/model_customer_session.go index e577bf60..74345937 100644 --- a/model_customer_session.go +++ b/model_customer_session.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ import ( type CustomerSession struct { // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` @@ -29,11 +29,11 @@ type CustomerSession struct { 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`. 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). + // 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](https://docs.talon.one/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. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). + // 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"` diff --git a/model_customer_session_v2.go b/model_customer_session_v2.go index 3050a735..f594af56 100644 --- a/model_customer_session_v2.go +++ b/model_customer_session_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // CustomerSessionV2 type CustomerSessionV2 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. The exact moment this entity was created. + // The time this entity was created. The time this entity was created. Created time.Time `json:"created"` // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` @@ -27,19 +27,21 @@ type CustomerSessionV2 struct { ApplicationId int32 `json:"applicationId"` // 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"` + // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` // 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. **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"` // 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). + // 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)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). State string `json:"state"` // 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"` - // 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/). + // 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. 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. + // 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**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). Identifiers *[]string `json:"identifiers,omitempty"` // 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"` @@ -130,6 +132,39 @@ func (o *CustomerSessionV2) SetProfileId(v string) { o.ProfileId = v } +// GetEvaluableCampaignIds returns the EvaluableCampaignIds field value if set, zero value otherwise. +func (o *CustomerSessionV2) GetEvaluableCampaignIds() []int32 { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret + } + return *o.EvaluableCampaignIds +} + +// GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerSessionV2) GetEvaluableCampaignIdsOk() ([]int32, bool) { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.EvaluableCampaignIds, true +} + +// HasEvaluableCampaignIds returns a boolean if a field has been set. +func (o *CustomerSessionV2) HasEvaluableCampaignIds() bool { + if o != nil && o.EvaluableCampaignIds != nil { + return true + } + + return false +} + +// SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. +func (o *CustomerSessionV2) SetEvaluableCampaignIds(v []int32) { + o.EvaluableCampaignIds = &v +} + // GetCouponCodes returns the CouponCodes field value if set, zero value otherwise. func (o *CustomerSessionV2) GetCouponCodes() []string { if o == nil || o.CouponCodes == nil { diff --git a/model_deduct_loyalty_points.go b/model_deduct_loyalty_points.go new file mode 100644 index 00000000..9c0c83ce --- /dev/null +++ b/model_deduct_loyalty_points.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// DeductLoyaltyPoints Points to deduct. +type DeductLoyaltyPoints struct { + // Amount of loyalty points. + Points float32 `json:"points"` + // Name / reason for the point deduction. + Name *string `json:"name,omitempty"` + // ID of the subledger the points are deducted from. + SubledgerId *string `json:"subledgerId,omitempty"` + // ID of the Application that is connected to the loyalty program. + ApplicationId *int32 `json:"applicationId,omitempty"` +} + +// GetPoints returns the Points field value +func (o *DeductLoyaltyPoints) GetPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Points +} + +// SetPoints sets field value +func (o *DeductLoyaltyPoints) SetPoints(v float32) { + o.Points = v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) SetName(v string) { + o.Name = &v +} + +// GetSubledgerId returns the SubledgerId field value if set, zero value otherwise. +func (o *DeductLoyaltyPoints) GetSubledgerId() string { + if o == nil || o.SubledgerId == nil { + var ret string + return ret + } + return *o.SubledgerId +} + +// GetSubledgerIdOk returns a tuple with the SubledgerId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *DeductLoyaltyPoints) GetSubledgerIdOk() (string, bool) { + if o == nil || o.SubledgerId == nil { + var ret string + return ret, false + } + return *o.SubledgerId, true +} + +// HasSubledgerId returns a boolean if a field has been set. +func (o *DeductLoyaltyPoints) HasSubledgerId() bool { + if o != nil && o.SubledgerId != nil { + return true + } + + return false +} + +// SetSubledgerId gets a reference to the given string and assigns it to the SubledgerId field. +func (o *DeductLoyaltyPoints) SetSubledgerId(v string) { + o.SubledgerId = &v +} + +// GetApplicationId returns the ApplicationId field value if set, zero value otherwise. +func (o *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) 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 *DeductLoyaltyPoints) SetApplicationId(v int32) { + o.ApplicationId = &v +} + +type NullableDeductLoyaltyPoints struct { + Value DeductLoyaltyPoints + ExplicitNull bool +} + +func (v NullableDeductLoyaltyPoints) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableDeductLoyaltyPoints) 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_deduct_loyalty_points_effect_props.go b/model_deduct_loyalty_points_effect_props.go index 44dbd7c8..b8e51a62 100644 --- a/model_deduct_loyalty_points_effect_props.go +++ b/model_deduct_loyalty_points_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -28,7 +28,7 @@ type DeductLoyaltyPointsEffectProps struct { 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. + // The alphanumeric identifier of the loyalty card. CardIdentifier *string `json:"cardIdentifier,omitempty"` } diff --git a/model_effect.go b/model_effect.go index b776a215..20b45b15 100644 --- a/model_effect.go +++ b/model_effect.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -24,13 +24,14 @@ type Effect struct { RuleIndex int32 `json:"ruleIndex"` // 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. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). EffectType string `json:"effectType"` // 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"` + TriggeredForCatalogItem *int32 `json:"triggeredForCatalogItem,omitempty"` + // The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + Props map[string]interface{} `json:"props"` } // GetCampaignId returns the CampaignId field value diff --git a/model_effect_entity.go b/model_effect_entity.go index 709b27b7..d1d4c6cf 100644 --- a/model_effect_entity.go +++ b/model_effect_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -24,7 +24,7 @@ type EffectEntity struct { RuleIndex int32 `json:"ruleIndex"` // 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. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). EffectType string `json:"effectType"` // The ID of the coupon that was being evaluated when this effect was triggered. TriggeredByCoupon *int32 `json:"triggeredByCoupon,omitempty"` diff --git a/model_email_entity.go b/model_email_entity.go index a37c5c2d..80d0043a 100644 --- a/model_email_entity.go +++ b/model_email_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_endpoint.go b/model_endpoint.go index 8e4cd05e..665d7225 100644 --- a/model_endpoint.go +++ b/model_endpoint.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_entity.go b/model_entity.go index 79f9d595..2278810a 100644 --- a/model_entity.go +++ b/model_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // Entity struct for Entity type Entity 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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 95df1e4d..1ad27684 100644 --- a/model_entity_with_talang_visible_id.go +++ b/model_entity_with_talang_visible_id.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_environment.go b/model_environment.go index 5f8c844b..b4164a38 100644 --- a/model_environment.go +++ b/model_environment.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // Environment type Environment 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` diff --git a/model_error_effect_props.go b/model_error_effect_props.go index 84c1abe4..5d50bf3b 100644 --- a/model_error_effect_props.go +++ b/model_error_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_error_response.go b/model_error_response.go index e7dbd383..1579e96e 100644 --- a/model_error_response.go +++ b/model_error_response.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_error_response_with_status.go b/model_error_response_with_status.go index 7caa9c51..cd2453d1 100644 --- a/model_error_response_with_status.go +++ b/model_error_response_with_status.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_error_source.go b/model_error_source.go index e83de672..5cac9d5e 100644 --- a/model_error_source.go +++ b/model_error_source.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_evaluable_campaign_ids.go b/model_evaluable_campaign_ids.go new file mode 100644 index 00000000..54a0ad9f --- /dev/null +++ b/model_evaluable_campaign_ids.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// EvaluableCampaignIds struct for EvaluableCampaignIds +type EvaluableCampaignIds struct { + // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` +} + +// GetEvaluableCampaignIds returns the EvaluableCampaignIds field value if set, zero value otherwise. +func (o *EvaluableCampaignIds) GetEvaluableCampaignIds() []int32 { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret + } + return *o.EvaluableCampaignIds +} + +// GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EvaluableCampaignIds) GetEvaluableCampaignIdsOk() ([]int32, bool) { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.EvaluableCampaignIds, true +} + +// HasEvaluableCampaignIds returns a boolean if a field has been set. +func (o *EvaluableCampaignIds) HasEvaluableCampaignIds() bool { + if o != nil && o.EvaluableCampaignIds != nil { + return true + } + + return false +} + +// SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. +func (o *EvaluableCampaignIds) SetEvaluableCampaignIds(v []int32) { + o.EvaluableCampaignIds = &v +} + +type NullableEvaluableCampaignIds struct { + Value EvaluableCampaignIds + ExplicitNull bool +} + +func (v NullableEvaluableCampaignIds) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableEvaluableCampaignIds) 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_event.go b/model_event.go index fb2b76ea..fecab667 100644 --- a/model_event.go +++ b/model_event.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // Event type Event 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` @@ -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 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). + // 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](https://docs.talon.one/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 000e785f..4b41a2f6 100644 --- a/model_event_type.go +++ b/model_event_type.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,15 +17,15 @@ import ( // EventType type EventType 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The human-friendly display name for this event type. Use a short, past-tense, description of the event. + // The human-friendly name for this event type. 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. + // The integration 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. + // A description of what the event represents. Description *string `json:"description,omitempty"` } diff --git a/model_event_v2.go b/model_event_v2.go index e740fbda..cd0de713 100644 --- a/model_event_v2.go +++ b/model_event_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,9 +18,11 @@ import ( 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. + // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` + // A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. Type string `json:"type"` - // Arbitrary additional JSON data associated with the event. + // Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). Attributes *map[string]interface{} `json:"attributes,omitempty"` } @@ -57,6 +59,39 @@ func (o *EventV2) SetProfileId(v string) { o.ProfileId = &v } +// GetEvaluableCampaignIds returns the EvaluableCampaignIds field value if set, zero value otherwise. +func (o *EventV2) GetEvaluableCampaignIds() []int32 { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret + } + return *o.EvaluableCampaignIds +} + +// GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EventV2) GetEvaluableCampaignIdsOk() ([]int32, bool) { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.EvaluableCampaignIds, true +} + +// HasEvaluableCampaignIds returns a boolean if a field has been set. +func (o *EventV2) HasEvaluableCampaignIds() bool { + if o != nil && o.EvaluableCampaignIds != nil { + return true + } + + return false +} + +// SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. +func (o *EventV2) SetEvaluableCampaignIds(v []int32) { + o.EvaluableCampaignIds = &v +} + // GetType returns the Type field value func (o *EventV2) GetType() string { if o == nil { diff --git a/model_expiring_points_notification_policy.go b/model_expiring_points_notification_policy.go new file mode 100644 index 00000000..5818c702 --- /dev/null +++ b/model_expiring_points_notification_policy.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ExpiringPointsNotificationPolicy struct for ExpiringPointsNotificationPolicy +type ExpiringPointsNotificationPolicy struct { + // Notification name. + Name string `json:"name"` + Triggers []ExpiringPointsNotificationTrigger `json:"triggers"` +} + +// GetName returns the Name field value +func (o *ExpiringPointsNotificationPolicy) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *ExpiringPointsNotificationPolicy) SetName(v string) { + o.Name = v +} + +// GetTriggers returns the Triggers field value +func (o *ExpiringPointsNotificationPolicy) GetTriggers() []ExpiringPointsNotificationTrigger { + if o == nil { + var ret []ExpiringPointsNotificationTrigger + return ret + } + + return o.Triggers +} + +// SetTriggers sets field value +func (o *ExpiringPointsNotificationPolicy) SetTriggers(v []ExpiringPointsNotificationTrigger) { + o.Triggers = v +} + +type NullableExpiringPointsNotificationPolicy struct { + Value ExpiringPointsNotificationPolicy + ExplicitNull bool +} + +func (v NullableExpiringPointsNotificationPolicy) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableExpiringPointsNotificationPolicy) 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_expiring_points_notification_trigger.go b/model_expiring_points_notification_trigger.go new file mode 100644 index 00000000..ffd5dc32 --- /dev/null +++ b/model_expiring_points_notification_trigger.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ExpiringPointsNotificationTrigger struct for ExpiringPointsNotificationTrigger +type ExpiringPointsNotificationTrigger struct { + // The amount of period. + Amount int32 `json:"amount"` + // Notification period indicated by a letter; \"w\" means week, \"d\" means day. + Period string `json:"period"` +} + +// GetAmount returns the Amount field value +func (o *ExpiringPointsNotificationTrigger) GetAmount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Amount +} + +// SetAmount sets field value +func (o *ExpiringPointsNotificationTrigger) SetAmount(v int32) { + o.Amount = v +} + +// GetPeriod returns the Period field value +func (o *ExpiringPointsNotificationTrigger) GetPeriod() string { + if o == nil { + var ret string + return ret + } + + return o.Period +} + +// SetPeriod sets field value +func (o *ExpiringPointsNotificationTrigger) SetPeriod(v string) { + o.Period = v +} + +type NullableExpiringPointsNotificationTrigger struct { + Value ExpiringPointsNotificationTrigger + ExplicitNull bool +} + +func (v NullableExpiringPointsNotificationTrigger) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableExpiringPointsNotificationTrigger) 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 1164904f..2fc84b0f 100644 --- a/model_export.go +++ b/model_export.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // Export type Export 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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 account that owns this entity. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` // The name of the entity that was exported. Entity string `json:"entity"` diff --git a/model_feature_flag.go b/model_feature_flag.go index d37d5143..098f2046 100644 --- a/model_feature_flag.go +++ b/model_feature_flag.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // FeatureFlag struct for FeatureFlag type FeatureFlag struct { - // The name for the featureflag. + // The name of the feature flag. Name string `json:"name"` - // The value for the featureflag. + // The value of the feature flag. Value string `json:"value"` - // The exact moment this entity was last created. + // The time this entity was last created. Created *time.Time `json:"created,omitempty"` - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified *time.Time `json:"modified,omitempty"` } diff --git a/model_features_feed.go b/model_features_feed.go index 674ba2f2..fcbffdea 100644 --- a/model_features_feed.go +++ b/model_features_feed.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_feed_notification.go b/model_feed_notification.go index 53017e5d..7e33e5b8 100644 --- a/model_feed_notification.go +++ b/model_feed_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_frontend_state.go b/model_frontend_state.go new file mode 100644 index 00000000..eb7d3d7c --- /dev/null +++ b/model_frontend_state.go @@ -0,0 +1,50 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// FrontendState A campaign state described exactly as in the Campaign Manager. +type FrontendState string + +// List of FrontendState +const ( + EXPIRED FrontendState = "expired" + SCHEDULED FrontendState = "scheduled" + RUNNING FrontendState = "running" + DRAFT FrontendState = "draft" + DISABLED FrontendState = "disabled" +) + +type NullableFrontendState struct { + Value FrontendState + ExplicitNull bool +} + +func (v NullableFrontendState) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableFrontendState) 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_func_arg_def.go b/model_func_arg_def.go index 2b494b8a..024ad27a 100644 --- a/model_func_arg_def.go +++ b/model_func_arg_def.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_function_def.go b/model_function_def.go index 0b697e2c..fbfe3000 100644 --- a/model_function_def.go +++ b/model_function_def.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_giveaway.go b/model_giveaway.go index 35d033a7..23bf312e 100644 --- a/model_giveaway.go +++ b/model_giveaway.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // Giveaway type Giveaway 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The code value of this giveaway. Code string `json:"code"` @@ -35,6 +35,10 @@ type Giveaway struct { Used *bool `json:"used,omitempty"` // The ID of the Import which created this giveaway. ImportId *int32 `json:"importId,omitempty"` + // The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded. + ProfileIntegrationId *string `json:"profileIntegrationId,omitempty"` + // The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists. + ProfileId *int32 `json:"profileId,omitempty"` } // GetId returns the Id field value @@ -262,6 +266,72 @@ func (o *Giveaway) SetImportId(v int32) { o.ImportId = &v } +// GetProfileIntegrationId returns the ProfileIntegrationId field value if set, zero value otherwise. +func (o *Giveaway) 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 *Giveaway) 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 *Giveaway) 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 *Giveaway) SetProfileIntegrationId(v string) { + o.ProfileIntegrationId = &v +} + +// GetProfileId returns the ProfileId field value if set, zero value otherwise. +func (o *Giveaway) 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 *Giveaway) 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 *Giveaway) 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 *Giveaway) SetProfileId(v int32) { + o.ProfileId = &v +} + type NullableGiveaway struct { Value Giveaway ExplicitNull bool diff --git a/model_giveaways_pool.go b/model_giveaways_pool.go index 31a7d4e6..82778dae 100644 --- a/model_giveaways_pool.go +++ b/model_giveaways_pool.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // GiveawaysPool Giveaways pools is an entity for managing multiple similar giveaways. type GiveawaysPool 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` @@ -29,6 +29,8 @@ type GiveawaysPool struct { Description *string `json:"description,omitempty"` // A list of the IDs of the applications that this giveaways pool is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. + Sandbox bool `json:"sandbox"` // Timestamp of the most recent update to the giveaways pool. Modified *time.Time `json:"modified,omitempty"` // ID of the user who created this giveaways pool. @@ -163,6 +165,21 @@ func (o *GiveawaysPool) SetSubscribedApplicationsIds(v []int32) { o.SubscribedApplicationsIds = &v } +// GetSandbox returns the Sandbox field value +func (o *GiveawaysPool) GetSandbox() bool { + if o == nil { + var ret bool + return ret + } + + return o.Sandbox +} + +// SetSandbox sets field value +func (o *GiveawaysPool) SetSandbox(v bool) { + o.Sandbox = v +} + // GetModified returns the Modified field value if set, zero value otherwise. func (o *GiveawaysPool) GetModified() time.Time { if o == nil || o.Modified == nil { diff --git a/model_import.go b/model_import.go index 8b8be80e..2ab8d34a 100644 --- a/model_import.go +++ b/model_import.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // Import type Import 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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 account that owns this entity. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` // The name of the entity that was imported. Entity string `json:"entity"` diff --git a/model_import_entity.go b/model_import_entity.go index b3e6db24..f7dc7c6a 100644 --- a/model_import_entity.go +++ b/model_import_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_inline_response_200.go b/model_inline_response_200.go index d909e5b0..ddccf430 100644 --- a/model_inline_response_200.go +++ b/model_inline_response_200.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 6374322f..62ce9899 100644 --- a/model_inline_response_200_1.go +++ b/model_inline_response_200_1.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse2001 struct for InlineResponse2001 type InlineResponse2001 struct { - HasMore bool `json:"hasMore"` - Data []LedgerTransactionLogEntryIntegrationApi `json:"data"` + HasMore bool `json:"hasMore"` + Data []CardLedgerTransactionLogEntryIntegrationApi `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,9 +36,9 @@ func (o *InlineResponse2001) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse2001) GetData() []LedgerTransactionLogEntryIntegrationApi { +func (o *InlineResponse2001) GetData() []CardLedgerTransactionLogEntryIntegrationApi { if o == nil { - var ret []LedgerTransactionLogEntryIntegrationApi + var ret []CardLedgerTransactionLogEntryIntegrationApi return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2001) GetData() []LedgerTransactionLogEntryIntegrationApi } // SetData sets field value -func (o *InlineResponse2001) SetData(v []LedgerTransactionLogEntryIntegrationApi) { +func (o *InlineResponse2001) SetData(v []CardLedgerTransactionLogEntryIntegrationApi) { o.Data = v } diff --git a/model_inline_response_200_10.go b/model_inline_response_200_10.go index d1c1998d..068b41a4 100644 --- a/model_inline_response_200_10.go +++ b/model_inline_response_200_10.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,81 +16,29 @@ import ( // InlineResponse20010 struct for InlineResponse20010 type InlineResponse20010 struct { - HasMore *bool `json:"hasMore,omitempty"` - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - Data []CollectionWithoutPayload `json:"data"` + HasMore bool `json:"hasMore"` + Data []CampaignTemplate `json:"data"` } -// GetHasMore returns the HasMore field value if set, zero value otherwise. +// GetHasMore returns the HasMore field value func (o *InlineResponse20010) 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 *InlineResponse20010) 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 *InlineResponse20010) 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 *InlineResponse20010) SetHasMore(v bool) { - o.HasMore = &v -} - -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. -func (o *InlineResponse20010) 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 *InlineResponse20010) 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 *InlineResponse20010) 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 *InlineResponse20010) SetTotalResultSize(v int32) { - o.TotalResultSize = &v + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20010) GetData() []CollectionWithoutPayload { +func (o *InlineResponse20010) GetData() []CampaignTemplate { if o == nil { - var ret []CollectionWithoutPayload + var ret []CampaignTemplate return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20010) GetData() []CollectionWithoutPayload { } // SetData sets field value -func (o *InlineResponse20010) SetData(v []CollectionWithoutPayload) { +func (o *InlineResponse20010) SetData(v []CampaignTemplate) { o.Data = v } diff --git a/model_inline_response_200_11.go b/model_inline_response_200_11.go index 99714c88..bb4d6916 100644 --- a/model_inline_response_200_11.go +++ b/model_inline_response_200_11.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,29 @@ import ( // InlineResponse20011 struct for InlineResponse20011 type InlineResponse20011 struct { - HasMore bool `json:"hasMore"` - Data []CollectionItem `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []LoyaltyProgram `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20011) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20011) 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 *InlineResponse20011) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20011) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20011) GetData() []CollectionItem { +func (o *InlineResponse20011) GetData() []LoyaltyProgram { if o == nil { - var ret []CollectionItem + var ret []LoyaltyProgram return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20011) GetData() []CollectionItem { } // SetData sets field value -func (o *InlineResponse20011) SetData(v []CollectionItem) { +func (o *InlineResponse20011) SetData(v []LoyaltyProgram) { o.Data = v } diff --git a/model_inline_response_200_12.go b/model_inline_response_200_12.go index 08d5b43e..530ecca4 100644 --- a/model_inline_response_200_12.go +++ b/model_inline_response_200_12.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,81 +16,29 @@ import ( // InlineResponse20012 struct for InlineResponse20012 type InlineResponse20012 struct { - HasMore *bool `json:"hasMore,omitempty"` - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - Data []Collection `json:"data"` + HasMore bool `json:"hasMore"` + Data []LoyaltyProgramTransaction `json:"data"` } -// GetHasMore returns the HasMore field value if set, zero value otherwise. +// GetHasMore returns the HasMore field value func (o *InlineResponse20012) 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 *InlineResponse20012) 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 *InlineResponse20012) 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 *InlineResponse20012) SetHasMore(v bool) { - o.HasMore = &v -} - -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. -func (o *InlineResponse20012) 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 *InlineResponse20012) 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 *InlineResponse20012) 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 *InlineResponse20012) SetTotalResultSize(v int32) { - o.TotalResultSize = &v + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20012) GetData() []Collection { +func (o *InlineResponse20012) GetData() []LoyaltyProgramTransaction { if o == nil { - var ret []Collection + var ret []LoyaltyProgramTransaction return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20012) GetData() []Collection { } // SetData sets field value -func (o *InlineResponse20012) SetData(v []Collection) { +func (o *InlineResponse20012) SetData(v []LoyaltyProgramTransaction) { o.Data = v } diff --git a/model_inline_response_200_13.go b/model_inline_response_200_13.go index b02326b2..c454879b 100644 --- a/model_inline_response_200_13.go +++ b/model_inline_response_200_13.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse20013 struct for InlineResponse20013 type InlineResponse20013 struct { - HasMore bool `json:"hasMore"` - Data []AccessLogEntry `json:"data"` + HasMore bool `json:"hasMore"` + Data []LoyaltyCard `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,9 +36,9 @@ func (o *InlineResponse20013) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse20013) GetData() []AccessLogEntry { +func (o *InlineResponse20013) GetData() []LoyaltyCard { if o == nil { - var ret []AccessLogEntry + var ret []LoyaltyCard return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20013) GetData() []AccessLogEntry { } // SetData sets field value -func (o *InlineResponse20013) SetData(v []AccessLogEntry) { +func (o *InlineResponse20013) SetData(v []LoyaltyCard) { o.Data = v } diff --git a/model_inline_response_200_14.go b/model_inline_response_200_14.go index eea9f812..ab41e096 100644 --- a/model_inline_response_200_14.go +++ b/model_inline_response_200_14.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,31 @@ import ( // InlineResponse20014 struct for InlineResponse20014 type InlineResponse20014 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []AccessLogEntry `json:"data"` + // true means there is more data in the source collection to request.. + HasMore bool `json:"hasMore"` + // List of loyalty card transaction logs. + Data []CardLedgerTransactionLogEntry `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20014) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20014) 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 *InlineResponse20014) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20014) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20014) GetData() []AccessLogEntry { +func (o *InlineResponse20014) GetData() []CardLedgerTransactionLogEntry { if o == nil { - var ret []AccessLogEntry + var ret []CardLedgerTransactionLogEntry return ret } @@ -46,7 +48,7 @@ func (o *InlineResponse20014) GetData() []AccessLogEntry { } // SetData sets field value -func (o *InlineResponse20014) SetData(v []AccessLogEntry) { +func (o *InlineResponse20014) SetData(v []CardLedgerTransactionLogEntry) { o.Data = v } diff --git a/model_inline_response_200_15.go b/model_inline_response_200_15.go index cdfbf773..fbac5928 100644 --- a/model_inline_response_200_15.go +++ b/model_inline_response_200_15.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,81 @@ import ( // InlineResponse20015 struct for InlineResponse20015 type InlineResponse20015 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []CampaignAnalytics `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 *InlineResponse20015) 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 *InlineResponse20015) 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 *InlineResponse20015) 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 *InlineResponse20015) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20015) 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 *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 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 *InlineResponse20015) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20015) GetData() []CampaignAnalytics { +func (o *InlineResponse20015) GetData() []CollectionWithoutPayload { if o == nil { - var ret []CampaignAnalytics + var ret []CollectionWithoutPayload return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20015) GetData() []CampaignAnalytics { } // SetData sets field value -func (o *InlineResponse20015) SetData(v []CampaignAnalytics) { +func (o *InlineResponse20015) SetData(v []CollectionWithoutPayload) { o.Data = v } diff --git a/model_inline_response_200_16.go b/model_inline_response_200_16.go index ccb763ae..676a9ae0 100644 --- a/model_inline_response_200_16.go +++ b/model_inline_response_200_16.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,81 +16,29 @@ import ( // InlineResponse20016 struct for InlineResponse20016 type InlineResponse20016 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - HasMore *bool `json:"hasMore,omitempty"` - Data []ApplicationCustomer `json:"data"` + HasMore bool `json:"hasMore"` + Data []CollectionItem `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. -func (o *InlineResponse20016) 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 *InlineResponse20016) 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 *InlineResponse20016) 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 *InlineResponse20016) SetTotalResultSize(v int32) { - o.TotalResultSize = &v -} - -// GetHasMore returns the HasMore field value if set, zero value otherwise. +// GetHasMore returns the HasMore field value func (o *InlineResponse20016) 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 *InlineResponse20016) 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 *InlineResponse20016) HasHasMore() bool { - if o != nil && o.HasMore != nil { - return true - } - return false + return o.HasMore } -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +// SetHasMore sets field value func (o *InlineResponse20016) SetHasMore(v bool) { - o.HasMore = &v + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20016) GetData() []ApplicationCustomer { +func (o *InlineResponse20016) GetData() []CollectionItem { if o == nil { - var ret []ApplicationCustomer + var ret []CollectionItem return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20016) GetData() []ApplicationCustomer { } // SetData sets field value -func (o *InlineResponse20016) SetData(v []ApplicationCustomer) { +func (o *InlineResponse20016) SetData(v []CollectionItem) { o.Data = v } diff --git a/model_inline_response_200_17.go b/model_inline_response_200_17.go index 1b385488..4f87f655 100644 --- a/model_inline_response_200_17.go +++ b/model_inline_response_200_17.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,81 @@ import ( // InlineResponse20017 struct for InlineResponse20017 type InlineResponse20017 struct { - HasMore bool `json:"hasMore"` - Data []ApplicationCustomer `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []Collection `json:"data"` } -// GetHasMore returns the HasMore field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. func (o *InlineResponse20017) GetHasMore() bool { - if o == nil { + if o == nil || o.HasMore == nil { var ret bool return ret } + return *o.HasMore +} - 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 *InlineResponse20017) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true } -// SetHasMore sets field value +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20017) 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 *InlineResponse20017) SetHasMore(v bool) { - o.HasMore = v + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +func (o *InlineResponse20017) 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 *InlineResponse20017) 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 *InlineResponse20017) 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 *InlineResponse20017) SetTotalResultSize(v int32) { + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20017) GetData() []ApplicationCustomer { +func (o *InlineResponse20017) GetData() []Collection { if o == nil { - var ret []ApplicationCustomer + var ret []Collection return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20017) GetData() []ApplicationCustomer { } // SetData sets field value -func (o *InlineResponse20017) SetData(v []ApplicationCustomer) { +func (o *InlineResponse20017) SetData(v []Collection) { o.Data = v } diff --git a/model_inline_response_200_18.go b/model_inline_response_200_18.go index c0ca7b55..9cfd1086 100644 --- a/model_inline_response_200_18.go +++ b/model_inline_response_200_18.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse20018 struct for InlineResponse20018 type InlineResponse20018 struct { - HasMore bool `json:"hasMore"` - Data []CustomerProfile `json:"data"` + HasMore bool `json:"hasMore"` + Data []AccessLogEntry `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,9 +36,9 @@ func (o *InlineResponse20018) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse20018) GetData() []CustomerProfile { +func (o *InlineResponse20018) GetData() []AccessLogEntry { if o == nil { - var ret []CustomerProfile + var ret []AccessLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20018) GetData() []CustomerProfile { } // SetData sets field value -func (o *InlineResponse20018) SetData(v []CustomerProfile) { +func (o *InlineResponse20018) SetData(v []AccessLogEntry) { o.Data = v } diff --git a/model_inline_response_200_19.go b/model_inline_response_200_19.go index aad18fe0..2020087c 100644 --- a/model_inline_response_200_19.go +++ b/model_inline_response_200_19.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,29 @@ import ( // InlineResponse20019 struct for InlineResponse20019 type InlineResponse20019 struct { - HasMore bool `json:"hasMore"` - Data []CustomerActivityReport `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []AccessLogEntry `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20019) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20019) 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 *InlineResponse20019) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20019) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20019) GetData() []CustomerActivityReport { +func (o *InlineResponse20019) GetData() []AccessLogEntry { if o == nil { - var ret []CustomerActivityReport + var ret []AccessLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20019) GetData() []CustomerActivityReport { } // SetData sets field value -func (o *InlineResponse20019) SetData(v []CustomerActivityReport) { +func (o *InlineResponse20019) SetData(v []AccessLogEntry) { o.Data = v } diff --git a/model_inline_response_200_2.go b/model_inline_response_200_2.go index 0d0e5a66..a48234b7 100644 --- a/model_inline_response_200_2.go +++ b/model_inline_response_200_2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,29 @@ import ( // InlineResponse2002 struct for InlineResponse2002 type InlineResponse2002 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Application `json:"data"` + HasMore bool `json:"hasMore"` + Data []LedgerTransactionLogEntryIntegrationApi `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse2002) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse2002) 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 *InlineResponse2002) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse2002) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse2002) GetData() []Application { +func (o *InlineResponse2002) GetData() []LedgerTransactionLogEntryIntegrationApi { if o == nil { - var ret []Application + var ret []LedgerTransactionLogEntryIntegrationApi return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2002) GetData() []Application { } // SetData sets field value -func (o *InlineResponse2002) SetData(v []Application) { +func (o *InlineResponse2002) SetData(v []LedgerTransactionLogEntryIntegrationApi) { o.Data = v } diff --git a/model_inline_response_200_20.go b/model_inline_response_200_20.go index 69cece0f..f5cade25 100644 --- a/model_inline_response_200_20.go +++ b/model_inline_response_200_20.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,47 +16,29 @@ import ( // InlineResponse20020 struct for InlineResponse20020 type InlineResponse20020 struct { - HasMore *bool `json:"hasMore,omitempty"` - Data []ApplicationSession `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []CampaignAnalytics `json:"data"` } -// GetHasMore returns the HasMore field value if set, zero value otherwise. -func (o *InlineResponse20020) GetHasMore() bool { - if o == nil || o.HasMore == nil { - var ret bool +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20020) GetTotalResultSize() int32 { + if o == nil { + var ret int32 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 *InlineResponse20020) 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 *InlineResponse20020) HasHasMore() bool { - if o != nil && o.HasMore != nil { - return true - } - return false + return o.TotalResultSize } -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -func (o *InlineResponse20020) SetHasMore(v bool) { - o.HasMore = &v +// SetTotalResultSize sets field value +func (o *InlineResponse20020) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20020) GetData() []ApplicationSession { +func (o *InlineResponse20020) GetData() []CampaignAnalytics { if o == nil { - var ret []ApplicationSession + var ret []CampaignAnalytics return ret } @@ -64,7 +46,7 @@ func (o *InlineResponse20020) GetData() []ApplicationSession { } // SetData sets field value -func (o *InlineResponse20020) SetData(v []ApplicationSession) { +func (o *InlineResponse20020) SetData(v []CampaignAnalytics) { o.Data = v } diff --git a/model_inline_response_200_21.go b/model_inline_response_200_21.go index 1a805bc8..d476855c 100644 --- a/model_inline_response_200_21.go +++ b/model_inline_response_200_21.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,81 @@ import ( // InlineResponse20021 struct for InlineResponse20021 type InlineResponse20021 struct { - HasMore bool `json:"hasMore"` - Data []ApplicationEvent `json:"data"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + HasMore *bool `json:"hasMore,omitempty"` + Data []ApplicationCustomer `json:"data"` } -// GetHasMore returns the HasMore field value +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +func (o *InlineResponse20021) 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 *InlineResponse20021) 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 *InlineResponse20021) 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 *InlineResponse20021) SetTotalResultSize(v int32) { + o.TotalResultSize = &v +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. func (o *InlineResponse20021) GetHasMore() bool { - if o == nil { + 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 *InlineResponse20021) 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 *InlineResponse20021) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } - return o.HasMore + return false } -// SetHasMore sets field value +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. func (o *InlineResponse20021) SetHasMore(v bool) { - o.HasMore = v + o.HasMore = &v } // GetData returns the Data field value -func (o *InlineResponse20021) GetData() []ApplicationEvent { +func (o *InlineResponse20021) GetData() []ApplicationCustomer { if o == nil { - var ret []ApplicationEvent + var ret []ApplicationCustomer return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20021) GetData() []ApplicationEvent { } // SetData sets field value -func (o *InlineResponse20021) SetData(v []ApplicationEvent) { +func (o *InlineResponse20021) SetData(v []ApplicationCustomer) { o.Data = v } diff --git a/model_inline_response_200_22.go b/model_inline_response_200_22.go index b84a427f..0524b99d 100644 --- a/model_inline_response_200_22.go +++ b/model_inline_response_200_22.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 []string `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []ApplicationCustomer `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() []string { +func (o *InlineResponse20022) GetData() []ApplicationCustomer { if o == nil { - var ret []string + var ret []ApplicationCustomer return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20022) GetData() []string { } // SetData sets field value -func (o *InlineResponse20022) SetData(v []string) { +func (o *InlineResponse20022) SetData(v []ApplicationCustomer) { o.Data = v } diff --git a/model_inline_response_200_23.go b/model_inline_response_200_23.go index 1b4369a3..f9e5c685 100644 --- a/model_inline_response_200_23.go +++ b/model_inline_response_200_23.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,9 +16,9 @@ import ( // InlineResponse20023 struct for InlineResponse20023 type InlineResponse20023 struct { - HasMore *bool `json:"hasMore,omitempty"` - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - Data []Audience `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []CustomerProfile `json:"data"` } // GetHasMore returns the HasMore field value if set, zero value otherwise. @@ -88,9 +88,9 @@ func (o *InlineResponse20023) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20023) GetData() []Audience { +func (o *InlineResponse20023) GetData() []CustomerProfile { if o == nil { - var ret []Audience + var ret []CustomerProfile return ret } @@ -98,7 +98,7 @@ func (o *InlineResponse20023) GetData() []Audience { } // SetData sets field value -func (o *InlineResponse20023) SetData(v []Audience) { +func (o *InlineResponse20023) SetData(v []CustomerProfile) { o.Data = v } diff --git a/model_inline_response_200_24.go b/model_inline_response_200_24.go index cd1c09d3..a827d4b3 100644 --- a/model_inline_response_200_24.go +++ b/model_inline_response_200_24.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,9 +16,8 @@ import ( // InlineResponse20024 struct for InlineResponse20024 type InlineResponse20024 struct { - HasMore bool `json:"hasMore"` - TotalResultSize int32 `json:"totalResultSize"` - Data []ApplicationReferee `json:"data"` + HasMore bool `json:"hasMore"` + Data []CustomerProfile `json:"data"` } // GetHasMore returns the HasMore field value @@ -36,25 +35,10 @@ func (o *InlineResponse20024) SetHasMore(v bool) { o.HasMore = v } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20024) GetTotalResultSize() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.TotalResultSize -} - -// SetTotalResultSize sets field value -func (o *InlineResponse20024) SetTotalResultSize(v int32) { - o.TotalResultSize = v -} - // GetData returns the Data field value -func (o *InlineResponse20024) GetData() []ApplicationReferee { +func (o *InlineResponse20024) GetData() []CustomerProfile { if o == nil { - var ret []ApplicationReferee + var ret []CustomerProfile return ret } @@ -62,7 +46,7 @@ func (o *InlineResponse20024) GetData() []ApplicationReferee { } // SetData sets field value -func (o *InlineResponse20024) SetData(v []ApplicationReferee) { +func (o *InlineResponse20024) SetData(v []CustomerProfile) { o.Data = v } diff --git a/model_inline_response_200_25.go b/model_inline_response_200_25.go index 01eed4e0..d107fdf1 100644 --- a/model_inline_response_200_25.go +++ b/model_inline_response_200_25.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,29 @@ import ( // InlineResponse20025 struct for InlineResponse20025 type InlineResponse20025 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Attribute `json:"data"` + HasMore bool `json:"hasMore"` + Data []CustomerActivityReport `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20025) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20025) 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 *InlineResponse20025) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20025) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20025) GetData() []Attribute { +func (o *InlineResponse20025) GetData() []CustomerActivityReport { if o == nil { - var ret []Attribute + var ret []CustomerActivityReport return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20025) GetData() []Attribute { } // SetData sets field value -func (o *InlineResponse20025) SetData(v []Attribute) { +func (o *InlineResponse20025) SetData(v []CustomerActivityReport) { o.Data = v } diff --git a/model_inline_response_200_26.go b/model_inline_response_200_26.go index 3577784a..12854fb2 100644 --- a/model_inline_response_200_26.go +++ b/model_inline_response_200_26.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,47 @@ import ( // InlineResponse20026 struct for InlineResponse20026 type InlineResponse20026 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []AccountAdditionalCost `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + Data []ApplicationSession `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20026) GetTotalResultSize() int32 { - if o == nil { - var ret int32 +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20026) 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 *InlineResponse20026) 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 *InlineResponse20026) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } - return o.TotalResultSize + return false } -// SetTotalResultSize sets field value -func (o *InlineResponse20026) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20026) SetHasMore(v bool) { + o.HasMore = &v } // GetData returns the Data field value -func (o *InlineResponse20026) GetData() []AccountAdditionalCost { +func (o *InlineResponse20026) GetData() []ApplicationSession { if o == nil { - var ret []AccountAdditionalCost + var ret []ApplicationSession return ret } @@ -46,7 +64,7 @@ func (o *InlineResponse20026) GetData() []AccountAdditionalCost { } // SetData sets field value -func (o *InlineResponse20026) SetData(v []AccountAdditionalCost) { +func (o *InlineResponse20026) SetData(v []ApplicationSession) { o.Data = v } diff --git a/model_inline_response_200_27.go b/model_inline_response_200_27.go index ec86a83b..54d47656 100644 --- a/model_inline_response_200_27.go +++ b/model_inline_response_200_27.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,29 @@ import ( // InlineResponse20027 struct for InlineResponse20027 type InlineResponse20027 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Webhook `json:"data"` + HasMore bool `json:"hasMore"` + Data []ApplicationEvent `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20027) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20027) 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 *InlineResponse20027) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20027) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse20027) GetData() []Webhook { +func (o *InlineResponse20027) GetData() []ApplicationEvent { if o == nil { - var ret []Webhook + var ret []ApplicationEvent return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20027) GetData() []Webhook { } // SetData sets field value -func (o *InlineResponse20027) SetData(v []Webhook) { +func (o *InlineResponse20027) SetData(v []ApplicationEvent) { o.Data = v } diff --git a/model_inline_response_200_28.go b/model_inline_response_200_28.go index 4e3c2579..9aaed6d4 100644 --- a/model_inline_response_200_28.go +++ b/model_inline_response_200_28.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 []WebhookActivationLogEntry `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []string `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() []WebhookActivationLogEntry { +func (o *InlineResponse20028) GetData() []string { if o == nil { - var ret []WebhookActivationLogEntry + var ret []string return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20028) GetData() []WebhookActivationLogEntry { } // SetData sets field value -func (o *InlineResponse20028) SetData(v []WebhookActivationLogEntry) { +func (o *InlineResponse20028) SetData(v []string) { o.Data = v } diff --git a/model_inline_response_200_29.go b/model_inline_response_200_29.go index fbbcbaa2..c57c88ba 100644 --- a/model_inline_response_200_29.go +++ b/model_inline_response_200_29.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,81 @@ import ( // InlineResponse20029 struct for InlineResponse20029 type InlineResponse20029 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []WebhookLogEntry `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 *InlineResponse20029) 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 *InlineResponse20029) 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 *InlineResponse20029) 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 *InlineResponse20029) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20029) 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 *InlineResponse20029) 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 *InlineResponse20029) 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 *InlineResponse20029) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20029) GetData() []WebhookLogEntry { +func (o *InlineResponse20029) GetData() []Audience { if o == nil { - var ret []WebhookLogEntry + var ret []Audience return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20029) GetData() []WebhookLogEntry { } // SetData sets field value -func (o *InlineResponse20029) SetData(v []WebhookLogEntry) { +func (o *InlineResponse20029) SetData(v []Audience) { o.Data = v } diff --git a/model_inline_response_200_3.go b/model_inline_response_200_3.go index d032d85e..e77bab71 100644 --- a/model_inline_response_200_3.go +++ b/model_inline_response_200_3.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 []Campaign `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Application `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() []Campaign { +func (o *InlineResponse2003) GetData() []Application { if o == nil { - var ret []Campaign + var ret []Application return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2003) GetData() []Campaign { } // SetData sets field value -func (o *InlineResponse2003) SetData(v []Campaign) { +func (o *InlineResponse2003) SetData(v []Application) { o.Data = v } diff --git a/model_inline_response_200_30.go b/model_inline_response_200_30.go index 8d086329..8108530c 100644 --- a/model_inline_response_200_30.go +++ b/model_inline_response_200_30.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,81 @@ import ( // InlineResponse20030 struct for InlineResponse20030 type InlineResponse20030 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []EventType `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []ApplicationReferee `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20030) 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 *InlineResponse20030) 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 *InlineResponse20030) 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 *InlineResponse20030) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20030) 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 *InlineResponse20030) 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 *InlineResponse20030) 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 *InlineResponse20030) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20030) GetData() []EventType { +func (o *InlineResponse20030) GetData() []ApplicationReferee { if o == nil { - var ret []EventType + var ret []ApplicationReferee return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20030) GetData() []EventType { } // SetData sets field value -func (o *InlineResponse20030) SetData(v []EventType) { +func (o *InlineResponse20030) SetData(v []ApplicationReferee) { o.Data = v } diff --git a/model_inline_response_200_31.go b/model_inline_response_200_31.go index 6daba7b5..68271b03 100644 --- a/model_inline_response_200_31.go +++ b/model_inline_response_200_31.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse20031 struct for InlineResponse20031 type InlineResponse20031 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []User `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Attribute `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20031) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20031) GetData() []User { +func (o *InlineResponse20031) GetData() []Attribute { if o == nil { - var ret []User + var ret []Attribute return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20031) GetData() []User { } // SetData sets field value -func (o *InlineResponse20031) SetData(v []User) { +func (o *InlineResponse20031) SetData(v []Attribute) { o.Data = v } diff --git a/model_inline_response_200_32.go b/model_inline_response_200_32.go index 0296ac99..a92bae76 100644 --- a/model_inline_response_200_32.go +++ b/model_inline_response_200_32.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,81 +16,29 @@ import ( // InlineResponse20032 struct for InlineResponse20032 type InlineResponse20032 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - HasMore *bool `json:"hasMore,omitempty"` - Data []Change `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []AccountAdditionalCost `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +// GetTotalResultSize returns the TotalResultSize field value func (o *InlineResponse20032) 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 *InlineResponse20032) 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 *InlineResponse20032) 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 *InlineResponse20032) SetTotalResultSize(v int32) { - o.TotalResultSize = &v -} - -// GetHasMore returns the HasMore field value if set, zero value otherwise. -func (o *InlineResponse20032) 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 *InlineResponse20032) 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 *InlineResponse20032) 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 *InlineResponse20032) SetHasMore(v bool) { - o.HasMore = &v + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20032) GetData() []Change { +func (o *InlineResponse20032) GetData() []AccountAdditionalCost { if o == nil { - var ret []Change + var ret []AccountAdditionalCost return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20032) GetData() []Change { } // SetData sets field value -func (o *InlineResponse20032) SetData(v []Change) { +func (o *InlineResponse20032) SetData(v []AccountAdditionalCost) { o.Data = v } diff --git a/model_inline_response_200_33.go b/model_inline_response_200_33.go index 4f4a668f..b2b5f92c 100644 --- a/model_inline_response_200_33.go +++ b/model_inline_response_200_33.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse20033 struct for InlineResponse20033 type InlineResponse20033 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Export `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Webhook `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20033) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20033) GetData() []Export { +func (o *InlineResponse20033) GetData() []Webhook { if o == nil { - var ret []Export + var ret []Webhook return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20033) GetData() []Export { } // SetData sets field value -func (o *InlineResponse20033) SetData(v []Export) { +func (o *InlineResponse20033) SetData(v []Webhook) { o.Data = v } diff --git a/model_inline_response_200_34.go b/model_inline_response_200_34.go index 75a08b12..9a19a2f3 100644 --- a/model_inline_response_200_34.go +++ b/model_inline_response_200_34.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse20034 struct for InlineResponse20034 type InlineResponse20034 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Role `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []WebhookActivationLogEntry `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20034) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20034) GetData() []Role { +func (o *InlineResponse20034) GetData() []WebhookActivationLogEntry { if o == nil { - var ret []Role + var ret []WebhookActivationLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20034) GetData() []Role { } // SetData sets field value -func (o *InlineResponse20034) SetData(v []Role) { +func (o *InlineResponse20034) SetData(v []WebhookActivationLogEntry) { o.Data = v } diff --git a/model_inline_response_200_35.go b/model_inline_response_200_35.go new file mode 100644 index 00000000..08cd0eea --- /dev/null +++ b/model_inline_response_200_35.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20035 struct for InlineResponse20035 +type InlineResponse20035 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []WebhookLogEntry `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20035) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20035) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20035) GetData() []WebhookLogEntry { + if o == nil { + var ret []WebhookLogEntry + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20035) SetData(v []WebhookLogEntry) { + o.Data = v +} + +type NullableInlineResponse20035 struct { + Value InlineResponse20035 + ExplicitNull bool +} + +func (v NullableInlineResponse20035) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20035) 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_36.go b/model_inline_response_200_36.go new file mode 100644 index 00000000..77d29bfe --- /dev/null +++ b/model_inline_response_200_36.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20036 struct for InlineResponse20036 +type InlineResponse20036 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []EventType `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20036) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20036) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20036) GetData() []EventType { + if o == nil { + var ret []EventType + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20036) SetData(v []EventType) { + o.Data = v +} + +type NullableInlineResponse20036 struct { + Value InlineResponse20036 + ExplicitNull bool +} + +func (v NullableInlineResponse20036) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20036) 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_37.go b/model_inline_response_200_37.go new file mode 100644 index 00000000..69110ecf --- /dev/null +++ b/model_inline_response_200_37.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20037 struct for InlineResponse20037 +type InlineResponse20037 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []User `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20037) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20037) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20037) GetData() []User { + if o == nil { + var ret []User + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20037) SetData(v []User) { + o.Data = v +} + +type NullableInlineResponse20037 struct { + Value InlineResponse20037 + ExplicitNull bool +} + +func (v NullableInlineResponse20037) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20037) 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_38.go b/model_inline_response_200_38.go new file mode 100644 index 00000000..691b6187 --- /dev/null +++ b/model_inline_response_200_38.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20038 struct for InlineResponse20038 +type InlineResponse20038 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 *InlineResponse20038) 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 *InlineResponse20038) 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 *InlineResponse20038) 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 *InlineResponse20038) SetTotalResultSize(v int32) { + o.TotalResultSize = &v +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20038) 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 *InlineResponse20038) 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 *InlineResponse20038) 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 *InlineResponse20038) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetData returns the Data field value +func (o *InlineResponse20038) GetData() []Change { + if o == nil { + var ret []Change + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20038) SetData(v []Change) { + o.Data = v +} + +type NullableInlineResponse20038 struct { + Value InlineResponse20038 + ExplicitNull bool +} + +func (v NullableInlineResponse20038) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20038) 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_39.go b/model_inline_response_200_39.go new file mode 100644 index 00000000..54ebefed --- /dev/null +++ b/model_inline_response_200_39.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20039 struct for InlineResponse20039 +type InlineResponse20039 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []Export `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20039) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20039) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20039) GetData() []Export { + if o == nil { + var ret []Export + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20039) SetData(v []Export) { + o.Data = v +} + +type NullableInlineResponse20039 struct { + Value InlineResponse20039 + ExplicitNull bool +} + +func (v NullableInlineResponse20039) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20039) 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 f8cd6f58..3164295a 100644 --- a/model_inline_response_200_4.go +++ b/model_inline_response_200_4.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 []NotificationWebhook `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Campaign `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() []NotificationWebhook { +func (o *InlineResponse2004) GetData() []Campaign { if o == nil { - var ret []NotificationWebhook + var ret []Campaign return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2004) GetData() []NotificationWebhook { } // SetData sets field value -func (o *InlineResponse2004) SetData(v []NotificationWebhook) { +func (o *InlineResponse2004) SetData(v []Campaign) { o.Data = v } diff --git a/model_inline_response_200_40.go b/model_inline_response_200_40.go new file mode 100644 index 00000000..f99d9479 --- /dev/null +++ b/model_inline_response_200_40.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// InlineResponse20040 struct for InlineResponse20040 +type InlineResponse20040 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []Role `json:"data"` +} + +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20040) GetTotalResultSize() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalResultSize +} + +// SetTotalResultSize sets field value +func (o *InlineResponse20040) SetTotalResultSize(v int32) { + o.TotalResultSize = v +} + +// GetData returns the Data field value +func (o *InlineResponse20040) GetData() []Role { + if o == nil { + var ret []Role + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *InlineResponse20040) SetData(v []Role) { + o.Data = v +} + +type NullableInlineResponse20040 struct { + Value InlineResponse20040 + ExplicitNull bool +} + +func (v NullableInlineResponse20040) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInlineResponse20040) 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_5.go b/model_inline_response_200_5.go index 990ae920..68386840 100644 --- a/model_inline_response_200_5.go +++ b/model_inline_response_200_5.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse2005 struct for InlineResponse2005 type InlineResponse2005 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 *InlineResponse2005) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse2005) GetData() []Ruleset { +func (o *InlineResponse2005) GetData() []NotificationWebhook { if o == nil { - var ret []Ruleset + var ret []NotificationWebhook return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2005) GetData() []Ruleset { } // SetData sets field value -func (o *InlineResponse2005) SetData(v []Ruleset) { +func (o *InlineResponse2005) SetData(v []NotificationWebhook) { o.Data = v } diff --git a/model_inline_response_200_6.go b/model_inline_response_200_6.go index 521c6430..b4f6a17d 100644 --- a/model_inline_response_200_6.go +++ b/model_inline_response_200_6.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse2006 struct for InlineResponse2006 type InlineResponse2006 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 *InlineResponse2006) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse2006) GetData() []Coupon { +func (o *InlineResponse2006) GetData() []Ruleset { if o == nil { - var ret []Coupon + var ret []Ruleset return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2006) GetData() []Coupon { } // SetData sets field value -func (o *InlineResponse2006) SetData(v []Coupon) { +func (o *InlineResponse2006) SetData(v []Ruleset) { o.Data = v } diff --git a/model_inline_response_200_7.go b/model_inline_response_200_7.go index 4e0dc18e..64c402dd 100644 --- a/model_inline_response_200_7.go +++ b/model_inline_response_200_7.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,23 +16,23 @@ import ( // InlineResponse2007 struct for InlineResponse2007 type InlineResponse2007 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 *InlineResponse2007) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse2007) 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 *InlineResponse2007) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse2007) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value diff --git a/model_inline_response_200_8.go b/model_inline_response_200_8.go index b829bd42..12e2b838 100644 --- a/model_inline_response_200_8.go +++ b/model_inline_response_200_8.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ import ( // InlineResponse2008 struct for InlineResponse2008 type InlineResponse2008 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 *InlineResponse2008) SetHasMore(v bool) { } // GetData returns the Data field value -func (o *InlineResponse2008) GetData() []Referral { +func (o *InlineResponse2008) GetData() []Coupon { if o == nil { - var ret []Referral + var ret []Coupon return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2008) GetData() []Referral { } // SetData sets field value -func (o *InlineResponse2008) SetData(v []Referral) { +func (o *InlineResponse2008) SetData(v []Coupon) { o.Data = v } diff --git a/model_inline_response_200_9.go b/model_inline_response_200_9.go index 09be024d..f56155bf 100644 --- a/model_inline_response_200_9.go +++ b/model_inline_response_200_9.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,29 +16,29 @@ import ( // InlineResponse2009 struct for InlineResponse2009 type InlineResponse2009 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 *InlineResponse2009) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse2009) 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 *InlineResponse2009) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse2009) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value -func (o *InlineResponse2009) GetData() []LoyaltyProgram { +func (o *InlineResponse2009) GetData() []Referral { if o == nil { - var ret []LoyaltyProgram + var ret []Referral return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2009) GetData() []LoyaltyProgram { } // SetData sets field value -func (o *InlineResponse2009) SetData(v []LoyaltyProgram) { +func (o *InlineResponse2009) SetData(v []Referral) { o.Data = v } diff --git a/model_inline_response_201.go b/model_inline_response_201.go index 30b87ce7..98cb05af 100644 --- a/model_inline_response_201.go +++ b/model_inline_response_201.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_integration_coupon.go b/model_integration_coupon.go new file mode 100644 index 00000000..13ef8bb0 --- /dev/null +++ b/model_integration_coupon.go @@ -0,0 +1,687 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// IntegrationCoupon +type IntegrationCoupon struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. + Created time.Time `json:"created"` + // The ID of the campaign that owns this entity. + CampaignId int32 `json:"campaignId"` + // The coupon code. + Value string `json:"value"` + // 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 total discount value that the code can give. Typically used to represent a gift card value. + DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` + // Timestamp at which point the coupon becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiration 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 the coupon has been successfully redeemed. + 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"` + // The number of times this coupon has been reserved. + ReservationCounter *float32 `json:"reservationCounter,omitempty"` + // 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"` + // The Integration ID of the customer that is allowed to redeem this coupon. + RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` + // The ID of the Import which created this coupon. + ImportId *int32 `json:"importId,omitempty"` + // 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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. + Reservation *bool `json:"reservation,omitempty"` + // The id of the batch the coupon belongs to. + BatchId *string `json:"batchId,omitempty"` + // Whether the reservation effect actually created a new reservation. + IsReservationMandatory *bool `json:"isReservationMandatory,omitempty"` + // The number of times the coupon was redeemed by the profile. + ProfileRedemptionCount int32 `json:"profileRedemptionCount"` +} + +// GetId returns the Id field value +func (o *IntegrationCoupon) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *IntegrationCoupon) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *IntegrationCoupon) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *IntegrationCoupon) SetCreated(v time.Time) { + o.Created = v +} + +// GetCampaignId returns the CampaignId field value +func (o *IntegrationCoupon) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *IntegrationCoupon) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetValue returns the Value field value +func (o *IntegrationCoupon) GetValue() string { + if o == nil { + var ret string + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *IntegrationCoupon) SetValue(v string) { + o.Value = v +} + +// GetUsageLimit returns the UsageLimit field value +func (o *IntegrationCoupon) GetUsageLimit() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageLimit +} + +// SetUsageLimit sets field value +func (o *IntegrationCoupon) SetUsageLimit(v int32) { + o.UsageLimit = v +} + +// GetDiscountLimit returns the DiscountLimit field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetDiscountLimit() float32 { + if o == nil || o.DiscountLimit == nil { + var ret float32 + return ret + } + return *o.DiscountLimit +} + +// GetDiscountLimitOk returns a tuple with the DiscountLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetDiscountLimitOk() (float32, bool) { + if o == nil || o.DiscountLimit == nil { + var ret float32 + return ret, false + } + return *o.DiscountLimit, true +} + +// HasDiscountLimit returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasDiscountLimit() bool { + if o != nil && o.DiscountLimit != nil { + return true + } + + return false +} + +// SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +func (o *IntegrationCoupon) SetDiscountLimit(v float32) { + o.DiscountLimit = &v +} + +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *IntegrationCoupon) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) SetLimits(v []LimitConfig) { + o.Limits = &v +} + +// GetUsageCounter returns the UsageCounter field value +func (o *IntegrationCoupon) GetUsageCounter() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageCounter +} + +// SetUsageCounter sets field value +func (o *IntegrationCoupon) SetUsageCounter(v int32) { + o.UsageCounter = v +} + +// GetDiscountCounter returns the DiscountCounter field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetDiscountCounter() float32 { + if o == nil || o.DiscountCounter == nil { + var ret float32 + return ret + } + return *o.DiscountCounter +} + +// GetDiscountCounterOk returns a tuple with the DiscountCounter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetDiscountCounterOk() (float32, bool) { + if o == nil || o.DiscountCounter == nil { + var ret float32 + return ret, false + } + return *o.DiscountCounter, true +} + +// HasDiscountCounter returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasDiscountCounter() bool { + if o != nil && o.DiscountCounter != nil { + return true + } + + return false +} + +// SetDiscountCounter gets a reference to the given float32 and assigns it to the DiscountCounter field. +func (o *IntegrationCoupon) SetDiscountCounter(v float32) { + o.DiscountCounter = &v +} + +// GetDiscountRemainder returns the DiscountRemainder field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetDiscountRemainder() float32 { + if o == nil || o.DiscountRemainder == nil { + var ret float32 + return ret + } + return *o.DiscountRemainder +} + +// GetDiscountRemainderOk returns a tuple with the DiscountRemainder field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetDiscountRemainderOk() (float32, bool) { + if o == nil || o.DiscountRemainder == nil { + var ret float32 + return ret, false + } + return *o.DiscountRemainder, true +} + +// HasDiscountRemainder returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasDiscountRemainder() bool { + if o != nil && o.DiscountRemainder != nil { + return true + } + + return false +} + +// SetDiscountRemainder gets a reference to the given float32 and assigns it to the DiscountRemainder field. +func (o *IntegrationCoupon) SetDiscountRemainder(v float32) { + o.DiscountRemainder = &v +} + +// GetReservationCounter returns the ReservationCounter field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetReservationCounter() float32 { + if o == nil || o.ReservationCounter == nil { + var ret float32 + return ret + } + return *o.ReservationCounter +} + +// GetReservationCounterOk returns a tuple with the ReservationCounter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetReservationCounterOk() (float32, bool) { + if o == nil || o.ReservationCounter == nil { + var ret float32 + return ret, false + } + return *o.ReservationCounter, true +} + +// HasReservationCounter returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasReservationCounter() bool { + if o != nil && o.ReservationCounter != nil { + return true + } + + return false +} + +// SetReservationCounter gets a reference to the given float32 and assigns it to the ReservationCounter field. +func (o *IntegrationCoupon) SetReservationCounter(v float32) { + o.ReservationCounter = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetReferralId returns the ReferralId field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetReferralId() int32 { + if o == nil || o.ReferralId == nil { + var ret int32 + return ret + } + return *o.ReferralId +} + +// GetReferralIdOk returns a tuple with the ReferralId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetReferralIdOk() (int32, bool) { + if o == nil || o.ReferralId == nil { + var ret int32 + return ret, false + } + return *o.ReferralId, true +} + +// HasReferralId returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasReferralId() bool { + if o != nil && o.ReferralId != nil { + return true + } + + return false +} + +// SetReferralId gets a reference to the given int32 and assigns it to the ReferralId field. +func (o *IntegrationCoupon) SetReferralId(v int32) { + o.ReferralId = &v +} + +// GetRecipientIntegrationId returns the RecipientIntegrationId field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetRecipientIntegrationId() string { + if o == nil || o.RecipientIntegrationId == nil { + var ret string + return ret + } + return *o.RecipientIntegrationId +} + +// GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetRecipientIntegrationIdOk() (string, bool) { + if o == nil || o.RecipientIntegrationId == nil { + var ret string + return ret, false + } + return *o.RecipientIntegrationId, true +} + +// HasRecipientIntegrationId returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasRecipientIntegrationId() bool { + if o != nil && o.RecipientIntegrationId != nil { + return true + } + + return false +} + +// SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. +func (o *IntegrationCoupon) SetRecipientIntegrationId(v string) { + o.RecipientIntegrationId = &v +} + +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) SetImportId(v int32) { + o.ImportId = &v +} + +// GetReservation returns the Reservation field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetReservation() bool { + if o == nil || o.Reservation == nil { + var ret bool + return ret + } + return *o.Reservation +} + +// GetReservationOk returns a tuple with the Reservation field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetReservationOk() (bool, bool) { + if o == nil || o.Reservation == nil { + var ret bool + return ret, false + } + return *o.Reservation, true +} + +// HasReservation returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasReservation() bool { + if o != nil && o.Reservation != nil { + return true + } + + return false +} + +// SetReservation gets a reference to the given bool and assigns it to the Reservation field. +func (o *IntegrationCoupon) SetReservation(v bool) { + o.Reservation = &v +} + +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) 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 *IntegrationCoupon) SetBatchId(v string) { + o.BatchId = &v +} + +// GetIsReservationMandatory returns the IsReservationMandatory field value if set, zero value otherwise. +func (o *IntegrationCoupon) GetIsReservationMandatory() bool { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret + } + return *o.IsReservationMandatory +} + +// GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationCoupon) GetIsReservationMandatoryOk() (bool, bool) { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret, false + } + return *o.IsReservationMandatory, true +} + +// HasIsReservationMandatory returns a boolean if a field has been set. +func (o *IntegrationCoupon) HasIsReservationMandatory() bool { + if o != nil && o.IsReservationMandatory != nil { + return true + } + + return false +} + +// SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. +func (o *IntegrationCoupon) SetIsReservationMandatory(v bool) { + o.IsReservationMandatory = &v +} + +// GetProfileRedemptionCount returns the ProfileRedemptionCount field value +func (o *IntegrationCoupon) GetProfileRedemptionCount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProfileRedemptionCount +} + +// SetProfileRedemptionCount sets field value +func (o *IntegrationCoupon) SetProfileRedemptionCount(v int32) { + o.ProfileRedemptionCount = v +} + +type NullableIntegrationCoupon struct { + Value IntegrationCoupon + ExplicitNull bool +} + +func (v NullableIntegrationCoupon) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableIntegrationCoupon) 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_customer_session_response.go b/model_integration_customer_session_response.go index dba352af..25e5f0d9 100644 --- a/model_integration_customer_session_response.go +++ b/model_integration_customer_session_response.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_integration_entity.go b/model_integration_entity.go index 275fab16..1ed6a272 100644 --- a/model_integration_entity.go +++ b/model_integration_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ import ( type IntegrationEntity struct { // The integration ID set by your integration layer. IntegrationId string `json:"integrationId"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` } diff --git a/model_integration_event.go b/model_integration_event.go index ab161637..0e7f88be 100644 --- a/model_integration_event.go +++ b/model_integration_event.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_integration_event_v2_request.go b/model_integration_event_v2_request.go index 8ce0c9aa..758dff7a 100644 --- a/model_integration_event_v2_request.go +++ b/model_integration_event_v2_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,9 +18,11 @@ import ( 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. + // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` + // A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. Type string `json:"type"` - // Arbitrary additional JSON data associated with the event. + // Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). 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"` @@ -59,6 +61,39 @@ func (o *IntegrationEventV2Request) SetProfileId(v string) { o.ProfileId = &v } +// GetEvaluableCampaignIds returns the EvaluableCampaignIds field value if set, zero value otherwise. +func (o *IntegrationEventV2Request) GetEvaluableCampaignIds() []int32 { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret + } + return *o.EvaluableCampaignIds +} + +// GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationEventV2Request) GetEvaluableCampaignIdsOk() ([]int32, bool) { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.EvaluableCampaignIds, true +} + +// HasEvaluableCampaignIds returns a boolean if a field has been set. +func (o *IntegrationEventV2Request) HasEvaluableCampaignIds() bool { + if o != nil && o.EvaluableCampaignIds != nil { + return true + } + + return false +} + +// SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. +func (o *IntegrationEventV2Request) SetEvaluableCampaignIds(v []int32) { + o.EvaluableCampaignIds = &v +} + // GetType returns the Type field value func (o *IntegrationEventV2Request) GetType() string { if o == nil { diff --git a/model_integration_profile_entity.go b/model_integration_profile_entity.go index ec11d277..4f339174 100644 --- a/model_integration_profile_entity.go +++ b/model_integration_profile_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_integration_request.go b/model_integration_request.go index 598bc9e6..0b8e5750 100644 --- a/model_integration_request.go +++ b/model_integration_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 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`. + // Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer session_ request instead of sending extra requests to other endpoints. ResponseContent *[]string `json:"responseContent,omitempty"` } diff --git a/model_integration_state.go b/model_integration_state.go index 96a2c3b6..910a552a 100644 --- a/model_integration_state.go +++ b/model_integration_state.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_integration_state_v2.go b/model_integration_state_v2.go index 1c295184..861a0841 100644 --- a/model_integration_state_v2.go +++ b/model_integration_state_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,15 +14,16 @@ import ( "encoding/json" ) -// IntegrationStateV2 Contains all entities that might interest Talon.One integrations. This is the response type returned by the V2 PUT customer_session endpoint +// IntegrationStateV2 Contains all entities that might interest Talon.One integrations. type IntegrationStateV2 struct { CustomerSession *CustomerSessionV2 `json:"customerSession,omitempty"` CustomerProfile *CustomerProfile `json:"customerProfile,omitempty"` Event *Event `json:"event,omitempty"` Loyalty *Loyalty `json:"loyalty,omitempty"` Referral *InventoryReferral `json:"referral,omitempty"` - Coupons *[]Coupon `json:"coupons,omitempty"` + Coupons *[]IntegrationCoupon `json:"coupons,omitempty"` TriggeredCampaigns *[]Campaign `json:"triggeredCampaigns,omitempty"` + // The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). Effects []Effect `json:"effects"` RuleFailureReasons *[]RuleFailureReason `json:"ruleFailureReasons,omitempty"` CreatedCoupons []Coupon `json:"createdCoupons"` @@ -198,9 +199,9 @@ func (o *IntegrationStateV2) SetReferral(v InventoryReferral) { } // GetCoupons returns the Coupons field value if set, zero value otherwise. -func (o *IntegrationStateV2) GetCoupons() []Coupon { +func (o *IntegrationStateV2) GetCoupons() []IntegrationCoupon { if o == nil || o.Coupons == nil { - var ret []Coupon + var ret []IntegrationCoupon return ret } return *o.Coupons @@ -208,9 +209,9 @@ func (o *IntegrationStateV2) GetCoupons() []Coupon { // GetCouponsOk returns a tuple with the Coupons field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *IntegrationStateV2) GetCouponsOk() ([]Coupon, bool) { +func (o *IntegrationStateV2) GetCouponsOk() ([]IntegrationCoupon, bool) { if o == nil || o.Coupons == nil { - var ret []Coupon + var ret []IntegrationCoupon return ret, false } return *o.Coupons, true @@ -225,8 +226,8 @@ func (o *IntegrationStateV2) HasCoupons() bool { return false } -// SetCoupons gets a reference to the given []Coupon and assigns it to the Coupons field. -func (o *IntegrationStateV2) SetCoupons(v []Coupon) { +// SetCoupons gets a reference to the given []IntegrationCoupon and assigns it to the Coupons field. +func (o *IntegrationStateV2) SetCoupons(v []IntegrationCoupon) { o.Coupons = &v } diff --git a/model_inventory_coupon.go b/model_inventory_coupon.go index e8506255..8396968b 100644 --- a/model_inventory_coupon.go +++ b/model_inventory_coupon.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // InventoryCoupon type InventoryCoupon 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the campaign that owns this entity. CampaignId int32 `json:"campaignId"` @@ -27,20 +27,24 @@ type InventoryCoupon struct { Value string `json:"value"` // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration 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. + // The number of times the coupon has been successfully redeemed. 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"` + // The number of times this coupon has been reserved. + ReservationCounter *float32 `json:"reservationCounter,omitempty"` // 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. @@ -49,10 +53,12 @@ type InventoryCoupon struct { RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` // The ID of the Import which created this coupon. ImportId *int32 `json:"importId,omitempty"` - // 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). + // 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](https://docs.talon.one/integration-api#operation/createCouponReservation) endpoint. - `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](https://docs.talon.one/management-api#operation/createCoupons) endpoint or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint. Reservation *bool `json:"reservation,omitempty"` // The id of the batch the coupon belongs to. BatchId *string `json:"batchId,omitempty"` + // Whether the reservation effect actually created a new reservation. + IsReservationMandatory *bool `json:"isReservationMandatory,omitempty"` // The number of times the coupon was redeemed by the profile. ProfileRedemptionCount int32 `json:"profileRedemptionCount"` // 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. @@ -167,6 +173,39 @@ func (o *InventoryCoupon) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *InventoryCoupon) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *InventoryCoupon) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *InventoryCoupon) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *InventoryCoupon) GetStartDate() time.Time { if o == nil || o.StartDate == nil { @@ -347,6 +386,39 @@ func (o *InventoryCoupon) SetDiscountRemainder(v float32) { o.DiscountRemainder = &v } +// GetReservationCounter returns the ReservationCounter field value if set, zero value otherwise. +func (o *InventoryCoupon) GetReservationCounter() float32 { + if o == nil || o.ReservationCounter == nil { + var ret float32 + return ret + } + return *o.ReservationCounter +} + +// GetReservationCounterOk returns a tuple with the ReservationCounter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetReservationCounterOk() (float32, bool) { + if o == nil || o.ReservationCounter == nil { + var ret float32 + return ret, false + } + return *o.ReservationCounter, true +} + +// HasReservationCounter returns a boolean if a field has been set. +func (o *InventoryCoupon) HasReservationCounter() bool { + if o != nil && o.ReservationCounter != nil { + return true + } + + return false +} + +// SetReservationCounter gets a reference to the given float32 and assigns it to the ReservationCounter field. +func (o *InventoryCoupon) SetReservationCounter(v float32) { + o.ReservationCounter = &v +} + // GetAttributes returns the Attributes field value if set, zero value otherwise. func (o *InventoryCoupon) GetAttributes() map[string]interface{} { if o == nil || o.Attributes == nil { @@ -545,6 +617,39 @@ func (o *InventoryCoupon) SetBatchId(v string) { o.BatchId = &v } +// GetIsReservationMandatory returns the IsReservationMandatory field value if set, zero value otherwise. +func (o *InventoryCoupon) GetIsReservationMandatory() bool { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret + } + return *o.IsReservationMandatory +} + +// GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetIsReservationMandatoryOk() (bool, bool) { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret, false + } + return *o.IsReservationMandatory, true +} + +// HasIsReservationMandatory returns a boolean if a field has been set. +func (o *InventoryCoupon) HasIsReservationMandatory() bool { + if o != nil && o.IsReservationMandatory != nil { + return true + } + + return false +} + +// SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. +func (o *InventoryCoupon) SetIsReservationMandatory(v bool) { + o.IsReservationMandatory = &v +} + // GetProfileRedemptionCount returns the ProfileRedemptionCount field value func (o *InventoryCoupon) GetProfileRedemptionCount() int32 { if o == nil { diff --git a/model_inventory_referral.go b/model_inventory_referral.go index 36afa9bd..6cd226d8 100644 --- a/model_inventory_referral.go +++ b/model_inventory_referral.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // Expiration 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"` diff --git a/model_item_attribute.go b/model_item_attribute.go index 95b1210d..95957521 100644 --- a/model_item_attribute.go +++ b/model_item_attribute.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_ledger_entry.go b/model_ledger_entry.go index 0ab8f159..c4dd2c18 100644 --- a/model_ledger_entry.go +++ b/model_ledger_entry.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // LedgerEntry type LedgerEntry 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // 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"` @@ -33,7 +33,7 @@ type LedgerEntry struct { Amount int32 `json:"amount"` // reason for awarding/deducting points. Reason string `json:"reason"` - // Expiry date of the points. + // Expiration date of the points. ExpiryDate time.Time `json:"expiryDate"` // The ID of the balancing ledgerEntry. ReferenceId *int32 `json:"referenceId,omitempty"` diff --git a/model_ledger_info.go b/model_ledger_info.go index 04794fde..3bc8db32 100644 --- a/model_ledger_info.go +++ b/model_ledger_info.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -20,16 +20,17 @@ type LedgerInfo struct { CurrentBalance float32 `json:"currentBalance"` // Sum of pending points. PendingBalance float32 `json:"pendingBalance"` - // Sum of expired points. + // **DEPRECATED** Value is shown as 0. ExpiredBalance float32 `json:"expiredBalance"` - // Sum of spent points. + // **DEPRECATED** Value is shown as 0. SpentBalance float32 `json:"spentBalance"` - // Sum of currently active points, including points added and deducted in open sessions. + // Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied. TentativeCurrentBalance float32 `json:"tentativeCurrentBalance"` - CurrentTier *Tier `json:"currentTier,omitempty"` + // Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied. + TentativePendingBalance *float32 `json:"tentativePendingBalance,omitempty"` + CurrentTier *Tier `json:"currentTier,omitempty"` // Points required to move up a tier. - PointsToNextTier *float32 `json:"pointsToNextTier,omitempty"` - Projection *LoyaltyProjection `json:"projection,omitempty"` + PointsToNextTier *float32 `json:"pointsToNextTier,omitempty"` } // GetCurrentBalance returns the CurrentBalance field value @@ -107,6 +108,39 @@ func (o *LedgerInfo) SetTentativeCurrentBalance(v float32) { o.TentativeCurrentBalance = v } +// GetTentativePendingBalance returns the TentativePendingBalance field value if set, zero value otherwise. +func (o *LedgerInfo) GetTentativePendingBalance() float32 { + if o == nil || o.TentativePendingBalance == nil { + var ret float32 + return ret + } + return *o.TentativePendingBalance +} + +// GetTentativePendingBalanceOk returns a tuple with the TentativePendingBalance field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LedgerInfo) GetTentativePendingBalanceOk() (float32, bool) { + if o == nil || o.TentativePendingBalance == nil { + var ret float32 + return ret, false + } + return *o.TentativePendingBalance, true +} + +// HasTentativePendingBalance returns a boolean if a field has been set. +func (o *LedgerInfo) HasTentativePendingBalance() bool { + if o != nil && o.TentativePendingBalance != nil { + return true + } + + return false +} + +// SetTentativePendingBalance gets a reference to the given float32 and assigns it to the TentativePendingBalance field. +func (o *LedgerInfo) SetTentativePendingBalance(v float32) { + o.TentativePendingBalance = &v +} + // GetCurrentTier returns the CurrentTier field value if set, zero value otherwise. func (o *LedgerInfo) GetCurrentTier() Tier { if o == nil || o.CurrentTier == nil { @@ -173,39 +207,6 @@ 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 index e9434ae4..b792c599 100644 --- a/model_ledger_transaction_log_entry_integration_api.go +++ b/model_ledger_transaction_log_entry_integration_api.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,17 +17,17 @@ import ( // LedgerTransactionLogEntryIntegrationApi Log entry for a given loyalty card transaction. type LedgerTransactionLogEntryIntegrationApi struct { - // Date and time the loyalty card transaction occurred. + // Date and time the loyalty 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. + CustomerSessionId *string `json:"customerSessionId,omitempty"` + // Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. 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. + // When points become active. Possible values: - `immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time. 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"` @@ -73,19 +73,37 @@ func (o *LedgerTransactionLogEntryIntegrationApi) SetProgramId(v int32) { o.ProgramId = v } -// GetCustomerSessionId returns the CustomerSessionId field value +// GetCustomerSessionId returns the CustomerSessionId field value if set, zero value otherwise. func (o *LedgerTransactionLogEntryIntegrationApi) GetCustomerSessionId() string { - if o == nil { + if o == nil || o.CustomerSessionId == nil { var ret string return ret } + return *o.CustomerSessionId +} + +// GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LedgerTransactionLogEntryIntegrationApi) GetCustomerSessionIdOk() (string, bool) { + if o == nil || o.CustomerSessionId == nil { + var ret string + return ret, false + } + return *o.CustomerSessionId, true +} + +// HasCustomerSessionId returns a boolean if a field has been set. +func (o *LedgerTransactionLogEntryIntegrationApi) HasCustomerSessionId() bool { + if o != nil && o.CustomerSessionId != nil { + return true + } - return o.CustomerSessionId + return false } -// SetCustomerSessionId sets field value +// SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. func (o *LedgerTransactionLogEntryIntegrationApi) SetCustomerSessionId(v string) { - o.CustomerSessionId = v + o.CustomerSessionId = &v } // GetType returns the Type field value diff --git a/model_library_attribute.go b/model_library_attribute.go index 5dac061b..7459ccd3 100644 --- a/model_library_attribute.go +++ b/model_library_attribute.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_limit_config.go b/model_limit_config.go index 14970e02..a40c3cf2 100644 --- a/model_limit_config.go +++ b/model_limit_config.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_limit_counter.go b/model_limit_counter.go index fbffe7e6..b03474dc 100644 --- a/model_limit_counter.go +++ b/model_limit_counter.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -30,7 +30,7 @@ type LimitCounter struct { ProfileId *int32 `json:"profileId,omitempty"` // The profile integration ID for which this limit counter is used. ProfileIntegrationId *string `json:"profileIntegrationId,omitempty"` - // The coupon ID for which this limit counter is used. + // The internal coupon ID for which this limit counter is used. CouponId *int32 `json:"couponId,omitempty"` // The coupon value for which this limit counter is used. CouponValue *string `json:"couponValue,omitempty"` @@ -39,7 +39,7 @@ type LimitCounter struct { // The referral value for which this limit counter is used. ReferralValue *string `json:"referralValue,omitempty"` // The arbitrary identifier for which this limit counter is used. - Identifier *int32 `json:"identifier,omitempty"` + Identifier *string `json:"identifier,omitempty"` // The time period for which this limit counter is used. Period *string `json:"period,omitempty"` // The highest possible value for this limit counter. @@ -322,9 +322,9 @@ func (o *LimitCounter) SetReferralValue(v string) { } // GetIdentifier returns the Identifier field value if set, zero value otherwise. -func (o *LimitCounter) GetIdentifier() int32 { +func (o *LimitCounter) GetIdentifier() string { if o == nil || o.Identifier == nil { - var ret int32 + var ret string return ret } return *o.Identifier @@ -332,9 +332,9 @@ func (o *LimitCounter) GetIdentifier() int32 { // GetIdentifierOk returns a tuple with the Identifier field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *LimitCounter) GetIdentifierOk() (int32, bool) { +func (o *LimitCounter) GetIdentifierOk() (string, bool) { if o == nil || o.Identifier == nil { - var ret int32 + var ret string return ret, false } return *o.Identifier, true @@ -349,8 +349,8 @@ func (o *LimitCounter) HasIdentifier() bool { return false } -// SetIdentifier gets a reference to the given int32 and assigns it to the Identifier field. -func (o *LimitCounter) SetIdentifier(v int32) { +// SetIdentifier gets a reference to the given string and assigns it to the Identifier field. +func (o *LimitCounter) SetIdentifier(v string) { o.Identifier = &v } diff --git a/model_login_params.go b/model_login_params.go index eeb0bb1a..f7c0138a 100644 --- a/model_login_params.go +++ b/model_login_params.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty.go b/model_loyalty.go index 687603b2..1049236d 100644 --- a/model_loyalty.go +++ b/model_loyalty.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_balance.go b/model_loyalty_balance.go index 76c8ac02..d61c7f15 100644 --- a/model_loyalty_balance.go +++ b/model_loyalty_balance.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_balances.go b/model_loyalty_balances.go index 97599a2d..2fa3d2e1 100644 --- a/model_loyalty_balances.go +++ b/model_loyalty_balances.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_card.go b/model_loyalty_card.go index 3bcb57aa..101bca6b 100644 --- a/model_loyalty_card.go +++ b/model_loyalty_card.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,25 +17,29 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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 of the loyalty card. Can be one of: ['active', 'inactive'] 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. + // The max amount of customer profiles that can be linked to the card. 0 means unlimited. UsersPerCardLimit int32 `json:"usersPerCardLimit"` - // Integration IDs of the customers associated with the card. + // Integration IDs of the customers profiles linked to 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"` + // The alphanumeric identifier of the loyalty card. + OldCardIdentifier *string `json:"oldCardIdentifier,omitempty"` + // The alphanumeric identifier of the loyalty card. + NewCardIdentifier *string `json:"newCardIdentifier,omitempty"` } // GetId returns the Id field value @@ -260,6 +264,72 @@ func (o *LoyaltyCard) SetModified(v time.Time) { o.Modified = &v } +// GetOldCardIdentifier returns the OldCardIdentifier field value if set, zero value otherwise. +func (o *LoyaltyCard) GetOldCardIdentifier() string { + if o == nil || o.OldCardIdentifier == nil { + var ret string + return ret + } + return *o.OldCardIdentifier +} + +// GetOldCardIdentifierOk returns a tuple with the OldCardIdentifier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetOldCardIdentifierOk() (string, bool) { + if o == nil || o.OldCardIdentifier == nil { + var ret string + return ret, false + } + return *o.OldCardIdentifier, true +} + +// HasOldCardIdentifier returns a boolean if a field has been set. +func (o *LoyaltyCard) HasOldCardIdentifier() bool { + if o != nil && o.OldCardIdentifier != nil { + return true + } + + return false +} + +// SetOldCardIdentifier gets a reference to the given string and assigns it to the OldCardIdentifier field. +func (o *LoyaltyCard) SetOldCardIdentifier(v string) { + o.OldCardIdentifier = &v +} + +// GetNewCardIdentifier returns the NewCardIdentifier field value if set, zero value otherwise. +func (o *LoyaltyCard) GetNewCardIdentifier() string { + if o == nil || o.NewCardIdentifier == nil { + var ret string + return ret + } + return *o.NewCardIdentifier +} + +// GetNewCardIdentifierOk returns a tuple with the NewCardIdentifier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetNewCardIdentifierOk() (string, bool) { + if o == nil || o.NewCardIdentifier == nil { + var ret string + return ret, false + } + return *o.NewCardIdentifier, true +} + +// HasNewCardIdentifier returns a boolean if a field has been set. +func (o *LoyaltyCard) HasNewCardIdentifier() bool { + if o != nil && o.NewCardIdentifier != nil { + return true + } + + return false +} + +// SetNewCardIdentifier gets a reference to the given string and assigns it to the NewCardIdentifier field. +func (o *LoyaltyCard) SetNewCardIdentifier(v string) { + o.NewCardIdentifier = &v +} + type NullableLoyaltyCard struct { Value LoyaltyCard ExplicitNull bool diff --git a/model_loyalty_card_profile_registration.go b/model_loyalty_card_profile_registration.go index a463a2c7..2e787cb0 100644 --- a/model_loyalty_card_profile_registration.go +++ b/model_loyalty_card_profile_registration.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,7 +17,7 @@ import ( // LoyaltyCardProfileRegistration struct for LoyaltyCardProfileRegistration type LoyaltyCardProfileRegistration struct { - // Integration ID of the customer associated with the card. + // Integration ID of the customer profile linked to the card. IntegrationId string `json:"integrationId"` // Timestamp of the registration to the card. Timestamp time.Time `json:"timestamp"` diff --git a/model_loyalty_card_registration.go b/model_loyalty_card_registration.go index b6a650d4..23ed1261 100644 --- a/model_loyalty_card_registration.go +++ b/model_loyalty_card_registration.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_dashboard_data.go b/model_loyalty_dashboard_data.go index 640109f7..83c4c425 100644 --- a/model_loyalty_dashboard_data.go +++ b/model_loyalty_dashboard_data.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 b0ea2aab..ed472418 100644 --- a/model_loyalty_dashboard_points_breakdown.go +++ b/model_loyalty_dashboard_points_breakdown.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_ledger.go b/model_loyalty_ledger.go index f5daa0dd..6edf27b7 100644 --- a/model_loyalty_ledger.go +++ b/model_loyalty_ledger.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_ledger_entry.go b/model_loyalty_ledger_entry.go index 32a06b24..0e678eab 100644 --- a/model_loyalty_ledger_entry.go +++ b/model_loyalty_ledger_entry.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,7 +23,7 @@ type LoyaltyLedgerEntry struct { 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) + // The type of the ledger transaction. Possible values are: - `addition` - `subtraction` - `expire` - `expiring` (for expiring points ledgers) Type string `json:"type"` Amount float32 `json:"amount"` StartDate *time.Time `json:"startDate,omitempty"` @@ -34,6 +34,8 @@ type LoyaltyLedgerEntry struct { 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"` + // Indicates if the entry belongs to the archived session. + Archived *bool `json:"archived,omitempty"` } // GetCreated returns the Created field value @@ -357,6 +359,39 @@ func (o *LoyaltyLedgerEntry) SetUserID(v int32) { o.UserID = &v } +// GetArchived returns the Archived field value if set, zero value otherwise. +func (o *LoyaltyLedgerEntry) GetArchived() bool { + if o == nil || o.Archived == nil { + var ret bool + return ret + } + return *o.Archived +} + +// GetArchivedOk returns a tuple with the Archived field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyLedgerEntry) GetArchivedOk() (bool, bool) { + if o == nil || o.Archived == nil { + var ret bool + return ret, false + } + return *o.Archived, true +} + +// HasArchived returns a boolean if a field has been set. +func (o *LoyaltyLedgerEntry) HasArchived() bool { + if o != nil && o.Archived != nil { + return true + } + + return false +} + +// SetArchived gets a reference to the given bool and assigns it to the Archived field. +func (o *LoyaltyLedgerEntry) SetArchived(v bool) { + o.Archived = &v +} + type NullableLoyaltyLedgerEntry struct { Value LoyaltyLedgerEntry ExplicitNull bool diff --git a/model_loyalty_ledger_transactions.go b/model_loyalty_ledger_transactions.go index be92621a..d786e852 100644 --- a/model_loyalty_ledger_transactions.go +++ b/model_loyalty_ledger_transactions.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_membership.go b/model_loyalty_membership.go index 1c431a91..8ffe8a47 100644 --- a/model_loyalty_membership.go +++ b/model_loyalty_membership.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_points.go b/model_loyalty_points.go deleted file mode 100644 index 77dad0b5..00000000 --- a/model_loyalty_points.go +++ /dev/null @@ -1,199 +0,0 @@ -/* - * 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" -) - -// LoyaltyPoints Points to add or deduct. -type LoyaltyPoints struct { - // Amount of loyalty points. - Points float32 `json:"points"` - // 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. - SubLedgerID *string `json:"subLedgerID,omitempty"` -} - -// GetPoints returns the Points field value -func (o *LoyaltyPoints) GetPoints() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.Points -} - -// SetPoints sets field value -func (o *LoyaltyPoints) SetPoints(v float32) { - o.Points = v -} - -// GetName returns the Name field value if set, zero value otherwise. -func (o *LoyaltyPoints) 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 *LoyaltyPoints) 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 *LoyaltyPoints) 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 *LoyaltyPoints) SetName(v string) { - o.Name = &v -} - -// GetValidityDuration returns the ValidityDuration field value if set, zero value otherwise. -func (o *LoyaltyPoints) GetValidityDuration() string { - if o == nil || o.ValidityDuration == nil { - var ret string - return ret - } - return *o.ValidityDuration -} - -// GetValidityDurationOk returns a tuple with the ValidityDuration field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *LoyaltyPoints) GetValidityDurationOk() (string, bool) { - if o == nil || o.ValidityDuration == nil { - var ret string - return ret, false - } - return *o.ValidityDuration, true -} - -// HasValidityDuration returns a boolean if a field has been set. -func (o *LoyaltyPoints) HasValidityDuration() bool { - if o != nil && o.ValidityDuration != nil { - return true - } - - return false -} - -// SetValidityDuration gets a reference to the given string and assigns it to the ValidityDuration field. -func (o *LoyaltyPoints) SetValidityDuration(v string) { - o.ValidityDuration = &v -} - -// GetPendingDuration returns the PendingDuration field value if set, zero value otherwise. -func (o *LoyaltyPoints) GetPendingDuration() string { - if o == nil || o.PendingDuration == nil { - var ret string - return ret - } - return *o.PendingDuration -} - -// GetPendingDurationOk returns a tuple with the PendingDuration field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *LoyaltyPoints) GetPendingDurationOk() (string, bool) { - if o == nil || o.PendingDuration == nil { - var ret string - return ret, false - } - return *o.PendingDuration, true -} - -// HasPendingDuration returns a boolean if a field has been set. -func (o *LoyaltyPoints) HasPendingDuration() bool { - if o != nil && o.PendingDuration != nil { - return true - } - - return false -} - -// SetPendingDuration gets a reference to the given string and assigns it to the PendingDuration field. -func (o *LoyaltyPoints) SetPendingDuration(v string) { - o.PendingDuration = &v -} - -// GetSubLedgerID returns the SubLedgerID field value if set, zero value otherwise. -func (o *LoyaltyPoints) GetSubLedgerID() string { - if o == nil || o.SubLedgerID == nil { - var ret string - return ret - } - return *o.SubLedgerID -} - -// GetSubLedgerIDOk returns a tuple with the SubLedgerID field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *LoyaltyPoints) GetSubLedgerIDOk() (string, bool) { - if o == nil || o.SubLedgerID == nil { - var ret string - return ret, false - } - return *o.SubLedgerID, true -} - -// HasSubLedgerID returns a boolean if a field has been set. -func (o *LoyaltyPoints) HasSubLedgerID() bool { - if o != nil && o.SubLedgerID != nil { - return true - } - - return false -} - -// SetSubLedgerID gets a reference to the given string and assigns it to the SubLedgerID field. -func (o *LoyaltyPoints) SetSubLedgerID(v string) { - o.SubLedgerID = &v -} - -type NullableLoyaltyPoints struct { - Value LoyaltyPoints - ExplicitNull bool -} - -func (v NullableLoyaltyPoints) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableLoyaltyPoints) 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_program.go b/model_loyalty_program.go index a6b0b789..c88297c9 100644 --- a/model_loyalty_program.go +++ b/model_loyalty_program.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // LoyaltyProgram type LoyaltyProgram struct { - // 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. + // The ID of loyalty program. Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The display title for the Loyalty Program. Title string `json:"title"` @@ -27,14 +27,16 @@ type LoyaltyProgram struct { Description string `json:"description"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications []int32 `json:"subscribedApplications"` - // 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'. + // The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. 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'. + // The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. DefaultPending string `json:"defaultPending"` // Indicates if this program supports subledgers inside the program. AllowSubledger bool `json:"allowSubledger"` // 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"` + // Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. + Sandbox bool `json:"sandbox"` // 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. @@ -200,6 +202,21 @@ func (o *LoyaltyProgram) SetUsersPerCardLimit(v int32) { o.UsersPerCardLimit = &v } +// GetSandbox returns the Sandbox field value +func (o *LoyaltyProgram) GetSandbox() bool { + if o == nil { + var ret bool + return ret + } + + return o.Sandbox +} + +// SetSandbox sets field value +func (o *LoyaltyProgram) SetSandbox(v bool) { + o.Sandbox = v +} + // GetAccountID returns the AccountID field value func (o *LoyaltyProgram) GetAccountID() int32 { if o == nil { diff --git a/model_loyalty_program_balance.go b/model_loyalty_program_balance.go index f153c262..99ba55cf 100644 --- a/model_loyalty_program_balance.go +++ b/model_loyalty_program_balance.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -20,12 +20,14 @@ type LoyaltyProgramBalance struct { CurrentBalance float32 `json:"currentBalance"` // Sum of pending points. PendingBalance float32 `json:"pendingBalance"` - // Sum of expired points. + // **DEPRECATED** Value is shown as 0. ExpiredBalance float32 `json:"expiredBalance"` - // Sum of spent points. + // **DEPRECATED** Value is shown as 0. SpentBalance float32 `json:"spentBalance"` - // Sum of currently active points, including points added and deducted in open sessions. + // Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied. TentativeCurrentBalance float32 `json:"tentativeCurrentBalance"` + // Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied. + TentativePendingBalance *float32 `json:"tentativePendingBalance,omitempty"` } // GetCurrentBalance returns the CurrentBalance field value @@ -103,6 +105,39 @@ func (o *LoyaltyProgramBalance) SetTentativeCurrentBalance(v float32) { o.TentativeCurrentBalance = v } +// GetTentativePendingBalance returns the TentativePendingBalance field value if set, zero value otherwise. +func (o *LoyaltyProgramBalance) GetTentativePendingBalance() float32 { + if o == nil || o.TentativePendingBalance == nil { + var ret float32 + return ret + } + return *o.TentativePendingBalance +} + +// GetTentativePendingBalanceOk returns a tuple with the TentativePendingBalance field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgramBalance) GetTentativePendingBalanceOk() (float32, bool) { + if o == nil || o.TentativePendingBalance == nil { + var ret float32 + return ret, false + } + return *o.TentativePendingBalance, true +} + +// HasTentativePendingBalance returns a boolean if a field has been set. +func (o *LoyaltyProgramBalance) HasTentativePendingBalance() bool { + if o != nil && o.TentativePendingBalance != nil { + return true + } + + return false +} + +// SetTentativePendingBalance gets a reference to the given float32 and assigns it to the TentativePendingBalance field. +func (o *LoyaltyProgramBalance) SetTentativePendingBalance(v float32) { + o.TentativePendingBalance = &v +} + type NullableLoyaltyProgramBalance struct { Value LoyaltyProgramBalance ExplicitNull bool diff --git a/model_loyalty_program_entity.go b/model_loyalty_program_entity.go index 899279dd..ba1bacff 100644 --- a/model_loyalty_program_entity.go +++ b/model_loyalty_program_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_program_ledgers.go b/model_loyalty_program_ledgers.go index 1ff2ea16..23e3136e 100644 --- a/model_loyalty_program_ledgers.go +++ b/model_loyalty_program_ledgers.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_program_transaction.go b/model_loyalty_program_transaction.go new file mode 100644 index 00000000..6fb1ad42 --- /dev/null +++ b/model_loyalty_program_transaction.go @@ -0,0 +1,476 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// LoyaltyProgramTransaction struct for LoyaltyProgramTransaction +type LoyaltyProgramTransaction struct { + // ID of the loyalty ledger transaction. + Id int32 `json:"id"` + // ID of the loyalty program. + ProgramId int32 `json:"programId"` + // Date and time the loyalty transaction occurred. + Created time.Time `json:"created"` + // Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. + Type string `json:"type"` + // Amount of loyalty points added or deducted in the transaction. + Amount float32 `json:"amount"` + // Name or reason for the loyalty ledger transaction. + Name string `json:"name"` + // When points become active. Possible values: - `immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time. + StartDate string `json:"startDate"` + // When points expire. Possible values: - `unlimited`: Points have no expiration date. - a timestamp value: Points expire at a given date and time. + ExpiryDate string `json:"expiryDate"` + // Customer profile integration ID used in the loyalty program. + CustomerProfileId *string `json:"customerProfileId,omitempty"` + // The alphanumeric identifier of the loyalty card. + CardIdentifier *string `json:"cardIdentifier,omitempty"` + // ID of the subledger. + SubledgerId string `json:"subledgerId"` + // ID of the customer session where the transaction occurred. + CustomerSessionId *string `json:"customerSessionId,omitempty"` + // ID of the import where the transaction occurred. + ImportId *int32 `json:"importId,omitempty"` + // ID of the user who manually added or deducted points. Applies only for manual transactions. + UserId *int32 `json:"userId,omitempty"` + // The email of the user who manually added or deducted points. Applies only for manual transactions. + UserEmail *string `json:"userEmail,omitempty"` + // ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session. + RulesetId *int32 `json:"rulesetId,omitempty"` + // Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session. + RuleName *string `json:"ruleName,omitempty"` +} + +// GetId returns the Id field value +func (o *LoyaltyProgramTransaction) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *LoyaltyProgramTransaction) SetId(v int32) { + o.Id = v +} + +// GetProgramId returns the ProgramId field value +func (o *LoyaltyProgramTransaction) GetProgramId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramId +} + +// SetProgramId sets field value +func (o *LoyaltyProgramTransaction) SetProgramId(v int32) { + o.ProgramId = v +} + +// GetCreated returns the Created field value +func (o *LoyaltyProgramTransaction) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *LoyaltyProgramTransaction) SetCreated(v time.Time) { + o.Created = v +} + +// GetType returns the Type field value +func (o *LoyaltyProgramTransaction) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *LoyaltyProgramTransaction) SetType(v string) { + o.Type = v +} + +// GetAmount returns the Amount field value +func (o *LoyaltyProgramTransaction) GetAmount() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Amount +} + +// SetAmount sets field value +func (o *LoyaltyProgramTransaction) SetAmount(v float32) { + o.Amount = v +} + +// GetName returns the Name field value +func (o *LoyaltyProgramTransaction) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *LoyaltyProgramTransaction) SetName(v string) { + o.Name = v +} + +// GetStartDate returns the StartDate field value +func (o *LoyaltyProgramTransaction) GetStartDate() string { + if o == nil { + var ret string + return ret + } + + return o.StartDate +} + +// SetStartDate sets field value +func (o *LoyaltyProgramTransaction) SetStartDate(v string) { + o.StartDate = v +} + +// GetExpiryDate returns the ExpiryDate field value +func (o *LoyaltyProgramTransaction) GetExpiryDate() string { + if o == nil { + var ret string + return ret + } + + return o.ExpiryDate +} + +// SetExpiryDate sets field value +func (o *LoyaltyProgramTransaction) SetExpiryDate(v string) { + o.ExpiryDate = v +} + +// GetCustomerProfileId returns the CustomerProfileId field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) GetCustomerProfileId() string { + 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) HasCustomerProfileId() bool { + if o != nil && o.CustomerProfileId != nil { + return true + } + + return false +} + +// SetCustomerProfileId gets a reference to the given string and assigns it to the CustomerProfileId field. +func (o *LoyaltyProgramTransaction) SetCustomerProfileId(v string) { + o.CustomerProfileId = &v +} + +// GetCardIdentifier returns the CardIdentifier field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) SetCardIdentifier(v string) { + o.CardIdentifier = &v +} + +// GetSubledgerId returns the SubledgerId field value +func (o *LoyaltyProgramTransaction) GetSubledgerId() string { + if o == nil { + var ret string + return ret + } + + return o.SubledgerId +} + +// SetSubledgerId sets field value +func (o *LoyaltyProgramTransaction) SetSubledgerId(v string) { + o.SubledgerId = v +} + +// GetCustomerSessionId returns the CustomerSessionId field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) GetCustomerSessionId() string { + if o == nil || o.CustomerSessionId == nil { + var ret string + return ret + } + return *o.CustomerSessionId +} + +// GetCustomerSessionIdOk returns a tuple with the CustomerSessionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgramTransaction) GetCustomerSessionIdOk() (string, bool) { + if o == nil || o.CustomerSessionId == nil { + var ret string + return ret, false + } + return *o.CustomerSessionId, true +} + +// HasCustomerSessionId returns a boolean if a field has been set. +func (o *LoyaltyProgramTransaction) HasCustomerSessionId() bool { + if o != nil && o.CustomerSessionId != nil { + return true + } + + return false +} + +// SetCustomerSessionId gets a reference to the given string and assigns it to the CustomerSessionId field. +func (o *LoyaltyProgramTransaction) SetCustomerSessionId(v string) { + o.CustomerSessionId = &v +} + +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) SetImportId(v int32) { + o.ImportId = &v +} + +// GetUserId returns the UserId field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) GetUserId() int32 { + if o == nil || o.UserId == nil { + var ret int32 + return ret + } + return *o.UserId +} + +// GetUserIdOk returns a tuple with the UserId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgramTransaction) GetUserIdOk() (int32, bool) { + if o == nil || o.UserId == nil { + var ret int32 + return ret, false + } + return *o.UserId, true +} + +// HasUserId returns a boolean if a field has been set. +func (o *LoyaltyProgramTransaction) HasUserId() bool { + if o != nil && o.UserId != nil { + return true + } + + return false +} + +// SetUserId gets a reference to the given int32 and assigns it to the UserId field. +func (o *LoyaltyProgramTransaction) SetUserId(v int32) { + o.UserId = &v +} + +// GetUserEmail returns the UserEmail field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) GetUserEmail() string { + if o == nil || o.UserEmail == nil { + var ret string + return ret + } + return *o.UserEmail +} + +// GetUserEmailOk returns a tuple with the UserEmail field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgramTransaction) GetUserEmailOk() (string, bool) { + if o == nil || o.UserEmail == nil { + var ret string + return ret, false + } + return *o.UserEmail, true +} + +// HasUserEmail returns a boolean if a field has been set. +func (o *LoyaltyProgramTransaction) HasUserEmail() bool { + if o != nil && o.UserEmail != nil { + return true + } + + return false +} + +// SetUserEmail gets a reference to the given string and assigns it to the UserEmail field. +func (o *LoyaltyProgramTransaction) SetUserEmail(v string) { + o.UserEmail = &v +} + +// GetRulesetId returns the RulesetId field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) SetRulesetId(v int32) { + o.RulesetId = &v +} + +// GetRuleName returns the RuleName field value if set, zero value otherwise. +func (o *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) 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 *LoyaltyProgramTransaction) SetRuleName(v string) { + o.RuleName = &v +} + +type NullableLoyaltyProgramTransaction struct { + Value LoyaltyProgramTransaction + ExplicitNull bool +} + +func (v NullableLoyaltyProgramTransaction) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyProgramTransaction) 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.go b/model_loyalty_projection.go deleted file mode 100644 index 82717c47..00000000 --- a/model_loyalty_projection.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * 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 deleted file mode 100644 index a47b3737..00000000 --- a/model_loyalty_projection_data.go +++ /dev/null @@ -1,111 +0,0 @@ -/* - * 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 f953edf7..789d1627 100644 --- a/model_loyalty_statistics.go +++ b/model_loyalty_statistics.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_sub_ledger.go b/model_loyalty_sub_ledger.go index b99bec20..24f499b5 100644 --- a/model_loyalty_sub_ledger.go +++ b/model_loyalty_sub_ledger.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_loyalty_tier.go b/model_loyalty_tier.go index 41e07f35..65029570 100644 --- a/model_loyalty_tier.go +++ b/model_loyalty_tier.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // LoyaltyTier type LoyaltyTier 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the loyalty program that owns this entity. ProgramID int32 `json:"programID"` diff --git a/model_management_key.go b/model_management_key.go index 67893b15..6800e5f8 100644 --- a/model_management_key.go +++ b/model_management_key.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,6 +23,8 @@ type ManagementKey struct { ExpiryDate time.Time `json:"expiryDate"` // The list of endpoints that can be accessed with the key Endpoints []Endpoint `json:"endpoints"` + // A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. + AllowedApplicationIds *[]int32 `json:"allowedApplicationIds,omitempty"` // ID of the management key. Id int32 `json:"id"` // ID of the user who created it. @@ -78,6 +80,39 @@ func (o *ManagementKey) SetEndpoints(v []Endpoint) { o.Endpoints = v } +// GetAllowedApplicationIds returns the AllowedApplicationIds field value if set, zero value otherwise. +func (o *ManagementKey) GetAllowedApplicationIds() []int32 { + if o == nil || o.AllowedApplicationIds == nil { + var ret []int32 + return ret + } + return *o.AllowedApplicationIds +} + +// GetAllowedApplicationIdsOk returns a tuple with the AllowedApplicationIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ManagementKey) GetAllowedApplicationIdsOk() ([]int32, bool) { + if o == nil || o.AllowedApplicationIds == nil { + var ret []int32 + return ret, false + } + return *o.AllowedApplicationIds, true +} + +// HasAllowedApplicationIds returns a boolean if a field has been set. +func (o *ManagementKey) HasAllowedApplicationIds() bool { + if o != nil && o.AllowedApplicationIds != nil { + return true + } + + return false +} + +// SetAllowedApplicationIds gets a reference to the given []int32 and assigns it to the AllowedApplicationIds field. +func (o *ManagementKey) SetAllowedApplicationIds(v []int32) { + o.AllowedApplicationIds = &v +} + // GetId returns the Id field value func (o *ManagementKey) GetId() int32 { if o == nil { diff --git a/model_manager_config.go b/model_manager_config.go index 4db2f9d6..af6ce75b 100644 --- a/model_manager_config.go +++ b/model_manager_config.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_meta.go b/model_meta.go index f5c70de2..c64fa097 100644 --- a/model_meta.go +++ b/model_meta.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_multi_application_entity.go b/model_multi_application_entity.go index 4cf791c4..4671887f 100644 --- a/model_multi_application_entity.go +++ b/model_multi_application_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ import ( // MultiApplicationEntity struct for MultiApplicationEntity type MultiApplicationEntity struct { - // 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"` } diff --git a/model_multiple_attribute.go b/model_multiple_attribute.go index 475ce9be..c515440b 100644 --- a/model_multiple_attribute.go +++ b/model_multiple_attribute.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_multiple_audiences.go b/model_multiple_audiences.go index 3a7fd2d4..de054195 100644 --- a/model_multiple_audiences.go +++ b/model_multiple_audiences.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_multiple_audiences_item.go b/model_multiple_audiences_item.go index fc762a6b..b4b2a0fe 100644 --- a/model_multiple_audiences_item.go +++ b/model_multiple_audiences_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The human-friendly display name for this audience. Name string `json:"name"` diff --git a/model_multiple_customer_profile_integration_request.go b/model_multiple_customer_profile_integration_request.go index f6a45eb3..b3c41930 100644 --- a/model_multiple_customer_profile_integration_request.go +++ b/model_multiple_customer_profile_integration_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 32c969e9..dd7d5b89 100644 --- a/model_multiple_customer_profile_integration_request_item.go +++ b/model_multiple_customer_profile_integration_request_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,7 +18,7 @@ import ( type MultipleCustomerProfileIntegrationRequestItem struct { // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` - // 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). + // 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](https://docs.talon.one/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 14d079f5..c227db85 100644 --- a/model_multiple_customer_profile_integration_response_v2.go +++ b/model_multiple_customer_profile_integration_response_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,13 +16,13 @@ import ( // MultipleCustomerProfileIntegrationResponseV2 struct for MultipleCustomerProfileIntegrationResponseV2 type MultipleCustomerProfileIntegrationResponseV2 struct { - IntegrationStates *[]IntegrationStateV2 `json:"integrationStates,omitempty"` + IntegrationStates *[]CustomerProfileUpdateV2Response `json:"integrationStates,omitempty"` } // GetIntegrationStates returns the IntegrationStates field value if set, zero value otherwise. -func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() []IntegrationStateV2 { +func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() []CustomerProfileUpdateV2Response { if o == nil || o.IntegrationStates == nil { - var ret []IntegrationStateV2 + var ret []CustomerProfileUpdateV2Response return ret } return *o.IntegrationStates @@ -30,9 +30,9 @@ func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() [] // GetIntegrationStatesOk returns a tuple with the IntegrationStates field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStatesOk() ([]IntegrationStateV2, bool) { +func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStatesOk() ([]CustomerProfileUpdateV2Response, bool) { if o == nil || o.IntegrationStates == nil { - var ret []IntegrationStateV2 + var ret []CustomerProfileUpdateV2Response return ret, false } return *o.IntegrationStates, true @@ -47,8 +47,8 @@ func (o *MultipleCustomerProfileIntegrationResponseV2) HasIntegrationStates() bo return false } -// SetIntegrationStates gets a reference to the given []IntegrationStateV2 and assigns it to the IntegrationStates field. -func (o *MultipleCustomerProfileIntegrationResponseV2) SetIntegrationStates(v []IntegrationStateV2) { +// SetIntegrationStates gets a reference to the given []CustomerProfileUpdateV2Response and assigns it to the IntegrationStates field. +func (o *MultipleCustomerProfileIntegrationResponseV2) SetIntegrationStates(v []CustomerProfileUpdateV2Response) { o.IntegrationStates = &v } diff --git a/model_multiple_new_attribute.go b/model_multiple_new_attribute.go index d166d611..3d5d6b65 100644 --- a/model_multiple_new_attribute.go +++ b/model_multiple_new_attribute.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_multiple_new_audiences.go b/model_multiple_new_audiences.go index ce076589..369971c7 100644 --- a/model_multiple_new_audiences.go +++ b/model_multiple_new_audiences.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_mutable_entity.go b/model_mutable_entity.go index 6da02666..054bff7d 100644 --- a/model_mutable_entity.go +++ b/model_mutable_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,7 +17,7 @@ import ( // MutableEntity struct for MutableEntity type MutableEntity struct { - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified time.Time `json:"modified"` } diff --git a/model_new_account.go b/model_new_account.go index d4f11b2b..e3a5ea23 100644 --- a/model_new_account.go +++ b/model_new_account.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 b388f9ce..155de05c 100644 --- a/model_new_account_sign_up.go +++ b/model_new_account_sign_up.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_additional_cost.go b/model_new_additional_cost.go index 969d8e4a..90b0e6a4 100644 --- a/model_new_additional_cost.go +++ b/model_new_additional_cost.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ import ( // NewAdditionalCost type NewAdditionalCost struct { - // 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. + // The internal name used in API requests. Name string `json:"name"` // 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. Title string `json:"title"` @@ -24,7 +24,7 @@ type NewAdditionalCost struct { Description string `json:"description"` // 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. + // The type of additional cost. Possible value: - `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"` } diff --git a/model_new_application.go b/model_new_application.go index 92262be4..02d0bcc6 100644 --- a/model_new_application.go +++ b/model_new_application.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -38,7 +38,7 @@ type NewApplication struct { DefaultDiscountScope *string `json:"defaultDiscountScope,omitempty"` // 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. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). + // 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#flattening). EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` // Indicates if this is a live or sandbox Application. diff --git a/model_new_application_api_key.go b/model_new_application_api_key.go index aa88d798..36690a38 100644 --- a/model_new_application_api_key.go +++ b/model_new_application_api_key.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_attribute.go b/model_new_attribute.go index 5e37d84f..293664f5 100644 --- a/model_new_attribute.go +++ b/model_new_attribute.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_audience.go b/model_new_audience.go index 347c387f..93e182da 100644 --- a/model_new_audience.go +++ b/model_new_audience.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,6 +12,7 @@ package talon import ( "bytes" "encoding/json" + "time" ) // NewAudience @@ -28,6 +29,8 @@ type NewAudience struct { IntegrationId *string `json:"integrationId,omitempty"` // Determines if this audience is a 3rd party audience or not. CreatedIn3rdParty *bool `json:"createdIn3rdParty,omitempty"` + // The last time that the audience memberships changed. + LastUpdate *time.Time `json:"lastUpdate,omitempty"` } // GetName returns the Name field value @@ -210,6 +213,39 @@ func (o *NewAudience) SetCreatedIn3rdParty(v bool) { o.CreatedIn3rdParty = &v } +// GetLastUpdate returns the LastUpdate field value if set, zero value otherwise. +func (o *NewAudience) GetLastUpdate() time.Time { + if o == nil || o.LastUpdate == nil { + var ret time.Time + return ret + } + return *o.LastUpdate +} + +// GetLastUpdateOk returns a tuple with the LastUpdate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewAudience) GetLastUpdateOk() (time.Time, bool) { + if o == nil || o.LastUpdate == nil { + var ret time.Time + return ret, false + } + return *o.LastUpdate, true +} + +// HasLastUpdate returns a boolean if a field has been set. +func (o *NewAudience) HasLastUpdate() bool { + if o != nil && o.LastUpdate != nil { + return true + } + + return false +} + +// SetLastUpdate gets a reference to the given time.Time and assigns it to the LastUpdate field. +func (o *NewAudience) SetLastUpdate(v time.Time) { + o.LastUpdate = &v +} + type NullableNewAudience struct { Value NewAudience ExplicitNull bool diff --git a/model_new_base_notification.go b/model_new_base_notification.go new file mode 100644 index 00000000..4f3ef5cd --- /dev/null +++ b/model_new_base_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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewBaseNotification +type NewBaseNotification struct { + Policy map[string]interface{} `json:"policy"` + Webhook NewNotificationWebhook `json:"webhook"` +} + +// GetPolicy returns the Policy field value +func (o *NewBaseNotification) GetPolicy() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Policy +} + +// SetPolicy sets field value +func (o *NewBaseNotification) SetPolicy(v map[string]interface{}) { + o.Policy = v +} + +// GetWebhook returns the Webhook field value +func (o *NewBaseNotification) GetWebhook() NewNotificationWebhook { + if o == nil { + var ret NewNotificationWebhook + return ret + } + + return o.Webhook +} + +// SetWebhook sets field value +func (o *NewBaseNotification) SetWebhook(v NewNotificationWebhook) { + o.Webhook = v +} + +type NullableNewBaseNotification struct { + Value NewBaseNotification + ExplicitNull bool +} + +func (v NullableNewBaseNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewBaseNotification) 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.go b/model_new_campaign.go index 9c4ad0f7..d80e520e 100644 --- a/model_new_campaign.go +++ b/model_new_campaign.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -29,7 +29,7 @@ type NewCampaign struct { 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](https://docs.talon.one/management-api/#operation/getRulesets) 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"` @@ -37,9 +37,9 @@ type NewCampaign struct { Features []string `json:"features"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) 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](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. + // 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 index 5a9e0ea8..2ec29676 100644 --- a/model_new_campaign_collection.go +++ b/model_new_campaign_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_campaign_group.go b/model_new_campaign_group.go index faae127e..0ae97b7e 100644 --- a/model_new_campaign_group.go +++ b/model_new_campaign_group.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_campaign_set.go b/model_new_campaign_set.go index 66995bec..d21bc6c1 100644 --- a/model_new_campaign_set.go +++ b/model_new_campaign_set.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_campaign_set_v2.go b/model_new_campaign_set_v2.go index 8c8d7f80..ec86956e 100644 --- a/model_new_campaign_set_v2.go +++ b/model_new_campaign_set_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_campaign_template.go b/model_new_campaign_template.go index 2f271eb8..6683fc72 100644 --- a/model_new_campaign_template.go +++ b/model_new_campaign_template.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,9 +22,9 @@ type NewCampaignTemplate struct { Description string `json:"description"` // Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. Instructions string `json:"instructions"` - // The Campaign Attributes that Campaigns created from this template will have by default. + // The campaign attributes that campaigns created from this template will have by default. CampaignAttributes *map[string]interface{} `json:"campaignAttributes,omitempty"` - // The Campaign Attributes that Coupons created from this template will have by default. + // The campaign attributes that coupons created from this template will have by default. CouponAttributes *map[string]interface{} `json:"couponAttributes,omitempty"` // Only Campaign Templates in 'available' state may be used to create Campaigns. State string `json:"state"` @@ -36,11 +36,11 @@ type NewCampaignTemplate struct { ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` // 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. + // 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. + // The default campaign group ID. DefaultCampaignGroupId *int32 `json:"defaultCampaignGroupId,omitempty"` } diff --git a/model_new_catalog.go b/model_new_catalog.go index 8abc57ea..751ce584 100644 --- a/model_new_catalog.go +++ b/model_new_catalog.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_collection.go b/model_new_collection.go index 65be4cf0..a900ee01 100644 --- a/model_new_collection.go +++ b/model_new_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_coupon_creation_job.go b/model_new_coupon_creation_job.go index dfc24ffb..886e8526 100644 --- a/model_new_coupon_creation_job.go +++ b/model_new_coupon_creation_job.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,13 +19,15 @@ import ( type NewCouponCreationJob struct { // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. + // The number of new coupon codes to generate for the campaign. NumberOfCoupons int32 `json:"numberOfCoupons"` CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` // Arbitrary properties associated with coupons. @@ -80,6 +82,39 @@ func (o *NewCouponCreationJob) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *NewCouponCreationJob) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCouponCreationJob) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *NewCouponCreationJob) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *NewCouponCreationJob) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *NewCouponCreationJob) GetStartDate() time.Time { if o == nil || o.StartDate == nil { diff --git a/model_new_coupons.go b/model_new_coupons.go index b603fcd0..20d48a7a 100644 --- a/model_new_coupons.go +++ b/model_new_coupons.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,17 +19,19 @@ import ( type NewCoupons struct { // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration 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"` - // **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously endpoint](https://docs.talon.one/management-api/#operation/createCouponsAsync). + // **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint. UniquePrefix *string `json:"uniquePrefix,omitempty"` // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` @@ -39,6 +41,8 @@ type NewCoupons struct { ValidCharacters *[]string `json:"validCharacters,omitempty"` // 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"` + // Whether the reservation effect actually created a new reservation. + IsReservationMandatory *bool `json:"isReservationMandatory,omitempty"` } // GetUsageLimit returns the UsageLimit field value @@ -89,6 +93,39 @@ func (o *NewCoupons) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *NewCoupons) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCoupons) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *NewCoupons) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *NewCoupons) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *NewCoupons) GetStartDate() time.Time { if o == nil || o.StartDate == nil { @@ -368,6 +405,39 @@ func (o *NewCoupons) SetCouponPattern(v string) { o.CouponPattern = &v } +// GetIsReservationMandatory returns the IsReservationMandatory field value if set, zero value otherwise. +func (o *NewCoupons) GetIsReservationMandatory() bool { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret + } + return *o.IsReservationMandatory +} + +// GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCoupons) GetIsReservationMandatoryOk() (bool, bool) { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret, false + } + return *o.IsReservationMandatory, true +} + +// HasIsReservationMandatory returns a boolean if a field has been set. +func (o *NewCoupons) HasIsReservationMandatory() bool { + if o != nil && o.IsReservationMandatory != nil { + return true + } + + return false +} + +// SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. +func (o *NewCoupons) SetIsReservationMandatory(v bool) { + o.IsReservationMandatory = &v +} + type NullableNewCoupons struct { Value NewCoupons ExplicitNull bool diff --git a/model_new_coupons_for_multiple_recipients.go b/model_new_coupons_for_multiple_recipients.go index 64c3aa4a..a5227e12 100644 --- a/model_new_coupons_for_multiple_recipients.go +++ b/model_new_coupons_for_multiple_recipients.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,11 +19,13 @@ import ( type NewCouponsForMultipleRecipients struct { // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration 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. Attributes *map[string]interface{} `json:"attributes,omitempty"` @@ -83,6 +85,39 @@ func (o *NewCouponsForMultipleRecipients) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *NewCouponsForMultipleRecipients) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCouponsForMultipleRecipients) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *NewCouponsForMultipleRecipients) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *NewCouponsForMultipleRecipients) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *NewCouponsForMultipleRecipients) GetStartDate() time.Time { if o == nil || o.StartDate == nil { diff --git a/model_new_custom_effect.go b/model_new_custom_effect.go index 71a07562..f07b7109 100644 --- a/model_new_custom_effect.go +++ b/model_new_custom_effect.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,10 @@ import ( // NewCustomEffect type NewCustomEffect struct { - // 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"` + // Indicates if this effect is per item or not. + IsPerItem *bool `json:"isPerItem,omitempty"` // The name of this effect. Name string `json:"name"` // The title of this effect. @@ -47,6 +49,39 @@ func (o *NewCustomEffect) SetApplicationIds(v []int32) { o.ApplicationIds = v } +// GetIsPerItem returns the IsPerItem field value if set, zero value otherwise. +func (o *NewCustomEffect) GetIsPerItem() bool { + if o == nil || o.IsPerItem == nil { + var ret bool + return ret + } + return *o.IsPerItem +} + +// GetIsPerItemOk returns a tuple with the IsPerItem field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCustomEffect) GetIsPerItemOk() (bool, bool) { + if o == nil || o.IsPerItem == nil { + var ret bool + return ret, false + } + return *o.IsPerItem, true +} + +// HasIsPerItem returns a boolean if a field has been set. +func (o *NewCustomEffect) HasIsPerItem() bool { + if o != nil && o.IsPerItem != nil { + return true + } + + return false +} + +// SetIsPerItem gets a reference to the given bool and assigns it to the IsPerItem field. +func (o *NewCustomEffect) SetIsPerItem(v bool) { + o.IsPerItem = &v +} + // GetName returns the Name field value func (o *NewCustomEffect) GetName() string { if o == nil { diff --git a/model_new_customer_profile.go b/model_new_customer_profile.go index c2557f56..2401a4e6 100644 --- a/model_new_customer_profile.go +++ b/model_new_customer_profile.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_customer_session.go b/model_new_customer_session.go index 704cb68e..488930e2 100644 --- a/model_new_customer_session.go +++ b/model_new_customer_session.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,11 +22,11 @@ type NewCustomerSession struct { 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`. 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). + // 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](https://docs.talon.one/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. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). + // 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 96eb99ba..a06dc243 100644 --- a/model_new_customer_session_v2.go +++ b/model_new_customer_session_v2.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,23 +14,25 @@ import ( "encoding/json" ) -// NewCustomerSessionV2 +// NewCustomerSessionV2 The representation of the customer session. type NewCustomerSessionV2 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"` + // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. + EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` // 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. **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"` // 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). + // 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)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). State *string `json:"state,omitempty"` // 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"` - // 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/). + // 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. 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. + // 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**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). Identifiers *[]string `json:"identifiers,omitempty"` // 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"` @@ -69,6 +71,39 @@ func (o *NewCustomerSessionV2) SetProfileId(v string) { o.ProfileId = &v } +// GetEvaluableCampaignIds returns the EvaluableCampaignIds field value if set, zero value otherwise. +func (o *NewCustomerSessionV2) GetEvaluableCampaignIds() []int32 { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret + } + return *o.EvaluableCampaignIds +} + +// GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCustomerSessionV2) GetEvaluableCampaignIdsOk() ([]int32, bool) { + if o == nil || o.EvaluableCampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.EvaluableCampaignIds, true +} + +// HasEvaluableCampaignIds returns a boolean if a field has been set. +func (o *NewCustomerSessionV2) HasEvaluableCampaignIds() bool { + if o != nil && o.EvaluableCampaignIds != nil { + return true + } + + return false +} + +// SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field. +func (o *NewCustomerSessionV2) SetEvaluableCampaignIds(v []int32) { + o.EvaluableCampaignIds = &v +} + // GetCouponCodes returns the CouponCodes field value if set, zero value otherwise. func (o *NewCustomerSessionV2) GetCouponCodes() []string { if o == nil || o.CouponCodes == nil { diff --git a/model_new_event.go b/model_new_event.go index a282200e..b58fa6e2 100644 --- a/model_new_event.go +++ b/model_new_event.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_event_type.go b/model_new_event_type.go index ba2853c5..b402b5ee 100644 --- a/model_new_event_type.go +++ b/model_new_event_type.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,11 +16,11 @@ import ( // NewEventType type NewEventType struct { - // The human-friendly display name for this event type. Use a short, past-tense, description of the event. + // The human-friendly name for this event type. 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. + // The integration 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. + // A description of what the event represents. Description *string `json:"description,omitempty"` } diff --git a/model_new_giveaways_pool.go b/model_new_giveaways_pool.go index 4887ac96..1805087b 100644 --- a/model_new_giveaways_pool.go +++ b/model_new_giveaways_pool.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,6 +22,8 @@ type NewGiveawaysPool struct { Description *string `json:"description,omitempty"` // A list of the IDs of the applications that this giveaways pool is enabled for. SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. + Sandbox bool `json:"sandbox"` } // GetName returns the Name field value @@ -105,6 +107,21 @@ func (o *NewGiveawaysPool) SetSubscribedApplicationsIds(v []int32) { o.SubscribedApplicationsIds = &v } +// GetSandbox returns the Sandbox field value +func (o *NewGiveawaysPool) GetSandbox() bool { + if o == nil { + var ret bool + return ret + } + + return o.Sandbox +} + +// SetSandbox sets field value +func (o *NewGiveawaysPool) SetSandbox(v bool) { + o.Sandbox = v +} + type NullableNewGiveawaysPool struct { Value NewGiveawaysPool ExplicitNull bool diff --git a/model_new_internal_audience.go b/model_new_internal_audience.go index 4743f86a..37bf01f6 100644 --- a/model_new_internal_audience.go +++ b/model_new_internal_audience.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_invitation.go b/model_new_invitation.go index c3e5a7da..725e1170 100644 --- a/model_new_invitation.go +++ b/model_new_invitation.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ type NewInvitation struct { // Name of the user being invited. Name *string `json:"name,omitempty"` Email string `json:"email"` - // 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}` + // The `Access Control List` json defining the role of the user. This represents the 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. Roles *[]int32 `json:"roles,omitempty"` diff --git a/model_new_invite_email.go b/model_new_invite_email.go index 96e63964..6c9142dc 100644 --- a/model_new_invite_email.go +++ b/model_new_invite_email.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_loyalty_program.go b/model_new_loyalty_program.go index a85f44b9..e5839410 100644 --- a/model_new_loyalty_program.go +++ b/model_new_loyalty_program.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,14 +22,16 @@ type NewLoyaltyProgram struct { Description *string `json:"description,omitempty"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications *[]int32 `json:"subscribedApplications,omitempty"` - // 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'. + // The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. 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'. + // The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. DefaultPending string `json:"defaultPending"` // Indicates if this program supports subledgers inside the program. AllowSubledger bool `json:"allowSubledger"` // 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"` + // Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. + Sandbox bool `json:"sandbox"` // The internal name for the Loyalty Program. This is an immutable value. Name string `json:"name"` // The tiers in this loyalty program. @@ -199,6 +201,21 @@ func (o *NewLoyaltyProgram) SetUsersPerCardLimit(v int32) { o.UsersPerCardLimit = &v } +// GetSandbox returns the Sandbox field value +func (o *NewLoyaltyProgram) GetSandbox() bool { + if o == nil { + var ret bool + return ret + } + + return o.Sandbox +} + +// SetSandbox sets field value +func (o *NewLoyaltyProgram) SetSandbox(v bool) { + o.Sandbox = v +} + // GetName returns the Name field value func (o *NewLoyaltyProgram) GetName() string { if o == nil { diff --git a/model_new_loyalty_tier.go b/model_new_loyalty_tier.go index 837c9a30..71237106 100644 --- a/model_new_loyalty_tier.go +++ b/model_new_loyalty_tier.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_management_key.go b/model_new_management_key.go index 93a951d7..eff5769b 100644 --- a/model_new_management_key.go +++ b/model_new_management_key.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,6 +23,8 @@ type NewManagementKey struct { ExpiryDate time.Time `json:"expiryDate"` // The list of endpoints that can be accessed with the key Endpoints []Endpoint `json:"endpoints"` + // A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. + AllowedApplicationIds *[]int32 `json:"allowedApplicationIds,omitempty"` // ID of the management key. Id int32 `json:"id"` // ID of the user who created it. @@ -80,6 +82,39 @@ func (o *NewManagementKey) SetEndpoints(v []Endpoint) { o.Endpoints = v } +// GetAllowedApplicationIds returns the AllowedApplicationIds field value if set, zero value otherwise. +func (o *NewManagementKey) GetAllowedApplicationIds() []int32 { + if o == nil || o.AllowedApplicationIds == nil { + var ret []int32 + return ret + } + return *o.AllowedApplicationIds +} + +// GetAllowedApplicationIdsOk returns a tuple with the AllowedApplicationIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewManagementKey) GetAllowedApplicationIdsOk() ([]int32, bool) { + if o == nil || o.AllowedApplicationIds == nil { + var ret []int32 + return ret, false + } + return *o.AllowedApplicationIds, true +} + +// HasAllowedApplicationIds returns a boolean if a field has been set. +func (o *NewManagementKey) HasAllowedApplicationIds() bool { + if o != nil && o.AllowedApplicationIds != nil { + return true + } + + return false +} + +// SetAllowedApplicationIds gets a reference to the given []int32 and assigns it to the AllowedApplicationIds field. +func (o *NewManagementKey) SetAllowedApplicationIds(v []int32) { + o.AllowedApplicationIds = &v +} + // GetId returns the Id field value func (o *NewManagementKey) GetId() int32 { if o == nil { diff --git a/model_new_multiple_audiences_item.go b/model_new_multiple_audiences_item.go index 3c14f740..56138629 100644 --- a/model_new_multiple_audiences_item.go +++ b/model_new_multiple_audiences_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_notification_webhook.go b/model_new_notification_webhook.go index cdfcab8e..ef2ee1c1 100644 --- a/model_new_notification_webhook.go +++ b/model_new_notification_webhook.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,9 +16,9 @@ import ( // NewNotificationWebhook struct for NewNotificationWebhook type NewNotificationWebhook struct { - // API url for this notification webhook. + // API URL for the given webhook-based notification. Url string `json:"url"` - // List of API HTTP headers for this notification webhook. + // List of API HTTP headers for the given webhook-based notification. Headers []string `json:"headers"` } diff --git a/model_new_outgoing_integration_webhook.go b/model_new_outgoing_integration_webhook.go new file mode 100644 index 00000000..d9bb41b0 --- /dev/null +++ b/model_new_outgoing_integration_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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewOutgoingIntegrationWebhook struct for NewOutgoingIntegrationWebhook +type NewOutgoingIntegrationWebhook struct { + // Webhook title. + Title string `json:"title"` + // IDs of the Applications to which a webhook must be linked. + ApplicationIds []int32 `json:"applicationIds"` +} + +// GetTitle returns the Title field value +func (o *NewOutgoingIntegrationWebhook) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *NewOutgoingIntegrationWebhook) SetTitle(v string) { + o.Title = v +} + +// GetApplicationIds returns the ApplicationIds field value +func (o *NewOutgoingIntegrationWebhook) GetApplicationIds() []int32 { + if o == nil { + var ret []int32 + return ret + } + + return o.ApplicationIds +} + +// SetApplicationIds sets field value +func (o *NewOutgoingIntegrationWebhook) SetApplicationIds(v []int32) { + o.ApplicationIds = v +} + +type NullableNewOutgoingIntegrationWebhook struct { + Value NewOutgoingIntegrationWebhook + ExplicitNull bool +} + +func (v NullableNewOutgoingIntegrationWebhook) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewOutgoingIntegrationWebhook) 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 5e0d9ee2..60e316d8 100644 --- a/model_new_password.go +++ b/model_new_password.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_password_email.go b/model_new_password_email.go index 16f119cb..6c48062b 100644 --- a/model_new_password_email.go +++ b/model_new_password_email.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_picklist.go b/model_new_picklist.go new file mode 100644 index 00000000..35ab059c --- /dev/null +++ b/model_new_picklist.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewPicklist struct for NewPicklist +type NewPicklist struct { + // The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. + Type string `json:"type"` + // The list of allowed values provided by this picklist. + Values []string `json:"values"` +} + +// GetType returns the Type field value +func (o *NewPicklist) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *NewPicklist) SetType(v string) { + o.Type = v +} + +// GetValues returns the Values field value +func (o *NewPicklist) GetValues() []string { + if o == nil { + var ret []string + return ret + } + + return o.Values +} + +// SetValues sets field value +func (o *NewPicklist) SetValues(v []string) { + o.Values = v +} + +type NullableNewPicklist struct { + Value NewPicklist + ExplicitNull bool +} + +func (v NullableNewPicklist) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewPicklist) 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_referral.go b/model_new_referral.go index b9e37949..0e5dba7d 100644 --- a/model_new_referral.go +++ b/model_new_referral.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ import ( type NewReferral struct { // 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. + // Expiration 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,omitempty"` diff --git a/model_new_referrals_for_multiple_advocates.go b/model_new_referrals_for_multiple_advocates.go index 357c9cb4..714b2ac3 100644 --- a/model_new_referrals_for_multiple_advocates.go +++ b/model_new_referrals_for_multiple_advocates.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ import ( type NewReferralsForMultipleAdvocates struct { // 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. + // Expiration 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"` @@ -27,7 +27,7 @@ type NewReferralsForMultipleAdvocates struct { CampaignId int32 `json:"campaignId"` // An array containing all the respective advocate profiles. AdvocateProfileIntegrationIds []string `json:"advocateProfileIntegrationIds"` - // Arbitrary properties associated with this item. + // Arbitrary properties associated with this referral code. Attributes *map[string]interface{} `json:"attributes,omitempty"` // 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"` diff --git a/model_new_return.go b/model_new_return.go index ed6608a9..7d88d845 100644 --- a/model_new_return.go +++ b/model_new_return.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_role.go b/model_new_role.go index 90a07e11..65b0b5ad 100644 --- a/model_new_role.go +++ b/model_new_role.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -20,7 +20,7 @@ type NewRole struct { Name string `json:"name"` // Description of the role. Description *string `json:"description,omitempty"` - // Role Policy this should be a stringified blob of json. + // The `Access Control List` json defining the role of the user. This represents the access control on the user level. Acl string `json:"acl"` // An array of user identifiers. Members []int32 `json:"members"` diff --git a/model_new_ruleset.go b/model_new_ruleset.go index 395f1b2d..7c363b91 100644 --- a/model_new_ruleset.go +++ b/model_new_ruleset.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,6 +18,8 @@ import ( type NewRuleset struct { // Set of rules to apply. Rules []Rule `json:"rules"` + // Set of rules to apply for strikethrough. + StrikethroughRules *[]Rule `json:"strikethroughRules,omitempty"` // 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"` // The version of the rulebuilder used to create this ruleset. @@ -41,6 +43,39 @@ func (o *NewRuleset) SetRules(v []Rule) { o.Rules = v } +// GetStrikethroughRules returns the StrikethroughRules field value if set, zero value otherwise. +func (o *NewRuleset) GetStrikethroughRules() []Rule { + if o == nil || o.StrikethroughRules == nil { + var ret []Rule + return ret + } + return *o.StrikethroughRules +} + +// GetStrikethroughRulesOk returns a tuple with the StrikethroughRules field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRuleset) GetStrikethroughRulesOk() ([]Rule, bool) { + if o == nil || o.StrikethroughRules == nil { + var ret []Rule + return ret, false + } + return *o.StrikethroughRules, true +} + +// HasStrikethroughRules returns a boolean if a field has been set. +func (o *NewRuleset) HasStrikethroughRules() bool { + if o != nil && o.StrikethroughRules != nil { + return true + } + + return false +} + +// SetStrikethroughRules gets a reference to the given []Rule and assigns it to the StrikethroughRules field. +func (o *NewRuleset) SetStrikethroughRules(v []Rule) { + o.StrikethroughRules = &v +} + // GetBindings returns the Bindings field value func (o *NewRuleset) GetBindings() []Binding { if o == nil { diff --git a/model_new_saml_connection.go b/model_new_saml_connection.go index 7c076a47..f79dff5a 100644 --- a/model_new_saml_connection.go +++ b/model_new_saml_connection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_template_def.go b/model_new_template_def.go index 9faaf0c5..bd92bbf0 100644 --- a/model_new_template_def.go +++ b/model_new_template_def.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -25,7 +25,7 @@ type NewTemplateDef struct { // Used for grouping templates in the rule editor sidebar. Category string `json:"category"` // A Talang expression that contains variable bindings referring to args. - Expr []map[string]interface{} `json:"expr"` + Expr []interface{} `json:"expr"` // An array of argument definitions. Args []TemplateArgDef `json:"args"` // A flag to control exposure in Rule Builder. @@ -129,9 +129,9 @@ func (o *NewTemplateDef) SetCategory(v string) { } // GetExpr returns the Expr field value -func (o *NewTemplateDef) GetExpr() []map[string]interface{} { +func (o *NewTemplateDef) GetExpr() []interface{} { if o == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } @@ -139,7 +139,7 @@ func (o *NewTemplateDef) GetExpr() []map[string]interface{} { } // SetExpr sets field value -func (o *NewTemplateDef) SetExpr(v []map[string]interface{}) { +func (o *NewTemplateDef) SetExpr(v []interface{}) { o.Expr = v } diff --git a/model_new_user.go b/model_new_user.go index 4a9f8792..0832cebc 100644 --- a/model_new_user.go +++ b/model_new_user.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_new_webhook.go b/model_new_webhook.go index c791a538..caea4be3 100644 --- a/model_new_webhook.go +++ b/model_new_webhook.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,13 +16,13 @@ import ( // NewWebhook type NewWebhook struct { - // 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. + // Name or title for this webhook. Title string `json:"title"` // 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. Headers []string `json:"headers"` @@ -30,7 +30,7 @@ type NewWebhook struct { Payload *string `json:"payload,omitempty"` // 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 the Rule Builder. Enabled bool `json:"enabled"` } diff --git a/model_notification.go b/model_notification.go index 517475db..6c795a7b 100644 --- a/model_notification.go +++ b/model_notification.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_notification_webhook.go b/model_notification_webhook.go index 1af0de9a..fbfcd110 100644 --- a/model_notification_webhook.go +++ b/model_notification_webhook.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,17 +17,17 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time 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. + // API URL for the given webhook-based notification. Url string `json:"url"` - // List of API HTTP headers for this notification webhook. + // List of API HTTP headers for the given webhook-based notification. Headers []string `json:"headers"` } diff --git a/model_outgoing_integration_braze_policy.go b/model_outgoing_integration_braze_policy.go new file mode 100644 index 00000000..3961f324 --- /dev/null +++ b/model_outgoing_integration_braze_policy.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OutgoingIntegrationBrazePolicy struct for OutgoingIntegrationBrazePolicy +type OutgoingIntegrationBrazePolicy struct { + // The base URL of your Braze deployment. + BaseUrl string `json:"baseUrl"` + // The API key of your Braze deployment. + ApiKey string `json:"apiKey"` +} + +// GetBaseUrl returns the BaseUrl field value +func (o *OutgoingIntegrationBrazePolicy) GetBaseUrl() string { + if o == nil { + var ret string + return ret + } + + return o.BaseUrl +} + +// SetBaseUrl sets field value +func (o *OutgoingIntegrationBrazePolicy) SetBaseUrl(v string) { + o.BaseUrl = v +} + +// GetApiKey returns the ApiKey field value +func (o *OutgoingIntegrationBrazePolicy) GetApiKey() string { + if o == nil { + var ret string + return ret + } + + return o.ApiKey +} + +// SetApiKey sets field value +func (o *OutgoingIntegrationBrazePolicy) SetApiKey(v string) { + o.ApiKey = v +} + +type NullableOutgoingIntegrationBrazePolicy struct { + Value OutgoingIntegrationBrazePolicy + ExplicitNull bool +} + +func (v NullableOutgoingIntegrationBrazePolicy) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOutgoingIntegrationBrazePolicy) 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_outgoing_integration_configuration.go b/model_outgoing_integration_configuration.go new file mode 100644 index 00000000..f0afca26 --- /dev/null +++ b/model_outgoing_integration_configuration.go @@ -0,0 +1,109 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OutgoingIntegrationConfiguration struct for OutgoingIntegrationConfiguration +type OutgoingIntegrationConfiguration struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The ID of the account to which this configuration belongs. + AccountId int32 `json:"accountId"` + // The outgoing integration type ID. + TypeId int32 `json:"typeId"` + Policy map[string]interface{} `json:"policy"` +} + +// GetId returns the Id field value +func (o *OutgoingIntegrationConfiguration) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *OutgoingIntegrationConfiguration) SetId(v int32) { + o.Id = v +} + +// GetAccountId returns the AccountId field value +func (o *OutgoingIntegrationConfiguration) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *OutgoingIntegrationConfiguration) SetAccountId(v int32) { + o.AccountId = v +} + +// GetTypeId returns the TypeId field value +func (o *OutgoingIntegrationConfiguration) GetTypeId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TypeId +} + +// SetTypeId sets field value +func (o *OutgoingIntegrationConfiguration) SetTypeId(v int32) { + o.TypeId = v +} + +// GetPolicy returns the Policy field value +func (o *OutgoingIntegrationConfiguration) GetPolicy() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Policy +} + +// SetPolicy sets field value +func (o *OutgoingIntegrationConfiguration) SetPolicy(v map[string]interface{}) { + o.Policy = v +} + +type NullableOutgoingIntegrationConfiguration struct { + Value OutgoingIntegrationConfiguration + ExplicitNull bool +} + +func (v NullableOutgoingIntegrationConfiguration) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOutgoingIntegrationConfiguration) 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_outgoing_integration_type.go b/model_outgoing_integration_type.go new file mode 100644 index 00000000..e89a2c67 --- /dev/null +++ b/model_outgoing_integration_type.go @@ -0,0 +1,181 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OutgoingIntegrationType struct for OutgoingIntegrationType +type OutgoingIntegrationType struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // Name of the outgoing integration. + Name string `json:"name"` + // Description of the outgoing integration. + Description *string `json:"description,omitempty"` + // Category of the outgoing integration. + Category *string `json:"category,omitempty"` + // Http link to the outgoing integration's documentation. + DocumentationLink *string `json:"documentationLink,omitempty"` +} + +// GetId returns the Id field value +func (o *OutgoingIntegrationType) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *OutgoingIntegrationType) SetId(v int32) { + o.Id = v +} + +// GetName returns the Name field value +func (o *OutgoingIntegrationType) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *OutgoingIntegrationType) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *OutgoingIntegrationType) 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 *OutgoingIntegrationType) 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 *OutgoingIntegrationType) 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 *OutgoingIntegrationType) SetDescription(v string) { + o.Description = &v +} + +// GetCategory returns the Category field value if set, zero value otherwise. +func (o *OutgoingIntegrationType) GetCategory() string { + if o == nil || o.Category == nil { + var ret string + return ret + } + return *o.Category +} + +// GetCategoryOk returns a tuple with the Category field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *OutgoingIntegrationType) GetCategoryOk() (string, bool) { + if o == nil || o.Category == nil { + var ret string + return ret, false + } + return *o.Category, true +} + +// HasCategory returns a boolean if a field has been set. +func (o *OutgoingIntegrationType) HasCategory() bool { + if o != nil && o.Category != nil { + return true + } + + return false +} + +// SetCategory gets a reference to the given string and assigns it to the Category field. +func (o *OutgoingIntegrationType) SetCategory(v string) { + o.Category = &v +} + +// GetDocumentationLink returns the DocumentationLink field value if set, zero value otherwise. +func (o *OutgoingIntegrationType) GetDocumentationLink() string { + if o == nil || o.DocumentationLink == nil { + var ret string + return ret + } + return *o.DocumentationLink +} + +// GetDocumentationLinkOk returns a tuple with the DocumentationLink field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *OutgoingIntegrationType) GetDocumentationLinkOk() (string, bool) { + if o == nil || o.DocumentationLink == nil { + var ret string + return ret, false + } + return *o.DocumentationLink, true +} + +// HasDocumentationLink returns a boolean if a field has been set. +func (o *OutgoingIntegrationType) HasDocumentationLink() bool { + if o != nil && o.DocumentationLink != nil { + return true + } + + return false +} + +// SetDocumentationLink gets a reference to the given string and assigns it to the DocumentationLink field. +func (o *OutgoingIntegrationType) SetDocumentationLink(v string) { + o.DocumentationLink = &v +} + +type NullableOutgoingIntegrationType struct { + Value OutgoingIntegrationType + ExplicitNull bool +} + +func (v NullableOutgoingIntegrationType) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOutgoingIntegrationType) 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_outgoing_integration_types.go b/model_outgoing_integration_types.go new file mode 100644 index 00000000..49b2d249 --- /dev/null +++ b/model_outgoing_integration_types.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OutgoingIntegrationTypes struct for OutgoingIntegrationTypes +type OutgoingIntegrationTypes struct { + // List of outgoing integrations. + Data *[]OutgoingIntegrationType `json:"data,omitempty"` +} + +// GetData returns the Data field value if set, zero value otherwise. +func (o *OutgoingIntegrationTypes) GetData() []OutgoingIntegrationType { + if o == nil || o.Data == nil { + var ret []OutgoingIntegrationType + 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 *OutgoingIntegrationTypes) GetDataOk() ([]OutgoingIntegrationType, bool) { + if o == nil || o.Data == nil { + var ret []OutgoingIntegrationType + return ret, false + } + return *o.Data, true +} + +// HasData returns a boolean if a field has been set. +func (o *OutgoingIntegrationTypes) HasData() bool { + if o != nil && o.Data != nil { + return true + } + + return false +} + +// SetData gets a reference to the given []OutgoingIntegrationType and assigns it to the Data field. +func (o *OutgoingIntegrationTypes) SetData(v []OutgoingIntegrationType) { + o.Data = &v +} + +type NullableOutgoingIntegrationTypes struct { + Value OutgoingIntegrationTypes + ExplicitNull bool +} + +func (v NullableOutgoingIntegrationTypes) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOutgoingIntegrationTypes) 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_outgoing_integration_webhook_template.go b/model_outgoing_integration_webhook_template.go new file mode 100644 index 00000000..81be4ed0 --- /dev/null +++ b/model_outgoing_integration_webhook_template.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OutgoingIntegrationWebhookTemplate struct for OutgoingIntegrationWebhookTemplate +type OutgoingIntegrationWebhookTemplate struct { + // Unique Id for this entity. + Id int32 `json:"id"` + // Unique Id of outgoing integration type. + IntegrationType int32 `json:"integrationType"` + // Title of the webhook template. + Title string `json:"title"` + // General description for the specific outgoing integration webhook template. + Description string `json:"description"` + // API payload (supports templating using parameters) for this webhook template. + Payload string `json:"payload"` + // API method for this webhook. + Method string `json:"method"` +} + +// GetId returns the Id field value +func (o *OutgoingIntegrationWebhookTemplate) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *OutgoingIntegrationWebhookTemplate) SetId(v int32) { + o.Id = v +} + +// GetIntegrationType returns the IntegrationType field value +func (o *OutgoingIntegrationWebhookTemplate) GetIntegrationType() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.IntegrationType +} + +// SetIntegrationType sets field value +func (o *OutgoingIntegrationWebhookTemplate) SetIntegrationType(v int32) { + o.IntegrationType = v +} + +// GetTitle returns the Title field value +func (o *OutgoingIntegrationWebhookTemplate) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *OutgoingIntegrationWebhookTemplate) SetTitle(v string) { + o.Title = v +} + +// GetDescription returns the Description field value +func (o *OutgoingIntegrationWebhookTemplate) GetDescription() string { + if o == nil { + var ret string + return ret + } + + return o.Description +} + +// SetDescription sets field value +func (o *OutgoingIntegrationWebhookTemplate) SetDescription(v string) { + o.Description = v +} + +// GetPayload returns the Payload field value +func (o *OutgoingIntegrationWebhookTemplate) GetPayload() string { + if o == nil { + var ret string + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *OutgoingIntegrationWebhookTemplate) SetPayload(v string) { + o.Payload = v +} + +// GetMethod returns the Method field value +func (o *OutgoingIntegrationWebhookTemplate) GetMethod() string { + if o == nil { + var ret string + return ret + } + + return o.Method +} + +// SetMethod sets field value +func (o *OutgoingIntegrationWebhookTemplate) SetMethod(v string) { + o.Method = v +} + +type NullableOutgoingIntegrationWebhookTemplate struct { + Value OutgoingIntegrationWebhookTemplate + ExplicitNull bool +} + +func (v NullableOutgoingIntegrationWebhookTemplate) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOutgoingIntegrationWebhookTemplate) 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_outgoing_integration_webhook_templates.go b/model_outgoing_integration_webhook_templates.go new file mode 100644 index 00000000..0564740f --- /dev/null +++ b/model_outgoing_integration_webhook_templates.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OutgoingIntegrationWebhookTemplates struct for OutgoingIntegrationWebhookTemplates +type OutgoingIntegrationWebhookTemplates struct { + // The list of webhook templates for a given outgoing integration type. + Data *[]OutgoingIntegrationWebhookTemplate `json:"data,omitempty"` +} + +// GetData returns the Data field value if set, zero value otherwise. +func (o *OutgoingIntegrationWebhookTemplates) GetData() []OutgoingIntegrationWebhookTemplate { + if o == nil || o.Data == nil { + var ret []OutgoingIntegrationWebhookTemplate + 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 *OutgoingIntegrationWebhookTemplates) GetDataOk() ([]OutgoingIntegrationWebhookTemplate, bool) { + if o == nil || o.Data == nil { + var ret []OutgoingIntegrationWebhookTemplate + return ret, false + } + return *o.Data, true +} + +// HasData returns a boolean if a field has been set. +func (o *OutgoingIntegrationWebhookTemplates) HasData() bool { + if o != nil && o.Data != nil { + return true + } + + return false +} + +// SetData gets a reference to the given []OutgoingIntegrationWebhookTemplate and assigns it to the Data field. +func (o *OutgoingIntegrationWebhookTemplates) SetData(v []OutgoingIntegrationWebhookTemplate) { + o.Data = &v +} + +type NullableOutgoingIntegrationWebhookTemplates struct { + Value OutgoingIntegrationWebhookTemplates + ExplicitNull bool +} + +func (v NullableOutgoingIntegrationWebhookTemplates) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOutgoingIntegrationWebhookTemplates) 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 index c0a934b8..76329a36 100644 --- a/model_patch_item_catalog_action.go +++ b/model_patch_item_catalog_action.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_patch_many_items_catalog_action.go b/model_patch_many_items_catalog_action.go index 6b02d00a..d162ed73 100644 --- a/model_patch_many_items_catalog_action.go +++ b/model_patch_many_items_catalog_action.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_picklist.go b/model_picklist.go new file mode 100644 index 00000000..1ec3cd5b --- /dev/null +++ b/model_picklist.go @@ -0,0 +1,233 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// Picklist +type Picklist struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. + Created time.Time `json:"created"` + // The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. + Type string `json:"type"` + // The list of allowed values provided by this picklist. + Values []string `json:"values"` + // 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 account that owns this entity. + AccountId *int32 `json:"accountId,omitempty"` + // Imported flag shows that a picklist is imported by a CSV file or not + Imported *bool `json:"imported,omitempty"` +} + +// GetId returns the Id field value +func (o *Picklist) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *Picklist) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *Picklist) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Picklist) SetCreated(v time.Time) { + o.Created = v +} + +// GetType returns the Type field value +func (o *Picklist) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *Picklist) SetType(v string) { + o.Type = v +} + +// GetValues returns the Values field value +func (o *Picklist) GetValues() []string { + if o == nil { + var ret []string + return ret + } + + return o.Values +} + +// SetValues sets field value +func (o *Picklist) SetValues(v []string) { + o.Values = v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *Picklist) 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 *Picklist) 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 *Picklist) 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 *Picklist) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *Picklist) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *Picklist) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetAccountId returns the AccountId field value if set, zero value otherwise. +func (o *Picklist) GetAccountId() int32 { + if o == nil || o.AccountId == nil { + var ret int32 + return ret + } + return *o.AccountId +} + +// GetAccountIdOk returns a tuple with the AccountId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Picklist) GetAccountIdOk() (int32, bool) { + if o == nil || o.AccountId == nil { + var ret int32 + return ret, false + } + return *o.AccountId, true +} + +// HasAccountId returns a boolean if a field has been set. +func (o *Picklist) HasAccountId() bool { + if o != nil && o.AccountId != nil { + return true + } + + return false +} + +// SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. +func (o *Picklist) SetAccountId(v int32) { + o.AccountId = &v +} + +// GetImported returns the Imported field value if set, zero value otherwise. +func (o *Picklist) GetImported() bool { + if o == nil || o.Imported == nil { + var ret bool + return ret + } + return *o.Imported +} + +// GetImportedOk returns a tuple with the Imported field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Picklist) GetImportedOk() (bool, bool) { + if o == nil || o.Imported == nil { + var ret bool + return ret, false + } + return *o.Imported, true +} + +// HasImported returns a boolean if a field has been set. +func (o *Picklist) HasImported() bool { + if o != nil && o.Imported != nil { + return true + } + + return false +} + +// SetImported gets a reference to the given bool and assigns it to the Imported field. +func (o *Picklist) SetImported(v bool) { + o.Imported = &v +} + +type NullablePicklist struct { + Value Picklist + ExplicitNull bool +} + +func (v NullablePicklist) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullablePicklist) 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_priority_position.go b/model_priority_position.go new file mode 100644 index 00000000..11cd780b --- /dev/null +++ b/model_priority_position.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// PriorityPosition The campaign priority. +type PriorityPosition struct { + // The name of the priority set where the campaign is located. + Set string `json:"set"` + // The position of the campaign in the priority order starting from 1. + Position int32 `json:"position"` +} + +// GetSet returns the Set field value +func (o *PriorityPosition) GetSet() string { + if o == nil { + var ret string + return ret + } + + return o.Set +} + +// SetSet sets field value +func (o *PriorityPosition) SetSet(v string) { + o.Set = v +} + +// GetPosition returns the Position field value +func (o *PriorityPosition) GetPosition() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Position +} + +// SetPosition sets field value +func (o *PriorityPosition) SetPosition(v int32) { + o.Position = v +} + +type NullablePriorityPosition struct { + Value PriorityPosition + ExplicitNull bool +} + +func (v NullablePriorityPosition) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullablePriorityPosition) 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 7bd2c379..4097efdd 100644 --- a/model_profile_audiences_changes.go +++ b/model_profile_audiences_changes.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 38be5889..c6c7b340 100644 --- a/model_redeem_referral_effect_props.go +++ b/model_redeem_referral_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_referral.go b/model_referral.go index e466bcf0..20480752 100644 --- a/model_referral.go +++ b/model_referral.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,13 +17,13 @@ import ( // Referral type Referral 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time 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. + // Expiration 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"` diff --git a/model_referral_constraints.go b/model_referral_constraints.go index 3afac68a..57ae54d0 100644 --- a/model_referral_constraints.go +++ b/model_referral_constraints.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,7 +19,7 @@ import ( type ReferralConstraints struct { // 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. + // Expiration 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,omitempty"` diff --git a/model_referral_created_effect_props.go b/model_referral_created_effect_props.go index 0fa1fe51..68fdae50 100644 --- a/model_referral_created_effect_props.go +++ b/model_referral_created_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_referral_rejection_reason.go b/model_referral_rejection_reason.go index 72048547..e94e8941 100644 --- a/model_referral_rejection_reason.go +++ b/model_referral_rejection_reason.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * 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 08ce29bf..c2d43dc2 100644 --- a/model_reject_coupon_effect_props.go +++ b/model_reject_coupon_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_reject_referral_effect_props.go b/model_reject_referral_effect_props.go index fbfc71a3..1808a60e 100644 --- a/model_reject_referral_effect_props.go +++ b/model_reject_referral_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_remove_item_catalog_action.go b/model_remove_item_catalog_action.go index 03ca3def..2e4c3aca 100644 --- a/model_remove_item_catalog_action.go +++ b/model_remove_item_catalog_action.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_remove_many_items_catalog_action.go b/model_remove_many_items_catalog_action.go index 04df4a04..3cfa4c96 100644 --- a/model_remove_many_items_catalog_action.go +++ b/model_remove_many_items_catalog_action.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_reopen_session_response.go b/model_reopen_session_response.go new file mode 100644 index 00000000..0346c491 --- /dev/null +++ b/model_reopen_session_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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ReopenSessionResponse This is the response type returned by the Reopen customer sessions endpoint. It contains the rolled back effects. +type ReopenSessionResponse struct { + // The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). + Effects []Effect `json:"effects"` +} + +// GetEffects returns the Effects field value +func (o *ReopenSessionResponse) GetEffects() []Effect { + if o == nil { + var ret []Effect + return ret + } + + return o.Effects +} + +// SetEffects sets field value +func (o *ReopenSessionResponse) SetEffects(v []Effect) { + o.Effects = v +} + +type NullableReopenSessionResponse struct { + Value ReopenSessionResponse + ExplicitNull bool +} + +func (v NullableReopenSessionResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableReopenSessionResponse) 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_reserve_coupon_effect_props.go b/model_reserve_coupon_effect_props.go new file mode 100644 index 00000000..7d212117 --- /dev/null +++ b/model_reserve_coupon_effect_props.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ReserveCouponEffectProps The properties specific to the \"reserveCoupon\" effect. This gets triggered whenever a validated rule contained a \"reserve coupon\" effect. This reserves the coupon currently on scope to the profile on scope. +type ReserveCouponEffectProps struct { + // The value of the coupon currently on scope. + CouponValue string `json:"couponValue"` + // The ID of this customer profile in the third-party integration. + ProfileIntegrationId string `json:"profileIntegrationId"` + // Indicates whether this is a new coupon reservation or not. + IsNewReservation bool `json:"isNewReservation"` +} + +// GetCouponValue returns the CouponValue field value +func (o *ReserveCouponEffectProps) GetCouponValue() string { + if o == nil { + var ret string + return ret + } + + return o.CouponValue +} + +// SetCouponValue sets field value +func (o *ReserveCouponEffectProps) SetCouponValue(v string) { + o.CouponValue = v +} + +// GetProfileIntegrationId returns the ProfileIntegrationId field value +func (o *ReserveCouponEffectProps) GetProfileIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.ProfileIntegrationId +} + +// SetProfileIntegrationId sets field value +func (o *ReserveCouponEffectProps) SetProfileIntegrationId(v string) { + o.ProfileIntegrationId = v +} + +// GetIsNewReservation returns the IsNewReservation field value +func (o *ReserveCouponEffectProps) GetIsNewReservation() bool { + if o == nil { + var ret bool + return ret + } + + return o.IsNewReservation +} + +// SetIsNewReservation sets field value +func (o *ReserveCouponEffectProps) SetIsNewReservation(v bool) { + o.IsNewReservation = v +} + +type NullableReserveCouponEffectProps struct { + Value ReserveCouponEffectProps + ExplicitNull bool +} + +func (v NullableReserveCouponEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableReserveCouponEffectProps) 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 index bbec2cbe..6e433f5f 100644 --- a/model_return.go +++ b/model_return.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` diff --git a/model_return_integration_request.go b/model_return_integration_request.go index ecc2bddb..f54b48e0 100644 --- a/model_return_integration_request.go +++ b/model_return_integration_request.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,7 +17,7 @@ import ( // 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`. + // Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer session_ request instead of sending extra requests to other endpoints. ResponseContent *[]string `json:"responseContent,omitempty"` } diff --git a/model_returned_cart_item.go b/model_returned_cart_item.go index 4dc864b6..3280772d 100644 --- a/model_returned_cart_item.go +++ b/model_returned_cart_item.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,7 +18,7 @@ import ( 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. + // Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. Quantity *int32 `json:"quantity,omitempty"` } diff --git a/model_role.go b/model_role.go index 23e4d10e..4a0cf1d3 100644 --- a/model_role.go +++ b/model_role.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,15 +17,15 @@ import ( // Role type Role 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified time.Time `json:"modified"` // The ID of the account that owns this entity. AccountId int32 `json:"accountId"` - // The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups/) 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 string `json:"name"` @@ -33,7 +33,7 @@ type Role struct { Description *string `json:"description,omitempty"` // A list of user identifiers assigned to this role. Members *[]int32 `json:"members,omitempty"` - // Role ACL Policy. + // The `Access Control List` json defining the role of the user. This represents the access control on the user level. Acl map[string]interface{} `json:"acl"` } diff --git a/model_role_assign.go b/model_role_assign.go index a4e4d6e2..ede37cdc 100644 --- a/model_role_assign.go +++ b/model_role_assign.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_role_membership.go b/model_role_membership.go index 5e505bf9..c307d3c6 100644 --- a/model_role_membership.go +++ b/model_role_membership.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_role_v2.go b/model_role_v2.go new file mode 100644 index 00000000..4bb012ec --- /dev/null +++ b/model_role_v2.go @@ -0,0 +1,216 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RoleV2 struct for RoleV2 +type RoleV2 struct { + // Name of the role. + Name *string `json:"name,omitempty"` + // Description of the role. + Description *string `json:"description,omitempty"` + // Indicates whether the role grants admin permissions. + IsAdmin *bool `json:"isAdmin,omitempty"` + Permissions *RoleV2Permissions `json:"permissions,omitempty"` + // An array of user identifiers. + Members *[]int32 `json:"members,omitempty"` +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *RoleV2) 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 *RoleV2) 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 *RoleV2) 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 *RoleV2) SetName(v string) { + o.Name = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *RoleV2) 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 *RoleV2) 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 *RoleV2) 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 *RoleV2) SetDescription(v string) { + o.Description = &v +} + +// GetIsAdmin returns the IsAdmin field value if set, zero value otherwise. +func (o *RoleV2) GetIsAdmin() bool { + if o == nil || o.IsAdmin == nil { + var ret bool + return ret + } + return *o.IsAdmin +} + +// GetIsAdminOk returns a tuple with the IsAdmin field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2) GetIsAdminOk() (bool, bool) { + if o == nil || o.IsAdmin == nil { + var ret bool + return ret, false + } + return *o.IsAdmin, true +} + +// HasIsAdmin returns a boolean if a field has been set. +func (o *RoleV2) HasIsAdmin() bool { + if o != nil && o.IsAdmin != nil { + return true + } + + return false +} + +// SetIsAdmin gets a reference to the given bool and assigns it to the IsAdmin field. +func (o *RoleV2) SetIsAdmin(v bool) { + o.IsAdmin = &v +} + +// GetPermissions returns the Permissions field value if set, zero value otherwise. +func (o *RoleV2) GetPermissions() RoleV2Permissions { + if o == nil || o.Permissions == nil { + var ret RoleV2Permissions + return ret + } + return *o.Permissions +} + +// GetPermissionsOk returns a tuple with the Permissions field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2) GetPermissionsOk() (RoleV2Permissions, bool) { + if o == nil || o.Permissions == nil { + var ret RoleV2Permissions + return ret, false + } + return *o.Permissions, true +} + +// HasPermissions returns a boolean if a field has been set. +func (o *RoleV2) HasPermissions() bool { + if o != nil && o.Permissions != nil { + return true + } + + return false +} + +// SetPermissions gets a reference to the given RoleV2Permissions and assigns it to the Permissions field. +func (o *RoleV2) SetPermissions(v RoleV2Permissions) { + o.Permissions = &v +} + +// GetMembers returns the Members field value if set, zero value otherwise. +func (o *RoleV2) GetMembers() []int32 { + if o == nil || o.Members == nil { + var ret []int32 + return ret + } + return *o.Members +} + +// GetMembersOk returns a tuple with the Members field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2) GetMembersOk() ([]int32, bool) { + if o == nil || o.Members == nil { + var ret []int32 + return ret, false + } + return *o.Members, true +} + +// HasMembers returns a boolean if a field has been set. +func (o *RoleV2) HasMembers() bool { + if o != nil && o.Members != nil { + return true + } + + return false +} + +// SetMembers gets a reference to the given []int32 and assigns it to the Members field. +func (o *RoleV2) SetMembers(v []int32) { + o.Members = &v +} + +type NullableRoleV2 struct { + Value RoleV2 + ExplicitNull bool +} + +func (v NullableRoleV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRoleV2) 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_v2_application_details.go b/model_role_v2_application_details.go new file mode 100644 index 00000000..2c2df824 --- /dev/null +++ b/model_role_v2_application_details.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RoleV2ApplicationDetails struct for RoleV2ApplicationDetails +type RoleV2ApplicationDetails struct { + // Name of the Application-level permission set. + Application *string `json:"application,omitempty"` + // Name of the campaign-level permission set. + Campaign *string `json:"campaign,omitempty"` + // Name of the draft campaign-level permission set. + DraftCampaign *string `json:"draftCampaign,omitempty"` +} + +// GetApplication returns the Application field value if set, zero value otherwise. +func (o *RoleV2ApplicationDetails) GetApplication() string { + if o == nil || o.Application == nil { + var ret string + return ret + } + return *o.Application +} + +// GetApplicationOk returns a tuple with the Application field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2ApplicationDetails) GetApplicationOk() (string, bool) { + if o == nil || o.Application == nil { + var ret string + return ret, false + } + return *o.Application, true +} + +// HasApplication returns a boolean if a field has been set. +func (o *RoleV2ApplicationDetails) HasApplication() bool { + if o != nil && o.Application != nil { + return true + } + + return false +} + +// SetApplication gets a reference to the given string and assigns it to the Application field. +func (o *RoleV2ApplicationDetails) SetApplication(v string) { + o.Application = &v +} + +// GetCampaign returns the Campaign field value if set, zero value otherwise. +func (o *RoleV2ApplicationDetails) GetCampaign() string { + if o == nil || o.Campaign == nil { + var ret string + return ret + } + return *o.Campaign +} + +// GetCampaignOk returns a tuple with the Campaign field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2ApplicationDetails) GetCampaignOk() (string, bool) { + if o == nil || o.Campaign == nil { + var ret string + return ret, false + } + return *o.Campaign, true +} + +// HasCampaign returns a boolean if a field has been set. +func (o *RoleV2ApplicationDetails) HasCampaign() bool { + if o != nil && o.Campaign != nil { + return true + } + + return false +} + +// SetCampaign gets a reference to the given string and assigns it to the Campaign field. +func (o *RoleV2ApplicationDetails) SetCampaign(v string) { + o.Campaign = &v +} + +// GetDraftCampaign returns the DraftCampaign field value if set, zero value otherwise. +func (o *RoleV2ApplicationDetails) GetDraftCampaign() string { + if o == nil || o.DraftCampaign == nil { + var ret string + return ret + } + return *o.DraftCampaign +} + +// GetDraftCampaignOk returns a tuple with the DraftCampaign field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2ApplicationDetails) GetDraftCampaignOk() (string, bool) { + if o == nil || o.DraftCampaign == nil { + var ret string + return ret, false + } + return *o.DraftCampaign, true +} + +// HasDraftCampaign returns a boolean if a field has been set. +func (o *RoleV2ApplicationDetails) HasDraftCampaign() bool { + if o != nil && o.DraftCampaign != nil { + return true + } + + return false +} + +// SetDraftCampaign gets a reference to the given string and assigns it to the DraftCampaign field. +func (o *RoleV2ApplicationDetails) SetDraftCampaign(v string) { + o.DraftCampaign = &v +} + +type NullableRoleV2ApplicationDetails struct { + Value RoleV2ApplicationDetails + ExplicitNull bool +} + +func (v NullableRoleV2ApplicationDetails) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRoleV2ApplicationDetails) 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_v2_permission_set.go b/model_role_v2_permission_set.go new file mode 100644 index 00000000..f06cc2ef --- /dev/null +++ b/model_role_v2_permission_set.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RoleV2PermissionSet struct for RoleV2PermissionSet +type RoleV2PermissionSet struct { + // Name of the permission set. + Name string `json:"name"` + OperationIds []string `json:"operationIds"` +} + +// GetName returns the Name field value +func (o *RoleV2PermissionSet) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *RoleV2PermissionSet) SetName(v string) { + o.Name = v +} + +// GetOperationIds returns the OperationIds field value +func (o *RoleV2PermissionSet) GetOperationIds() []string { + if o == nil { + var ret []string + return ret + } + + return o.OperationIds +} + +// SetOperationIds sets field value +func (o *RoleV2PermissionSet) SetOperationIds(v []string) { + o.OperationIds = v +} + +type NullableRoleV2PermissionSet struct { + Value RoleV2PermissionSet + ExplicitNull bool +} + +func (v NullableRoleV2PermissionSet) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRoleV2PermissionSet) 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_v2_permissions.go b/model_role_v2_permissions.go new file mode 100644 index 00000000..33acc2b3 --- /dev/null +++ b/model_role_v2_permissions.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RoleV2Permissions struct for RoleV2Permissions +type RoleV2Permissions struct { + // List of grouped operation IDs to use as a reference in the roles section. Each group of operation IDs has a name. + PermissionSets *[]RoleV2PermissionSet `json:"permissionSets,omitempty"` + Roles *RoleV2PermissionsRoles `json:"roles,omitempty"` +} + +// GetPermissionSets returns the PermissionSets field value if set, zero value otherwise. +func (o *RoleV2Permissions) GetPermissionSets() []RoleV2PermissionSet { + if o == nil || o.PermissionSets == nil { + var ret []RoleV2PermissionSet + return ret + } + return *o.PermissionSets +} + +// GetPermissionSetsOk returns a tuple with the PermissionSets field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2Permissions) GetPermissionSetsOk() ([]RoleV2PermissionSet, bool) { + if o == nil || o.PermissionSets == nil { + var ret []RoleV2PermissionSet + return ret, false + } + return *o.PermissionSets, true +} + +// HasPermissionSets returns a boolean if a field has been set. +func (o *RoleV2Permissions) HasPermissionSets() bool { + if o != nil && o.PermissionSets != nil { + return true + } + + return false +} + +// SetPermissionSets gets a reference to the given []RoleV2PermissionSet and assigns it to the PermissionSets field. +func (o *RoleV2Permissions) SetPermissionSets(v []RoleV2PermissionSet) { + o.PermissionSets = &v +} + +// GetRoles returns the Roles field value if set, zero value otherwise. +func (o *RoleV2Permissions) GetRoles() RoleV2PermissionsRoles { + if o == nil || o.Roles == nil { + var ret RoleV2PermissionsRoles + return ret + } + return *o.Roles +} + +// GetRolesOk returns a tuple with the Roles field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2Permissions) GetRolesOk() (RoleV2PermissionsRoles, bool) { + if o == nil || o.Roles == nil { + var ret RoleV2PermissionsRoles + return ret, false + } + return *o.Roles, true +} + +// HasRoles returns a boolean if a field has been set. +func (o *RoleV2Permissions) HasRoles() bool { + if o != nil && o.Roles != nil { + return true + } + + return false +} + +// SetRoles gets a reference to the given RoleV2PermissionsRoles and assigns it to the Roles field. +func (o *RoleV2Permissions) SetRoles(v RoleV2PermissionsRoles) { + o.Roles = &v +} + +type NullableRoleV2Permissions struct { + Value RoleV2Permissions + ExplicitNull bool +} + +func (v NullableRoleV2Permissions) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRoleV2Permissions) 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_v2_permissions_roles.go b/model_role_v2_permissions_roles.go new file mode 100644 index 00000000..b293b477 --- /dev/null +++ b/model_role_v2_permissions_roles.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RoleV2PermissionsRoles struct for RoleV2PermissionsRoles +type RoleV2PermissionsRoles struct { + Applications *map[string]RoleV2ApplicationDetails `json:"applications,omitempty"` + LoyaltyPrograms *map[string]string `json:"loyaltyPrograms,omitempty"` + CampaignAccessGroups *map[string]string `json:"campaignAccessGroups,omitempty"` +} + +// GetApplications returns the Applications field value if set, zero value otherwise. +func (o *RoleV2PermissionsRoles) GetApplications() map[string]RoleV2ApplicationDetails { + if o == nil || o.Applications == nil { + var ret map[string]RoleV2ApplicationDetails + return ret + } + return *o.Applications +} + +// GetApplicationsOk returns a tuple with the Applications field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2PermissionsRoles) GetApplicationsOk() (map[string]RoleV2ApplicationDetails, bool) { + if o == nil || o.Applications == nil { + var ret map[string]RoleV2ApplicationDetails + return ret, false + } + return *o.Applications, true +} + +// HasApplications returns a boolean if a field has been set. +func (o *RoleV2PermissionsRoles) HasApplications() bool { + if o != nil && o.Applications != nil { + return true + } + + return false +} + +// SetApplications gets a reference to the given map[string]RoleV2ApplicationDetails and assigns it to the Applications field. +func (o *RoleV2PermissionsRoles) SetApplications(v map[string]RoleV2ApplicationDetails) { + o.Applications = &v +} + +// GetLoyaltyPrograms returns the LoyaltyPrograms field value if set, zero value otherwise. +func (o *RoleV2PermissionsRoles) GetLoyaltyPrograms() map[string]string { + if o == nil || o.LoyaltyPrograms == nil { + var ret map[string]string + return ret + } + return *o.LoyaltyPrograms +} + +// GetLoyaltyProgramsOk returns a tuple with the LoyaltyPrograms field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2PermissionsRoles) GetLoyaltyProgramsOk() (map[string]string, bool) { + if o == nil || o.LoyaltyPrograms == nil { + var ret map[string]string + return ret, false + } + return *o.LoyaltyPrograms, true +} + +// HasLoyaltyPrograms returns a boolean if a field has been set. +func (o *RoleV2PermissionsRoles) HasLoyaltyPrograms() bool { + if o != nil && o.LoyaltyPrograms != nil { + return true + } + + return false +} + +// SetLoyaltyPrograms gets a reference to the given map[string]string and assigns it to the LoyaltyPrograms field. +func (o *RoleV2PermissionsRoles) SetLoyaltyPrograms(v map[string]string) { + o.LoyaltyPrograms = &v +} + +// GetCampaignAccessGroups returns the CampaignAccessGroups field value if set, zero value otherwise. +func (o *RoleV2PermissionsRoles) GetCampaignAccessGroups() map[string]string { + if o == nil || o.CampaignAccessGroups == nil { + var ret map[string]string + return ret + } + return *o.CampaignAccessGroups +} + +// GetCampaignAccessGroupsOk returns a tuple with the CampaignAccessGroups field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RoleV2PermissionsRoles) GetCampaignAccessGroupsOk() (map[string]string, bool) { + if o == nil || o.CampaignAccessGroups == nil { + var ret map[string]string + return ret, false + } + return *o.CampaignAccessGroups, true +} + +// HasCampaignAccessGroups returns a boolean if a field has been set. +func (o *RoleV2PermissionsRoles) HasCampaignAccessGroups() bool { + if o != nil && o.CampaignAccessGroups != nil { + return true + } + + return false +} + +// SetCampaignAccessGroups gets a reference to the given map[string]string and assigns it to the CampaignAccessGroups field. +func (o *RoleV2PermissionsRoles) SetCampaignAccessGroups(v map[string]string) { + o.CampaignAccessGroups = &v +} + +type NullableRoleV2PermissionsRoles struct { + Value RoleV2PermissionsRoles + ExplicitNull bool +} + +func (v NullableRoleV2PermissionsRoles) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRoleV2PermissionsRoles) 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_rollback_added_loyalty_points_effect_props.go b/model_rollback_added_loyalty_points_effect_props.go index af580ee5..7f62fcf6 100644 --- a/model_rollback_added_loyalty_points_effect_props.go +++ b/model_rollback_added_loyalty_points_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -28,9 +28,9 @@ type RollbackAddedLoyaltyPointsEffectProps struct { 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. + // The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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. + // The alphanumeric identifier of the loyalty card. CardIdentifier *string `json:"cardIdentifier,omitempty"` } diff --git a/model_rollback_coupon_effect_props.go b/model_rollback_coupon_effect_props.go index 28b2f2b8..122750de 100644 --- a/model_rollback_coupon_effect_props.go +++ b/model_rollback_coupon_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_rollback_deducted_loyalty_points_effect_props.go b/model_rollback_deducted_loyalty_points_effect_props.go index 258101d5..2c3f3707 100644 --- a/model_rollback_deducted_loyalty_points_effect_props.go +++ b/model_rollback_deducted_loyalty_points_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -31,7 +31,7 @@ type RollbackDeductedLoyaltyPointsEffectProps struct { ExpiryDate *time.Time `json:"expiryDate,omitempty"` // 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. + // The alphanumeric identifier of the loyalty card. CardIdentifier *string `json:"cardIdentifier,omitempty"` } diff --git a/model_rollback_discount_effect_props.go b/model_rollback_discount_effect_props.go index 39eea23a..8f05511b 100644 --- a/model_rollback_discount_effect_props.go +++ b/model_rollback_discount_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_rollback_referral_effect_props.go b/model_rollback_referral_effect_props.go index a9a4eb31..13b4e7a9 100644 --- a/model_rollback_referral_effect_props.go +++ b/model_rollback_referral_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_rule.go b/model_rule.go index 544dbc31..e2401b6f 100644 --- a/model_rule.go +++ b/model_rule.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,6 +16,10 @@ import ( // Rule struct for Rule type Rule struct { + // A unique identifier for the rule. + Id *string `json:"id,omitempty"` + // The ID of the rule that was copied to create this rule. + ParentId *string `json:"parentId,omitempty"` // A short description of the rule. Title string `json:"title"` // A longer, more detailed description of the rule. @@ -28,6 +32,72 @@ type Rule struct { Effects [][]interface{} `json:"effects"` } +// GetId returns the Id field value if set, zero value otherwise. +func (o *Rule) GetId() string { + if o == nil || o.Id == nil { + var ret string + return ret + } + return *o.Id +} + +// GetIdOk returns a tuple with the Id field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Rule) GetIdOk() (string, bool) { + if o == nil || o.Id == nil { + var ret string + return ret, false + } + return *o.Id, true +} + +// HasId returns a boolean if a field has been set. +func (o *Rule) HasId() bool { + if o != nil && o.Id != nil { + return true + } + + return false +} + +// SetId gets a reference to the given string and assigns it to the Id field. +func (o *Rule) SetId(v string) { + o.Id = &v +} + +// GetParentId returns the ParentId field value if set, zero value otherwise. +func (o *Rule) GetParentId() string { + if o == nil || o.ParentId == nil { + var ret string + return ret + } + return *o.ParentId +} + +// GetParentIdOk returns a tuple with the ParentId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Rule) GetParentIdOk() (string, bool) { + if o == nil || o.ParentId == nil { + var ret string + return ret, false + } + return *o.ParentId, true +} + +// HasParentId returns a boolean if a field has been set. +func (o *Rule) HasParentId() bool { + if o != nil && o.ParentId != nil { + return true + } + + return false +} + +// SetParentId gets a reference to the given string and assigns it to the ParentId field. +func (o *Rule) SetParentId(v string) { + o.ParentId = &v +} + // GetTitle returns the Title field value func (o *Rule) GetTitle() string { if o == nil { diff --git a/model_rule_failure_reason.go b/model_rule_failure_reason.go index 6cd17231..6a91b9f2 100644 --- a/model_rule_failure_reason.go +++ b/model_rule_failure_reason.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_ruleset.go b/model_ruleset.go index 691bd775..e0c7f657 100644 --- a/model_ruleset.go +++ b/model_ruleset.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,14 +17,16 @@ import ( // Ruleset type Ruleset 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The ID of the account that owns this entity. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` // Set of rules to apply. Rules []Rule `json:"rules"` + // Set of rules to apply for strikethrough. + StrikethroughRules *[]Rule `json:"strikethroughRules,omitempty"` // 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"` // The version of the rulebuilder used to create this ruleset. @@ -99,6 +101,39 @@ func (o *Ruleset) SetRules(v []Rule) { o.Rules = v } +// GetStrikethroughRules returns the StrikethroughRules field value if set, zero value otherwise. +func (o *Ruleset) GetStrikethroughRules() []Rule { + if o == nil || o.StrikethroughRules == nil { + var ret []Rule + return ret + } + return *o.StrikethroughRules +} + +// GetStrikethroughRulesOk returns a tuple with the StrikethroughRules field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Ruleset) GetStrikethroughRulesOk() ([]Rule, bool) { + if o == nil || o.StrikethroughRules == nil { + var ret []Rule + return ret, false + } + return *o.StrikethroughRules, true +} + +// HasStrikethroughRules returns a boolean if a field has been set. +func (o *Ruleset) HasStrikethroughRules() bool { + if o != nil && o.StrikethroughRules != nil { + return true + } + + return false +} + +// SetStrikethroughRules gets a reference to the given []Rule and assigns it to the StrikethroughRules field. +func (o *Ruleset) SetStrikethroughRules(v []Rule) { + o.StrikethroughRules = &v +} + // GetBindings returns the Bindings field value func (o *Ruleset) GetBindings() []Binding { if o == nil { diff --git a/model_saml_connection.go b/model_saml_connection.go index fcdcce19..4bb694fd 100644 --- a/model_saml_connection.go +++ b/model_saml_connection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -35,9 +35,9 @@ 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. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` } diff --git a/model_saml_connection_metadata.go b/model_saml_connection_metadata.go index 409956c5..839ee999 100644 --- a/model_saml_connection_metadata.go +++ b/model_saml_connection_metadata.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_saml_login_endpoint.go b/model_saml_login_endpoint.go index 148f1cbc..c656ffdc 100644 --- a/model_saml_login_endpoint.go +++ b/model_saml_login_endpoint.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_session.go b/model_session.go index 1c8110bf..2f8e03cf 100644 --- a/model_session.go +++ b/model_session.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_set_discount_effect_props.go b/model_set_discount_effect_props.go index e5442327..85fa9b79 100644 --- a/model_set_discount_effect_props.go +++ b/model_set_discount_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ 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. Value float32 `json:"value"` diff --git a/model_set_discount_per_additional_cost_effect_props.go b/model_set_discount_per_additional_cost_effect_props.go index 312384a8..f827ea1a 100644 --- a/model_set_discount_per_additional_cost_effect_props.go +++ b/model_set_discount_per_additional_cost_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ 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. AdditionalCostId int32 `json:"additionalCostId"` 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 index e45cd870..886230da 100644 --- a/model_set_discount_per_additional_cost_per_item_effect_props.go +++ b/model_set_discount_per_additional_cost_per_item_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ import ( // 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. + // The name / description of this discount Name string `json:"name"` // The ID of the additional cost. AdditionalCostId int32 `json:"additionalCostId"` @@ -24,7 +24,7 @@ type SetDiscountPerAdditionalCostPerItemEffectProps struct { 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. + // Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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"` diff --git a/model_set_discount_per_item_effect_props.go b/model_set_discount_per_item_effect_props.go index 68c091cf..452358ec 100644 --- a/model_set_discount_per_item_effect_props.go +++ b/model_set_discount_per_item_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,7 +22,7 @@ type SetDiscountPerItemEffectProps struct { Value float32 `json:"value"` // The index of the item in the cart items list on which this discount should be applied. 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. + // Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) 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"` @@ -34,7 +34,7 @@ type SetDiscountPerItemEffectProps struct { 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. + // The name of the bundle definition. BundleName *string `json:"bundleName,omitempty"` } diff --git a/model_show_bundle_metadata_effect_props.go b/model_show_bundle_metadata_effect_props.go index 27c703b8..51d4ca19 100644 --- a/model_show_bundle_metadata_effect_props.go +++ b/model_show_bundle_metadata_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_show_notification_effect_props.go b/model_show_notification_effect_props.go index d52360cc..75087d1d 100644 --- a/model_show_notification_effect_props.go +++ b/model_show_notification_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_slot_def.go b/model_slot_def.go index 67c72542..64810e8b 100644 --- a/model_slot_def.go +++ b/model_slot_def.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_strikethrough_changed_item.go b/model_strikethrough_changed_item.go new file mode 100644 index 00000000..c995843d --- /dev/null +++ b/model_strikethrough_changed_item.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// StrikethroughChangedItem The information of affected items. +type StrikethroughChangedItem struct { + // The ID of the event that triggered the strikethrough labeling. + Id int32 `json:"id"` + // The ID of the catalog that the changed item belongs to. + CatalogId int32 `json:"catalogId"` + // The unique SKU of the changed item. + Sku string `json:"sku"` + // The version of the changed item. + Version int32 `json:"version"` + // The price of the changed item. + Price float32 `json:"price"` + // The evaluation time of the changed item. + EvaluatedAt time.Time `json:"evaluatedAt"` + Effects *[]StrikethroughEffect `json:"effects,omitempty"` +} + +// GetId returns the Id field value +func (o *StrikethroughChangedItem) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *StrikethroughChangedItem) SetId(v int32) { + o.Id = v +} + +// GetCatalogId returns the CatalogId field value +func (o *StrikethroughChangedItem) GetCatalogId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CatalogId +} + +// SetCatalogId sets field value +func (o *StrikethroughChangedItem) SetCatalogId(v int32) { + o.CatalogId = v +} + +// GetSku returns the Sku field value +func (o *StrikethroughChangedItem) GetSku() string { + if o == nil { + var ret string + return ret + } + + return o.Sku +} + +// SetSku sets field value +func (o *StrikethroughChangedItem) SetSku(v string) { + o.Sku = v +} + +// GetVersion returns the Version field value +func (o *StrikethroughChangedItem) GetVersion() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Version +} + +// SetVersion sets field value +func (o *StrikethroughChangedItem) SetVersion(v int32) { + o.Version = v +} + +// GetPrice returns the Price field value +func (o *StrikethroughChangedItem) GetPrice() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Price +} + +// SetPrice sets field value +func (o *StrikethroughChangedItem) SetPrice(v float32) { + o.Price = v +} + +// GetEvaluatedAt returns the EvaluatedAt field value +func (o *StrikethroughChangedItem) GetEvaluatedAt() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EvaluatedAt +} + +// SetEvaluatedAt sets field value +func (o *StrikethroughChangedItem) SetEvaluatedAt(v time.Time) { + o.EvaluatedAt = v +} + +// GetEffects returns the Effects field value if set, zero value otherwise. +func (o *StrikethroughChangedItem) GetEffects() []StrikethroughEffect { + if o == nil || o.Effects == nil { + var ret []StrikethroughEffect + 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 *StrikethroughChangedItem) GetEffectsOk() ([]StrikethroughEffect, bool) { + if o == nil || o.Effects == nil { + var ret []StrikethroughEffect + return ret, false + } + return *o.Effects, true +} + +// HasEffects returns a boolean if a field has been set. +func (o *StrikethroughChangedItem) HasEffects() bool { + if o != nil && o.Effects != nil { + return true + } + + return false +} + +// SetEffects gets a reference to the given []StrikethroughEffect and assigns it to the Effects field. +func (o *StrikethroughChangedItem) SetEffects(v []StrikethroughEffect) { + o.Effects = &v +} + +type NullableStrikethroughChangedItem struct { + Value StrikethroughChangedItem + ExplicitNull bool +} + +func (v NullableStrikethroughChangedItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableStrikethroughChangedItem) 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_strikethrough_custom_effect_per_item_props.go b/model_strikethrough_custom_effect_per_item_props.go new file mode 100644 index 00000000..98cbf3e2 --- /dev/null +++ b/model_strikethrough_custom_effect_per_item_props.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// StrikethroughCustomEffectPerItemProps customEffectPerItem effect in strikethrough pricing payload. +type StrikethroughCustomEffectPerItemProps struct { + // ID of the effect. + EffectId int32 `json:"effectId"` + // The type of the custom effect. + Name string `json:"name"` + // The JSON payload of the custom effect. + Payload map[string]interface{} `json:"payload"` +} + +// GetEffectId returns the EffectId field value +func (o *StrikethroughCustomEffectPerItemProps) GetEffectId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.EffectId +} + +// SetEffectId sets field value +func (o *StrikethroughCustomEffectPerItemProps) SetEffectId(v int32) { + o.EffectId = v +} + +// GetName returns the Name field value +func (o *StrikethroughCustomEffectPerItemProps) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *StrikethroughCustomEffectPerItemProps) SetName(v string) { + o.Name = v +} + +// GetPayload returns the Payload field value +func (o *StrikethroughCustomEffectPerItemProps) GetPayload() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *StrikethroughCustomEffectPerItemProps) SetPayload(v map[string]interface{}) { + o.Payload = v +} + +type NullableStrikethroughCustomEffectPerItemProps struct { + Value StrikethroughCustomEffectPerItemProps + ExplicitNull bool +} + +func (v NullableStrikethroughCustomEffectPerItemProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableStrikethroughCustomEffectPerItemProps) 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_strikethrough_effect.go b/model_strikethrough_effect.go new file mode 100644 index 00000000..24b7364f --- /dev/null +++ b/model_strikethrough_effect.go @@ -0,0 +1,143 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// StrikethroughEffect The effect produced for the catalog item. +type StrikethroughEffect struct { + // The ID of the campaign that effect belongs to. + CampaignId int32 `json:"campaignId"` + // The ID of the ruleset containing the rule that triggered this effect. + RulesetId int32 `json:"rulesetId"` + // 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. + RuleName string `json:"ruleName"` + // The type of this effect. + Type string `json:"type"` + Props map[string]interface{} `json:"props"` +} + +// GetCampaignId returns the CampaignId field value +func (o *StrikethroughEffect) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *StrikethroughEffect) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetRulesetId returns the RulesetId field value +func (o *StrikethroughEffect) GetRulesetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.RulesetId +} + +// SetRulesetId sets field value +func (o *StrikethroughEffect) SetRulesetId(v int32) { + o.RulesetId = v +} + +// GetRuleIndex returns the RuleIndex field value +func (o *StrikethroughEffect) GetRuleIndex() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.RuleIndex +} + +// SetRuleIndex sets field value +func (o *StrikethroughEffect) SetRuleIndex(v int32) { + o.RuleIndex = v +} + +// GetRuleName returns the RuleName field value +func (o *StrikethroughEffect) GetRuleName() string { + if o == nil { + var ret string + return ret + } + + return o.RuleName +} + +// SetRuleName sets field value +func (o *StrikethroughEffect) SetRuleName(v string) { + o.RuleName = v +} + +// GetType returns the Type field value +func (o *StrikethroughEffect) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *StrikethroughEffect) SetType(v string) { + o.Type = v +} + +// GetProps returns the Props field value +func (o *StrikethroughEffect) GetProps() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Props +} + +// SetProps sets field value +func (o *StrikethroughEffect) SetProps(v map[string]interface{}) { + o.Props = v +} + +type NullableStrikethroughEffect struct { + Value StrikethroughEffect + ExplicitNull bool +} + +func (v NullableStrikethroughEffect) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableStrikethroughEffect) 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_strikethrough_labeling_notification.go b/model_strikethrough_labeling_notification.go new file mode 100644 index 00000000..c3a6678e --- /dev/null +++ b/model_strikethrough_labeling_notification.go @@ -0,0 +1,125 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// StrikethroughLabelingNotification The strikethrough labels notification for an application. +type StrikethroughLabelingNotification struct { + // The ID of the application that catalog items labels belongs to. + ApplicationId int32 `json:"applicationId"` + // The batch number of the notification. Notifications might be sent in different batches. + CurrentBatch int32 `json:"currentBatch"` + // The total number of batches for the notification. + TotalBatches int32 `json:"totalBatches"` + Trigger StrikethroughTrigger `json:"trigger"` + ChangedItems []StrikethroughChangedItem `json:"changedItems"` +} + +// GetApplicationId returns the ApplicationId field value +func (o *StrikethroughLabelingNotification) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *StrikethroughLabelingNotification) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetCurrentBatch returns the CurrentBatch field value +func (o *StrikethroughLabelingNotification) GetCurrentBatch() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CurrentBatch +} + +// SetCurrentBatch sets field value +func (o *StrikethroughLabelingNotification) SetCurrentBatch(v int32) { + o.CurrentBatch = v +} + +// GetTotalBatches returns the TotalBatches field value +func (o *StrikethroughLabelingNotification) GetTotalBatches() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalBatches +} + +// SetTotalBatches sets field value +func (o *StrikethroughLabelingNotification) SetTotalBatches(v int32) { + o.TotalBatches = v +} + +// GetTrigger returns the Trigger field value +func (o *StrikethroughLabelingNotification) GetTrigger() StrikethroughTrigger { + if o == nil { + var ret StrikethroughTrigger + return ret + } + + return o.Trigger +} + +// SetTrigger sets field value +func (o *StrikethroughLabelingNotification) SetTrigger(v StrikethroughTrigger) { + o.Trigger = v +} + +// GetChangedItems returns the ChangedItems field value +func (o *StrikethroughLabelingNotification) GetChangedItems() []StrikethroughChangedItem { + if o == nil { + var ret []StrikethroughChangedItem + return ret + } + + return o.ChangedItems +} + +// SetChangedItems sets field value +func (o *StrikethroughLabelingNotification) SetChangedItems(v []StrikethroughChangedItem) { + o.ChangedItems = v +} + +type NullableStrikethroughLabelingNotification struct { + Value StrikethroughLabelingNotification + ExplicitNull bool +} + +func (v NullableStrikethroughLabelingNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableStrikethroughLabelingNotification) 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_strikethrough_set_discount_per_item_effect_props.go b/model_strikethrough_set_discount_per_item_effect_props.go new file mode 100644 index 00000000..789f6d6e --- /dev/null +++ b/model_strikethrough_set_discount_per_item_effect_props.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// StrikethroughSetDiscountPerItemEffectProps setDiscountPerItem effect in strikethrough pricing payload. +type StrikethroughSetDiscountPerItemEffectProps struct { + // effect name. + Name string `json:"name"` + // discount value. + Value map[string]interface{} `json:"value"` +} + +// GetName returns the Name field value +func (o *StrikethroughSetDiscountPerItemEffectProps) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *StrikethroughSetDiscountPerItemEffectProps) SetName(v string) { + o.Name = v +} + +// GetValue returns the Value field value +func (o *StrikethroughSetDiscountPerItemEffectProps) GetValue() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *StrikethroughSetDiscountPerItemEffectProps) SetValue(v map[string]interface{}) { + o.Value = v +} + +type NullableStrikethroughSetDiscountPerItemEffectProps struct { + Value StrikethroughSetDiscountPerItemEffectProps + ExplicitNull bool +} + +func (v NullableStrikethroughSetDiscountPerItemEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableStrikethroughSetDiscountPerItemEffectProps) 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_strikethrough_trigger.go b/model_strikethrough_trigger.go new file mode 100644 index 00000000..7afb97ed --- /dev/null +++ b/model_strikethrough_trigger.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// StrikethroughTrigger Information about the event that triggered the strikethrough labeling. +type StrikethroughTrigger struct { + // The ID of the event that triggered the strikethrough labeling. + Id int32 `json:"id"` + // The type of event that triggered the strikethrough labeling. + Type string `json:"type"` + // The creation time of the event that triggered the strikethrough labeling. + TriggeredAt time.Time `json:"triggeredAt"` + // The total number of items affected by the event that triggered the strikethrough labeling. + TotalAffectedItems int32 `json:"totalAffectedItems"` + // The arbitrary properties associated with this trigger type. + Payload map[string]interface{} `json:"payload"` +} + +// GetId returns the Id field value +func (o *StrikethroughTrigger) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *StrikethroughTrigger) SetId(v int32) { + o.Id = v +} + +// GetType returns the Type field value +func (o *StrikethroughTrigger) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *StrikethroughTrigger) SetType(v string) { + o.Type = v +} + +// GetTriggeredAt returns the TriggeredAt field value +func (o *StrikethroughTrigger) GetTriggeredAt() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.TriggeredAt +} + +// SetTriggeredAt sets field value +func (o *StrikethroughTrigger) SetTriggeredAt(v time.Time) { + o.TriggeredAt = v +} + +// GetTotalAffectedItems returns the TotalAffectedItems field value +func (o *StrikethroughTrigger) GetTotalAffectedItems() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.TotalAffectedItems +} + +// SetTotalAffectedItems sets field value +func (o *StrikethroughTrigger) SetTotalAffectedItems(v int32) { + o.TotalAffectedItems = v +} + +// GetPayload returns the Payload field value +func (o *StrikethroughTrigger) GetPayload() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *StrikethroughTrigger) SetPayload(v map[string]interface{}) { + o.Payload = v +} + +type NullableStrikethroughTrigger struct { + Value StrikethroughTrigger + ExplicitNull bool +} + +func (v NullableStrikethroughTrigger) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableStrikethroughTrigger) 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_talang_attribute.go b/model_talang_attribute.go new file mode 100644 index 00000000..c477aa32 --- /dev/null +++ b/model_talang_attribute.go @@ -0,0 +1,267 @@ +/* + * 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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// TalangAttribute +type TalangAttribute struct { + // The name of the entity of the attribute. + Entity *string `json:"entity,omitempty"` + // 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. + Name string `json:"name"` + // The name of the attribute that is displayed to the user in the Campaign Manager. + Title *string `json:"title,omitempty"` + // The talang type of the attribute. + Type string `json:"type"` + // A description of the attribute. + Description *string `json:"description,omitempty"` + // Indicates whether the attribute is visible in the UI or not. + Visible bool `json:"visible"` + // Indicate the kind of the attribute. + Kind string `json:"kind"` + // The number of campaigns that refer to the attribute. + CampaignsCount int32 `json:"campaignsCount"` + // Examples of values that can be assigned to the attribute. + ExampleValue *[]string `json:"exampleValue,omitempty"` +} + +// GetEntity returns the Entity field value if set, zero value otherwise. +func (o *TalangAttribute) GetEntity() string { + if o == nil || o.Entity == nil { + var ret string + return ret + } + return *o.Entity +} + +// GetEntityOk returns a tuple with the Entity field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TalangAttribute) GetEntityOk() (string, bool) { + if o == nil || o.Entity == nil { + var ret string + return ret, false + } + return *o.Entity, true +} + +// HasEntity returns a boolean if a field has been set. +func (o *TalangAttribute) HasEntity() bool { + if o != nil && o.Entity != nil { + return true + } + + return false +} + +// SetEntity gets a reference to the given string and assigns it to the Entity field. +func (o *TalangAttribute) SetEntity(v string) { + o.Entity = &v +} + +// GetName returns the Name field value +func (o *TalangAttribute) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *TalangAttribute) SetName(v string) { + o.Name = v +} + +// GetTitle returns the Title field value if set, zero value otherwise. +func (o *TalangAttribute) GetTitle() string { + if o == nil || o.Title == nil { + var ret string + return ret + } + return *o.Title +} + +// GetTitleOk returns a tuple with the Title field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TalangAttribute) GetTitleOk() (string, bool) { + if o == nil || o.Title == nil { + var ret string + return ret, false + } + return *o.Title, true +} + +// HasTitle returns a boolean if a field has been set. +func (o *TalangAttribute) HasTitle() bool { + if o != nil && o.Title != nil { + return true + } + + return false +} + +// SetTitle gets a reference to the given string and assigns it to the Title field. +func (o *TalangAttribute) SetTitle(v string) { + o.Title = &v +} + +// GetType returns the Type field value +func (o *TalangAttribute) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *TalangAttribute) SetType(v string) { + o.Type = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *TalangAttribute) 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 *TalangAttribute) 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 *TalangAttribute) 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 *TalangAttribute) SetDescription(v string) { + o.Description = &v +} + +// GetVisible returns the Visible field value +func (o *TalangAttribute) GetVisible() bool { + if o == nil { + var ret bool + return ret + } + + return o.Visible +} + +// SetVisible sets field value +func (o *TalangAttribute) SetVisible(v bool) { + o.Visible = v +} + +// GetKind returns the Kind field value +func (o *TalangAttribute) GetKind() string { + if o == nil { + var ret string + return ret + } + + return o.Kind +} + +// SetKind sets field value +func (o *TalangAttribute) SetKind(v string) { + o.Kind = v +} + +// GetCampaignsCount returns the CampaignsCount field value +func (o *TalangAttribute) GetCampaignsCount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignsCount +} + +// SetCampaignsCount sets field value +func (o *TalangAttribute) SetCampaignsCount(v int32) { + o.CampaignsCount = v +} + +// GetExampleValue returns the ExampleValue field value if set, zero value otherwise. +func (o *TalangAttribute) GetExampleValue() []string { + if o == nil || o.ExampleValue == nil { + var ret []string + return ret + } + return *o.ExampleValue +} + +// GetExampleValueOk returns a tuple with the ExampleValue field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TalangAttribute) GetExampleValueOk() ([]string, bool) { + if o == nil || o.ExampleValue == nil { + var ret []string + return ret, false + } + return *o.ExampleValue, true +} + +// HasExampleValue returns a boolean if a field has been set. +func (o *TalangAttribute) HasExampleValue() bool { + if o != nil && o.ExampleValue != nil { + return true + } + + return false +} + +// SetExampleValue gets a reference to the given []string and assigns it to the ExampleValue field. +func (o *TalangAttribute) SetExampleValue(v []string) { + o.ExampleValue = &v +} + +type NullableTalangAttribute struct { + Value TalangAttribute + ExplicitNull bool +} + +func (v NullableTalangAttribute) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableTalangAttribute) 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_talang_attribute_visibility.go b/model_talang_attribute_visibility.go new file mode 100644 index 00000000..09471e8d --- /dev/null +++ b/model_talang_attribute_visibility.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// TalangAttributeVisibility struct for TalangAttributeVisibility +type TalangAttributeVisibility struct { + // List of attribute names to hide in the UI. + Invisible *[]string `json:"invisible,omitempty"` + // List of attribute names to show in the UI. + Visible *[]string `json:"visible,omitempty"` +} + +// GetInvisible returns the Invisible field value if set, zero value otherwise. +func (o *TalangAttributeVisibility) GetInvisible() []string { + if o == nil || o.Invisible == nil { + var ret []string + return ret + } + return *o.Invisible +} + +// GetInvisibleOk returns a tuple with the Invisible field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TalangAttributeVisibility) GetInvisibleOk() ([]string, bool) { + if o == nil || o.Invisible == nil { + var ret []string + return ret, false + } + return *o.Invisible, true +} + +// HasInvisible returns a boolean if a field has been set. +func (o *TalangAttributeVisibility) HasInvisible() bool { + if o != nil && o.Invisible != nil { + return true + } + + return false +} + +// SetInvisible gets a reference to the given []string and assigns it to the Invisible field. +func (o *TalangAttributeVisibility) SetInvisible(v []string) { + o.Invisible = &v +} + +// GetVisible returns the Visible field value if set, zero value otherwise. +func (o *TalangAttributeVisibility) GetVisible() []string { + if o == nil || o.Visible == nil { + var ret []string + return ret + } + return *o.Visible +} + +// GetVisibleOk returns a tuple with the Visible field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TalangAttributeVisibility) GetVisibleOk() ([]string, bool) { + if o == nil || o.Visible == nil { + var ret []string + return ret, false + } + return *o.Visible, true +} + +// HasVisible returns a boolean if a field has been set. +func (o *TalangAttributeVisibility) HasVisible() bool { + if o != nil && o.Visible != nil { + return true + } + + return false +} + +// SetVisible gets a reference to the given []string and assigns it to the Visible field. +func (o *TalangAttributeVisibility) SetVisible(v []string) { + o.Visible = &v +} + +type NullableTalangAttributeVisibility struct { + Value TalangAttributeVisibility + ExplicitNull bool +} + +func (v NullableTalangAttributeVisibility) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableTalangAttributeVisibility) 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_template_arg_def.go b/model_template_arg_def.go index 339fb948..4cb40726 100644 --- a/model_template_arg_def.go +++ b/model_template_arg_def.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -24,6 +24,10 @@ type TemplateArgDef struct { Title string `json:"title"` // Arbitrary metadata that may be used to render an input for this argument. Ui map[string]interface{} `json:"ui"` + // ID of the picklist linked to a template. + PicklistID *int32 `json:"picklistID,omitempty"` + // Whether or not this attribute's value is restricted by picklist (`picklist` property) + RestrictedByPicklist *bool `json:"restrictedByPicklist,omitempty"` } // GetType returns the Type field value @@ -86,6 +90,72 @@ func (o *TemplateArgDef) SetUi(v map[string]interface{}) { o.Ui = v } +// GetPicklistID returns the PicklistID field value if set, zero value otherwise. +func (o *TemplateArgDef) GetPicklistID() int32 { + if o == nil || o.PicklistID == nil { + var ret int32 + return ret + } + return *o.PicklistID +} + +// GetPicklistIDOk returns a tuple with the PicklistID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TemplateArgDef) GetPicklistIDOk() (int32, bool) { + if o == nil || o.PicklistID == nil { + var ret int32 + return ret, false + } + return *o.PicklistID, true +} + +// HasPicklistID returns a boolean if a field has been set. +func (o *TemplateArgDef) HasPicklistID() bool { + if o != nil && o.PicklistID != nil { + return true + } + + return false +} + +// SetPicklistID gets a reference to the given int32 and assigns it to the PicklistID field. +func (o *TemplateArgDef) SetPicklistID(v int32) { + o.PicklistID = &v +} + +// GetRestrictedByPicklist returns the RestrictedByPicklist field value if set, zero value otherwise. +func (o *TemplateArgDef) GetRestrictedByPicklist() bool { + if o == nil || o.RestrictedByPicklist == nil { + var ret bool + return ret + } + return *o.RestrictedByPicklist +} + +// GetRestrictedByPicklistOk returns a tuple with the RestrictedByPicklist field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TemplateArgDef) GetRestrictedByPicklistOk() (bool, bool) { + if o == nil || o.RestrictedByPicklist == nil { + var ret bool + return ret, false + } + return *o.RestrictedByPicklist, true +} + +// HasRestrictedByPicklist returns a boolean if a field has been set. +func (o *TemplateArgDef) HasRestrictedByPicklist() bool { + if o != nil && o.RestrictedByPicklist != nil { + return true + } + + return false +} + +// SetRestrictedByPicklist gets a reference to the given bool and assigns it to the RestrictedByPicklist field. +func (o *TemplateArgDef) SetRestrictedByPicklist(v bool) { + o.RestrictedByPicklist = &v +} + type NullableTemplateArgDef struct { Value TemplateArgDef ExplicitNull bool diff --git a/model_template_def.go b/model_template_def.go index 991c08ca..61712310 100644 --- a/model_template_def.go +++ b/model_template_def.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,9 +17,9 @@ import ( // TemplateDef type TemplateDef 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` diff --git a/model_template_limit_config.go b/model_template_limit_config.go index 0cb28024..db6498ef 100644 --- a/model_template_limit_config.go +++ b/model_template_limit_config.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_tier.go b/model_tier.go index 8d535252..dd35a788 100644 --- a/model_tier.go +++ b/model_tier.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_transfer_loyalty_card.go b/model_transfer_loyalty_card.go new file mode 100644 index 00000000..8bec08e0 --- /dev/null +++ b/model_transfer_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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// TransferLoyaltyCard struct for TransferLoyaltyCard +type TransferLoyaltyCard struct { + // The alphanumeric identifier of the loyalty card. + NewCardIdentifier string `json:"newCardIdentifier"` +} + +// GetNewCardIdentifier returns the NewCardIdentifier field value +func (o *TransferLoyaltyCard) GetNewCardIdentifier() string { + if o == nil { + var ret string + return ret + } + + return o.NewCardIdentifier +} + +// SetNewCardIdentifier sets field value +func (o *TransferLoyaltyCard) SetNewCardIdentifier(v string) { + o.NewCardIdentifier = v +} + +type NullableTransferLoyaltyCard struct { + Value TransferLoyaltyCard + ExplicitNull bool +} + +func (v NullableTransferLoyaltyCard) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableTransferLoyaltyCard) 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_trigger_webhook_effect_props.go b/model_trigger_webhook_effect_props.go index ebab3b3e..4ff8c824 100644 --- a/model_trigger_webhook_effect_props.go +++ b/model_trigger_webhook_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_account.go b/model_update_account.go index 3418b6a5..570e489c 100644 --- a/model_update_account.go +++ b/model_update_account.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_application.go b/model_update_application.go index 3943ee96..be145538 100644 --- a/model_update_application.go +++ b/model_update_application.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -38,7 +38,7 @@ type UpdateApplication struct { DefaultDiscountScope *string `json:"defaultDiscountScope,omitempty"` // 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. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). + // 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#flattening). EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` // Indicates if this is a live or sandbox Application. diff --git a/model_update_attribute_effect_props.go b/model_update_attribute_effect_props.go index 58555174..907bcb12 100644 --- a/model_update_attribute_effect_props.go +++ b/model_update_attribute_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_audience.go b/model_update_audience.go index 34236678..15ae0432 100644 --- a/model_update_audience.go +++ b/model_update_audience.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_campaign.go b/model_update_campaign.go index a4aee733..486d7ce6 100644 --- a/model_update_campaign.go +++ b/model_update_campaign.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_campaign_collection.go b/model_update_campaign_collection.go index a7def640..198be071 100644 --- a/model_update_campaign_collection.go +++ b/model_update_campaign_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_campaign_group.go b/model_update_campaign_group.go index 3b0737d3..b51e3ee7 100644 --- a/model_update_campaign_group.go +++ b/model_update_campaign_group.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_campaign_template.go b/model_update_campaign_template.go index 35be8793..ecd62be2 100644 --- a/model_update_campaign_template.go +++ b/model_update_campaign_template.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,13 +22,13 @@ type UpdateCampaignTemplate struct { Description string `json:"description"` // Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. Instructions string `json:"instructions"` - // The Campaign Attributes that Campaigns created from this template will have by default. + // The campaign attributes that campaigns created from this template will have by default. CampaignAttributes *map[string]interface{} `json:"campaignAttributes,omitempty"` - // The Campaign Attributes that Coupons created from this template will have by default. + // The campaign attributes that coupons created from this template will have by default. CouponAttributes *map[string]interface{} `json:"couponAttributes,omitempty"` - // Only Campaign Templates in 'available' state may be used to create Campaigns. + // Only campaign templates in 'available' state may be used to create campaigns. State string `json:"state"` - // The ID of the Ruleset this Campaign Template will use. + // The ID of the ruleset this campaign template will use. ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` // A list of tags for the campaign template. Tags *[]string `json:"tags,omitempty"` @@ -36,15 +36,15 @@ 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 operate for this campaign template. Limits *[]TemplateLimitConfig `json:"limits,omitempty"` - // Template parameters are fields which can be used to replace values in a rule. + // 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 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. + // The default campaign group ID. DefaultCampaignGroupId *int32 `json:"defaultCampaignGroupId,omitempty"` } diff --git a/model_update_catalog.go b/model_update_catalog.go index 6e4a4d39..436c3ce6 100644 --- a/model_update_catalog.go +++ b/model_update_catalog.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_collection.go b/model_update_collection.go index 38ca8110..db8452ee 100644 --- a/model_update_collection.go +++ b/model_update_collection.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_update_coupon.go b/model_update_coupon.go index 99d45950..91dbfaa3 100644 --- a/model_update_coupon.go +++ b/model_update_coupon.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,11 +19,13 @@ import ( type UpdateCoupon struct { // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration 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"` @@ -31,6 +33,8 @@ type UpdateCoupon struct { RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Whether the reservation effect actually created a new reservation. + IsReservationMandatory *bool `json:"isReservationMandatory,omitempty"` } // GetUsageLimit returns the UsageLimit field value if set, zero value otherwise. @@ -99,6 +103,39 @@ func (o *UpdateCoupon) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *UpdateCoupon) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCoupon) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *UpdateCoupon) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *UpdateCoupon) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *UpdateCoupon) GetStartDate() time.Time { if o == nil || o.StartDate == nil { @@ -264,6 +301,39 @@ func (o *UpdateCoupon) SetAttributes(v map[string]interface{}) { o.Attributes = &v } +// GetIsReservationMandatory returns the IsReservationMandatory field value if set, zero value otherwise. +func (o *UpdateCoupon) GetIsReservationMandatory() bool { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret + } + return *o.IsReservationMandatory +} + +// GetIsReservationMandatoryOk returns a tuple with the IsReservationMandatory field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCoupon) GetIsReservationMandatoryOk() (bool, bool) { + if o == nil || o.IsReservationMandatory == nil { + var ret bool + return ret, false + } + return *o.IsReservationMandatory, true +} + +// HasIsReservationMandatory returns a boolean if a field has been set. +func (o *UpdateCoupon) HasIsReservationMandatory() bool { + if o != nil && o.IsReservationMandatory != nil { + return true + } + + return false +} + +// SetIsReservationMandatory gets a reference to the given bool and assigns it to the IsReservationMandatory field. +func (o *UpdateCoupon) SetIsReservationMandatory(v bool) { + o.IsReservationMandatory = &v +} + type NullableUpdateCoupon struct { Value UpdateCoupon ExplicitNull bool diff --git a/model_update_coupon_batch.go b/model_update_coupon_batch.go index 632ced3f..40855c0f 100644 --- a/model_update_coupon_batch.go +++ b/model_update_coupon_batch.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,11 +19,13 @@ import ( type UpdateCouponBatch struct { // 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. + // The total discount value that the code can give. Typically used to represent a gift card value. DiscountLimit *float32 `json:"discountLimit,omitempty"` + // The number of reservations that can be made with this coupon code. + ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration 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. Attributes *map[string]interface{} `json:"attributes,omitempty"` @@ -97,6 +99,39 @@ func (o *UpdateCouponBatch) SetDiscountLimit(v float32) { o.DiscountLimit = &v } +// GetReservationLimit returns the ReservationLimit field value if set, zero value otherwise. +func (o *UpdateCouponBatch) GetReservationLimit() int32 { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret + } + return *o.ReservationLimit +} + +// GetReservationLimitOk returns a tuple with the ReservationLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCouponBatch) GetReservationLimitOk() (int32, bool) { + if o == nil || o.ReservationLimit == nil { + var ret int32 + return ret, false + } + return *o.ReservationLimit, true +} + +// HasReservationLimit returns a boolean if a field has been set. +func (o *UpdateCouponBatch) HasReservationLimit() bool { + if o != nil && o.ReservationLimit != nil { + return true + } + + return false +} + +// SetReservationLimit gets a reference to the given int32 and assigns it to the ReservationLimit field. +func (o *UpdateCouponBatch) SetReservationLimit(v int32) { + o.ReservationLimit = &v +} + // GetStartDate returns the StartDate field value if set, zero value otherwise. func (o *UpdateCouponBatch) GetStartDate() time.Time { if o == nil || o.StartDate == nil { diff --git a/model_update_custom_effect.go b/model_update_custom_effect.go index ea6ed342..e2dd384f 100644 --- a/model_update_custom_effect.go +++ b/model_update_custom_effect.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,10 @@ import ( // UpdateCustomEffect type UpdateCustomEffect struct { - // 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"` + // Indicates if this effect is per item or not. + IsPerItem *bool `json:"isPerItem,omitempty"` // The name of this effect. Name string `json:"name"` // The title of this effect. @@ -47,6 +49,39 @@ func (o *UpdateCustomEffect) SetApplicationIds(v []int32) { o.ApplicationIds = v } +// GetIsPerItem returns the IsPerItem field value if set, zero value otherwise. +func (o *UpdateCustomEffect) GetIsPerItem() bool { + if o == nil || o.IsPerItem == nil { + var ret bool + return ret + } + return *o.IsPerItem +} + +// GetIsPerItemOk returns a tuple with the IsPerItem field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCustomEffect) GetIsPerItemOk() (bool, bool) { + if o == nil || o.IsPerItem == nil { + var ret bool + return ret, false + } + return *o.IsPerItem, true +} + +// HasIsPerItem returns a boolean if a field has been set. +func (o *UpdateCustomEffect) HasIsPerItem() bool { + if o != nil && o.IsPerItem != nil { + return true + } + + return false +} + +// SetIsPerItem gets a reference to the given bool and assigns it to the IsPerItem field. +func (o *UpdateCustomEffect) SetIsPerItem(v bool) { + o.IsPerItem = &v +} + // GetName returns the Name field value func (o *UpdateCustomEffect) GetName() string { if o == nil { diff --git a/model_update_loyalty_card.go b/model_update_loyalty_card.go index 600ae3ec..6d6f58b4 100644 --- a/model_update_loyalty_card.go +++ b/model_update_loyalty_card.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ import ( // UpdateLoyaltyCard struct for UpdateLoyaltyCard type UpdateLoyaltyCard struct { - // Status of the loyalty card. Can be one of: ['active', 'disabled'] + // Status of the loyalty card. Can be one of: ['active', 'inactive'] Status string `json:"status"` } diff --git a/model_update_loyalty_program.go b/model_update_loyalty_program.go index 7b82fc47..9e1c196d 100644 --- a/model_update_loyalty_program.go +++ b/model_update_loyalty_program.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -22,14 +22,16 @@ type UpdateLoyaltyProgram struct { Description *string `json:"description,omitempty"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications *[]int32 `json:"subscribedApplications,omitempty"` - // 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'. + // The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. 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'. + // The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. DefaultPending *string `json:"defaultPending,omitempty"` // Indicates if this program supports subledgers inside the program. AllowSubledger *bool `json:"allowSubledger,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"` + // Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. + Sandbox *bool `json:"sandbox,omitempty"` // The tiers in this loyalty program. Tiers *[]NewLoyaltyTier `json:"tiers,omitempty"` } @@ -265,6 +267,39 @@ func (o *UpdateLoyaltyProgram) SetUsersPerCardLimit(v int32) { o.UsersPerCardLimit = &v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *UpdateLoyaltyProgram) 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 *UpdateLoyaltyProgram) 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 *UpdateLoyaltyProgram) 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 *UpdateLoyaltyProgram) SetSandbox(v bool) { + o.Sandbox = &v +} + // GetTiers returns the Tiers field value if set, zero value otherwise. func (o *UpdateLoyaltyProgram) GetTiers() []NewLoyaltyTier { if o == nil || o.Tiers == nil { diff --git a/model_update_picklist.go b/model_update_picklist.go new file mode 100644 index 00000000..d08ece90 --- /dev/null +++ b/model_update_picklist.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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// UpdatePicklist +type UpdatePicklist struct { + // The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. + Type string `json:"type"` + // The list of allowed values provided by this picklist. + Values []string `json:"values"` +} + +// GetType returns the Type field value +func (o *UpdatePicklist) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *UpdatePicklist) SetType(v string) { + o.Type = v +} + +// GetValues returns the Values field value +func (o *UpdatePicklist) GetValues() []string { + if o == nil { + var ret []string + return ret + } + + return o.Values +} + +// SetValues sets field value +func (o *UpdatePicklist) SetValues(v []string) { + o.Values = v +} + +type NullableUpdatePicklist struct { + Value UpdatePicklist + ExplicitNull bool +} + +func (v NullableUpdatePicklist) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdatePicklist) 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 c814e435..a320da1a 100644 --- a/model_update_referral.go +++ b/model_update_referral.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -21,7 +21,7 @@ type UpdateReferral struct { FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` // 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. + // Expiration 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. UsageLimit *int32 `json:"usageLimit,omitempty"` diff --git a/model_update_referral_batch.go b/model_update_referral_batch.go index f703c707..e0288faa 100644 --- a/model_update_referral_batch.go +++ b/model_update_referral_batch.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,7 +23,7 @@ type UpdateReferralBatch struct { BatchID string `json:"batchID"` // 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. + // Expiration 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. UsageLimit *int32 `json:"usageLimit,omitempty"` diff --git a/model_update_role.go b/model_update_role.go index 2f79f2a4..1808dde8 100644 --- a/model_update_role.go +++ b/model_update_role.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -20,7 +20,7 @@ type UpdateRole struct { Name *string `json:"name,omitempty"` // Description of the role. Description *string `json:"description,omitempty"` - // Role Policy this should be a stringified blob of json. + // The `Access Control List` json defining the role of the user. This represents the access control on the user level. Acl *string `json:"acl,omitempty"` // An array of user identifiers. Members *[]int32 `json:"members,omitempty"` diff --git a/model_update_user.go b/model_update_user.go index bffdc0d8..5a1e4d2f 100644 --- a/model_update_user.go +++ b/model_update_user.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,7 +18,7 @@ import ( type UpdateUser struct { // The user name. Name *string `json:"name,omitempty"` - // ACL Json. + // The `Access Control List` json defining the role of the user. This represents the access control on the user level. 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"` diff --git a/model_update_user_latest_feed_timestamp.go b/model_update_user_latest_feed_timestamp.go index 1e32acde..d272ecc2 100644 --- a/model_update_user_latest_feed_timestamp.go +++ b/model_update_user_latest_feed_timestamp.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_user.go b/model_user.go index 5199e541..fcee70ac 100644 --- a/model_user.go +++ b/model_user.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,11 +17,11 @@ import ( // User type User 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time this entity was last modified. Modified time.Time `json:"modified"` // The email address associated with your account. Email string `json:"email"` diff --git a/model_user_entity.go b/model_user_entity.go index 52e21454..bcd7b7cf 100644 --- a/model_user_entity.go +++ b/model_user_entity.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,7 +16,7 @@ import ( // UserEntity struct for UserEntity type UserEntity struct { - // The ID of the account that owns this entity. + // The ID of the user associated with this entity. UserId int32 `json:"userId"` } diff --git a/model_user_feed_notifications.go b/model_user_feed_notifications.go index 52ff359f..598c9cd4 100644 --- a/model_user_feed_notifications.go +++ b/model_user_feed_notifications.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_webhook.go b/model_webhook.go index 70bd4c63..d8f66a34 100644 --- a/model_webhook.go +++ b/model_webhook.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,19 +17,19 @@ import ( // Webhook type Webhook 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. + // Internal ID of this entity. Id int32 `json:"id"` - // The exact moment this entity was created. + // The time this entity was created. Created time.Time `json:"created"` - // The exact moment this entity was last modified. + // The time this entity was last modified. 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. + // 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. + // Name or title for this webhook. Title string `json:"title"` // 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. Headers []string `json:"headers"` @@ -37,7 +37,7 @@ type Webhook struct { Payload *string `json:"payload,omitempty"` // 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 the Rule Builder. Enabled bool `json:"enabled"` } diff --git a/model_webhook_activation_log_entry.go b/model_webhook_activation_log_entry.go index 1ca86a19..5c41800a 100644 --- a/model_webhook_activation_log_entry.go +++ b/model_webhook_activation_log_entry.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/model_webhook_log_entry.go b/model_webhook_log_entry.go index f20efb66..15bb7da2 100644 --- a/model_webhook_log_entry.go +++ b/model_webhook_log_entry.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,7 +15,7 @@ import ( "time" ) -// WebhookLogEntry Log of webhook api calls. +// WebhookLogEntry Log of webhook API calls. type WebhookLogEntry struct { // UUID reference of the webhook request. Id string `json:"id"` diff --git a/model_will_award_giveaway_effect_props.go b/model_will_award_giveaway_effect_props.go index 221207e0..9cd40604 100644 --- a/model_will_award_giveaway_effect_props.go +++ b/model_will_award_giveaway_effect_props.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/response.go b/response.go index 0e207605..b64e64c4 100644 --- a/response.go +++ b/response.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/utils.go b/utils.go index a5f652b3..c28cc629 100644 --- a/utils.go +++ b/utils.go @@ -1,9 +1,9 @@ /* * 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}` + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` * - * API version: 1.0.0 + * API version: * Generated by: OpenAPI Generator (https://openapi-generator.tech) */